diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..bd2db95 Binary files /dev/null and b/.DS_Store differ diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..9e008c5 --- /dev/null +++ b/.flake8 @@ -0,0 +1,3 @@ +[flake8] +max-line-length = 88 +exclude = .git,__pycache__,__init__.py,.mypy_cache,.pytest_cache,.venv diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..43995bd --- /dev/null +++ b/.gitignore @@ -0,0 +1,66 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +venv/ +.venv/ +.python-version +.pytest_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +#Ipython Notebook +.ipynb_checkpoints diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..5a39c63 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,24 @@ +# ref: https://docs.gitlab.com/ee/ci/README.html + +stages: + - test + +.tests: + stage: test + script: + - pip install -r requirements.txt + - pip install -r test-requirements.txt + - pytest --cov=openapi_client + +test-3.6: + extends: .tests + image: python:3.6-alpine +test-3.7: + extends: .tests + image: python:3.7-alpine +test-3.8: + extends: .tests + image: python:3.8-alpine +test-3.9: + extends: .tests + image: python:3.9-alpine diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore new file mode 100644 index 0000000..7484ee5 --- /dev/null +++ b/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES new file mode 100644 index 0000000..f0926e8 --- /dev/null +++ b/.openapi-generator/FILES @@ -0,0 +1,1245 @@ +.gitignore +.gitlab-ci.yml +.travis.yml +README.md +docs/AdministrationAuditLogApi.md +docs/AdministrationUserAndGroupApi.md +docs/AdvancedRadioSetting.md +docs/ApiReKeyDevice.md +docs/ApiReKeyDeviceList.md +docs/AwsIamCredentials.md +docs/AwsKeyCredentials.md +docs/AzureCredentials.md +docs/Banner.md +docs/Bfd.md +docs/BfdTimerOnTransportTunnels.md +docs/BizInternetTimer.md +docs/Cellular.md +docs/CellularAllOf.md +docs/CellularProfile.md +docs/CertificateManagementDeviceApi.md +docs/CertificateManagementVManageApi.md +docs/CertificateStates.md +docs/CertificateValidity.md +docs/ChannelPowerSettings.md +docs/ClusterManagementApi.md +docs/ColocationApi.md +docs/ColocationServiceGroupApi.md +docs/ConfigGroup.md +docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md +docs/ConfigurationAzureConnectApi.md +docs/ConfigurationCircuitsApi.md +docs/ConfigurationCloudExpressApi.md +docs/ConfigurationCloudOnRampApi.md +docs/ConfigurationConfigurationGroupApi.md +docs/ConfigurationDashboardStatusApi.md +docs/ConfigurationDeviceActionsApi.md +docs/ConfigurationDeviceConfigHistoryApi.md +docs/ConfigurationDeviceConnectivityApi.md +docs/ConfigurationDeviceFirmwareUpdateApi.md +docs/ConfigurationDeviceInventoryApi.md +docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md +docs/ConfigurationDeviceSoftwarePackageApi.md +docs/ConfigurationDeviceSoftwareUpdateApi.md +docs/ConfigurationDeviceTemplateApi.md +docs/ConfigurationDisasterRecoveryApi.md +docs/ConfigurationDownloadedImagesApi.md +docs/ConfigurationFQDNListBuilderApi.md +docs/ConfigurationFeatureCertificateApi.md +docs/ConfigurationFeatureProfileMobilityApi.md +docs/ConfigurationFeatureProfileSDWANApi.md +docs/ConfigurationGeneralTemplateApi.md +docs/ConfigurationIdentityServiceEngineApi.md +docs/ConfigurationIseServerApi.md +docs/ConfigurationMultiCloudApi.md +docs/ConfigurationMultidomainPolicyApi.md +docs/ConfigurationNetworkDesignApi.md +docs/ConfigurationNetworkDesignTemplatesApi.md +docs/ConfigurationPolicyAMPDefinitionBuilderApi.md +docs/ConfigurationPolicyASPathListBuilderApi.md +docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md +docs/ConfigurationPolicyAppProbeClassListBuilderApi.md +docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md +docs/ConfigurationPolicyApplicationListBuilderApi.md +docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md +docs/ConfigurationPolicyCloudApplicationBuilderApi.md +docs/ConfigurationPolicyColorListBuilderApi.md +docs/ConfigurationPolicyCommunityListBuilderApi.md +docs/ConfigurationPolicyControlDefinitionBuilderApi.md +docs/ConfigurationPolicyCustomApplicationBuilderApi.md +docs/ConfigurationPolicyDataDefinitionBuilderApi.md +docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md +docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md +docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md +docs/ConfigurationPolicyDataPrefixListBuilderApi.md +docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md +docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md +docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md +docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md +docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md +docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md +docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md +docs/ConfigurationPolicyFaxProtocolListBuilderApi.md +docs/ConfigurationPolicyForwardingClassListBuilderApi.md +docs/ConfigurationPolicyGeoLocationListBuilderApi.md +docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md +docs/ConfigurationPolicyIPSSignatureListBuilderApi.md +docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md +docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md +docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md +docs/ConfigurationPolicyIdentityListBuilderApi.md +docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md +docs/ConfigurationPolicyListBuilderApi.md +docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md +docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md +docs/ConfigurationPolicyMediaProfileListBuilderApi.md +docs/ConfigurationPolicyMeshDefinitionBuilderApi.md +docs/ConfigurationPolicyMirrorListBuilderApi.md +docs/ConfigurationPolicyModemPassthroughListBuilderApi.md +docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md +docs/ConfigurationPolicyPolicerClassListBuilderApi.md +docs/ConfigurationPolicyPortListBuilderApi.md +docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md +docs/ConfigurationPolicyPrefixListBuilderApi.md +docs/ConfigurationPolicyProtocolNameListBuilderApi.md +docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md +docs/ConfigurationPolicyRegionListBuilderApi.md +docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md +docs/ConfigurationPolicySLAClassListBuilderApi.md +docs/ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi.md +docs/ConfigurationPolicySecurityAssemblerApi.md +docs/ConfigurationPolicySiteListBuilderApi.md +docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md +docs/ConfigurationPolicyTLOCListBuilderApi.md +docs/ConfigurationPolicyThreatGridApiKeyListApi.md +docs/ConfigurationPolicyTranslationProfileListBuilderApi.md +docs/ConfigurationPolicyTranslationRulesListBuilderApi.md +docs/ConfigurationPolicyTrunkGroupListBuilderApi.md +docs/ConfigurationPolicyURLBlackListBuilderApi.md +docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md +docs/ConfigurationPolicyURLWhiteListBuilderApi.md +docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md +docs/ConfigurationPolicyVEdgeAssemblerApi.md +docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md +docs/ConfigurationPolicyVPNListBuilderApi.md +docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md +docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md +docs/ConfigurationPolicyVSmartAssemblerApi.md +docs/ConfigurationPolicyVoiceAssemblerApi.md +docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md +docs/ConfigurationPolicyZoneListBuilderApi.md +docs/ConfigurationPreUpgradeCheckStatusApi.md +docs/ConfigurationPreferredColorGroupListBuilderApi.md +docs/ConfigurationQuickConnectApi.md +docs/ConfigurationRuleSetDefinitionApi.md +docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md +docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md +docs/ConfigurationSecureInternetGatewayTunnelsApi.md +docs/ConfigurationSecurityGroupDefinitionApi.md +docs/ConfigurationSecurityTemplatePolicyApi.md +docs/ConfigurationSegmentsApi.md +docs/ConfigurationSettingsApi.md +docs/ConfigurationSoftwareActionsApi.md +docs/ConfigurationTemplateConfigurationApi.md +docs/ConfigurationTemplateLockApi.md +docs/ConfigurationTemplateMasterApi.md +docs/ConfigurationTopologyApi.md +docs/ConfigurationVEdgeTemplatePolicyApi.md +docs/ConfigurationVSmartTemplatePolicyApi.md +docs/ConfigurationVoiceTemplatePolicyApi.md +docs/ConnectToNtpServer.md +docs/ControlStatus.md +docs/CorporateWifi.md +docs/CountryRegionSettings.md +docs/CreateDeviceParams.md +docs/CreateTenantModel.md +docs/DHCPPool.md +docs/DataCenter.md +docs/DataCenterRegistration.md +docs/DataCollectionAgentApi.md +docs/DeleteTenantBulkModel.md +docs/DeleteTenantModel.md +docs/DeploymentModeApi.md +docs/Device.md +docs/DeviceHealthDetails.md +docs/DeviceIP.md +docs/DeviceMessagingApi.md +docs/DeviceModel.md +docs/DeviceNetworkApi.md +docs/DeviceType.md +docs/DeviceUuid.md +docs/DevicesHealth.md +docs/DevicesHealthOverview.md +docs/DisasterRecoverySettings.md +docs/DomainDetail.md +docs/EntityOwnershipInfo.md +docs/EquinixCredentials.md +docs/EquinixLocationInfo.md +docs/EquinixNEInfo.md +docs/EquinixPartnerPort.md +docs/Ethernet.md +docs/EthernetAllOf.md +docs/EthernetInterface.md +docs/EventName.md +docs/FeatureProfile.md +docs/GcpCredentials.md +docs/GetO365PreferredPathFromVAnalyticsRequest.md +docs/GetO365PreferredPathFromVAnalyticsRequestValue.md +docs/GlobalSettings.md +docs/GlobalSettingsAllOf.md +docs/GroupId.md +docs/GuestWifi.md +docs/HSECApi.md +docs/HSECLicenseApi.md +docs/Header.md +docs/HeaderElement.md +docs/Host.md +docs/HsecActivateApi.md +docs/IkePhase.md +docs/IpSecPolicy.md +docs/IpSecSecurity.md +docs/LocaleApi.md +docs/LoggingSystemMessages.md +docs/LoginAccessToRouter.md +docs/LteTimer.md +docs/MSLAApi.md +docs/MegaportCredentials.md +docs/MegaportLocationInfo.md +docs/MegaportMVEInfo.md +docs/MegaportPartnerPort.md +docs/MonitoringARTApi.md +docs/MonitoringAlarmsDetailsApi.md +docs/MonitoringAlarmsNotificationApi.md +docs/MonitoringAppHostingApi.md +docs/MonitoringApplicationAwareRoutingApi.md +docs/MonitoringApplicationAwareRoutingStatisticsApi.md +docs/MonitoringBFDApi.md +docs/MonitoringBridgeApi.md +docs/MonitoringCellularEIOLTEApi.md +docs/MonitoringCflowdApi.md +docs/MonitoringCloudExpressApi.md +docs/MonitoringDPIApi.md +docs/MonitoringDPIOnDemandTroubleshootingApi.md +docs/MonitoringDeviceDetailsApi.md +docs/MonitoringDeviceStatisticsApi.md +docs/MonitoringDeviceStatisticsDetailsApi.md +docs/MonitoringEndpointTrackerStatusApi.md +docs/MonitoringEventsApi.md +docs/MonitoringFlowlogApi.md +docs/MonitoringHealthApi.md +docs/MonitoringIPsAlertApi.md +docs/MonitoringInterfaceStatisticsApi.md +docs/MonitoringQoSApi.md +docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md +docs/MonitoringServerInfoApi.md +docs/MonitoringStatsDownloadApi.md +docs/MonitoringStatsProcessingApi.md +docs/MonitoringStatusApi.md +docs/MonitoringSystemStatusStatsApi.md +docs/MonitoringURLFilteringApi.md +docs/MonitoringUmbrellaApi.md +docs/MonitoringUmbrellaPatternsApi.md +docs/MonitoringVNFInterfaceStatisticsApi.md +docs/MonitoringWlanClientInfoApi.md +docs/MplsTimer.md +docs/MultiCloudAccountInfo.md +docs/MultiCloudEdgeAccountInfo.md +docs/MultiCloudEdgeBillingAccountInfo.md +docs/MultiCloudEdgeLocationInfo.md +docs/MultiCloudEdgePartnerPort.md +docs/MultitenantAPIsProviderApi.md +docs/NATRule.md +docs/NWPIApi.md +docs/NameValuePair.md +docs/NetworkProtocol.md +docs/NetworkProtocolAllOf.md +docs/Node.md +docs/NwpiDomainMonitor.md +docs/OMP.md +docs/OnDemandQueueEntry.md +docs/PartnerACIPolicyBuilderApi.md +docs/PartnerDNACSDAAPIApi.md +docs/PartnerRegistrationApi.md +docs/PartnerType.md +docs/PartnerWCMConfigsApi.md +docs/PolicyRule.md +docs/ProfileParcel.md +docs/PropertyDefinition.md +docs/PublicInternetTimer.md +docs/QueueEntries.md +docs/QueueProperties.md +docs/RadioBandSetting24G.md +docs/RadioBandSetting5G.md +docs/RadiusServer.md +docs/RealTimeMonitoringAAAApi.md +docs/RealTimeMonitoringARPApi.md +docs/RealTimeMonitoringAppHostingApi.md +docs/RealTimeMonitoringAppLogsApi.md +docs/RealTimeMonitoringApplicationAwareRouteApi.md +docs/RealTimeMonitoringAppqoeApi.md +docs/RealTimeMonitoringBFDApi.md +docs/RealTimeMonitoringBGPApi.md +docs/RealTimeMonitoringBridgeApi.md +docs/RealTimeMonitoringCFMApi.md +docs/RealTimeMonitoringCellularAONIpsecInterfaceApi.md +docs/RealTimeMonitoringCellularApi.md +docs/RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md +docs/RealTimeMonitoringCellularEIOLTEHardwareServiceApi.md +docs/RealTimeMonitoringCellularEIOLTENetworkServiceApi.md +docs/RealTimeMonitoringCellularEIOLTESimServiceApi.md +docs/RealTimeMonitoringCloudExpressApi.md +docs/RealTimeMonitoringCommitListApi.md +docs/RealTimeMonitoringContainerLifecycleApi.md +docs/RealTimeMonitoringCrashLogApi.md +docs/RealTimeMonitoringDHCPApi.md +docs/RealTimeMonitoringDOT1xApi.md +docs/RealTimeMonitoringDPIApi.md +docs/RealTimeMonitoringDREApi.md +docs/RealTimeMonitoringDeviceApi.md +docs/RealTimeMonitoringDeviceControlApi.md +docs/RealTimeMonitoringDeviceFeatureListApi.md +docs/RealTimeMonitoringDeviceSystemStatsApi.md +docs/RealTimeMonitoringDualStaticRouteTrackerServiceApi.md +docs/RealTimeMonitoringEIGRPApi.md +docs/RealTimeMonitoringEndpointTrackerGroupServiceApi.md +docs/RealTimeMonitoringEndpointTrackerServiceApi.md +docs/RealTimeMonitoringGeoFencingApi.md +docs/RealTimeMonitoringHardwareApi.md +docs/RealTimeMonitoringIGMPApi.md +docs/RealTimeMonitoringIPApi.md +docs/RealTimeMonitoringIPsecApi.md +docs/RealTimeMonitoringIPv4FIBApi.md +docs/RealTimeMonitoringIPv6FIBApi.md +docs/RealTimeMonitoringIPv6NeighboursApi.md +docs/RealTimeMonitoringInterfaceApi.md +docs/RealTimeMonitoringLicenseInfoApi.md +docs/RealTimeMonitoringMulticastApi.md +docs/RealTimeMonitoringNMSApi.md +docs/RealTimeMonitoringNTPApi.md +docs/RealTimeMonitoringNetworkHubResourcesApi.md +docs/RealTimeMonitoringOMPApi.md +docs/RealTimeMonitoringOSPFApi.md +docs/RealTimeMonitoringOrchestratorApi.md +docs/RealTimeMonitoringPIMApi.md +docs/RealTimeMonitoringPPPoEApi.md +docs/RealTimeMonitoringPolicerApi.md +docs/RealTimeMonitoringPolicyApi.md +docs/RealTimeMonitoringRBACApi.md +docs/RealTimeMonitoringRebootHistoryApi.md +docs/RealTimeMonitoringSDWANStatisticsApi.md +docs/RealTimeMonitoringSFPApi.md +docs/RealTimeMonitoringSIGApi.md +docs/RealTimeMonitoringSecurityApi.md +docs/RealTimeMonitoringShowOnDemandLocalApi.md +docs/RealTimeMonitoringShowOnDemandRemoteApi.md +docs/RealTimeMonitoringSoftwareApi.md +docs/RealTimeMonitoringSslproxyApi.md +docs/RealTimeMonitoringStaticRouteTrackerServiceApi.md +docs/RealTimeMonitoringSystemApi.md +docs/RealTimeMonitoringTCPOptimizationApi.md +docs/RealTimeMonitoringTcpproxyApi.md +docs/RealTimeMonitoringToolsApi.md +docs/RealTimeMonitoringTransportApi.md +docs/RealTimeMonitoringTrustsecApi.md +docs/RealTimeMonitoringTunnelApi.md +docs/RealTimeMonitoringUTDApi.md +docs/RealTimeMonitoringUcseApi.md +docs/RealTimeMonitoringUmbrellaApi.md +docs/RealTimeMonitoringVDSLServiceApi.md +docs/RealTimeMonitoringVMApi.md +docs/RealTimeMonitoringVPNApi.md +docs/RealTimeMonitoringVRRPApi.md +docs/RealTimeMonitoringVoiceApi.md +docs/RealTimeMonitoringWLANApi.md +docs/RealTimeMonitoringWirelessApi.md +docs/ResourceGroup.md +docs/ResourcePoolApi.md +docs/SDAVCCloudConnectorApi.md +docs/SDAVCDomainBasedAppRulesApi.md +docs/SDAVCIPAddressBasedAppRulesApi.md +docs/SSIDConfig.md +docs/ScheduledBackupRestoreApi.md +docs/SchemaDefinition.md +docs/SecurityPolicy.md +docs/SecurityPolicyAllOf.md +docs/SimSlotConfig.md +docs/SiteHealth.md +docs/SiteToSiteVpn.md +docs/SmartAccountModel.md +docs/SmartLicenseApi.md +docs/SoftwareUploadFileData.md +docs/StatisticsProcessingCounters.md +docs/StatsTypeProcessingCounters.md +docs/SystemCloudServiceApi.md +docs/SystemCloudServiceWebexApi.md +docs/SystemContainerApi.md +docs/SystemReverseProxyApi.md +docs/Systems.md +docs/TagApi.md +docs/TagRestfulResource.md +docs/TenantBackupRestoreApi.md +docs/TenantManagementApi.md +docs/TenantMigrationApi.md +docs/TenantStatus.md +docs/TenantStatusListModel.md +docs/ThreadPoolDefinition.md +docs/ThreadPoolsDefinition.md +docs/ToolsTACCasesApi.md +docs/TroubleshootingToolsDeviceConnectivityApi.md +docs/TroubleshootingToolsDeviceGroupApi.md +docs/TroubleshootingToolsDiagnosticsApi.md +docs/UmbrellaApi.md +docs/UpdateTenantModel.md +docs/UpdateTenantvSmartModel.md +docs/UtilityConfigurationDBApi.md +docs/UtilityLoggingApi.md +docs/UtilitySecurityApi.md +docs/Uuid.md +docs/UuidToDomainId.md +docs/UuidToDomainIdMapping.md +docs/VEdgeBootstrapConfig.md +docs/VEdgeHealth.md +docs/VPNID.md +docs/VResourceGroupNameModel.md +docs/VSmartStatus.md +docs/Variable.md +docs/VertexDefinition.md +docs/Vpn.md +docs/VpnAllOf.md +docs/WanSpec.md +docs/Wifi.md +docs/WifiAllOf.md +docs/WorkflowManagementApi.md +git_push.sh +openapi_client/__init__.py +openapi_client/api/__init__.py +openapi_client/api/administration_audit_log_api.py +openapi_client/api/administration_user_and_group_api.py +openapi_client/api/certificate_management_device_api.py +openapi_client/api/certificate_management_v_manage_api.py +openapi_client/api/cluster_management_api.py +openapi_client/api/colocation_api.py +openapi_client/api/colocation_service_group_api.py +openapi_client/api/configuration_advanced_inspection_profile_definition_api.py +openapi_client/api/configuration_azure_connect_api.py +openapi_client/api/configuration_circuits_api.py +openapi_client/api/configuration_cloud_express_api.py +openapi_client/api/configuration_cloud_on_ramp_api.py +openapi_client/api/configuration_configuration_group_api.py +openapi_client/api/configuration_dashboard_status_api.py +openapi_client/api/configuration_device_actions_api.py +openapi_client/api/configuration_device_config_history_api.py +openapi_client/api/configuration_device_connectivity_api.py +openapi_client/api/configuration_device_firmware_update_api.py +openapi_client/api/configuration_device_inventory_api.py +openapi_client/api/configuration_device_software_package_api.py +openapi_client/api/configuration_device_software_update_api.py +openapi_client/api/configuration_device_ssl_proxy_certificate_management_api.py +openapi_client/api/configuration_device_template_api.py +openapi_client/api/configuration_disaster_recovery_api.py +openapi_client/api/configuration_downloaded_images_api.py +openapi_client/api/configuration_feature_certificate_api.py +openapi_client/api/configuration_feature_profile_mobility_api.py +openapi_client/api/configuration_feature_profile_sdwan_api.py +openapi_client/api/configuration_fqdn_list_builder_api.py +openapi_client/api/configuration_general_template_api.py +openapi_client/api/configuration_identity_service_engine_api.py +openapi_client/api/configuration_ise_server_api.py +openapi_client/api/configuration_multi_cloud_api.py +openapi_client/api/configuration_multidomain_policy_api.py +openapi_client/api/configuration_network_design_api.py +openapi_client/api/configuration_network_design_templates_api.py +openapi_client/api/configuration_policy_access_list_definition_builder_api.py +openapi_client/api/configuration_policy_amp_definition_builder_api.py +openapi_client/api/configuration_policy_app_probe_class_list_builder_api.py +openapi_client/api/configuration_policy_app_route_definition_builder_api.py +openapi_client/api/configuration_policy_application_list_builder_api.py +openapi_client/api/configuration_policy_as_path_list_builder_api.py +openapi_client/api/configuration_policy_cflowd_definition_builder_api.py +openapi_client/api/configuration_policy_cloud_application_builder_api.py +openapi_client/api/configuration_policy_color_list_builder_api.py +openapi_client/api/configuration_policy_community_list_builder_api.py +openapi_client/api/configuration_policy_control_definition_builder_api.py +openapi_client/api/configuration_policy_custom_application_builder_api.py +openapi_client/api/configuration_policy_data_definition_builder_api.py +openapi_client/api/configuration_policy_data_ipv6_prefix_list_builder_api.py +openapi_client/api/configuration_policy_data_prefix_all_types_of_lists_builder_api.py +openapi_client/api/configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py +openapi_client/api/configuration_policy_data_prefix_list_builder_api.py +openapi_client/api/configuration_policy_device_access_definition_builder_api.py +openapi_client/api/configuration_policy_dial_peer_definition_builder_api.py +openapi_client/api/configuration_policy_expanded_community_list_builder_api.py +openapi_client/api/configuration_policy_extended_community_list_builder_api.py +openapi_client/api/configuration_policy_fax_protocol_list_builder_api.py +openapi_client/api/configuration_policy_forwarding_class_list_builder_api.py +openapi_client/api/configuration_policy_fxo_port_definition_builder_api.py +openapi_client/api/configuration_policy_fxs_port_definition_builder_api.py +openapi_client/api/configuration_policy_fxsdid_port_definition_builder_api.py +openapi_client/api/configuration_policy_geo_location_list_builder_api.py +openapi_client/api/configuration_policy_hub_and_spoke_definition_builder_api.py +openapi_client/api/configuration_policy_identity_list_builder_api.py +openapi_client/api/configuration_policy_intrusion_prevention_definition_builder_api.py +openapi_client/api/configuration_policy_ips_signature_list_builder_api.py +openapi_client/api/configuration_policy_ipv6_access_definition_builder_api.py +openapi_client/api/configuration_policy_ipv6_device_access_definition_builder_api.py +openapi_client/api/configuration_policy_ipv6_prefix_list_builder_api.py +openapi_client/api/configuration_policy_list_builder_api.py +openapi_client/api/configuration_policy_local_domain_definition_builder_api.py +openapi_client/api/configuration_policy_local_domain_name_list_builder_api.py +openapi_client/api/configuration_policy_media_profile_list_builder_api.py +openapi_client/api/configuration_policy_mesh_definition_builder_api.py +openapi_client/api/configuration_policy_mirror_list_builder_api.py +openapi_client/api/configuration_policy_modem_passthrough_list_builder_api.py +openapi_client/api/configuration_policy_policer_class_list_builder_api.py +openapi_client/api/configuration_policy_port_list_builder_api.py +openapi_client/api/configuration_policy_prefix_for_all_types_of_lists_builder_api.py +openapi_client/api/configuration_policy_prefix_list_builder_api.py +openapi_client/api/configuration_policy_priisdn_port_definition_builder_api.py +openapi_client/api/configuration_policy_protocol_name_list_builder_api.py +openapi_client/api/configuration_policy_qos_map_definition_builder_api.py +openapi_client/api/configuration_policy_region_list_builder_api.py +openapi_client/api/configuration_policy_rewrite_rule_definition_builder_api.py +openapi_client/api/configuration_policy_secure_internet_gateway_data_centers_builder_api.py +openapi_client/api/configuration_policy_security_assembler_api.py +openapi_client/api/configuration_policy_site_list_builder_api.py +openapi_client/api/configuration_policy_sla_class_list_builder_api.py +openapi_client/api/configuration_policy_supervisory_disc_list_builder_api.py +openapi_client/api/configuration_policy_threat_grid_api_key_list_api.py +openapi_client/api/configuration_policy_tloc_list_builder_api.py +openapi_client/api/configuration_policy_translation_profile_list_builder_api.py +openapi_client/api/configuration_policy_translation_rules_list_builder_api.py +openapi_client/api/configuration_policy_trunk_group_list_builder_api.py +openapi_client/api/configuration_policy_umbrella_data_list_builder_api.py +openapi_client/api/configuration_policy_url_black_list_builder_api.py +openapi_client/api/configuration_policy_url_filtering_definition_builder_api.py +openapi_client/api/configuration_policy_url_white_list_builder_api.py +openapi_client/api/configuration_policy_v_edge_assembler_api.py +openapi_client/api/configuration_policy_v_edge_route_definition_builder_api.py +openapi_client/api/configuration_policy_v_smart_assembler_api.py +openapi_client/api/configuration_policy_voice_assembler_api.py +openapi_client/api/configuration_policy_vpn_list_builder_api.py +openapi_client/api/configuration_policy_vpn_membership_group_definition_builder_api.py +openapi_client/api/configuration_policy_vpn_qos_map_definition_builder_api.py +openapi_client/api/configuration_policy_zone_based_firewall_definition_builder_api.py +openapi_client/api/configuration_policy_zone_list_builder_api.py +openapi_client/api/configuration_pre_upgrade_check_status_api.py +openapi_client/api/configuration_preferred_color_group_list_builder_api.py +openapi_client/api/configuration_quick_connect_api.py +openapi_client/api/configuration_rule_set_definition_api.py +openapi_client/api/configuration_secure_internet_gateway_tunnels_api.py +openapi_client/api/configuration_security_group_definition_api.py +openapi_client/api/configuration_security_template_policy_api.py +openapi_client/api/configuration_segments_api.py +openapi_client/api/configuration_settings_api.py +openapi_client/api/configuration_software_actions_api.py +openapi_client/api/configuration_ssl_decryption_policy_definition_builder_api.py +openapi_client/api/configuration_ssl_decryption_utd_profile_definition_api.py +openapi_client/api/configuration_template_configuration_api.py +openapi_client/api/configuration_template_lock_api.py +openapi_client/api/configuration_template_master_api.py +openapi_client/api/configuration_topology_api.py +openapi_client/api/configuration_v_edge_template_policy_api.py +openapi_client/api/configuration_v_smart_template_policy_api.py +openapi_client/api/configuration_voice_template_policy_api.py +openapi_client/api/data_collection_agent_api.py +openapi_client/api/deployment_mode_api.py +openapi_client/api/device_messaging_api.py +openapi_client/api/device_network_api.py +openapi_client/api/hsec_activate_api.py +openapi_client/api/hsec_api.py +openapi_client/api/hsec_license_api.py +openapi_client/api/locale_api.py +openapi_client/api/monitoring_alarms_details_api.py +openapi_client/api/monitoring_alarms_notification_api.py +openapi_client/api/monitoring_app_hosting_api.py +openapi_client/api/monitoring_application_aware_routing_api.py +openapi_client/api/monitoring_application_aware_routing_statistics_api.py +openapi_client/api/monitoring_art_api.py +openapi_client/api/monitoring_bfd_api.py +openapi_client/api/monitoring_bridge_api.py +openapi_client/api/monitoring_cellular_eiolte_api.py +openapi_client/api/monitoring_cflowd_api.py +openapi_client/api/monitoring_cloud_express_api.py +openapi_client/api/monitoring_device_details_api.py +openapi_client/api/monitoring_device_statistics_api.py +openapi_client/api/monitoring_device_statistics_details_api.py +openapi_client/api/monitoring_dpi_api.py +openapi_client/api/monitoring_dpion_demand_troubleshooting_api.py +openapi_client/api/monitoring_endpoint_tracker_status_api.py +openapi_client/api/monitoring_events_api.py +openapi_client/api/monitoring_flowlog_api.py +openapi_client/api/monitoring_health_api.py +openapi_client/api/monitoring_interface_statistics_api.py +openapi_client/api/monitoring_ips_alert_api.py +openapi_client/api/monitoring_qo_s_api.py +openapi_client/api/monitoring_security_unified_logging_connection_events_api.py +openapi_client/api/monitoring_server_info_api.py +openapi_client/api/monitoring_stats_download_api.py +openapi_client/api/monitoring_stats_processing_api.py +openapi_client/api/monitoring_status_api.py +openapi_client/api/monitoring_system_status_stats_api.py +openapi_client/api/monitoring_umbrella_api.py +openapi_client/api/monitoring_umbrella_patterns_api.py +openapi_client/api/monitoring_url_filtering_api.py +openapi_client/api/monitoring_vnf_interface_statistics_api.py +openapi_client/api/monitoring_wlan_client_info_api.py +openapi_client/api/msla_api.py +openapi_client/api/multitenant_apis_provider_api.py +openapi_client/api/nwpi_api.py +openapi_client/api/partner_aci_policy_builder_api.py +openapi_client/api/partner_dnacsdaapi_api.py +openapi_client/api/partner_registration_api.py +openapi_client/api/partner_wcm_configs_api.py +openapi_client/api/real_time_monitoring_aaa_api.py +openapi_client/api/real_time_monitoring_app_hosting_api.py +openapi_client/api/real_time_monitoring_app_logs_api.py +openapi_client/api/real_time_monitoring_application_aware_route_api.py +openapi_client/api/real_time_monitoring_appqoe_api.py +openapi_client/api/real_time_monitoring_arp_api.py +openapi_client/api/real_time_monitoring_bfd_api.py +openapi_client/api/real_time_monitoring_bgp_api.py +openapi_client/api/real_time_monitoring_bridge_api.py +openapi_client/api/real_time_monitoring_cellular_aon_ipsec_interface_api.py +openapi_client/api/real_time_monitoring_cellular_api.py +openapi_client/api/real_time_monitoring_cellular_eiolte_connection_service_api.py +openapi_client/api/real_time_monitoring_cellular_eiolte_hardware_service_api.py +openapi_client/api/real_time_monitoring_cellular_eiolte_network_service_api.py +openapi_client/api/real_time_monitoring_cellular_eiolte_sim_service_api.py +openapi_client/api/real_time_monitoring_cfm_api.py +openapi_client/api/real_time_monitoring_cloud_express_api.py +openapi_client/api/real_time_monitoring_commit_list_api.py +openapi_client/api/real_time_monitoring_container_lifecycle_api.py +openapi_client/api/real_time_monitoring_crash_log_api.py +openapi_client/api/real_time_monitoring_device_api.py +openapi_client/api/real_time_monitoring_device_control_api.py +openapi_client/api/real_time_monitoring_device_feature_list_api.py +openapi_client/api/real_time_monitoring_device_system_stats_api.py +openapi_client/api/real_time_monitoring_dhcp_api.py +openapi_client/api/real_time_monitoring_dot1x_api.py +openapi_client/api/real_time_monitoring_dpi_api.py +openapi_client/api/real_time_monitoring_dre_api.py +openapi_client/api/real_time_monitoring_dual_static_route_tracker_service_api.py +openapi_client/api/real_time_monitoring_eigrp_api.py +openapi_client/api/real_time_monitoring_endpoint_tracker_group_service_api.py +openapi_client/api/real_time_monitoring_endpoint_tracker_service_api.py +openapi_client/api/real_time_monitoring_geo_fencing_api.py +openapi_client/api/real_time_monitoring_hardware_api.py +openapi_client/api/real_time_monitoring_i_psec_api.py +openapi_client/api/real_time_monitoring_igmp_api.py +openapi_client/api/real_time_monitoring_interface_api.py +openapi_client/api/real_time_monitoring_ip_api.py +openapi_client/api/real_time_monitoring_ipv4_fib_api.py +openapi_client/api/real_time_monitoring_ipv6_fib_api.py +openapi_client/api/real_time_monitoring_ipv6_neighbours_api.py +openapi_client/api/real_time_monitoring_license_info_api.py +openapi_client/api/real_time_monitoring_multicast_api.py +openapi_client/api/real_time_monitoring_network_hub_resources_api.py +openapi_client/api/real_time_monitoring_nms_api.py +openapi_client/api/real_time_monitoring_ntp_api.py +openapi_client/api/real_time_monitoring_omp_api.py +openapi_client/api/real_time_monitoring_orchestrator_api.py +openapi_client/api/real_time_monitoring_ospf_api.py +openapi_client/api/real_time_monitoring_pim_api.py +openapi_client/api/real_time_monitoring_policer_api.py +openapi_client/api/real_time_monitoring_policy_api.py +openapi_client/api/real_time_monitoring_pppo_e_api.py +openapi_client/api/real_time_monitoring_rbac_api.py +openapi_client/api/real_time_monitoring_reboot_history_api.py +openapi_client/api/real_time_monitoring_sdwan_statistics_api.py +openapi_client/api/real_time_monitoring_security_api.py +openapi_client/api/real_time_monitoring_sfp_api.py +openapi_client/api/real_time_monitoring_show_on_demand_local_api.py +openapi_client/api/real_time_monitoring_show_on_demand_remote_api.py +openapi_client/api/real_time_monitoring_sig_api.py +openapi_client/api/real_time_monitoring_software_api.py +openapi_client/api/real_time_monitoring_sslproxy_api.py +openapi_client/api/real_time_monitoring_static_route_tracker_service_api.py +openapi_client/api/real_time_monitoring_system_api.py +openapi_client/api/real_time_monitoring_tcp_optimization_api.py +openapi_client/api/real_time_monitoring_tcpproxy_api.py +openapi_client/api/real_time_monitoring_tools_api.py +openapi_client/api/real_time_monitoring_transport_api.py +openapi_client/api/real_time_monitoring_trustsec_api.py +openapi_client/api/real_time_monitoring_tunnel_api.py +openapi_client/api/real_time_monitoring_ucse_api.py +openapi_client/api/real_time_monitoring_umbrella_api.py +openapi_client/api/real_time_monitoring_utd_api.py +openapi_client/api/real_time_monitoring_vdsl_service_api.py +openapi_client/api/real_time_monitoring_vm_api.py +openapi_client/api/real_time_monitoring_voice_api.py +openapi_client/api/real_time_monitoring_vpn_api.py +openapi_client/api/real_time_monitoring_vrrp_api.py +openapi_client/api/real_time_monitoring_wireless_api.py +openapi_client/api/real_time_monitoring_wlan_api.py +openapi_client/api/resource_pool_api.py +openapi_client/api/scheduled_backup_restore_api.py +openapi_client/api/sdavc_cloud_connector_api.py +openapi_client/api/sdavc_domain_based_app_rules_api.py +openapi_client/api/sdavcip_address_based_app_rules_api.py +openapi_client/api/smart_license_api.py +openapi_client/api/system_cloud_service_api.py +openapi_client/api/system_cloud_service_webex_api.py +openapi_client/api/system_container_api.py +openapi_client/api/system_reverse_proxy_api.py +openapi_client/api/tag_api.py +openapi_client/api/tenant_backup_restore_api.py +openapi_client/api/tenant_management_api.py +openapi_client/api/tenant_migration_api.py +openapi_client/api/tools_tac_cases_api.py +openapi_client/api/troubleshooting_tools_device_connectivity_api.py +openapi_client/api/troubleshooting_tools_device_group_api.py +openapi_client/api/troubleshooting_tools_diagnostics_api.py +openapi_client/api/umbrella_api.py +openapi_client/api/utility_configuration_db_api.py +openapi_client/api/utility_logging_api.py +openapi_client/api/utility_security_api.py +openapi_client/api/workflow_management_api.py +openapi_client/api_client.py +openapi_client/apis/__init__.py +openapi_client/configuration.py +openapi_client/exceptions.py +openapi_client/model/__init__.py +openapi_client/model/advanced_radio_setting.py +openapi_client/model/api_re_key_device.py +openapi_client/model/api_re_key_device_list.py +openapi_client/model/aws_iam_credentials.py +openapi_client/model/aws_key_credentials.py +openapi_client/model/azure_credentials.py +openapi_client/model/banner.py +openapi_client/model/bfd.py +openapi_client/model/bfd_timer_on_transport_tunnels.py +openapi_client/model/biz_internet_timer.py +openapi_client/model/cellular.py +openapi_client/model/cellular_all_of.py +openapi_client/model/cellular_profile.py +openapi_client/model/certificate_states.py +openapi_client/model/certificate_validity.py +openapi_client/model/channel_power_settings.py +openapi_client/model/config_group.py +openapi_client/model/connect_to_ntp_server.py +openapi_client/model/control_status.py +openapi_client/model/corporate_wifi.py +openapi_client/model/country_region_settings.py +openapi_client/model/create_device_params.py +openapi_client/model/create_tenant_model.py +openapi_client/model/data_center.py +openapi_client/model/data_center_registration.py +openapi_client/model/delete_tenant_bulk_model.py +openapi_client/model/delete_tenant_model.py +openapi_client/model/device.py +openapi_client/model/device_health_details.py +openapi_client/model/device_ip.py +openapi_client/model/device_model.py +openapi_client/model/device_type.py +openapi_client/model/device_uuid.py +openapi_client/model/devices_health.py +openapi_client/model/devices_health_overview.py +openapi_client/model/dhcp_pool.py +openapi_client/model/disaster_recovery_settings.py +openapi_client/model/domain_detail.py +openapi_client/model/entity_ownership_info.py +openapi_client/model/equinix_credentials.py +openapi_client/model/equinix_location_info.py +openapi_client/model/equinix_ne_info.py +openapi_client/model/equinix_partner_port.py +openapi_client/model/ethernet.py +openapi_client/model/ethernet_all_of.py +openapi_client/model/ethernet_interface.py +openapi_client/model/event_name.py +openapi_client/model/feature_profile.py +openapi_client/model/gcp_credentials.py +openapi_client/model/get_o365_preferred_path_from_v_analytics_request.py +openapi_client/model/get_o365_preferred_path_from_v_analytics_request_value.py +openapi_client/model/global_settings.py +openapi_client/model/global_settings_all_of.py +openapi_client/model/group_id.py +openapi_client/model/guest_wifi.py +openapi_client/model/header.py +openapi_client/model/header_element.py +openapi_client/model/host.py +openapi_client/model/ike_phase.py +openapi_client/model/ip_sec_policy.py +openapi_client/model/ip_sec_security.py +openapi_client/model/logging_system_messages.py +openapi_client/model/login_access_to_router.py +openapi_client/model/lte_timer.py +openapi_client/model/megaport_credentials.py +openapi_client/model/megaport_location_info.py +openapi_client/model/megaport_mve_info.py +openapi_client/model/megaport_partner_port.py +openapi_client/model/mpls_timer.py +openapi_client/model/multi_cloud_account_info.py +openapi_client/model/multi_cloud_edge_account_info.py +openapi_client/model/multi_cloud_edge_billing_account_info.py +openapi_client/model/multi_cloud_edge_location_info.py +openapi_client/model/multi_cloud_edge_partner_port.py +openapi_client/model/name_value_pair.py +openapi_client/model/nat_rule.py +openapi_client/model/network_protocol.py +openapi_client/model/network_protocol_all_of.py +openapi_client/model/node.py +openapi_client/model/nwpi_domain_monitor.py +openapi_client/model/omp.py +openapi_client/model/on_demand_queue_entry.py +openapi_client/model/partner_type.py +openapi_client/model/policy_rule.py +openapi_client/model/profile_parcel.py +openapi_client/model/property_definition.py +openapi_client/model/public_internet_timer.py +openapi_client/model/queue_entries.py +openapi_client/model/queue_properties.py +openapi_client/model/radio_band_setting24_g.py +openapi_client/model/radio_band_setting5_g.py +openapi_client/model/radius_server.py +openapi_client/model/resource_group.py +openapi_client/model/schema_definition.py +openapi_client/model/security_policy.py +openapi_client/model/security_policy_all_of.py +openapi_client/model/sim_slot_config.py +openapi_client/model/site_health.py +openapi_client/model/site_to_site_vpn.py +openapi_client/model/smart_account_model.py +openapi_client/model/software_upload_file_data.py +openapi_client/model/ssid_config.py +openapi_client/model/statistics_processing_counters.py +openapi_client/model/stats_type_processing_counters.py +openapi_client/model/systems.py +openapi_client/model/tag_restful_resource.py +openapi_client/model/tenant_status.py +openapi_client/model/tenant_status_list_model.py +openapi_client/model/thread_pool_definition.py +openapi_client/model/thread_pools_definition.py +openapi_client/model/update_tenant_model.py +openapi_client/model/update_tenantv_smart_model.py +openapi_client/model/uuid.py +openapi_client/model/uuid_to_domain_id.py +openapi_client/model/uuid_to_domain_id_mapping.py +openapi_client/model/v_edge_bootstrap_config.py +openapi_client/model/v_edge_health.py +openapi_client/model/v_resource_group_name_model.py +openapi_client/model/v_smart_status.py +openapi_client/model/variable.py +openapi_client/model/vertex_definition.py +openapi_client/model/vpn.py +openapi_client/model/vpn_all_of.py +openapi_client/model/vpnid.py +openapi_client/model/wan_spec.py +openapi_client/model/wifi.py +openapi_client/model/wifi_all_of.py +openapi_client/model_utils.py +openapi_client/models/__init__.py +openapi_client/rest.py +requirements.txt +setup.cfg +setup.py +test-requirements.txt +test/__init__.py +test/test_administration_audit_log_api.py +test/test_administration_user_and_group_api.py +test/test_advanced_radio_setting.py +test/test_api_re_key_device.py +test/test_api_re_key_device_list.py +test/test_aws_iam_credentials.py +test/test_aws_key_credentials.py +test/test_azure_credentials.py +test/test_banner.py +test/test_bfd.py +test/test_bfd_timer_on_transport_tunnels.py +test/test_biz_internet_timer.py +test/test_cellular.py +test/test_cellular_all_of.py +test/test_cellular_profile.py +test/test_certificate_management_device_api.py +test/test_certificate_management_v_manage_api.py +test/test_certificate_states.py +test/test_certificate_validity.py +test/test_channel_power_settings.py +test/test_cluster_management_api.py +test/test_colocation_api.py +test/test_colocation_service_group_api.py +test/test_config_group.py +test/test_configuration_advanced_inspection_profile_definition_api.py +test/test_configuration_azure_connect_api.py +test/test_configuration_circuits_api.py +test/test_configuration_cloud_express_api.py +test/test_configuration_cloud_on_ramp_api.py +test/test_configuration_configuration_group_api.py +test/test_configuration_dashboard_status_api.py +test/test_configuration_device_actions_api.py +test/test_configuration_device_config_history_api.py +test/test_configuration_device_connectivity_api.py +test/test_configuration_device_firmware_update_api.py +test/test_configuration_device_inventory_api.py +test/test_configuration_device_software_package_api.py +test/test_configuration_device_software_update_api.py +test/test_configuration_device_ssl_proxy_certificate_management_api.py +test/test_configuration_device_template_api.py +test/test_configuration_disaster_recovery_api.py +test/test_configuration_downloaded_images_api.py +test/test_configuration_feature_certificate_api.py +test/test_configuration_feature_profile_mobility_api.py +test/test_configuration_feature_profile_sdwan_api.py +test/test_configuration_fqdn_list_builder_api.py +test/test_configuration_general_template_api.py +test/test_configuration_identity_service_engine_api.py +test/test_configuration_ise_server_api.py +test/test_configuration_multi_cloud_api.py +test/test_configuration_multidomain_policy_api.py +test/test_configuration_network_design_api.py +test/test_configuration_network_design_templates_api.py +test/test_configuration_policy_access_list_definition_builder_api.py +test/test_configuration_policy_amp_definition_builder_api.py +test/test_configuration_policy_app_probe_class_list_builder_api.py +test/test_configuration_policy_app_route_definition_builder_api.py +test/test_configuration_policy_application_list_builder_api.py +test/test_configuration_policy_as_path_list_builder_api.py +test/test_configuration_policy_cflowd_definition_builder_api.py +test/test_configuration_policy_cloud_application_builder_api.py +test/test_configuration_policy_color_list_builder_api.py +test/test_configuration_policy_community_list_builder_api.py +test/test_configuration_policy_control_definition_builder_api.py +test/test_configuration_policy_custom_application_builder_api.py +test/test_configuration_policy_data_definition_builder_api.py +test/test_configuration_policy_data_ipv6_prefix_list_builder_api.py +test/test_configuration_policy_data_prefix_all_types_of_lists_builder_api.py +test/test_configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py +test/test_configuration_policy_data_prefix_list_builder_api.py +test/test_configuration_policy_device_access_definition_builder_api.py +test/test_configuration_policy_dial_peer_definition_builder_api.py +test/test_configuration_policy_expanded_community_list_builder_api.py +test/test_configuration_policy_extended_community_list_builder_api.py +test/test_configuration_policy_fax_protocol_list_builder_api.py +test/test_configuration_policy_forwarding_class_list_builder_api.py +test/test_configuration_policy_fxo_port_definition_builder_api.py +test/test_configuration_policy_fxs_port_definition_builder_api.py +test/test_configuration_policy_fxsdid_port_definition_builder_api.py +test/test_configuration_policy_geo_location_list_builder_api.py +test/test_configuration_policy_hub_and_spoke_definition_builder_api.py +test/test_configuration_policy_identity_list_builder_api.py +test/test_configuration_policy_intrusion_prevention_definition_builder_api.py +test/test_configuration_policy_ips_signature_list_builder_api.py +test/test_configuration_policy_ipv6_access_definition_builder_api.py +test/test_configuration_policy_ipv6_device_access_definition_builder_api.py +test/test_configuration_policy_ipv6_prefix_list_builder_api.py +test/test_configuration_policy_list_builder_api.py +test/test_configuration_policy_local_domain_definition_builder_api.py +test/test_configuration_policy_local_domain_name_list_builder_api.py +test/test_configuration_policy_media_profile_list_builder_api.py +test/test_configuration_policy_mesh_definition_builder_api.py +test/test_configuration_policy_mirror_list_builder_api.py +test/test_configuration_policy_modem_passthrough_list_builder_api.py +test/test_configuration_policy_policer_class_list_builder_api.py +test/test_configuration_policy_port_list_builder_api.py +test/test_configuration_policy_prefix_for_all_types_of_lists_builder_api.py +test/test_configuration_policy_prefix_list_builder_api.py +test/test_configuration_policy_priisdn_port_definition_builder_api.py +test/test_configuration_policy_protocol_name_list_builder_api.py +test/test_configuration_policy_qos_map_definition_builder_api.py +test/test_configuration_policy_region_list_builder_api.py +test/test_configuration_policy_rewrite_rule_definition_builder_api.py +test/test_configuration_policy_secure_internet_gateway_data_centers_builder_api.py +test/test_configuration_policy_security_assembler_api.py +test/test_configuration_policy_site_list_builder_api.py +test/test_configuration_policy_sla_class_list_builder_api.py +test/test_configuration_policy_supervisory_disc_list_builder_api.py +test/test_configuration_policy_threat_grid_api_key_list_api.py +test/test_configuration_policy_tloc_list_builder_api.py +test/test_configuration_policy_translation_profile_list_builder_api.py +test/test_configuration_policy_translation_rules_list_builder_api.py +test/test_configuration_policy_trunk_group_list_builder_api.py +test/test_configuration_policy_umbrella_data_list_builder_api.py +test/test_configuration_policy_url_black_list_builder_api.py +test/test_configuration_policy_url_filtering_definition_builder_api.py +test/test_configuration_policy_url_white_list_builder_api.py +test/test_configuration_policy_v_edge_assembler_api.py +test/test_configuration_policy_v_edge_route_definition_builder_api.py +test/test_configuration_policy_v_smart_assembler_api.py +test/test_configuration_policy_voice_assembler_api.py +test/test_configuration_policy_vpn_list_builder_api.py +test/test_configuration_policy_vpn_membership_group_definition_builder_api.py +test/test_configuration_policy_vpn_qos_map_definition_builder_api.py +test/test_configuration_policy_zone_based_firewall_definition_builder_api.py +test/test_configuration_policy_zone_list_builder_api.py +test/test_configuration_pre_upgrade_check_status_api.py +test/test_configuration_preferred_color_group_list_builder_api.py +test/test_configuration_quick_connect_api.py +test/test_configuration_rule_set_definition_api.py +test/test_configuration_secure_internet_gateway_tunnels_api.py +test/test_configuration_security_group_definition_api.py +test/test_configuration_security_template_policy_api.py +test/test_configuration_segments_api.py +test/test_configuration_settings_api.py +test/test_configuration_software_actions_api.py +test/test_configuration_ssl_decryption_policy_definition_builder_api.py +test/test_configuration_ssl_decryption_utd_profile_definition_api.py +test/test_configuration_template_configuration_api.py +test/test_configuration_template_lock_api.py +test/test_configuration_template_master_api.py +test/test_configuration_topology_api.py +test/test_configuration_v_edge_template_policy_api.py +test/test_configuration_v_smart_template_policy_api.py +test/test_configuration_voice_template_policy_api.py +test/test_connect_to_ntp_server.py +test/test_control_status.py +test/test_corporate_wifi.py +test/test_country_region_settings.py +test/test_create_device_params.py +test/test_create_tenant_model.py +test/test_data_center.py +test/test_data_center_registration.py +test/test_data_collection_agent_api.py +test/test_delete_tenant_bulk_model.py +test/test_delete_tenant_model.py +test/test_deployment_mode_api.py +test/test_device.py +test/test_device_health_details.py +test/test_device_ip.py +test/test_device_messaging_api.py +test/test_device_model.py +test/test_device_network_api.py +test/test_device_type.py +test/test_device_uuid.py +test/test_devices_health.py +test/test_devices_health_overview.py +test/test_dhcp_pool.py +test/test_disaster_recovery_settings.py +test/test_domain_detail.py +test/test_entity_ownership_info.py +test/test_equinix_credentials.py +test/test_equinix_location_info.py +test/test_equinix_ne_info.py +test/test_equinix_partner_port.py +test/test_ethernet.py +test/test_ethernet_all_of.py +test/test_ethernet_interface.py +test/test_event_name.py +test/test_feature_profile.py +test/test_gcp_credentials.py +test/test_get_o365_preferred_path_from_v_analytics_request.py +test/test_get_o365_preferred_path_from_v_analytics_request_value.py +test/test_global_settings.py +test/test_global_settings_all_of.py +test/test_group_id.py +test/test_guest_wifi.py +test/test_header.py +test/test_header_element.py +test/test_host.py +test/test_hsec_activate_api.py +test/test_hsec_api.py +test/test_hsec_license_api.py +test/test_ike_phase.py +test/test_ip_sec_policy.py +test/test_ip_sec_security.py +test/test_locale_api.py +test/test_logging_system_messages.py +test/test_login_access_to_router.py +test/test_lte_timer.py +test/test_megaport_credentials.py +test/test_megaport_location_info.py +test/test_megaport_mve_info.py +test/test_megaport_partner_port.py +test/test_monitoring_alarms_details_api.py +test/test_monitoring_alarms_notification_api.py +test/test_monitoring_app_hosting_api.py +test/test_monitoring_application_aware_routing_api.py +test/test_monitoring_application_aware_routing_statistics_api.py +test/test_monitoring_art_api.py +test/test_monitoring_bfd_api.py +test/test_monitoring_bridge_api.py +test/test_monitoring_cellular_eiolte_api.py +test/test_monitoring_cflowd_api.py +test/test_monitoring_cloud_express_api.py +test/test_monitoring_device_details_api.py +test/test_monitoring_device_statistics_api.py +test/test_monitoring_device_statistics_details_api.py +test/test_monitoring_dpi_api.py +test/test_monitoring_dpion_demand_troubleshooting_api.py +test/test_monitoring_endpoint_tracker_status_api.py +test/test_monitoring_events_api.py +test/test_monitoring_flowlog_api.py +test/test_monitoring_health_api.py +test/test_monitoring_interface_statistics_api.py +test/test_monitoring_ips_alert_api.py +test/test_monitoring_qo_s_api.py +test/test_monitoring_security_unified_logging_connection_events_api.py +test/test_monitoring_server_info_api.py +test/test_monitoring_stats_download_api.py +test/test_monitoring_stats_processing_api.py +test/test_monitoring_status_api.py +test/test_monitoring_system_status_stats_api.py +test/test_monitoring_umbrella_api.py +test/test_monitoring_umbrella_patterns_api.py +test/test_monitoring_url_filtering_api.py +test/test_monitoring_vnf_interface_statistics_api.py +test/test_monitoring_wlan_client_info_api.py +test/test_mpls_timer.py +test/test_msla_api.py +test/test_multi_cloud_account_info.py +test/test_multi_cloud_edge_account_info.py +test/test_multi_cloud_edge_billing_account_info.py +test/test_multi_cloud_edge_location_info.py +test/test_multi_cloud_edge_partner_port.py +test/test_multitenant_apis_provider_api.py +test/test_name_value_pair.py +test/test_nat_rule.py +test/test_network_protocol.py +test/test_network_protocol_all_of.py +test/test_node.py +test/test_nwpi_api.py +test/test_nwpi_domain_monitor.py +test/test_omp.py +test/test_on_demand_queue_entry.py +test/test_partner_aci_policy_builder_api.py +test/test_partner_dnacsdaapi_api.py +test/test_partner_registration_api.py +test/test_partner_type.py +test/test_partner_wcm_configs_api.py +test/test_policy_rule.py +test/test_profile_parcel.py +test/test_property_definition.py +test/test_public_internet_timer.py +test/test_queue_entries.py +test/test_queue_properties.py +test/test_radio_band_setting24_g.py +test/test_radio_band_setting5_g.py +test/test_radius_server.py +test/test_real_time_monitoring_aaa_api.py +test/test_real_time_monitoring_app_hosting_api.py +test/test_real_time_monitoring_app_logs_api.py +test/test_real_time_monitoring_application_aware_route_api.py +test/test_real_time_monitoring_appqoe_api.py +test/test_real_time_monitoring_arp_api.py +test/test_real_time_monitoring_bfd_api.py +test/test_real_time_monitoring_bgp_api.py +test/test_real_time_monitoring_bridge_api.py +test/test_real_time_monitoring_cellular_aon_ipsec_interface_api.py +test/test_real_time_monitoring_cellular_api.py +test/test_real_time_monitoring_cellular_eiolte_connection_service_api.py +test/test_real_time_monitoring_cellular_eiolte_hardware_service_api.py +test/test_real_time_monitoring_cellular_eiolte_network_service_api.py +test/test_real_time_monitoring_cellular_eiolte_sim_service_api.py +test/test_real_time_monitoring_cfm_api.py +test/test_real_time_monitoring_cloud_express_api.py +test/test_real_time_monitoring_commit_list_api.py +test/test_real_time_monitoring_container_lifecycle_api.py +test/test_real_time_monitoring_crash_log_api.py +test/test_real_time_monitoring_device_api.py +test/test_real_time_monitoring_device_control_api.py +test/test_real_time_monitoring_device_feature_list_api.py +test/test_real_time_monitoring_device_system_stats_api.py +test/test_real_time_monitoring_dhcp_api.py +test/test_real_time_monitoring_dot1x_api.py +test/test_real_time_monitoring_dpi_api.py +test/test_real_time_monitoring_dre_api.py +test/test_real_time_monitoring_dual_static_route_tracker_service_api.py +test/test_real_time_monitoring_eigrp_api.py +test/test_real_time_monitoring_endpoint_tracker_group_service_api.py +test/test_real_time_monitoring_endpoint_tracker_service_api.py +test/test_real_time_monitoring_geo_fencing_api.py +test/test_real_time_monitoring_hardware_api.py +test/test_real_time_monitoring_i_psec_api.py +test/test_real_time_monitoring_igmp_api.py +test/test_real_time_monitoring_interface_api.py +test/test_real_time_monitoring_ip_api.py +test/test_real_time_monitoring_ipv4_fib_api.py +test/test_real_time_monitoring_ipv6_fib_api.py +test/test_real_time_monitoring_ipv6_neighbours_api.py +test/test_real_time_monitoring_license_info_api.py +test/test_real_time_monitoring_multicast_api.py +test/test_real_time_monitoring_network_hub_resources_api.py +test/test_real_time_monitoring_nms_api.py +test/test_real_time_monitoring_ntp_api.py +test/test_real_time_monitoring_omp_api.py +test/test_real_time_monitoring_orchestrator_api.py +test/test_real_time_monitoring_ospf_api.py +test/test_real_time_monitoring_pim_api.py +test/test_real_time_monitoring_policer_api.py +test/test_real_time_monitoring_policy_api.py +test/test_real_time_monitoring_pppo_e_api.py +test/test_real_time_monitoring_rbac_api.py +test/test_real_time_monitoring_reboot_history_api.py +test/test_real_time_monitoring_sdwan_statistics_api.py +test/test_real_time_monitoring_security_api.py +test/test_real_time_monitoring_sfp_api.py +test/test_real_time_monitoring_show_on_demand_local_api.py +test/test_real_time_monitoring_show_on_demand_remote_api.py +test/test_real_time_monitoring_sig_api.py +test/test_real_time_monitoring_software_api.py +test/test_real_time_monitoring_sslproxy_api.py +test/test_real_time_monitoring_static_route_tracker_service_api.py +test/test_real_time_monitoring_system_api.py +test/test_real_time_monitoring_tcp_optimization_api.py +test/test_real_time_monitoring_tcpproxy_api.py +test/test_real_time_monitoring_tools_api.py +test/test_real_time_monitoring_transport_api.py +test/test_real_time_monitoring_trustsec_api.py +test/test_real_time_monitoring_tunnel_api.py +test/test_real_time_monitoring_ucse_api.py +test/test_real_time_monitoring_umbrella_api.py +test/test_real_time_monitoring_utd_api.py +test/test_real_time_monitoring_vdsl_service_api.py +test/test_real_time_monitoring_vm_api.py +test/test_real_time_monitoring_voice_api.py +test/test_real_time_monitoring_vpn_api.py +test/test_real_time_monitoring_vrrp_api.py +test/test_real_time_monitoring_wireless_api.py +test/test_real_time_monitoring_wlan_api.py +test/test_resource_group.py +test/test_resource_pool_api.py +test/test_scheduled_backup_restore_api.py +test/test_schema_definition.py +test/test_sdavc_cloud_connector_api.py +test/test_sdavc_domain_based_app_rules_api.py +test/test_sdavcip_address_based_app_rules_api.py +test/test_security_policy.py +test/test_security_policy_all_of.py +test/test_sim_slot_config.py +test/test_site_health.py +test/test_site_to_site_vpn.py +test/test_smart_account_model.py +test/test_smart_license_api.py +test/test_software_upload_file_data.py +test/test_ssid_config.py +test/test_statistics_processing_counters.py +test/test_stats_type_processing_counters.py +test/test_system_cloud_service_api.py +test/test_system_cloud_service_webex_api.py +test/test_system_container_api.py +test/test_system_reverse_proxy_api.py +test/test_systems.py +test/test_tag_api.py +test/test_tag_restful_resource.py +test/test_tenant_backup_restore_api.py +test/test_tenant_management_api.py +test/test_tenant_migration_api.py +test/test_tenant_status.py +test/test_tenant_status_list_model.py +test/test_thread_pool_definition.py +test/test_thread_pools_definition.py +test/test_tools_tac_cases_api.py +test/test_troubleshooting_tools_device_connectivity_api.py +test/test_troubleshooting_tools_device_group_api.py +test/test_troubleshooting_tools_diagnostics_api.py +test/test_umbrella_api.py +test/test_update_tenant_model.py +test/test_update_tenantv_smart_model.py +test/test_utility_configuration_db_api.py +test/test_utility_logging_api.py +test/test_utility_security_api.py +test/test_uuid.py +test/test_uuid_to_domain_id.py +test/test_uuid_to_domain_id_mapping.py +test/test_v_edge_bootstrap_config.py +test/test_v_edge_health.py +test/test_v_resource_group_name_model.py +test/test_v_smart_status.py +test/test_variable.py +test/test_vertex_definition.py +test/test_vpn.py +test/test_vpn_all_of.py +test/test_vpnid.py +test/test_wan_spec.py +test/test_wifi.py +test/test_wifi_all_of.py +test/test_workflow_management_api.py +tox.ini diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION new file mode 100644 index 0000000..0df17dd --- /dev/null +++ b/.openapi-generator/VERSION @@ -0,0 +1 @@ +6.2.1 \ No newline at end of file diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..83e16f8 --- /dev/null +++ b/.rspec @@ -0,0 +1,2 @@ +--color +--require spec_helper diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..d32b2b1 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,148 @@ +# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license) +# Automatically generated by OpenAPI Generator (https://openapi-generator.tech) +AllCops: + TargetRubyVersion: 2.4 + # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop + # to ignore them, so only the ones explicitly set in this file are enabled. + DisabledByDefault: true + Exclude: + - '**/templates/**/*' + - '**/vendor/**/*' + - 'actionpack/lib/action_dispatch/journey/parser.rb' + +# Prefer &&/|| over and/or. +Style/AndOr: + Enabled: true + +# Align `when` with `case`. +Layout/CaseIndentation: + Enabled: true + +# Align comments with method definitions. +Layout/CommentIndentation: + Enabled: true + +Layout/ElseAlignment: + Enabled: true + +Layout/EmptyLineAfterMagicComment: + Enabled: true + +# In a regular class definition, no empty lines around the body. +Layout/EmptyLinesAroundClassBody: + Enabled: true + +# In a regular method definition, no empty lines around the body. +Layout/EmptyLinesAroundMethodBody: + Enabled: true + +# In a regular module definition, no empty lines around the body. +Layout/EmptyLinesAroundModuleBody: + Enabled: true + +Layout/FirstArgumentIndentation: + Enabled: true + +# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }. +Style/HashSyntax: + Enabled: false + +# Method definitions after `private` or `protected` isolated calls need one +# extra level of indentation. +Layout/IndentationConsistency: + Enabled: true + EnforcedStyle: indented_internal_methods + +# Two spaces, no tabs (for indentation). +Layout/IndentationWidth: + Enabled: true + +Layout/LeadingCommentSpace: + Enabled: true + +Layout/SpaceAfterColon: + Enabled: true + +Layout/SpaceAfterComma: + Enabled: true + +Layout/SpaceAroundEqualsInParameterDefault: + Enabled: true + +Layout/SpaceAroundKeyword: + Enabled: true + +Layout/SpaceAroundOperators: + Enabled: true + +Layout/SpaceBeforeComma: + Enabled: true + +Layout/SpaceBeforeFirstArg: + Enabled: true + +Style/DefWithParentheses: + Enabled: true + +# Defining a method with parameters needs parentheses. +Style/MethodDefParentheses: + Enabled: true + +Style/FrozenStringLiteralComment: + Enabled: false + EnforcedStyle: always + +# Use `foo {}` not `foo{}`. +Layout/SpaceBeforeBlockBraces: + Enabled: true + +# Use `foo { bar }` not `foo {bar}`. +Layout/SpaceInsideBlockBraces: + Enabled: true + +# Use `{ a: 1 }` not `{a:1}`. +Layout/SpaceInsideHashLiteralBraces: + Enabled: true + +Layout/SpaceInsideParens: + Enabled: true + +# Check quotes usage according to lint rule below. +#Style/StringLiterals: +# Enabled: true +# EnforcedStyle: single_quotes + +# Detect hard tabs, no hard tabs. +Layout/IndentationStyle: + Enabled: true + +# Blank lines should not have any spaces. +Layout/TrailingEmptyLines: + Enabled: true + +# No trailing whitespace. +Layout/TrailingWhitespace: + Enabled: false + +# Use quotes for string literals when they are enough. +Style/RedundantPercentQ: + Enabled: true + +# Align `end` with the matching keyword or starting expression except for +# assignments, where it should be aligned with the LHS. +Layout/EndAlignment: + Enabled: true + EnforcedStyleAlignWith: variable + AutoCorrect: true + +# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg. +Lint/RequireParentheses: + Enabled: true + +Style/RedundantReturn: + Enabled: true + AllowMultipleReturnValues: true + +Style/Semicolon: + Enabled: true + AllowAsExpressionSeparator: true diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..5b7949c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +# ref: https://docs.travis-ci.com/user/languages/python +language: python +python: + - "3.6" + - "3.7" + - "3.8" + - "3.9" +# command to install dependencies +install: + - "pip install -r requirements.txt" + - "pip install -r test-requirements.txt" +# command to run tests +script: pytest --cov=openapi_client diff --git a/README.md b/README.md new file mode 100644 index 0000000..b21f2c0 --- /dev/null +++ b/README.md @@ -0,0 +1,3108 @@ +# openapi-client +The vManage API exposes the functionality of operations maintaining devices and the overlay network + +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 2.0.0 +- Package version: 1.0.0 +- Build package: org.openapitools.codegen.languages.PythonPriorClientCodegen + +## Requirements. + +Python >=3.6 + +## Installation & Usage +### pip install + +If the python package is hosted on a repository, you can install directly using: + +```sh +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git +``` +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) + +Then import the package: +```python +import openapi_client +``` + +### Setuptools + +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import openapi_client +``` + +## Getting Started + +Please follow the [installation procedure](#installation--usage) and then run the following: + +```python + +import time +import openapi_client +from pprint import pprint +from openapi_client.api import administration_audit_log_api +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + query = "query_example" # str | Query filter (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + + try: + api_response = api_instance.generate_audit_log(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->generate_audit_log: %s\n" % e) +``` + +## Documentation for API Endpoints + +All URIs are relative to */dataservice* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AdministrationAuditLogApi* | [**generate_audit_log**](docs/AdministrationAuditLogApi.md#generate_audit_log) | **GET** /auditlog/severity | +*AdministrationAuditLogApi* | [**get_audit_severity_custom_histogram**](docs/AdministrationAuditLogApi.md#get_audit_severity_custom_histogram) | **GET** /auditlog/severity/summary | +*AdministrationAuditLogApi* | [**get_count**](docs/AdministrationAuditLogApi.md#get_count) | **GET** /auditlog/doccount | +*AdministrationAuditLogApi* | [**get_count_post**](docs/AdministrationAuditLogApi.md#get_count_post) | **POST** /auditlog/doccount | +*AdministrationAuditLogApi* | [**get_post_property_aggregation_data**](docs/AdministrationAuditLogApi.md#get_post_property_aggregation_data) | **POST** /auditlog/aggregation | +*AdministrationAuditLogApi* | [**get_post_stat_bulk_raw_property_data**](docs/AdministrationAuditLogApi.md#get_post_stat_bulk_raw_property_data) | **POST** /auditlog/page | +*AdministrationAuditLogApi* | [**get_property_aggregation_data**](docs/AdministrationAuditLogApi.md#get_property_aggregation_data) | **GET** /auditlog/aggregation | +*AdministrationAuditLogApi* | [**get_raw_property_data**](docs/AdministrationAuditLogApi.md#get_raw_property_data) | **POST** /auditlog | +*AdministrationAuditLogApi* | [**get_stat_bulk_raw_property_data**](docs/AdministrationAuditLogApi.md#get_stat_bulk_raw_property_data) | **GET** /auditlog/page | +*AdministrationAuditLogApi* | [**get_stat_data_fields**](docs/AdministrationAuditLogApi.md#get_stat_data_fields) | **GET** /auditlog/fields | +*AdministrationAuditLogApi* | [**get_stat_data_raw_audit_log_data**](docs/AdministrationAuditLogApi.md#get_stat_data_raw_audit_log_data) | **GET** /auditlog | +*AdministrationAuditLogApi* | [**get_stat_query_fields**](docs/AdministrationAuditLogApi.md#get_stat_query_fields) | **GET** /auditlog/query/fields | +*AdministrationUserAndGroupApi* | [**create_colo_group**](docs/AdministrationUserAndGroupApi.md#create_colo_group) | **POST** /admin/cologroup | +*AdministrationUserAndGroupApi* | [**create_group_grid_columns**](docs/AdministrationUserAndGroupApi.md#create_group_grid_columns) | **GET** /admin/usergroup/definition | +*AdministrationUserAndGroupApi* | [**create_user**](docs/AdministrationUserAndGroupApi.md#create_user) | **POST** /admin/user | +*AdministrationUserAndGroupApi* | [**create_user_group**](docs/AdministrationUserAndGroupApi.md#create_user_group) | **POST** /admin/usergroup | +*AdministrationUserAndGroupApi* | [**create_vpn_group**](docs/AdministrationUserAndGroupApi.md#create_vpn_group) | **POST** /admin/vpngroup | +*AdministrationUserAndGroupApi* | [**delete_colo_group**](docs/AdministrationUserAndGroupApi.md#delete_colo_group) | **DELETE** /admin/cologroup/{id} | +*AdministrationUserAndGroupApi* | [**delete_user**](docs/AdministrationUserAndGroupApi.md#delete_user) | **DELETE** /admin/user/{userName} | +*AdministrationUserAndGroupApi* | [**delete_user_group**](docs/AdministrationUserAndGroupApi.md#delete_user_group) | **DELETE** /admin/usergroup/{userGroupId} | +*AdministrationUserAndGroupApi* | [**delete_vpn_group**](docs/AdministrationUserAndGroupApi.md#delete_vpn_group) | **DELETE** /admin/vpngroup/{id} | +*AdministrationUserAndGroupApi* | [**edit_colo_group**](docs/AdministrationUserAndGroupApi.md#edit_colo_group) | **PUT** /admin/cologroup/{id} | +*AdministrationUserAndGroupApi* | [**edit_vpn_group**](docs/AdministrationUserAndGroupApi.md#edit_vpn_group) | **PUT** /admin/vpngroup/{id} | +*AdministrationUserAndGroupApi* | [**find_user_auth_type**](docs/AdministrationUserAndGroupApi.md#find_user_auth_type) | **GET** /admin/user/userAuthType | +*AdministrationUserAndGroupApi* | [**find_user_groups**](docs/AdministrationUserAndGroupApi.md#find_user_groups) | **GET** /admin/usergroup | +*AdministrationUserAndGroupApi* | [**find_user_groups_as_key_value**](docs/AdministrationUserAndGroupApi.md#find_user_groups_as_key_value) | **GET** /admin/usergroup/keyvalue | +*AdministrationUserAndGroupApi* | [**find_user_role**](docs/AdministrationUserAndGroupApi.md#find_user_role) | **GET** /admin/user/role | +*AdministrationUserAndGroupApi* | [**find_users**](docs/AdministrationUserAndGroupApi.md#find_users) | **GET** /admin/user | +*AdministrationUserAndGroupApi* | [**get_active_sessions**](docs/AdministrationUserAndGroupApi.md#get_active_sessions) | **GET** /admin/user/activeSessions | +*AdministrationUserAndGroupApi* | [**get_colo_groups**](docs/AdministrationUserAndGroupApi.md#get_colo_groups) | **GET** /admin/cologroup | +*AdministrationUserAndGroupApi* | [**get_vpn_groups**](docs/AdministrationUserAndGroupApi.md#get_vpn_groups) | **GET** /admin/vpngroup | +*AdministrationUserAndGroupApi* | [**remove_sessions**](docs/AdministrationUserAndGroupApi.md#remove_sessions) | **DELETE** /admin/user/removeSessions | +*AdministrationUserAndGroupApi* | [**reset_user**](docs/AdministrationUserAndGroupApi.md#reset_user) | **POST** /admin/user/reset | +*AdministrationUserAndGroupApi* | [**resource_group**](docs/AdministrationUserAndGroupApi.md#resource_group) | **GET** /admin/resourcegroup | +*AdministrationUserAndGroupApi* | [**resource_group1**](docs/AdministrationUserAndGroupApi.md#resource_group1) | **POST** /admin/resourcegroup/switch | +*AdministrationUserAndGroupApi* | [**resource_group2**](docs/AdministrationUserAndGroupApi.md#resource_group2) | **PUT** /admin/resourcegroup/{groupId} | +*AdministrationUserAndGroupApi* | [**resource_group3**](docs/AdministrationUserAndGroupApi.md#resource_group3) | **DELETE** /admin/resourcegroup/{groupId} | +*AdministrationUserAndGroupApi* | [**resource_group4**](docs/AdministrationUserAndGroupApi.md#resource_group4) | **POST** /admin/resourcegroup | +*AdministrationUserAndGroupApi* | [**resource_group_name**](docs/AdministrationUserAndGroupApi.md#resource_group_name) | **GET** /admin/user/resourceGroupName | +*AdministrationUserAndGroupApi* | [**update_admin_password**](docs/AdministrationUserAndGroupApi.md#update_admin_password) | **POST** /admin/user/admin/password | +*AdministrationUserAndGroupApi* | [**update_password**](docs/AdministrationUserAndGroupApi.md#update_password) | **PUT** /admin/user/password/{userName} | +*AdministrationUserAndGroupApi* | [**update_profile_locale**](docs/AdministrationUserAndGroupApi.md#update_profile_locale) | **PUT** /admin/user/profile/locale | +*AdministrationUserAndGroupApi* | [**update_profile_password**](docs/AdministrationUserAndGroupApi.md#update_profile_password) | **PUT** /admin/user/profile/password | +*AdministrationUserAndGroupApi* | [**update_user**](docs/AdministrationUserAndGroupApi.md#update_user) | **PUT** /admin/user/{userName} | +*AdministrationUserAndGroupApi* | [**update_user_group**](docs/AdministrationUserAndGroupApi.md#update_user_group) | **PUT** /admin/usergroup/{userGroupId} | +*AdministrationUserAndGroupApi* | [**validate_password**](docs/AdministrationUserAndGroupApi.md#validate_password) | **POST** /admin/user/password/validate | +*CertificateManagementDeviceApi* | [**decommission_enterprise_csr_for_vedge**](docs/CertificateManagementDeviceApi.md#decommission_enterprise_csr_for_vedge) | **POST** /certificate/revoke/enterprise/certificate | +*CertificateManagementDeviceApi* | [**delete_configuration**](docs/CertificateManagementDeviceApi.md#delete_configuration) | **DELETE** /certificate/{uuid} | +*CertificateManagementDeviceApi* | [**force_sync_root_cert**](docs/CertificateManagementDeviceApi.md#force_sync_root_cert) | **POST** /certificate/forcesync/rootCert | +*CertificateManagementDeviceApi* | [**generate_csr**](docs/CertificateManagementDeviceApi.md#generate_csr) | **POST** /certificate/generate/csr | +*CertificateManagementDeviceApi* | [**generate_edge_device_csr**](docs/CertificateManagementDeviceApi.md#generate_edge_device_csr) | **POST** /certificate/generate/wanedge/csr | +*CertificateManagementDeviceApi* | [**generate_enterprise_csr**](docs/CertificateManagementDeviceApi.md#generate_enterprise_csr) | **POST** /certificate/generate/enterprise/csr/vedge | +*CertificateManagementDeviceApi* | [**get_cert_details**](docs/CertificateManagementDeviceApi.md#get_cert_details) | **POST** /certificate/certdetails | +*CertificateManagementDeviceApi* | [**get_certificate_data**](docs/CertificateManagementDeviceApi.md#get_certificate_data) | **GET** /certificate/record | +*CertificateManagementDeviceApi* | [**get_certificate_detail**](docs/CertificateManagementDeviceApi.md#get_certificate_detail) | **GET** /certificate/stats/detail | +*CertificateManagementDeviceApi* | [**get_certificate_stats**](docs/CertificateManagementDeviceApi.md#get_certificate_stats) | **GET** /certificate/stats/summary | +*CertificateManagementDeviceApi* | [**get_csr_view_right_menus**](docs/CertificateManagementDeviceApi.md#get_csr_view_right_menus) | **GET** /certificate/csr/details | +*CertificateManagementDeviceApi* | [**get_device_view_right_menus**](docs/CertificateManagementDeviceApi.md#get_device_view_right_menus) | **GET** /certificate/device/details | +*CertificateManagementDeviceApi* | [**get_devices_list**](docs/CertificateManagementDeviceApi.md#get_devices_list) | **GET** /certificate/device/list | +*CertificateManagementDeviceApi* | [**get_installed_cert**](docs/CertificateManagementDeviceApi.md#get_installed_cert) | **GET** /certificate/vedge | +*CertificateManagementDeviceApi* | [**get_list_status**](docs/CertificateManagementDeviceApi.md#get_list_status) | **GET** /certificate/list/status | +*CertificateManagementDeviceApi* | [**get_root_cert_chains**](docs/CertificateManagementDeviceApi.md#get_root_cert_chains) | **GET** /certificate/rootcertchains | +*CertificateManagementDeviceApi* | [**get_root_certificate**](docs/CertificateManagementDeviceApi.md#get_root_certificate) | **GET** /certificate/rootcertificate | +*CertificateManagementDeviceApi* | [**get_view**](docs/CertificateManagementDeviceApi.md#get_view) | **GET** /certificate/view | +*CertificateManagementDeviceApi* | [**getc_edge_list**](docs/CertificateManagementDeviceApi.md#getc_edge_list) | **GET** /certificate/tokengeneratedlist | +*CertificateManagementDeviceApi* | [**getv_edge_csr**](docs/CertificateManagementDeviceApi.md#getv_edge_csr) | **GET** /certificate/vedge/csr | +*CertificateManagementDeviceApi* | [**getv_edge_list**](docs/CertificateManagementDeviceApi.md#getv_edge_list) | **GET** /certificate/vedge/list | +*CertificateManagementDeviceApi* | [**getv_smart_list**](docs/CertificateManagementDeviceApi.md#getv_smart_list) | **GET** /certificate/vsmart/list | +*CertificateManagementDeviceApi* | [**install_certificate**](docs/CertificateManagementDeviceApi.md#install_certificate) | **POST** /certificate/install/signedCert | +*CertificateManagementDeviceApi* | [**reset_rsa**](docs/CertificateManagementDeviceApi.md#reset_rsa) | **POST** /certificate/reset/rsa | +*CertificateManagementDeviceApi* | [**save_root_cert_chain**](docs/CertificateManagementDeviceApi.md#save_root_cert_chain) | **PUT** /certificate/rootcertchains | +*CertificateManagementDeviceApi* | [**save_v_edge_list**](docs/CertificateManagementDeviceApi.md#save_v_edge_list) | **POST** /certificate/save/vedge/list | +*CertificateManagementDeviceApi* | [**setv_edge_list**](docs/CertificateManagementDeviceApi.md#setv_edge_list) | **POST** /certificate/vedge/list | +*CertificateManagementDeviceApi* | [**setv_smart_list**](docs/CertificateManagementDeviceApi.md#setv_smart_list) | **POST** /certificate/vsmart/list | +*CertificateManagementDeviceApi* | [**setv_smart_list1**](docs/CertificateManagementDeviceApi.md#setv_smart_list1) | **GET** /certificate/mthub/list | +*CertificateManagementDeviceApi* | [**syncv_bond**](docs/CertificateManagementDeviceApi.md#syncv_bond) | **GET** /certificate/syncvbond | +*CertificateManagementDeviceApi* | [**update_jks**](docs/CertificateManagementDeviceApi.md#update_jks) | **PUT** /certificate/jks | +*CertificateManagementVManageApi* | [**dump_certificate**](docs/CertificateManagementVManageApi.md#dump_certificate) | **GET** /setting/configuration/webserver/certificate/certificate | +*CertificateManagementVManageApi* | [**get_certificate**](docs/CertificateManagementVManageApi.md#get_certificate) | **GET** /setting/configuration/webserver/certificate/getcertificate | +*CertificateManagementVManageApi* | [**get_csr**](docs/CertificateManagementVManageApi.md#get_csr) | **POST** /setting/configuration/webserver/certificate | +*CertificateManagementVManageApi* | [**import_certificate**](docs/CertificateManagementVManageApi.md#import_certificate) | **PUT** /setting/configuration/webserver/certificate | +*CertificateManagementVManageApi* | [**rollback**](docs/CertificateManagementVManageApi.md#rollback) | **GET** /setting/configuration/webserver/certificate/rollback | +*CertificateManagementVManageApi* | [**show_info**](docs/CertificateManagementVManageApi.md#show_info) | **GET** /setting/configuration/webserver/certificate | +*ClusterManagementApi* | [**add_or_update_user_credentials**](docs/ClusterManagementApi.md#add_or_update_user_credentials) | **POST** /clusterManagement/userCreds | +*ClusterManagementApi* | [**add_vmanage**](docs/ClusterManagementApi.md#add_vmanage) | **POST** /clusterManagement/setup | +*ClusterManagementApi* | [**check_if_cluster_locked**](docs/ClusterManagementApi.md#check_if_cluster_locked) | **GET** /clusterManagement/clusterLocked | +*ClusterManagementApi* | [**configure_vmanage**](docs/ClusterManagementApi.md#configure_vmanage) | **POST** /clusterManagement/configure | +*ClusterManagementApi* | [**edit_vmanage**](docs/ClusterManagementApi.md#edit_vmanage) | **PUT** /clusterManagement/setup | +*ClusterManagementApi* | [**get_cluster_workflow_version**](docs/ClusterManagementApi.md#get_cluster_workflow_version) | **GET** /clusterManagement/clusterworkflow/version | +*ClusterManagementApi* | [**get_configured_ip_list**](docs/ClusterManagementApi.md#get_configured_ip_list) | **GET** /clusterManagement/iplist/{vmanageID} | +*ClusterManagementApi* | [**get_connected_devices**](docs/ClusterManagementApi.md#get_connected_devices) | **GET** /clusterManagement/connectedDevices/{vmanageIP} | +*ClusterManagementApi* | [**get_connected_devices_per_tenant**](docs/ClusterManagementApi.md#get_connected_devices_per_tenant) | **GET** /clusterManagement/{tenantId}/connectedDevices/{vmanageIP} | +*ClusterManagementApi* | [**get_tenancy_mode**](docs/ClusterManagementApi.md#get_tenancy_mode) | **GET** /clusterManagement/tenancy/mode | +*ClusterManagementApi* | [**get_tenants_list**](docs/ClusterManagementApi.md#get_tenants_list) | **GET** /clusterManagement/tenantList | +*ClusterManagementApi* | [**get_v_manage_details**](docs/ClusterManagementApi.md#get_v_manage_details) | **GET** /clusterManagement/vManage/details/{vmanageIP} | +*ClusterManagementApi* | [**health_details**](docs/ClusterManagementApi.md#health_details) | **GET** /clusterManagement/health/details | +*ClusterManagementApi* | [**health_status_info**](docs/ClusterManagementApi.md#health_status_info) | **GET** /clusterManagement/health/status | +*ClusterManagementApi* | [**health_summary**](docs/ClusterManagementApi.md#health_summary) | **GET** /clusterManagement/health/summary | +*ClusterManagementApi* | [**is_cluster_ready**](docs/ClusterManagementApi.md#is_cluster_ready) | **GET** /clusterManagement/isready | +*ClusterManagementApi* | [**list_vmanages**](docs/ClusterManagementApi.md#list_vmanages) | **GET** /clusterManagement/list | +*ClusterManagementApi* | [**node_properties**](docs/ClusterManagementApi.md#node_properties) | **GET** /clusterManagement/nodeProperties | +*ClusterManagementApi* | [**perform_replication_and_rebalance_of_kafka_partitions**](docs/ClusterManagementApi.md#perform_replication_and_rebalance_of_kafka_partitions) | **PUT** /clusterManagement/replicateAndRebalance | +*ClusterManagementApi* | [**remove_vmanage**](docs/ClusterManagementApi.md#remove_vmanage) | **POST** /clusterManagement/remove | +*ClusterManagementApi* | [**set_tenancy_mode**](docs/ClusterManagementApi.md#set_tenancy_mode) | **POST** /clusterManagement/tenancy/mode | +*ColocationApi* | [**acitvate_cloud_dock_cluster**](docs/ColocationApi.md#acitvate_cloud_dock_cluster) | **POST** /colocation/cluster/activate | +*ColocationApi* | [**attach_service_chain**](docs/ColocationApi.md#attach_service_chain) | **POST** /colocation/servicechain/attach | +*ColocationApi* | [**attach_service_chain1**](docs/ColocationApi.md#attach_service_chain1) | **POST** /colocation/servicechain/autoattach | +*ColocationApi* | [**cancel_button**](docs/ColocationApi.md#cancel_button) | **POST** /colocation/servicechain/cancel | +*ColocationApi* | [**cloud_dock_cluster_preview**](docs/ColocationApi.md#cloud_dock_cluster_preview) | **GET** /colocation/cluster/config | +*ColocationApi* | [**create_cloud_dock_cluster**](docs/ColocationApi.md#create_cloud_dock_cluster) | **POST** /colocation/cluster | +*ColocationApi* | [**de_acitvate_cloud_dock_cluster**](docs/ColocationApi.md#de_acitvate_cloud_dock_cluster) | **POST** /colocation/cluster/deactivate | +*ColocationApi* | [**delete_cloud_dock_cluster_by_name**](docs/ColocationApi.md#delete_cloud_dock_cluster_by_name) | **DELETE** /colocation/cluster/{clustername} | +*ColocationApi* | [**detach_service_chain**](docs/ColocationApi.md#detach_service_chain) | **PUT** /colocation/servicechain/detach | +*ColocationApi* | [**dummyccm**](docs/ColocationApi.md#dummyccm) | **GET** /colocation/cluster/activateClusterDummy | +*ColocationApi* | [**dummycsp_state**](docs/ColocationApi.md#dummycsp_state) | **GET** /colocation/cluster/activateClusterDummyState | +*ColocationApi* | [**get_cloud_dock_cluster_detail**](docs/ColocationApi.md#get_cloud_dock_cluster_detail) | **GET** /colocation/cluster | +*ColocationApi* | [**get_cloud_dock_cluster_detail_by_id**](docs/ColocationApi.md#get_cloud_dock_cluster_detail_by_id) | **GET** /colocation/cluster/id | +*ColocationApi* | [**get_cluster_config_by_cluster_id**](docs/ColocationApi.md#get_cluster_config_by_cluster_id) | **GET** /colocation/monitor/cluster/config | +*ColocationApi* | [**get_cluster_details_by_cluster_id**](docs/ColocationApi.md#get_cluster_details_by_cluster_id) | **GET** /colocation/monitor/cluster | +*ColocationApi* | [**get_cluster_port_mapping_by_cluster_id**](docs/ColocationApi.md#get_cluster_port_mapping_by_cluster_id) | **GET** /colocation/monitor/cluster/portView | +*ColocationApi* | [**get_device_detail_by_device_id**](docs/ColocationApi.md#get_device_detail_by_device_id) | **GET** /colocation/monitor/device | +*ColocationApi* | [**get_edge_devices**](docs/ColocationApi.md#get_edge_devices) | **GET** /colocation/servicechain/edge/devices | +*ColocationApi* | [**get_pnf_config**](docs/ColocationApi.md#get_pnf_config) | **GET** /colocation/monitor/pnf/configuration | +*ColocationApi* | [**get_service_chain_details**](docs/ColocationApi.md#get_service_chain_details) | **GET** /colocation/monitor/servicechain | +*ColocationApi* | [**get_service_group_by_cluster_id**](docs/ColocationApi.md#get_service_group_by_cluster_id) | **GET** /colocation/monitor/servicegroup | +*ColocationApi* | [**get_system_status_by_device_id**](docs/ColocationApi.md#get_system_status_by_device_id) | **GET** /colocation/monitor/device/system | +*ColocationApi* | [**get_vnf_alarm_count**](docs/ColocationApi.md#get_vnf_alarm_count) | **GET** /colocation/monitor/vnf/alarms/count | +*ColocationApi* | [**get_vnf_events_count_detail**](docs/ColocationApi.md#get_vnf_events_count_detail) | **GET** /colocation/monitor/vnf/alarms | +*ColocationApi* | [**get_vnf_events_detail**](docs/ColocationApi.md#get_vnf_events_detail) | **GET** /colocation/monitor/vnf/events | +*ColocationApi* | [**get_vnf_interface_detail**](docs/ColocationApi.md#get_vnf_interface_detail) | **GET** /colocation/monitor/vnf/interface | +*ColocationApi* | [**getpnf_details**](docs/ColocationApi.md#getpnf_details) | **GET** /colocation/monitor/pnf | +*ColocationApi* | [**getpnf_devices**](docs/ColocationApi.md#getpnf_devices) | **GET** /colocation/servicechain/edge/pnfdevices | +*ColocationApi* | [**getvnf_by_device_id**](docs/ColocationApi.md#getvnf_by_device_id) | **GET** /colocation/monitor/device/vnf | +*ColocationApi* | [**getvnf_details**](docs/ColocationApi.md#getvnf_details) | **GET** /colocation/monitor/vnf | +*ColocationApi* | [**list_network_function_map**](docs/ColocationApi.md#list_network_function_map) | **GET** /colocation/monitor/networkfunction/listmap | +*ColocationApi* | [**rma_cloud_dock_csp**](docs/ColocationApi.md#rma_cloud_dock_csp) | **POST** /colocation/cluster/rma | +*ColocationApi* | [**update_cloud_dock_cluster**](docs/ColocationApi.md#update_cloud_dock_cluster) | **PUT** /colocation/cluster | +*ColocationApi* | [**update_csp_to_cluster**](docs/ColocationApi.md#update_csp_to_cluster) | **PUT** /colocation/cluster/attached/csp | +*ColocationApi* | [**vnf_actions**](docs/ColocationApi.md#vnf_actions) | **POST** /colocation/monitor/vnf/action | +*ColocationServiceGroupApi* | [**create_service_group_cluster**](docs/ColocationServiceGroupApi.md#create_service_group_cluster) | **POST** /colocation/servicegroup | +*ColocationServiceGroupApi* | [**delete_service_group_cluster**](docs/ColocationServiceGroupApi.md#delete_service_group_cluster) | **DELETE** /colocation/servicegroup/{name} | +*ColocationServiceGroupApi* | [**get_available_chains**](docs/ColocationServiceGroupApi.md#get_available_chains) | **GET** /colocation/servicegroup/servicechains | +*ColocationServiceGroupApi* | [**get_default_chain**](docs/ColocationServiceGroupApi.md#get_default_chain) | **GET** /colocation/servicegroup/servicechain/default | +*ColocationServiceGroupApi* | [**get_service_chain**](docs/ColocationServiceGroupApi.md#get_service_chain) | **GET** /colocation/servicegroup | +*ColocationServiceGroupApi* | [**get_service_group_in_cluster**](docs/ColocationServiceGroupApi.md#get_service_group_in_cluster) | **GET** /colocation/servicegroup/attached | +*ColocationServiceGroupApi* | [**update_service_group_cluster**](docs/ColocationServiceGroupApi.md#update_service_group_cluster) | **PUT** /colocation/servicegroup | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**create_policy_definition10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#create_policy_definition10) | **POST** /template/policy/definition/advancedinspectionprofile | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**delete_policy_definition10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#delete_policy_definition10) | **DELETE** /template/policy/definition/advancedinspectionprofile/{id} | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**edit_multiple_policy_definition10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#edit_multiple_policy_definition10) | **PUT** /template/policy/definition/advancedinspectionprofile/multiple/{id} | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**edit_policy_definition10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#edit_policy_definition10) | **PUT** /template/policy/definition/advancedinspectionprofile/{id} | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**get_definitions10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#get_definitions10) | **GET** /template/policy/definition/advancedinspectionprofile | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**get_policy_definition10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#get_policy_definition10) | **GET** /template/policy/definition/advancedinspectionprofile/{id} | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**preview_policy_definition10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#preview_policy_definition10) | **POST** /template/policy/definition/advancedinspectionprofile/preview | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**preview_policy_definition_by_id10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#preview_policy_definition_by_id10) | **GET** /template/policy/definition/advancedinspectionprofile/preview/{id} | +*ConfigurationAdvancedInspectionProfileDefinitionApi* | [**save_policy_definition_in_bulk10**](docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md#save_policy_definition_in_bulk10) | **PUT** /template/policy/definition/advancedinspectionprofile/bulk | +*ConfigurationAzureConnectApi* | [**authenticate_azure_connect_cred_and_add**](docs/ConfigurationAzureConnectApi.md#authenticate_azure_connect_cred_and_add) | **POST** /template/cortex/cloud/authenticate | +*ConfigurationAzureConnectApi* | [**delete_wan_resource_groups**](docs/ConfigurationAzureConnectApi.md#delete_wan_resource_groups) | **DELETE** /template/cortex/wanrg | +*ConfigurationAzureConnectApi* | [**edit_wan_resource_groups**](docs/ConfigurationAzureConnectApi.md#edit_wan_resource_groups) | **PUT** /template/cortex/wanrg | +*ConfigurationAzureConnectApi* | [**get_cortex_status**](docs/ConfigurationAzureConnectApi.md#get_cortex_status) | **GET** /template/cortex | +*ConfigurationAzureConnectApi* | [**get_mapped_wan_resource_groups**](docs/ConfigurationAzureConnectApi.md#get_mapped_wan_resource_groups) | **GET** /template/cortex/map | +*ConfigurationAzureConnectApi* | [**get_wan_resource_groups**](docs/ConfigurationAzureConnectApi.md#get_wan_resource_groups) | **GET** /template/cortex/wanrg | +*ConfigurationAzureConnectApi* | [**save_wan_resource_groups**](docs/ConfigurationAzureConnectApi.md#save_wan_resource_groups) | **POST** /template/cortex/wanrg | +*ConfigurationAzureConnectApi* | [**sync_wan_resource_groups**](docs/ConfigurationAzureConnectApi.md#sync_wan_resource_groups) | **POST** /template/cortex/sync | +*ConfigurationCircuitsApi* | [**create_circuit**](docs/ConfigurationCircuitsApi.md#create_circuit) | **POST** /networkdesign/circuit | +*ConfigurationCircuitsApi* | [**delete_circuit**](docs/ConfigurationCircuitsApi.md#delete_circuit) | **DELETE** /networkdesign/circuit/{id} | +*ConfigurationCircuitsApi* | [**edit_circuit**](docs/ConfigurationCircuitsApi.md#edit_circuit) | **PUT** /networkdesign/circuit/{id} | +*ConfigurationCircuitsApi* | [**get_circuits**](docs/ConfigurationCircuitsApi.md#get_circuits) | **GET** /networkdesign/circuit | +*ConfigurationCloudExpressApi* | [**add_apps**](docs/ConfigurationCloudExpressApi.md#add_apps) | **POST** /template/cloudx/manage/apps | +*ConfigurationCloudExpressApi* | [**add_cloudx_interfaces**](docs/ConfigurationCloudExpressApi.md#add_cloudx_interfaces) | **POST** /template/cloudx/interfaces | +*ConfigurationCloudExpressApi* | [**add_cloudx_type**](docs/ConfigurationCloudExpressApi.md#add_cloudx_type) | **POST** /template/cloudx/addcloudx/{type} | +*ConfigurationCloudExpressApi* | [**delete_webex_prefix_lists**](docs/ConfigurationCloudExpressApi.md#delete_webex_prefix_lists) | **DELETE** /cloudservices/app/webex | +*ConfigurationCloudExpressApi* | [**edit_apps**](docs/ConfigurationCloudExpressApi.md#edit_apps) | **PUT** /template/cloudx/manage/apps | +*ConfigurationCloudExpressApi* | [**enable_webex**](docs/ConfigurationCloudExpressApi.md#enable_webex) | **POST** /cloudservices/app/webex | +*ConfigurationCloudExpressApi* | [**enable_webex1**](docs/ConfigurationCloudExpressApi.md#enable_webex1) | **PUT** /cloudservices/app/webex | +*ConfigurationCloudExpressApi* | [**get_apps**](docs/ConfigurationCloudExpressApi.md#get_apps) | **GET** /template/cloudx/manage/apps | +*ConfigurationCloudExpressApi* | [**get_attached_client_list**](docs/ConfigurationCloudExpressApi.md#get_attached_client_list) | **GET** /template/cloudx/attachedclient | +*ConfigurationCloudExpressApi* | [**get_attached_dia_list**](docs/ConfigurationCloudExpressApi.md#get_attached_dia_list) | **GET** /template/cloudx/attacheddia | +*ConfigurationCloudExpressApi* | [**get_attached_gateway_list**](docs/ConfigurationCloudExpressApi.md#get_attached_gateway_list) | **GET** /template/cloudx/attachedgateway | +*ConfigurationCloudExpressApi* | [**get_cloud_x_available_apps**](docs/ConfigurationCloudExpressApi.md#get_cloud_x_available_apps) | **GET** /template/cloudx/availableapps | +*ConfigurationCloudExpressApi* | [**get_cloud_x_status**](docs/ConfigurationCloudExpressApi.md#get_cloud_x_status) | **GET** /template/cloudx | +*ConfigurationCloudExpressApi* | [**get_dia_list**](docs/ConfigurationCloudExpressApi.md#get_dia_list) | **GET** /template/cloudx/dialist | +*ConfigurationCloudExpressApi* | [**get_gateway_list**](docs/ConfigurationCloudExpressApi.md#get_gateway_list) | **GET** /template/cloudx/gatewaylist | +*ConfigurationCloudExpressApi* | [**get_site_list**](docs/ConfigurationCloudExpressApi.md#get_site_list) | **GET** /template/cloudx/clientlist | +*ConfigurationCloudExpressApi* | [**site_per_app**](docs/ConfigurationCloudExpressApi.md#site_per_app) | **GET** /template/cloudx/status | +*ConfigurationCloudOnRampApi* | [**acquire_resource_pool**](docs/ConfigurationCloudOnRampApi.md#acquire_resource_pool) | **POST** /template/cor/acquireResourcePool | +*ConfigurationCloudOnRampApi* | [**add_device_pair**](docs/ConfigurationCloudOnRampApi.md#add_device_pair) | **POST** /template/cor/devicepair | +*ConfigurationCloudOnRampApi* | [**add_transit_vpc**](docs/ConfigurationCloudOnRampApi.md#add_transit_vpc) | **POST** /template/cor/transitvpc | +*ConfigurationCloudOnRampApi* | [**authenticate_cloud_on_ramp_cred_and_add**](docs/ConfigurationCloudOnRampApi.md#authenticate_cloud_on_ramp_cred_and_add) | **POST** /template/cor/cloud/authenticate | +*ConfigurationCloudOnRampApi* | [**authenticate_cred_and_update**](docs/ConfigurationCloudOnRampApi.md#authenticate_cred_and_update) | **PUT** /template/cor/cloud/authenticate | +*ConfigurationCloudOnRampApi* | [**create_and_map**](docs/ConfigurationCloudOnRampApi.md#create_and_map) | **POST** /template/cor | +*ConfigurationCloudOnRampApi* | [**create_resource_pool**](docs/ConfigurationCloudOnRampApi.md#create_resource_pool) | **POST** /template/cor/createResourcePool | +*ConfigurationCloudOnRampApi* | [**get_ami_list**](docs/ConfigurationCloudOnRampApi.md#get_ami_list) | **GET** /template/cor/ami | +*ConfigurationCloudOnRampApi* | [**get_cloud_accounts**](docs/ConfigurationCloudOnRampApi.md#get_cloud_accounts) | **GET** /template/cor/cloud/account | +*ConfigurationCloudOnRampApi* | [**get_cloud_host_vpc_account_details**](docs/ConfigurationCloudOnRampApi.md#get_cloud_host_vpc_account_details) | **GET** /template/cor/cloud/host/accountdetails | +*ConfigurationCloudOnRampApi* | [**get_cloud_host_vpcs**](docs/ConfigurationCloudOnRampApi.md#get_cloud_host_vpcs) | **GET** /template/cor/hostvpc | +*ConfigurationCloudOnRampApi* | [**get_cloud_list**](docs/ConfigurationCloudOnRampApi.md#get_cloud_list) | **GET** /template/cor/cloud | +*ConfigurationCloudOnRampApi* | [**get_cloud_mapped_host_accounts**](docs/ConfigurationCloudOnRampApi.md#get_cloud_mapped_host_accounts) | **GET** /template/cor/cloud/mappedhostaccounts | +*ConfigurationCloudOnRampApi* | [**get_cloud_on_ramp_devices**](docs/ConfigurationCloudOnRampApi.md#get_cloud_on_ramp_devices) | **GET** /template/cor/device | +*ConfigurationCloudOnRampApi* | [**get_cor_status**](docs/ConfigurationCloudOnRampApi.md#get_cor_status) | **GET** /template/cor | +*ConfigurationCloudOnRampApi* | [**get_external_id**](docs/ConfigurationCloudOnRampApi.md#get_external_id) | **GET** /template/cor/externalId | +*ConfigurationCloudOnRampApi* | [**get_host_vpcs**](docs/ConfigurationCloudOnRampApi.md#get_host_vpcs) | **GET** /template/cor/devicepair/hostvpc | +*ConfigurationCloudOnRampApi* | [**get_mapped_vpcs**](docs/ConfigurationCloudOnRampApi.md#get_mapped_vpcs) | **GET** /template/cor/map | +*ConfigurationCloudOnRampApi* | [**get_pem_key_list**](docs/ConfigurationCloudOnRampApi.md#get_pem_key_list) | **GET** /template/cor/pem | +*ConfigurationCloudOnRampApi* | [**get_transit_device_pair_and_host_list**](docs/ConfigurationCloudOnRampApi.md#get_transit_device_pair_and_host_list) | **GET** /template/cor/getTransitDevicePairAndHostList | +*ConfigurationCloudOnRampApi* | [**get_transit_vpc_supported_size**](docs/ConfigurationCloudOnRampApi.md#get_transit_vpc_supported_size) | **GET** /template/cor/transitvpc/size | +*ConfigurationCloudOnRampApi* | [**get_transit_vpc_vpn_list**](docs/ConfigurationCloudOnRampApi.md#get_transit_vpc_vpn_list) | **GET** /template/cor/getTransitVpnList | +*ConfigurationCloudOnRampApi* | [**get_transit_vpcs**](docs/ConfigurationCloudOnRampApi.md#get_transit_vpcs) | **GET** /template/cor/transitvpc | +*ConfigurationCloudOnRampApi* | [**map_vpcs**](docs/ConfigurationCloudOnRampApi.md#map_vpcs) | **POST** /template/cor/map | +*ConfigurationCloudOnRampApi* | [**remove_device_id**](docs/ConfigurationCloudOnRampApi.md#remove_device_id) | **DELETE** /template/cor/deleteDevicepair | +*ConfigurationCloudOnRampApi* | [**remove_transit_vpc**](docs/ConfigurationCloudOnRampApi.md#remove_transit_vpc) | **DELETE** /template/cor/accountid/{accountid} | +*ConfigurationCloudOnRampApi* | [**scale_down**](docs/ConfigurationCloudOnRampApi.md#scale_down) | **POST** /template/cor/scale/down | +*ConfigurationCloudOnRampApi* | [**scale_up**](docs/ConfigurationCloudOnRampApi.md#scale_up) | **POST** /template/cor/scale/up | +*ConfigurationCloudOnRampApi* | [**unmap_vpcs**](docs/ConfigurationCloudOnRampApi.md#unmap_vpcs) | **DELETE** /template/cor/map | +*ConfigurationCloudOnRampApi* | [**update_transit_vpc**](docs/ConfigurationCloudOnRampApi.md#update_transit_vpc) | **PUT** /template/cor/transitvpc | +*ConfigurationCloudOnRampApi* | [**update_transit_vpc_autoscale_properties**](docs/ConfigurationCloudOnRampApi.md#update_transit_vpc_autoscale_properties) | **PUT** /template/cor/transitvpc/autoscale-properties | +*ConfigurationConfigurationGroupApi* | [**create_config_group**](docs/ConfigurationConfigurationGroupApi.md#create_config_group) | **POST** /v1/config-group | +*ConfigurationConfigurationGroupApi* | [**create_config_group_association**](docs/ConfigurationConfigurationGroupApi.md#create_config_group_association) | **POST** /v1/config-group/{configGroupId}/device/associate | +*ConfigurationConfigurationGroupApi* | [**create_config_group_device_variables**](docs/ConfigurationConfigurationGroupApi.md#create_config_group_device_variables) | **PUT** /v1/config-group/{configGroupId}/device/variables | +*ConfigurationConfigurationGroupApi* | [**create_config_group_device_variables1**](docs/ConfigurationConfigurationGroupApi.md#create_config_group_device_variables1) | **GET** /v1/config-group/{configGroupId}/device/variables/schema | +*ConfigurationConfigurationGroupApi* | [**delete_config_group**](docs/ConfigurationConfigurationGroupApi.md#delete_config_group) | **DELETE** /v1/config-group/{configGroupId} | +*ConfigurationConfigurationGroupApi* | [**delete_config_group_association**](docs/ConfigurationConfigurationGroupApi.md#delete_config_group_association) | **DELETE** /v1/config-group/{configGroupId}/device/associate | +*ConfigurationConfigurationGroupApi* | [**deploy_config_group**](docs/ConfigurationConfigurationGroupApi.md#deploy_config_group) | **POST** /v1/config-group/{configGroupId}/device/deploy | +*ConfigurationConfigurationGroupApi* | [**edit_config_group**](docs/ConfigurationConfigurationGroupApi.md#edit_config_group) | **PUT** /v1/config-group/{configGroupId} | +*ConfigurationConfigurationGroupApi* | [**get_cedge_config_group_schema_by_schema_type**](docs/ConfigurationConfigurationGroupApi.md#get_cedge_config_group_schema_by_schema_type) | **GET** /v1/config-group/schema/sdwan | +*ConfigurationConfigurationGroupApi* | [**get_config_group**](docs/ConfigurationConfigurationGroupApi.md#get_config_group) | **GET** /v1/config-group/{configGroupId} | +*ConfigurationConfigurationGroupApi* | [**get_config_group_association**](docs/ConfigurationConfigurationGroupApi.md#get_config_group_association) | **GET** /v1/config-group/{configGroupId}/device/associate | +*ConfigurationConfigurationGroupApi* | [**get_config_group_by_solution**](docs/ConfigurationConfigurationGroupApi.md#get_config_group_by_solution) | **GET** /v1/config-group | +*ConfigurationConfigurationGroupApi* | [**get_config_group_device_configuration_preview**](docs/ConfigurationConfigurationGroupApi.md#get_config_group_device_configuration_preview) | **POST** /v1/config-group/{configGroupId}/device/{deviceId}/preview | +*ConfigurationConfigurationGroupApi* | [**get_config_group_device_variables**](docs/ConfigurationConfigurationGroupApi.md#get_config_group_device_variables) | **GET** /v1/config-group/{configGroupId}/device/variables | +*ConfigurationConfigurationGroupApi* | [**update_config_group_association**](docs/ConfigurationConfigurationGroupApi.md#update_config_group_association) | **PUT** /v1/config-group/{configGroupId}/device/associate | +*ConfigurationDashboardStatusApi* | [**cancel_pending_tasks**](docs/ConfigurationDashboardStatusApi.md#cancel_pending_tasks) | **POST** /device/action/status/cancel/{processId} | +*ConfigurationDashboardStatusApi* | [**clean_status**](docs/ConfigurationDashboardStatusApi.md#clean_status) | **GET** /device/action/status/clean | +*ConfigurationDashboardStatusApi* | [**delete_status**](docs/ConfigurationDashboardStatusApi.md#delete_status) | **DELETE** /device/action/status/clear | +*ConfigurationDashboardStatusApi* | [**find_running_tasks**](docs/ConfigurationDashboardStatusApi.md#find_running_tasks) | **GET** /device/action/status/tasks | +*ConfigurationDashboardStatusApi* | [**find_status**](docs/ConfigurationDashboardStatusApi.md#find_status) | **GET** /device/action/status/{actionName} | +*ConfigurationDashboardStatusApi* | [**get_active_task_count**](docs/ConfigurationDashboardStatusApi.md#get_active_task_count) | **GET** /device/action/status/tasks/activeCount | +*ConfigurationDashboardStatusApi* | [**get_clean_status**](docs/ConfigurationDashboardStatusApi.md#get_clean_status) | **GET** /device/action/status/tasks/clean | +*ConfigurationDashboardStatusApi* | [**update_device_action_status**](docs/ConfigurationDashboardStatusApi.md#update_device_action_status) | **PUT** /device/action/status | +*ConfigurationDeviceActionsApi* | [**create_filter_vpn_list**](docs/ConfigurationDeviceActionsApi.md#create_filter_vpn_list) | **GET** /device/action/filter/vpn | +*ConfigurationDeviceActionsApi* | [**create_unique_vpn_list**](docs/ConfigurationDeviceActionsApi.md#create_unique_vpn_list) | **POST** /device/action/uniquevpnlist | +*ConfigurationDeviceActionsApi* | [**create_vpn_list**](docs/ConfigurationDeviceActionsApi.md#create_vpn_list) | **GET** /device/action/vpn | +*ConfigurationDeviceActionsApi* | [**generate_change_partition_info**](docs/ConfigurationDeviceActionsApi.md#generate_change_partition_info) | **GET** /device/action/changepartition | +*ConfigurationDeviceActionsApi* | [**generate_deactivate_info**](docs/ConfigurationDeviceActionsApi.md#generate_deactivate_info) | **GET** /device/action/deactivate | +*ConfigurationDeviceActionsApi* | [**generate_device_action_list**](docs/ConfigurationDeviceActionsApi.md#generate_device_action_list) | **GET** /device/action/list | +*ConfigurationDeviceActionsApi* | [**generate_device_list**](docs/ConfigurationDeviceActionsApi.md#generate_device_list) | **GET** /device/action/install/devices/{deviceType} | +*ConfigurationDeviceActionsApi* | [**generate_install_info**](docs/ConfigurationDeviceActionsApi.md#generate_install_info) | **GET** /device/action/install | +*ConfigurationDeviceActionsApi* | [**generate_reboot_device_list**](docs/ConfigurationDeviceActionsApi.md#generate_reboot_device_list) | **GET** /device/action/reboot/devices/{deviceType} | +*ConfigurationDeviceActionsApi* | [**generate_reboot_info**](docs/ConfigurationDeviceActionsApi.md#generate_reboot_info) | **GET** /device/action/reboot | +*ConfigurationDeviceActionsApi* | [**generate_rediscover_info**](docs/ConfigurationDeviceActionsApi.md#generate_rediscover_info) | **GET** /device/action/rediscover | +*ConfigurationDeviceActionsApi* | [**generate_remove_partition_info**](docs/ConfigurationDeviceActionsApi.md#generate_remove_partition_info) | **GET** /device/action/removepartition | +*ConfigurationDeviceActionsApi* | [**generate_security_devices_list**](docs/ConfigurationDeviceActionsApi.md#generate_security_devices_list) | **GET** /device/action/security/devices/{policyType} | +*ConfigurationDeviceActionsApi* | [**get_ztp_upgrade_config**](docs/ConfigurationDeviceActionsApi.md#get_ztp_upgrade_config) | **GET** /device/action/ztp/upgrade | +*ConfigurationDeviceActionsApi* | [**get_ztp_upgrade_config_setting**](docs/ConfigurationDeviceActionsApi.md#get_ztp_upgrade_config_setting) | **GET** /device/action/ztp/upgrade/setting | +*ConfigurationDeviceActionsApi* | [**initiate_image_download**](docs/ConfigurationDeviceActionsApi.md#initiate_image_download) | **POST** /device/action/image-download | +*ConfigurationDeviceActionsApi* | [**process_amp_api_re_key**](docs/ConfigurationDeviceActionsApi.md#process_amp_api_re_key) | **POST** /device/action/security/amp/rekey | +*ConfigurationDeviceActionsApi* | [**process_cancel_task**](docs/ConfigurationDeviceActionsApi.md#process_cancel_task) | **POST** /device/action/cancel | +*ConfigurationDeviceActionsApi* | [**process_change_partition**](docs/ConfigurationDeviceActionsApi.md#process_change_partition) | **POST** /device/action/changepartition | +*ConfigurationDeviceActionsApi* | [**process_deactivate_smu**](docs/ConfigurationDeviceActionsApi.md#process_deactivate_smu) | **POST** /device/action/deactivate | +*ConfigurationDeviceActionsApi* | [**process_default_partition**](docs/ConfigurationDeviceActionsApi.md#process_default_partition) | **POST** /device/action/defaultpartition | +*ConfigurationDeviceActionsApi* | [**process_delete_amp_api_key**](docs/ConfigurationDeviceActionsApi.md#process_delete_amp_api_key) | **DELETE** /device/action/security/amp/apikey/{uuid} | +*ConfigurationDeviceActionsApi* | [**process_install**](docs/ConfigurationDeviceActionsApi.md#process_install) | **POST** /device/action/install | +*ConfigurationDeviceActionsApi* | [**process_lxc_activate**](docs/ConfigurationDeviceActionsApi.md#process_lxc_activate) | **POST** /device/action/lxcactivate | +*ConfigurationDeviceActionsApi* | [**process_lxc_delete**](docs/ConfigurationDeviceActionsApi.md#process_lxc_delete) | **POST** /device/action/lxcdelete | +*ConfigurationDeviceActionsApi* | [**process_lxc_install**](docs/ConfigurationDeviceActionsApi.md#process_lxc_install) | **POST** /device/action/lxcinstall | +*ConfigurationDeviceActionsApi* | [**process_lxc_reload**](docs/ConfigurationDeviceActionsApi.md#process_lxc_reload) | **POST** /device/action/lxcreload | +*ConfigurationDeviceActionsApi* | [**process_lxc_reset**](docs/ConfigurationDeviceActionsApi.md#process_lxc_reset) | **POST** /device/action/lxcreset | +*ConfigurationDeviceActionsApi* | [**process_lxc_upgrade**](docs/ConfigurationDeviceActionsApi.md#process_lxc_upgrade) | **POST** /device/action/lxcupgrade | +*ConfigurationDeviceActionsApi* | [**process_reboot**](docs/ConfigurationDeviceActionsApi.md#process_reboot) | **POST** /device/action/reboot | +*ConfigurationDeviceActionsApi* | [**process_remove_partition**](docs/ConfigurationDeviceActionsApi.md#process_remove_partition) | **POST** /device/action/removepartition | +*ConfigurationDeviceActionsApi* | [**process_remove_software_image**](docs/ConfigurationDeviceActionsApi.md#process_remove_software_image) | **POST** /device/action/image-remove | +*ConfigurationDeviceActionsApi* | [**process_vnf_install**](docs/ConfigurationDeviceActionsApi.md#process_vnf_install) | **POST** /device/action/vnfinstall | +*ConfigurationDeviceActionsApi* | [**process_ztp_upgrade_config**](docs/ConfigurationDeviceActionsApi.md#process_ztp_upgrade_config) | **POST** /device/action/ztp/upgrade | +*ConfigurationDeviceActionsApi* | [**process_ztp_upgrade_config_setting**](docs/ConfigurationDeviceActionsApi.md#process_ztp_upgrade_config_setting) | **POST** /device/action/ztp/upgrade/setting | +*ConfigurationDeviceActionsApi* | [**re_discover_all_device**](docs/ConfigurationDeviceActionsApi.md#re_discover_all_device) | **POST** /device/action/rediscoverall | +*ConfigurationDeviceActionsApi* | [**re_discover_devices**](docs/ConfigurationDeviceActionsApi.md#re_discover_devices) | **POST** /device/action/rediscover | +*ConfigurationDeviceActionsApi* | [**test_api_key**](docs/ConfigurationDeviceActionsApi.md#test_api_key) | **GET** /device/action/security/apikey/{uuid} | +*ConfigurationDeviceActionsApi* | [**test_iox_config**](docs/ConfigurationDeviceActionsApi.md#test_iox_config) | **GET** /device/action/test/ioxconfig/{deviceIP} | +*ConfigurationDeviceActionsApi* | [**trigger_pending_tasks_monitoring**](docs/ConfigurationDeviceActionsApi.md#trigger_pending_tasks_monitoring) | **GET** /device/action/startmonitor | +*ConfigurationDeviceConfigHistoryApi* | [**get_aggregation_data_by_query20**](docs/ConfigurationDeviceConfigHistoryApi.md#get_aggregation_data_by_query20) | **GET** /device/history/aggregation | +*ConfigurationDeviceConfigHistoryApi* | [**get_config_diff**](docs/ConfigurationDeviceConfigHistoryApi.md#get_config_diff) | **GET** /device/history/config/diff/list | +*ConfigurationDeviceConfigHistoryApi* | [**get_count22**](docs/ConfigurationDeviceConfigHistoryApi.md#get_count22) | **GET** /device/history/doccount | +*ConfigurationDeviceConfigHistoryApi* | [**get_count_post22**](docs/ConfigurationDeviceConfigHistoryApi.md#get_count_post22) | **POST** /device/history/doccount | +*ConfigurationDeviceConfigHistoryApi* | [**get_device_config**](docs/ConfigurationDeviceConfigHistoryApi.md#get_device_config) | **GET** /device/history/config/{config_id} | +*ConfigurationDeviceConfigHistoryApi* | [**get_last_thousand_config_list**](docs/ConfigurationDeviceConfigHistoryApi.md#get_last_thousand_config_list) | **GET** /device/history/config | +*ConfigurationDeviceConfigHistoryApi* | [**get_post_aggregation_app_data_by_query19**](docs/ConfigurationDeviceConfigHistoryApi.md#get_post_aggregation_app_data_by_query19) | **POST** /device/history/app-agg/aggregation | +*ConfigurationDeviceConfigHistoryApi* | [**get_post_aggregation_data_by_query19**](docs/ConfigurationDeviceConfigHistoryApi.md#get_post_aggregation_data_by_query19) | **POST** /device/history/aggregation | +*ConfigurationDeviceConfigHistoryApi* | [**get_post_stat_bulk_raw_data20**](docs/ConfigurationDeviceConfigHistoryApi.md#get_post_stat_bulk_raw_data20) | **POST** /device/history/page | +*ConfigurationDeviceConfigHistoryApi* | [**get_stat_bulk_raw_data20**](docs/ConfigurationDeviceConfigHistoryApi.md#get_stat_bulk_raw_data20) | **GET** /device/history/page | +*ConfigurationDeviceConfigHistoryApi* | [**get_stat_data_fields22**](docs/ConfigurationDeviceConfigHistoryApi.md#get_stat_data_fields22) | **GET** /device/history/fields | +*ConfigurationDeviceConfigHistoryApi* | [**get_stat_data_raw_data19**](docs/ConfigurationDeviceConfigHistoryApi.md#get_stat_data_raw_data19) | **GET** /device/history | +*ConfigurationDeviceConfigHistoryApi* | [**get_stat_data_raw_data_as_csv20**](docs/ConfigurationDeviceConfigHistoryApi.md#get_stat_data_raw_data_as_csv20) | **GET** /device/history/csv | +*ConfigurationDeviceConfigHistoryApi* | [**get_stat_query_fields22**](docs/ConfigurationDeviceConfigHistoryApi.md#get_stat_query_fields22) | **GET** /device/history/query/fields | +*ConfigurationDeviceConfigHistoryApi* | [**get_stats_raw_data20**](docs/ConfigurationDeviceConfigHistoryApi.md#get_stats_raw_data20) | **POST** /device/history | +*ConfigurationDeviceConnectivityApi* | [**invalidate_device**](docs/ConfigurationDeviceConnectivityApi.md#invalidate_device) | **POST** /certificate/device/invalidate | +*ConfigurationDeviceConnectivityApi* | [**stage_device**](docs/ConfigurationDeviceConnectivityApi.md#stage_device) | **POST** /certificate/device/stage | +*ConfigurationDeviceFirmwareUpdateApi* | [**activate_firmware_image**](docs/ConfigurationDeviceFirmwareUpdateApi.md#activate_firmware_image) | **POST** /device/action/firmware/activate | +*ConfigurationDeviceFirmwareUpdateApi* | [**delete_firmware_image**](docs/ConfigurationDeviceFirmwareUpdateApi.md#delete_firmware_image) | **DELETE** /device/action/firmware/{versionId} | +*ConfigurationDeviceFirmwareUpdateApi* | [**get_devices_fw_upgrade**](docs/ConfigurationDeviceFirmwareUpdateApi.md#get_devices_fw_upgrade) | **GET** /device/action/firmware/devices | +*ConfigurationDeviceFirmwareUpdateApi* | [**get_firmware_image_details**](docs/ConfigurationDeviceFirmwareUpdateApi.md#get_firmware_image_details) | **GET** /device/action/firmware/{versionId} | +*ConfigurationDeviceFirmwareUpdateApi* | [**get_firmware_images**](docs/ConfigurationDeviceFirmwareUpdateApi.md#get_firmware_images) | **GET** /device/action/firmware | +*ConfigurationDeviceFirmwareUpdateApi* | [**install_firmware_image**](docs/ConfigurationDeviceFirmwareUpdateApi.md#install_firmware_image) | **POST** /device/action/firmware/install | +*ConfigurationDeviceFirmwareUpdateApi* | [**process_firmware_image**](docs/ConfigurationDeviceFirmwareUpdateApi.md#process_firmware_image) | **POST** /device/action/firmware | +*ConfigurationDeviceFirmwareUpdateApi* | [**remove_firmware_image**](docs/ConfigurationDeviceFirmwareUpdateApi.md#remove_firmware_image) | **POST** /device/action/firmware/remove | +*ConfigurationDeviceInventoryApi* | [**check_self_signed_cert**](docs/ConfigurationDeviceInventoryApi.md#check_self_signed_cert) | **GET** /system/device/selfsignedcert/iscreated | +*ConfigurationDeviceInventoryApi* | [**claim_devices**](docs/ConfigurationDeviceInventoryApi.md#claim_devices) | **POST** /system/device/claimDevices | +*ConfigurationDeviceInventoryApi* | [**create_device**](docs/ConfigurationDeviceInventoryApi.md#create_device) | **POST** /system/device | +*ConfigurationDeviceInventoryApi* | [**decommission_vedge_cloud**](docs/ConfigurationDeviceInventoryApi.md#decommission_vedge_cloud) | **PUT** /system/device/decommission/{uuid} | +*ConfigurationDeviceInventoryApi* | [**delete_device**](docs/ConfigurationDeviceInventoryApi.md#delete_device) | **DELETE** /system/device/{uuid} | +*ConfigurationDeviceInventoryApi* | [**devices_without_subject_sudi**](docs/ConfigurationDeviceInventoryApi.md#devices_without_subject_sudi) | **GET** /system/device/devicesWithoutSubjectSudi | +*ConfigurationDeviceInventoryApi* | [**edit_device**](docs/ConfigurationDeviceInventoryApi.md#edit_device) | **PUT** /system/device/{uuid} | +*ConfigurationDeviceInventoryApi* | [**form_post**](docs/ConfigurationDeviceInventoryApi.md#form_post) | **POST** /system/device/fileupload | +*ConfigurationDeviceInventoryApi* | [**generate_bootstrap_config_for_vedge**](docs/ConfigurationDeviceInventoryApi.md#generate_bootstrap_config_for_vedge) | **GET** /system/device/bootstrap/device/{uuid} | +*ConfigurationDeviceInventoryApi* | [**generate_bootstrap_config_for_vedges**](docs/ConfigurationDeviceInventoryApi.md#generate_bootstrap_config_for_vedges) | **POST** /system/device/bootstrap/devices | +*ConfigurationDeviceInventoryApi* | [**generate_generic_bootstrap_config_for_vedges**](docs/ConfigurationDeviceInventoryApi.md#generate_generic_bootstrap_config_for_vedges) | **GET** /system/device/bootstrap/generic/devices | +*ConfigurationDeviceInventoryApi* | [**get_all_unclaimed_devices**](docs/ConfigurationDeviceInventoryApi.md#get_all_unclaimed_devices) | **GET** /system/device/unclaimedDevices | +*ConfigurationDeviceInventoryApi* | [**get_bootstrap_config_zip**](docs/ConfigurationDeviceInventoryApi.md#get_bootstrap_config_zip) | **GET** /system/device/bootstrap/download/{id} | +*ConfigurationDeviceInventoryApi* | [**get_cloud_dock_data_based_on_device_type**](docs/ConfigurationDeviceInventoryApi.md#get_cloud_dock_data_based_on_device_type) | **GET** /system/device/type/{deviceCategory} | +*ConfigurationDeviceInventoryApi* | [**get_cloud_dock_default_config_based_on_device_type**](docs/ConfigurationDeviceInventoryApi.md#get_cloud_dock_default_config_based_on_device_type) | **GET** /system/device/type/{deviceCategory}/defaultConfig | +*ConfigurationDeviceInventoryApi* | [**get_controller_v_edge_sync_status**](docs/ConfigurationDeviceInventoryApi.md#get_controller_v_edge_sync_status) | **GET** /system/device/controllers/vedge/status | +*ConfigurationDeviceInventoryApi* | [**get_devices_details**](docs/ConfigurationDeviceInventoryApi.md#get_devices_details) | **GET** /system/device/{deviceCategory} | +*ConfigurationDeviceInventoryApi* | [**get_management_system_ip_info**](docs/ConfigurationDeviceInventoryApi.md#get_management_system_ip_info) | **GET** /system/device/management/systemip | +*ConfigurationDeviceInventoryApi* | [**get_rma_candidates**](docs/ConfigurationDeviceInventoryApi.md#get_rma_candidates) | **GET** /system/device/rma/candidates/{deviceType} | +*ConfigurationDeviceInventoryApi* | [**get_root_cert_status_all**](docs/ConfigurationDeviceInventoryApi.md#get_root_cert_status_all) | **GET** /system/device/rootcertchain/status | +*ConfigurationDeviceInventoryApi* | [**get_tenant_management_system_ips**](docs/ConfigurationDeviceInventoryApi.md#get_tenant_management_system_ips) | **GET** /system/device/tenant/management/systemip | +*ConfigurationDeviceInventoryApi* | [**invalidate_vmanage_root_ca**](docs/ConfigurationDeviceInventoryApi.md#invalidate_vmanage_root_ca) | **DELETE** /system/device/vmanagerootca/{uuid} | +*ConfigurationDeviceInventoryApi* | [**migrate_device**](docs/ConfigurationDeviceInventoryApi.md#migrate_device) | **PUT** /system/device/migrateDevice/{uuid} | +*ConfigurationDeviceInventoryApi* | [**reset_vedge_cloud**](docs/ConfigurationDeviceInventoryApi.md#reset_vedge_cloud) | **PUT** /system/device/reset/{uuid} | +*ConfigurationDeviceInventoryApi* | [**set_life_cycle**](docs/ConfigurationDeviceInventoryApi.md#set_life_cycle) | **POST** /system/device/lifecycle/management/{uuid} | +*ConfigurationDeviceInventoryApi* | [**sync_devices**](docs/ConfigurationDeviceInventoryApi.md#sync_devices) | **POST** /system/device/smartaccount/sync | +*ConfigurationDeviceInventoryApi* | [**sync_root_cert_chain**](docs/ConfigurationDeviceInventoryApi.md#sync_root_cert_chain) | **GET** /system/device/sync/rootcertchain | +*ConfigurationDeviceInventoryApi* | [**update_device_subject_sudi**](docs/ConfigurationDeviceInventoryApi.md#update_device_subject_sudi) | **PUT** /system/device/updateDeviceSubjectSUDI/{uuid} | +*ConfigurationDeviceInventoryApi* | [**validate_user**](docs/ConfigurationDeviceInventoryApi.md#validate_user) | **POST** /system/device/smartaccount/authenticate | +*ConfigurationDeviceInventoryApi* | [**validate_user1**](docs/ConfigurationDeviceInventoryApi.md#validate_user1) | **POST** /system/device/generate-payg | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**add_wan_edge**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#add_wan_edge) | **POST** /sslproxy/certificate/wanedge/{deviceId} | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**generate_ssl_proxy_csr**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#generate_ssl_proxy_csr) | **POST** /sslproxy/generate/csr/sslproxy | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**generate_ssl_proxy_csr_0**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#generate_ssl_proxy_csr_0) | **POST** /sslproxy/generate/vmanage/csr | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_all_device_certificates**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_all_device_certificates) | **POST** /sslproxy/devicecertificates | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_all_device_csr**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_all_device_csr) | **POST** /sslproxy/devicecsr | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_certificate_state**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_certificate_state) | **GET** /sslproxy/settings/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_enterprise_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_enterprise_certificate) | **GET** /sslproxy/settings/enterprise/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_proxy_cert_of_edge**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_proxy_cert_of_edge) | **GET** /sslproxy/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_self_signed_cert**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_self_signed_cert) | **GET** /certificate/vmanage/selfsignedcert | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_ssl_proxy_csr**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_ssl_proxy_csr) | **GET** /sslproxy/csr | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_ssl_proxy_list**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_ssl_proxy_list) | **GET** /sslproxy/list | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**get_v_manage_enterprise_root_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_v_manage_enterprise_root_certificate) | **GET** /sslproxy/settings/enterprise/rootca | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**getv_manage_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#getv_manage_certificate) | **GET** /sslproxy/settings/vmanage/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**getv_manage_csr**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#getv_manage_csr) | **GET** /sslproxy/settings/vmanage/csr | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**getv_manage_root_ca**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#getv_manage_root_ca) | **GET** /sslproxy/settings/vmanage/rootca | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**renew_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#renew_certificate) | **POST** /sslproxy/renew | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**revoke_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#revoke_certificate) | **POST** /sslproxy/revoke | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**revoke_renew_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#revoke_renew_certificate) | **POST** /sslproxy/revokerenew | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**set_enterprise_cert**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#set_enterprise_cert) | **POST** /sslproxy/settings/enterprise/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**set_enterprise_root_ca_cert**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#set_enterprise_root_ca_cert) | **POST** /sslproxy/settings/enterprise/rootca | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**setv_manage_root_ca**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#setv_manage_root_ca) | **POST** /sslproxy/settings/vmanage/rootca | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**setv_manageintermediate_cert**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#setv_manageintermediate_cert) | **POST** /sslproxy/settings/vmanage/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**update_certificate**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#update_certificate) | **PUT** /sslproxy/certificate | +*ConfigurationDeviceSSLProxyCertificateManagementApi* | [**upload_certificiates**](docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md#upload_certificiates) | **POST** /sslproxy/certificates | +*ConfigurationDeviceSoftwarePackageApi* | [**create_vnf_package**](docs/ConfigurationDeviceSoftwarePackageApi.md#create_vnf_package) | **POST** /device/action/software/package/custom/vnfPackage | +*ConfigurationDeviceSoftwarePackageApi* | [**edit_config_file**](docs/ConfigurationDeviceSoftwarePackageApi.md#edit_config_file) | **PUT** /device/action/software/package/custom/file/{uuid} | +*ConfigurationDeviceSoftwarePackageApi* | [**get_file_contents**](docs/ConfigurationDeviceSoftwarePackageApi.md#get_file_contents) | **GET** /device/action/software/package/custom/file/{uuid} | +*ConfigurationDeviceSoftwarePackageApi* | [**upload_image_file**](docs/ConfigurationDeviceSoftwarePackageApi.md#upload_image_file) | **POST** /device/action/software/package/custom/uploads/{type} | +*ConfigurationDeviceSoftwareUpdateApi* | [**download_package_file**](docs/ConfigurationDeviceSoftwareUpdateApi.md#download_package_file) | **GET** /device/action/software/package/{fileName} | +*ConfigurationDeviceSoftwareUpdateApi* | [**edit_image_metadata**](docs/ConfigurationDeviceSoftwareUpdateApi.md#edit_image_metadata) | **PUT** /device/action/software/package/{versionId}/metadata | +*ConfigurationDeviceSoftwareUpdateApi* | [**get_image_metadata**](docs/ConfigurationDeviceSoftwareUpdateApi.md#get_image_metadata) | **GET** /device/action/software/package/{versionId}/metadata | +*ConfigurationDeviceSoftwareUpdateApi* | [**get_upload_images_count**](docs/ConfigurationDeviceSoftwareUpdateApi.md#get_upload_images_count) | **GET** /device/action/software/package/imageCount | +*ConfigurationDeviceSoftwareUpdateApi* | [**install_pkg**](docs/ConfigurationDeviceSoftwareUpdateApi.md#install_pkg) | **POST** /device/action/software/package | +*ConfigurationDeviceSoftwareUpdateApi* | [**process_software_image**](docs/ConfigurationDeviceSoftwareUpdateApi.md#process_software_image) | **POST** /device/action/software/package/{imageType} | +*ConfigurationDeviceTemplateApi* | [**attach_device_template**](docs/ConfigurationDeviceTemplateApi.md#attach_device_template) | **POST** /template/device/config/attachment | +*ConfigurationDeviceTemplateApi* | [**check_vbond**](docs/ConfigurationDeviceTemplateApi.md#check_vbond) | **GET** /template/device/config/vbond | +*ConfigurationDeviceTemplateApi* | [**create_device_input**](docs/ConfigurationDeviceTemplateApi.md#create_device_input) | **POST** /template/device/config/input | +*ConfigurationDeviceTemplateApi* | [**create_input_without_device**](docs/ConfigurationDeviceTemplateApi.md#create_input_without_device) | **POST** /template/device/config/exportcsv | +*ConfigurationDeviceTemplateApi* | [**detach_device_template**](docs/ConfigurationDeviceTemplateApi.md#detach_device_template) | **POST** /template/device/config/detach | +*ConfigurationDeviceTemplateApi* | [**detach_sites**](docs/ConfigurationDeviceTemplateApi.md#detach_sites) | **POST** /template/device/config/detachcloudx | +*ConfigurationDeviceTemplateApi* | [**edit_cloudx_config**](docs/ConfigurationDeviceTemplateApi.md#edit_cloudx_config) | **PUT** /template/device/config/attachcloudx | +*ConfigurationDeviceTemplateApi* | [**get_attached_config_to_device**](docs/ConfigurationDeviceTemplateApi.md#get_attached_config_to_device) | **GET** /template/device/config/attachedconfig | +*ConfigurationDeviceTemplateApi* | [**get_attached_device_list**](docs/ConfigurationDeviceTemplateApi.md#get_attached_device_list) | **GET** /template/device/config/attached/{masterTemplateId} | +*ConfigurationDeviceTemplateApi* | [**get_device_configuration_preview**](docs/ConfigurationDeviceTemplateApi.md#get_device_configuration_preview) | **POST** /template/device/config/config | +*ConfigurationDeviceTemplateApi* | [**get_device_list_by_master_template_id**](docs/ConfigurationDeviceTemplateApi.md#get_device_list_by_master_template_id) | **GET** /template/device/config/available/{masterTemplateId} | +*ConfigurationDeviceTemplateApi* | [**get_devices_with_duplicate_ip**](docs/ConfigurationDeviceTemplateApi.md#get_devices_with_duplicate_ip) | **POST** /template/device/config/duplicateip | +*ConfigurationDeviceTemplateApi* | [**get_devices_with_duplicate_location_name**](docs/ConfigurationDeviceTemplateApi.md#get_devices_with_duplicate_location_name) | **POST** /template/device/config/duplicatelocationname | +*ConfigurationDeviceTemplateApi* | [**get_quick_connect_variables**](docs/ConfigurationDeviceTemplateApi.md#get_quick_connect_variables) | **POST** /template/device/config/quickconnectvariable | +*ConfigurationDeviceTemplateApi* | [**process_input_comma_sep_file**](docs/ConfigurationDeviceTemplateApi.md#process_input_comma_sep_file) | **POST** /template/device/config/process/input/file | +*ConfigurationDeviceTemplateApi* | [**push_cli_template**](docs/ConfigurationDeviceTemplateApi.md#push_cli_template) | **POST** /template/device/config/attachcli | +*ConfigurationDeviceTemplateApi* | [**push_cloudx_config**](docs/ConfigurationDeviceTemplateApi.md#push_cloudx_config) | **POST** /template/device/config/attachcloudx | +*ConfigurationDeviceTemplateApi* | [**push_master_template**](docs/ConfigurationDeviceTemplateApi.md#push_master_template) | **POST** /template/device/config/attachfeature | +*ConfigurationDeviceTemplateApi* | [**push_master_template1**](docs/ConfigurationDeviceTemplateApi.md#push_master_template1) | **POST** /template/device/config/attachBootStrap | +*ConfigurationDeviceTemplateApi* | [**validate_template**](docs/ConfigurationDeviceTemplateApi.md#validate_template) | **POST** /template/device/config/verify | +*ConfigurationDisasterRecoveryApi* | [**activate**](docs/ConfigurationDisasterRecoveryApi.md#activate) | **POST** /disasterrecovery/activate | +*ConfigurationDisasterRecoveryApi* | [**delete**](docs/ConfigurationDisasterRecoveryApi.md#delete) | **POST** /disasterrecovery/deregister | +*ConfigurationDisasterRecoveryApi* | [**delete_dc**](docs/ConfigurationDisasterRecoveryApi.md#delete_dc) | **POST** /disasterrecovery/deleteRemoteDataCenter | +*ConfigurationDisasterRecoveryApi* | [**delete_local_dc**](docs/ConfigurationDisasterRecoveryApi.md#delete_local_dc) | **POST** /disasterrecovery/deleteLocalDataCenter | +*ConfigurationDisasterRecoveryApi* | [**disaster_recovery_pause_replication**](docs/ConfigurationDisasterRecoveryApi.md#disaster_recovery_pause_replication) | **POST** /disasterrecovery/pausereplication | +*ConfigurationDisasterRecoveryApi* | [**disaster_recovery_replication_request**](docs/ConfigurationDisasterRecoveryApi.md#disaster_recovery_replication_request) | **POST** /disasterrecovery/requestimport | +*ConfigurationDisasterRecoveryApi* | [**disaster_recovery_un_pause_replication**](docs/ConfigurationDisasterRecoveryApi.md#disaster_recovery_un_pause_replication) | **POST** /disasterrecovery/unpausereplication | +*ConfigurationDisasterRecoveryApi* | [**download**](docs/ConfigurationDisasterRecoveryApi.md#download) | **GET** /disasterrecovery/download/backup/{token}/db_bkp.tar.gz | +*ConfigurationDisasterRecoveryApi* | [**download_replication_data**](docs/ConfigurationDisasterRecoveryApi.md#download_replication_data) | **GET** /disasterrecovery/download/{token}/{fileName} | +*ConfigurationDisasterRecoveryApi* | [**get**](docs/ConfigurationDisasterRecoveryApi.md#get) | **GET** /disasterrecovery/usernames | +*ConfigurationDisasterRecoveryApi* | [**get_cluster_info**](docs/ConfigurationDisasterRecoveryApi.md#get_cluster_info) | **GET** /disasterrecovery/clusterInfo | +*ConfigurationDisasterRecoveryApi* | [**get_config_db_restore_status**](docs/ConfigurationDisasterRecoveryApi.md#get_config_db_restore_status) | **GET** /disasterrecovery/dbrestorestatus | +*ConfigurationDisasterRecoveryApi* | [**get_details**](docs/ConfigurationDisasterRecoveryApi.md#get_details) | **GET** /disasterrecovery/details | +*ConfigurationDisasterRecoveryApi* | [**get_disaster_recovery_local_replication_schedule**](docs/ConfigurationDisasterRecoveryApi.md#get_disaster_recovery_local_replication_schedule) | **GET** /disasterrecovery/schedule | +*ConfigurationDisasterRecoveryApi* | [**get_disaster_recovery_status**](docs/ConfigurationDisasterRecoveryApi.md#get_disaster_recovery_status) | **GET** /disasterrecovery/drstatus | +*ConfigurationDisasterRecoveryApi* | [**get_history**](docs/ConfigurationDisasterRecoveryApi.md#get_history) | **GET** /disasterrecovery/history | +*ConfigurationDisasterRecoveryApi* | [**get_local_data_center_state**](docs/ConfigurationDisasterRecoveryApi.md#get_local_data_center_state) | **GET** /disasterrecovery/localdc | +*ConfigurationDisasterRecoveryApi* | [**get_local_history**](docs/ConfigurationDisasterRecoveryApi.md#get_local_history) | **GET** /disasterrecovery/localLatestHistory | +*ConfigurationDisasterRecoveryApi* | [**get_reachability_info**](docs/ConfigurationDisasterRecoveryApi.md#get_reachability_info) | **POST** /disasterrecovery/validateNodes | +*ConfigurationDisasterRecoveryApi* | [**get_remote_data_center_state**](docs/ConfigurationDisasterRecoveryApi.md#get_remote_data_center_state) | **GET** /disasterrecovery/remotedc | +*ConfigurationDisasterRecoveryApi* | [**get_remote_data_center_version**](docs/ConfigurationDisasterRecoveryApi.md#get_remote_data_center_version) | **GET** /disasterrecovery/remotedc/swversion | +*ConfigurationDisasterRecoveryApi* | [**get_remote_dc_members_state**](docs/ConfigurationDisasterRecoveryApi.md#get_remote_dc_members_state) | **GET** /disasterrecovery/remoteDcState | +*ConfigurationDisasterRecoveryApi* | [**getdr_status**](docs/ConfigurationDisasterRecoveryApi.md#getdr_status) | **GET** /disasterrecovery/status | +*ConfigurationDisasterRecoveryApi* | [**pause_dr**](docs/ConfigurationDisasterRecoveryApi.md#pause_dr) | **POST** /disasterrecovery/pause | +*ConfigurationDisasterRecoveryApi* | [**pause_local_arbitrator**](docs/ConfigurationDisasterRecoveryApi.md#pause_local_arbitrator) | **POST** /disasterrecovery/pauseLocalArbitrator | +*ConfigurationDisasterRecoveryApi* | [**pause_local_dc_for_dr**](docs/ConfigurationDisasterRecoveryApi.md#pause_local_dc_for_dr) | **POST** /disasterrecovery/pauseLocalDC | +*ConfigurationDisasterRecoveryApi* | [**pause_local_dc_replication**](docs/ConfigurationDisasterRecoveryApi.md#pause_local_dc_replication) | **POST** /disasterrecovery/pauseLocalReplication | +*ConfigurationDisasterRecoveryApi* | [**register**](docs/ConfigurationDisasterRecoveryApi.md#register) | **POST** /disasterrecovery/register | +*ConfigurationDisasterRecoveryApi* | [**restart_data_center**](docs/ConfigurationDisasterRecoveryApi.md#restart_data_center) | **POST** /disasterrecovery/restartDataCenter | +*ConfigurationDisasterRecoveryApi* | [**restore_config_db**](docs/ConfigurationDisasterRecoveryApi.md#restore_config_db) | **POST** /disasterrecovery/dbrestore | +*ConfigurationDisasterRecoveryApi* | [**unpause_dr**](docs/ConfigurationDisasterRecoveryApi.md#unpause_dr) | **POST** /disasterrecovery/unpause | +*ConfigurationDisasterRecoveryApi* | [**unpause_local_arbitrator**](docs/ConfigurationDisasterRecoveryApi.md#unpause_local_arbitrator) | **POST** /disasterrecovery/unpauseLocalArbitrator | +*ConfigurationDisasterRecoveryApi* | [**unpause_local_dc_for_dr**](docs/ConfigurationDisasterRecoveryApi.md#unpause_local_dc_for_dr) | **POST** /disasterrecovery/unpauseLocalDC | +*ConfigurationDisasterRecoveryApi* | [**unpause_local_dc_replication**](docs/ConfigurationDisasterRecoveryApi.md#unpause_local_dc_replication) | **POST** /disasterrecovery/unpauseLocalReplication | +*ConfigurationDisasterRecoveryApi* | [**update**](docs/ConfigurationDisasterRecoveryApi.md#update) | **POST** /disasterrecovery/password | +*ConfigurationDisasterRecoveryApi* | [**update1**](docs/ConfigurationDisasterRecoveryApi.md#update1) | **PUT** /disasterrecovery/register | +*ConfigurationDisasterRecoveryApi* | [**update_disaster_recovery_state**](docs/ConfigurationDisasterRecoveryApi.md#update_disaster_recovery_state) | **POST** /disasterrecovery/remotePassword | +*ConfigurationDisasterRecoveryApi* | [**update_disaster_recovery_state1**](docs/ConfigurationDisasterRecoveryApi.md#update_disaster_recovery_state1) | **POST** /disasterrecovery/remotedc | +*ConfigurationDisasterRecoveryApi* | [**update_dr_state**](docs/ConfigurationDisasterRecoveryApi.md#update_dr_state) | **POST** /disasterrecovery/updateDRConfigOnArbitrator | +*ConfigurationDisasterRecoveryApi* | [**update_replication**](docs/ConfigurationDisasterRecoveryApi.md#update_replication) | **POST** /disasterrecovery/updateReplication | +*ConfigurationDownloadedImagesApi* | [**create_software_list**](docs/ConfigurationDownloadedImagesApi.md#create_software_list) | **GET** /device/downloadedImages | +*ConfigurationFQDNListBuilderApi* | [**create_policy_list16**](docs/ConfigurationFQDNListBuilderApi.md#create_policy_list16) | **POST** /template/policy/list/fqdn | +*ConfigurationFQDNListBuilderApi* | [**delete_policy_list16**](docs/ConfigurationFQDNListBuilderApi.md#delete_policy_list16) | **DELETE** /template/policy/list/fqdn/{id} | +*ConfigurationFQDNListBuilderApi* | [**delete_policy_lists_with_info_tag16**](docs/ConfigurationFQDNListBuilderApi.md#delete_policy_lists_with_info_tag16) | **DELETE** /template/policy/list/fqdn | +*ConfigurationFQDNListBuilderApi* | [**edit_policy_list16**](docs/ConfigurationFQDNListBuilderApi.md#edit_policy_list16) | **PUT** /template/policy/list/fqdn/{id} | +*ConfigurationFQDNListBuilderApi* | [**get_lists_by_id16**](docs/ConfigurationFQDNListBuilderApi.md#get_lists_by_id16) | **GET** /template/policy/list/fqdn/{id} | +*ConfigurationFQDNListBuilderApi* | [**get_policy_lists14**](docs/ConfigurationFQDNListBuilderApi.md#get_policy_lists14) | **GET** /template/policy/list/fqdn | +*ConfigurationFQDNListBuilderApi* | [**get_policy_lists_with_info_tag16**](docs/ConfigurationFQDNListBuilderApi.md#get_policy_lists_with_info_tag16) | **GET** /template/policy/list/fqdn/filtered | +*ConfigurationFQDNListBuilderApi* | [**preview_policy_list16**](docs/ConfigurationFQDNListBuilderApi.md#preview_policy_list16) | **POST** /template/policy/list/fqdn/preview | +*ConfigurationFQDNListBuilderApi* | [**preview_policy_list_by_id16**](docs/ConfigurationFQDNListBuilderApi.md#preview_policy_list_by_id16) | **GET** /template/policy/list/fqdn/preview/{id} | +*ConfigurationFeatureCertificateApi* | [**gen_device_csr**](docs/ConfigurationFeatureCertificateApi.md#gen_device_csr) | **PUT** /featurecertificate/devicecsr | +*ConfigurationFeatureCertificateApi* | [**get_device_certificate**](docs/ConfigurationFeatureCertificateApi.md#get_device_certificate) | **GET** /featurecertificate/certificate | +*ConfigurationFeatureCertificateApi* | [**get_device_csr**](docs/ConfigurationFeatureCertificateApi.md#get_device_csr) | **GET** /featurecertificate/devicecsr | +*ConfigurationFeatureCertificateApi* | [**get_feature_ca_state**](docs/ConfigurationFeatureCertificateApi.md#get_feature_ca_state) | **GET** /featurecertificate/syslogconfig | +*ConfigurationFeatureCertificateApi* | [**install_feature_certificate**](docs/ConfigurationFeatureCertificateApi.md#install_feature_certificate) | **PUT** /featurecertificate/certificate | +*ConfigurationFeatureCertificateApi* | [**revoke_feature_certificate**](docs/ConfigurationFeatureCertificateApi.md#revoke_feature_certificate) | **PUT** /featurecertificate/revoke | +*ConfigurationFeatureProfileMobilityApi* | [**create_basic_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_basic_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/basic | +*ConfigurationFeatureProfileMobilityApi* | [**create_cellular_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_cellular_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/cellular | +*ConfigurationFeatureProfileMobilityApi* | [**create_ethernet_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_ethernet_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/ethernet | +*ConfigurationFeatureProfileMobilityApi* | [**create_network_protocol_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_network_protocol_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/networkProtocol | +*ConfigurationFeatureProfileMobilityApi* | [**create_security_policy_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_security_policy_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/securityPolicy | +*ConfigurationFeatureProfileMobilityApi* | [**create_vpn_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_vpn_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/vpn | +*ConfigurationFeatureProfileMobilityApi* | [**create_wifi_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#create_wifi_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/wifi | +*ConfigurationFeatureProfileMobilityApi* | [**delete_a_cellular_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_a_cellular_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId} | +*ConfigurationFeatureProfileMobilityApi* | [**delete_a_vpn_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_a_vpn_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId} | +*ConfigurationFeatureProfileMobilityApi* | [**delete_basic_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_basic_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/basic/{parcelId} | +*ConfigurationFeatureProfileMobilityApi* | [**delete_ethernet_profile_parcel_for_system**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_ethernet_profile_parcel_for_system) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId} | +*ConfigurationFeatureProfileMobilityApi* | [**delete_network_protocol_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_network_protocol_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId} | +*ConfigurationFeatureProfileMobilityApi* | [**delete_security_policy_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_security_policy_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId} | +*ConfigurationFeatureProfileMobilityApi* | [**delete_wifi_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#delete_wifi_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_basic_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_basic_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/basic/{parcelId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_cellular_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_cellular_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_ethernet_profile_parcel_for_system**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_ethernet_profile_parcel_for_system) | **PUT** /v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_network_protocol_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_network_protocol_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_security_policy_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_security_policy_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_vpn_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_vpn_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId} | +*ConfigurationFeatureProfileMobilityApi* | [**edit_wifi_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#edit_wifi_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_basic_profile_parcel_by_parcel_id_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_basic_profile_parcel_by_parcel_id_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/basic/{parcelId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_basic_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_basic_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/basic | +*ConfigurationFeatureProfileMobilityApi* | [**get_cellular_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_cellular_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_cellular_profile_parcel_list_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_cellular_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/cellular | +*ConfigurationFeatureProfileMobilityApi* | [**get_ethernet_profile_parcel**](docs/ConfigurationFeatureProfileMobilityApi.md#get_ethernet_profile_parcel) | **GET** /v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_ethernet_profile_parcels**](docs/ConfigurationFeatureProfileMobilityApi.md#get_ethernet_profile_parcels) | **GET** /v1/feature-profile/mobility/global/{profileId}/ethernet | +*ConfigurationFeatureProfileMobilityApi* | [**get_mobility_feature_profile_by_global_id**](docs/ConfigurationFeatureProfileMobilityApi.md#get_mobility_feature_profile_by_global_id) | **GET** /v1/feature-profile/mobility/global/{profileId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_mobility_global_basic_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileMobilityApi.md#get_mobility_global_basic_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/mobility/global/basic/schema | +*ConfigurationFeatureProfileMobilityApi* | [**get_network_protocol_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_network_protocol_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_network_protocol_profile_parcel_list_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_network_protocol_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/networkProtocol | +*ConfigurationFeatureProfileMobilityApi* | [**get_security_policy_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_security_policy_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_security_policy_profile_parcel_list_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_security_policy_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/securityPolicy | +*ConfigurationFeatureProfileMobilityApi* | [**get_vpn_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_vpn_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_vpn_profile_parcel_list_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_vpn_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/vpn | +*ConfigurationFeatureProfileMobilityApi* | [**get_wifi_profile_parcel_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_wifi_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId} | +*ConfigurationFeatureProfileMobilityApi* | [**get_wifi_profile_parcel_list_for_mobility**](docs/ConfigurationFeatureProfileMobilityApi.md#get_wifi_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/wifi | +*ConfigurationFeatureProfileSDWANApi* | [**cedge_service_profile_switchport_parcel_restful_resource**](docs/ConfigurationFeatureProfileSDWANApi.md#cedge_service_profile_switchport_parcel_restful_resource) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/switchport | +*ConfigurationFeatureProfileSDWANApi* | [**create_aaa_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_aaa_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/aaa | +*ConfigurationFeatureProfileSDWANApi* | [**create_banner_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_banner_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/banner | +*ConfigurationFeatureProfileSDWANApi* | [**create_basic_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_basic_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/basic | +*ConfigurationFeatureProfileSDWANApi* | [**create_bfd_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_bfd_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/bfd | +*ConfigurationFeatureProfileSDWANApi* | [**create_cellular_controller_and_cellular_profile_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_cellular_controller_and_cellular_profile_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile | +*ConfigurationFeatureProfileSDWANApi* | [**create_cellular_controller_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_cellular_controller_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller | +*ConfigurationFeatureProfileSDWANApi* | [**create_cellular_profile_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_cellular_profile_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile | +*ConfigurationFeatureProfileSDWANApi* | [**create_dhcp_server_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_dhcp_server_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server | +*ConfigurationFeatureProfileSDWANApi* | [**create_global_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_global_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/global | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_and_routing_bgp_parcel_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_and_routing_bgp_parcel_association_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_and_routing_ospf_parcel_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_and_routing_ospf_parcel_association_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_interface_ethernet_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_ethernet_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_interface_svi_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_svi_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi | +*ConfigurationFeatureProfileSDWANApi* | [**create_lan_vpn_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn | +*ConfigurationFeatureProfileSDWANApi* | [**create_logging_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_logging_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/logging | +*ConfigurationFeatureProfileSDWANApi* | [**create_management_vpn_interface_ethernet_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_management_vpn_interface_ethernet_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet | +*ConfigurationFeatureProfileSDWANApi* | [**create_management_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_management_vpn_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn | +*ConfigurationFeatureProfileSDWANApi* | [**create_ntp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_ntp_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/ntp | +*ConfigurationFeatureProfileSDWANApi* | [**create_omp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_omp_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/omp | +*ConfigurationFeatureProfileSDWANApi* | [**create_routing_bgp_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_routing_bgp_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**create_routing_bgp_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_routing_bgp_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**create_routing_ospf_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_routing_ospf_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf | +*ConfigurationFeatureProfileSDWANApi* | [**create_sdwan_config_profile_parcel_for_cli**](docs/ConfigurationFeatureProfileSDWANApi.md#create_sdwan_config_profile_parcel_for_cli) | **POST** /v1/feature-profile/sdwan/cli/{cliId}/config | +*ConfigurationFeatureProfileSDWANApi* | [**create_sdwan_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#create_sdwan_feature_profile) | **POST** /v1/feature-profile/sdwan/cli | +*ConfigurationFeatureProfileSDWANApi* | [**create_sdwan_other_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#create_sdwan_other_feature_profile) | **POST** /v1/feature-profile/sdwan/other | +*ConfigurationFeatureProfileSDWANApi* | [**create_sdwan_service_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#create_sdwan_service_feature_profile) | **POST** /v1/feature-profile/sdwan/service | +*ConfigurationFeatureProfileSDWANApi* | [**create_sdwan_system_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#create_sdwan_system_feature_profile) | **POST** /v1/feature-profile/sdwan/system | +*ConfigurationFeatureProfileSDWANApi* | [**create_sdwan_transport_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#create_sdwan_transport_feature_profile) | **POST** /v1/feature-profile/sdwan/transport | +*ConfigurationFeatureProfileSDWANApi* | [**create_snmp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#create_snmp_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/snmp | +*ConfigurationFeatureProfileSDWANApi* | [**create_thousandeyes_profile_parcel_for_other**](docs/ConfigurationFeatureProfileSDWANApi.md#create_thousandeyes_profile_parcel_for_other) | **POST** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes | +*ConfigurationFeatureProfileSDWANApi* | [**create_tracker_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_tracker_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/tracker | +*ConfigurationFeatureProfileSDWANApi* | [**create_wan_vpn_and_routing_bgp_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_and_routing_bgp_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker | +*ConfigurationFeatureProfileSDWANApi* | [**create_wan_vpn_interface_cellular_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_cellular_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular | +*ConfigurationFeatureProfileSDWANApi* | [**create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker | +*ConfigurationFeatureProfileSDWANApi* | [**create_wan_vpn_interface_ethernet_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_ethernet_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet | +*ConfigurationFeatureProfileSDWANApi* | [**create_wan_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn | +*ConfigurationFeatureProfileSDWANApi* | [**create_wirelesslan_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#create_wirelesslan_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan | +*ConfigurationFeatureProfileSDWANApi* | [**delete_aaa_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_aaa_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_banner_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_banner_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_basic_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_basic_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/basic/{basicId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_bfd_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_bfd_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_cellular_controller_and_cellular_profile_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_cellular_controller_and_cellular_profile_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_cellular_controller_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_cellular_controller_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_cellular_profile_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_cellular_profile_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_config_profile_parcel_for_cli**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_config_profile_parcel_for_cli) | **DELETE** /v1/feature-profile/sdwan/cli/{cliId}/config/{configId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_dhcp_server_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_dhcp_server_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_global_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_global_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/global/{globalId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_and_routing_bgp_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_and_routing_bgp_association_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_and_routing_ospf_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_and_routing_ospf_association_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_interface_ethernet_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_ethernet_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_interface_svi_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_svi_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_lan_vpn_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_logging_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_logging_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_management_vpn_interface_ethernet_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_management_vpn_interface_ethernet_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_management_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_management_vpn_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_ntp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_ntp_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_omp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_omp_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/omp/{ompId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_routing_bgp_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_routing_bgp_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_routing_bgp_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_routing_bgp_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_routing_ospf_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_routing_ospf_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_sdwan_feature_profile_for_cli**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_feature_profile_for_cli) | **DELETE** /v1/feature-profile/sdwan/cli/{cliId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_sdwan_other_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_other_feature_profile) | **DELETE** /v1/feature-profile/sdwan/other/{otherId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_sdwan_service_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_service_feature_profile) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_sdwan_system_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_system_feature_profile) | **DELETE** /v1/feature-profile/sdwan/system/{systemId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_sdwan_transport_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_transport_feature_profile) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_snmp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_snmp_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_switchport_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_switchport_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_thousandeyes_profile_parcel_for_other**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_thousandeyes_profile_parcel_for_other) | **DELETE** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_tracker_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_tracker_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wan_vpn_and_routing_bgp_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_and_routing_bgp_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wan_vpn_interface_cellular_and_tracker_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_cellular_and_tracker_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wan_vpn_interface_cellular_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_cellular_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wan_vpn_interface_ethernet_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_ethernet_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wan_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**delete_wirelesslan_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#delete_wirelesslan_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_aaa_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_aaa_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_banner_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_banner_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_basic_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_basic_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/basic/{basicId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_bfd_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_bfd_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_cellular_controller_and_cellular_profile_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_cellular_controller_and_cellular_profile_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_cellular_controller_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_cellular_controller_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_cellular_profile_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_cellular_profile_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_config_profile_parcel_for_cli**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_config_profile_parcel_for_cli) | **PUT** /v1/feature-profile/sdwan/cli/{cliId}/config/{configId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_dhcp_server_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_dhcp_server_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_global_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_global_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/global/{globalId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_and_routing_bgp_parcel_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_and_routing_bgp_parcel_association_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_and_routing_ospf_parcel_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_and_routing_ospf_parcel_association_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_interface_ethernet_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_ethernet_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_interface_svi_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_svi_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_lan_vpn_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_logging_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_logging_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_management_vpn_interface_ethernet_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_management_vpn_interface_ethernet_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_management_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_management_vpn_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_ntp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_ntp_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_omp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_omp_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/omp/{ompId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_routing_bgp_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_routing_bgp_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_routing_bgp_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_routing_bgp_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_routing_ospf_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_routing_ospf_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_sdwan_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_feature_profile) | **PUT** /v1/feature-profile/sdwan/cli/{cliId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_sdwan_other_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_other_feature_profile) | **PUT** /v1/feature-profile/sdwan/other/{otherId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_sdwan_service_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_service_feature_profile) | **PUT** /v1/feature-profile/sdwan/service/{serviceId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_sdwan_system_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_system_feature_profile) | **PUT** /v1/feature-profile/sdwan/system/{systemId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_sdwan_transport_feature_profile**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_transport_feature_profile) | **PUT** /v1/feature-profile/sdwan/transport/{transportId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_snmp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_snmp_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_switchport_parcel_association_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_switchport_parcel_association_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_thousandeyes_profile_parcel_for_other**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_thousandeyes_profile_parcel_for_other) | **PUT** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_tracker_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_tracker_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wan_vpn_and_routing_bgp_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_and_routing_bgp_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wan_vpn_interface_cellular_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_cellular_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wan_vpn_interface_ethernet_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_ethernet_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wan_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**edit_wirelesslan_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#edit_wirelesslan_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_aaa_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_aaa_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_aaa_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_aaa_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/aaa | +*ConfigurationFeatureProfileSDWANApi* | [**get_banner_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_banner_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_banner_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_banner_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/banner | +*ConfigurationFeatureProfileSDWANApi* | [**get_basic_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_basic_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/basic/{basicId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_basic_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_basic_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/basic | +*ConfigurationFeatureProfileSDWANApi* | [**get_bfd_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_bfd_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_bfd_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_bfd_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/bfd | +*ConfigurationFeatureProfileSDWANApi* | [**get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_cedge_service_switchport_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cedge_service_switchport_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/switchport/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_cedge_system_global_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cedge_system_global_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/global/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_cellular_controller_associated_cellular_profile_parcels_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_associated_cellular_profile_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile | +*ConfigurationFeatureProfileSDWANApi* | [**get_cellular_controller_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_cellular_controller_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller | +*ConfigurationFeatureProfileSDWANApi* | [**get_cellular_profile_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cellular_profile_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_cellular_profile_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_cellular_profile_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile | +*ConfigurationFeatureProfileSDWANApi* | [**get_config_profile_parcel_by_parcel_id_for_cli**](docs/ConfigurationFeatureProfileSDWANApi.md#get_config_profile_parcel_by_parcel_id_for_cli) | **GET** /v1/feature-profile/sdwan/cli/{cliId}/config/{configId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_config_profile_parcel_for_cli**](docs/ConfigurationFeatureProfileSDWANApi.md#get_config_profile_parcel_for_cli) | **GET** /v1/feature-profile/sdwan/cli/{cliId}/config | +*ConfigurationFeatureProfileSDWANApi* | [**get_dhcp_server_profile_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_dhcp_server_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_dhcp_server_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_dhcp_server_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server | +*ConfigurationFeatureProfileSDWANApi* | [**get_global_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_global_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/global/{globalId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_global_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_global_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/global | +*ConfigurationFeatureProfileSDWANApi* | [**get_interface_cellular_parcels_for_transport_wan_vpn**](docs/ConfigurationFeatureProfileSDWANApi.md#get_interface_cellular_parcels_for_transport_wan_vpn) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular | +*ConfigurationFeatureProfileSDWANApi* | [**get_interface_ethernet_parcels_for_service_lan_vpn**](docs/ConfigurationFeatureProfileSDWANApi.md#get_interface_ethernet_parcels_for_service_lan_vpn) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet | +*ConfigurationFeatureProfileSDWANApi* | [**get_interface_ethernet_parcels_for_transport_management_vpn**](docs/ConfigurationFeatureProfileSDWANApi.md#get_interface_ethernet_parcels_for_transport_management_vpn) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet | +*ConfigurationFeatureProfileSDWANApi* | [**get_interface_ethernet_parcels_for_transport_wan_vpn**](docs/ConfigurationFeatureProfileSDWANApi.md#get_interface_ethernet_parcels_for_transport_wan_vpn) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet | +*ConfigurationFeatureProfileSDWANApi* | [**get_interface_svi_parcels_for_service_lan_vpn**](docs/ConfigurationFeatureProfileSDWANApi.md#get_interface_svi_parcels_for_service_lan_vpn) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_associated_routing_bgp_parcels_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_bgp_parcels_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_associated_routing_ospf_parcels_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_ospf_parcels_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_profile_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_lan_vpn_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn | +*ConfigurationFeatureProfileSDWANApi* | [**get_logging_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_logging_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_logging_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_logging_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/logging | +*ConfigurationFeatureProfileSDWANApi* | [**get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_management_vpn_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_management_vpn_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_management_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_management_vpn_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn | +*ConfigurationFeatureProfileSDWANApi* | [**get_ntp_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_ntp_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_ntp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_ntp_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/ntp | +*ConfigurationFeatureProfileSDWANApi* | [**get_omp_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_omp_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/omp/{ompId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_omp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_omp_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/omp | +*ConfigurationFeatureProfileSDWANApi* | [**get_routing_bgp_profile_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_routing_bgp_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_routing_bgp_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**get_routing_bgp_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**get_routing_ospf_profile_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_routing_ospf_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_routing_ospf_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_routing_ospf_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_feature_profile_by_profile_id**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/cli/{cliId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_feature_profile_by_sdwan_family**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_feature_profile_by_sdwan_family) | **GET** /v1/feature-profile/sdwan | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_feature_profiles_by_family_and_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_feature_profiles_by_family_and_type) | **GET** /v1/feature-profile/sdwan/cli | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_other_feature_profile_by_profile_id**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_other_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/other/{otherId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_other_feature_profiles**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_other_feature_profiles) | **GET** /v1/feature-profile/sdwan/other | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_other_thousandeyes_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_other_thousandeyes_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/other/thousandeyes/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_dhcp_server_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_dhcp_server_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/dhcp-server/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_feature_profile_by_profile_id**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/service/{serviceId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_feature_profiles**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_feature_profiles) | **GET** /v1/feature-profile/sdwan/service | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_lan_vpn_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_lan_vpn_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/lan/vpn/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_routing_bgp_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_routing_bgp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/routing/bgp/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_routing_ospf_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_routing_ospf_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/routing/ospf/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_service_wirelesslan_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_wirelesslan_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/wirelesslan/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_aaa_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_aaa_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/aaa/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_banner_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_banner_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/banner/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_basic_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_basic_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/basic/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_bfd_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_bfd_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/bfd/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_feature_profile_by_profile_id**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/system/{systemId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_feature_profiles**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_feature_profiles) | **GET** /v1/feature-profile/sdwan/system | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_logging_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_logging_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/logging/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_ntp_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_ntp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/ntp/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_omp_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_omp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/omp/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_system_snmp_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_snmp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/snmp/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/cellular-controller/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/cellular-profile/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_feature_profile_by_profile_id**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/transport/{transportId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_feature_profiles**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_feature_profiles) | **GET** /v1/feature-profile/sdwan/transport | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_management_vpn_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_management_vpn_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/management/vpn/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/routing/bgp/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_tracker_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_tracker_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/tracker/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type**](docs/ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/wan/vpn/schema | +*ConfigurationFeatureProfileSDWANApi* | [**get_snmp_profile_parcel_by_parcel_id_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_snmp_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_snmp_profile_parcel_for_system**](docs/ConfigurationFeatureProfileSDWANApi.md#get_snmp_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/snmp | +*ConfigurationFeatureProfileSDWANApi* | [**get_switchport_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_switchport_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_switchport_parcels_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_switchport_parcels_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/switchport | +*ConfigurationFeatureProfileSDWANApi* | [**get_thousandeyes_profile_parcel_by_parcel_id_for_other**](docs/ConfigurationFeatureProfileSDWANApi.md#get_thousandeyes_profile_parcel_by_parcel_id_for_other) | **GET** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_thousandeyes_profile_parcel_for_other**](docs/ConfigurationFeatureProfileSDWANApi.md#get_thousandeyes_profile_parcel_for_other) | **GET** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes | +*ConfigurationFeatureProfileSDWANApi* | [**get_tracker_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_tracker_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_tracker_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_tracker_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/tracker | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_associated_routing_bgp_parcels_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_associated_routing_bgp_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_profile_parcel_by_parcel_id_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wan_vpn_profile_parcel_for_transport**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn | +*ConfigurationFeatureProfileSDWANApi* | [**get_wirelesslan_profile_parcel_by_parcel_id_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wirelesslan_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId} | +*ConfigurationFeatureProfileSDWANApi* | [**get_wirelesslan_profile_parcel_for_service**](docs/ConfigurationFeatureProfileSDWANApi.md#get_wirelesslan_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan | +*ConfigurationGeneralTemplateApi* | [**change_template_resource_group**](docs/ConfigurationGeneralTemplateApi.md#change_template_resource_group) | **POST** /template/feature/resource-group/{resourceGroupName}/{templateId} | +*ConfigurationGeneralTemplateApi* | [**clone_template**](docs/ConfigurationGeneralTemplateApi.md#clone_template) | **POST** /template/feature/clone | +*ConfigurationGeneralTemplateApi* | [**create_feature_template**](docs/ConfigurationGeneralTemplateApi.md#create_feature_template) | **POST** /template/feature | +*ConfigurationGeneralTemplateApi* | [**create_li_template**](docs/ConfigurationGeneralTemplateApi.md#create_li_template) | **POST** /template/feature/li | +*ConfigurationGeneralTemplateApi* | [**delete_general_template**](docs/ConfigurationGeneralTemplateApi.md#delete_general_template) | **DELETE** /template/feature/{templateId} | +*ConfigurationGeneralTemplateApi* | [**edit_feature_template**](docs/ConfigurationGeneralTemplateApi.md#edit_feature_template) | **PUT** /template/feature/{templateId} | +*ConfigurationGeneralTemplateApi* | [**edit_li_template**](docs/ConfigurationGeneralTemplateApi.md#edit_li_template) | **PUT** /template/feature/li/{templateId} | +*ConfigurationGeneralTemplateApi* | [**generate_feature_template_list**](docs/ConfigurationGeneralTemplateApi.md#generate_feature_template_list) | **GET** /template/feature | +*ConfigurationGeneralTemplateApi* | [**generate_master_template_definition**](docs/ConfigurationGeneralTemplateApi.md#generate_master_template_definition) | **GET** /template/feature/master/{type_name} | +*ConfigurationGeneralTemplateApi* | [**generate_template_by_device_type**](docs/ConfigurationGeneralTemplateApi.md#generate_template_by_device_type) | **GET** /template/feature/{deviceType} | +*ConfigurationGeneralTemplateApi* | [**generate_template_type_definition**](docs/ConfigurationGeneralTemplateApi.md#generate_template_type_definition) | **GET** /template/feature/types/definition/{type_name}/{version} | +*ConfigurationGeneralTemplateApi* | [**generate_template_types**](docs/ConfigurationGeneralTemplateApi.md#generate_template_types) | **GET** /template/feature/types | +*ConfigurationGeneralTemplateApi* | [**get_default_networks**](docs/ConfigurationGeneralTemplateApi.md#get_default_networks) | **GET** /template/feature/default/networks | +*ConfigurationGeneralTemplateApi* | [**get_device_templates_attached_to_feature**](docs/ConfigurationGeneralTemplateApi.md#get_device_templates_attached_to_feature) | **GET** /template/feature/devicetemplates/{templateId} | +*ConfigurationGeneralTemplateApi* | [**get_encrypted_string**](docs/ConfigurationGeneralTemplateApi.md#get_encrypted_string) | **POST** /template/security/encryptText/encrypt | +*ConfigurationGeneralTemplateApi* | [**get_general_template**](docs/ConfigurationGeneralTemplateApi.md#get_general_template) | **GET** /template/feature/object/{templateId} | +*ConfigurationGeneralTemplateApi* | [**get_network_interface**](docs/ConfigurationGeneralTemplateApi.md#get_network_interface) | **GET** /template/feature/default/networkinterface | +*ConfigurationGeneralTemplateApi* | [**get_template_definition**](docs/ConfigurationGeneralTemplateApi.md#get_template_definition) | **GET** /template/feature/definition/{templateId} | +*ConfigurationGeneralTemplateApi* | [**get_template_for_migration**](docs/ConfigurationGeneralTemplateApi.md#get_template_for_migration) | **GET** /template/feature/migration | +*ConfigurationGeneralTemplateApi* | [**list_li_template**](docs/ConfigurationGeneralTemplateApi.md#list_li_template) | **GET** /template/feature/li | +*ConfigurationIdentityServiceEngineApi* | [**delete_all_identity_lists**](docs/ConfigurationIdentityServiceEngineApi.md#delete_all_identity_lists) | **DELETE** /template/policy/ise/identity/deleteAllLists | +*ConfigurationIdentityServiceEngineApi* | [**get_identity_list_reference**](docs/ConfigurationIdentityServiceEngineApi.md#get_identity_list_reference) | **GET** /template/policy/ise/identity/referenced/{listType} | +*ConfigurationIseServerApi* | [**account_activate**](docs/ConfigurationIseServerApi.md#account_activate) | **POST** /ise/pxgrid/activate | +*ConfigurationIseServerApi* | [**account_create**](docs/ConfigurationIseServerApi.md#account_create) | **POST** /ise/pxgrid/create | +*ConfigurationIseServerApi* | [**add_ise_server_credentials**](docs/ConfigurationIseServerApi.md#add_ise_server_credentials) | **POST** /ise/credentials | +*ConfigurationIseServerApi* | [**approve**](docs/ConfigurationIseServerApi.md#approve) | **PUT** /ise/pxgrid/approve | +*ConfigurationIseServerApi* | [**connect1**](docs/ConfigurationIseServerApi.md#connect1) | **GET** /ise/connect | +*ConfigurationIseServerApi* | [**delete_ise_and_px_grid_account**](docs/ConfigurationIseServerApi.md#delete_ise_and_px_grid_account) | **DELETE** /ise/credentials/iseandpxgrid | +*ConfigurationIseServerApi* | [**delete_px_grid**](docs/ConfigurationIseServerApi.md#delete_px_grid) | **DELETE** /ise/credentials/pxgrid | +*ConfigurationIseServerApi* | [**get_identity_user_groups**](docs/ConfigurationIseServerApi.md#get_identity_user_groups) | **POST** /template/policy/ise/identity/usergroups | +*ConfigurationIseServerApi* | [**get_identity_users**](docs/ConfigurationIseServerApi.md#get_identity_users) | **POST** /template/policy/ise/identity/users | +*ConfigurationIseServerApi* | [**get_ise_server_credentials**](docs/ConfigurationIseServerApi.md#get_ise_server_credentials) | **GET** /ise/credentials | +*ConfigurationIseServerApi* | [**get_p_xgrid_cert**](docs/ConfigurationIseServerApi.md#get_p_xgrid_cert) | **GET** /ise/credentials/pxgrid/cert | +*ConfigurationIseServerApi* | [**get_px_grid_account**](docs/ConfigurationIseServerApi.md#get_px_grid_account) | **GET** /ise/credentials/pxgrid | +*ConfigurationIseServerApi* | [**sync_vsmart**](docs/ConfigurationIseServerApi.md#sync_vsmart) | **POST** /ise/credentials/vsmart/sync | +*ConfigurationIseServerApi* | [**update_ise_server_credentials**](docs/ConfigurationIseServerApi.md#update_ise_server_credentials) | **PUT** /ise/credentials | +*ConfigurationMultiCloudApi* | [**add_edge_global_settings**](docs/ConfigurationMultiCloudApi.md#add_edge_global_settings) | **POST** /multicloud/settings/edge/global | +*ConfigurationMultiCloudApi* | [**add_global_settings**](docs/ConfigurationMultiCloudApi.md#add_global_settings) | **POST** /multicloud/settings/global | +*ConfigurationMultiCloudApi* | [**attach_sites**](docs/ConfigurationMultiCloudApi.md#attach_sites) | **POST** /multicloud/cloudgateway/{cloudGatewayName}/site | +*ConfigurationMultiCloudApi* | [**audit**](docs/ConfigurationMultiCloudApi.md#audit) | **POST** /multicloud/audit | +*ConfigurationMultiCloudApi* | [**audit_dry_run**](docs/ConfigurationMultiCloudApi.md#audit_dry_run) | **GET** /multicloud/audit | +*ConfigurationMultiCloudApi* | [**clean_up_all_connectivity_gateways_in_local_db**](docs/ConfigurationMultiCloudApi.md#clean_up_all_connectivity_gateways_in_local_db) | **DELETE** /multicloud/connectivitygateway | +*ConfigurationMultiCloudApi* | [**create_cgw**](docs/ConfigurationMultiCloudApi.md#create_cgw) | **POST** /multicloud/cloudgateway | +*ConfigurationMultiCloudApi* | [**create_connectivity_gateway**](docs/ConfigurationMultiCloudApi.md#create_connectivity_gateway) | **POST** /multicloud/connectivitygateway | +*ConfigurationMultiCloudApi* | [**create_device_link**](docs/ConfigurationMultiCloudApi.md#create_device_link) | **POST** /multicloud/devicelink/edge | +*ConfigurationMultiCloudApi* | [**create_edge_connectivity**](docs/ConfigurationMultiCloudApi.md#create_edge_connectivity) | **POST** /multicloud/connectivity/edge | +*ConfigurationMultiCloudApi* | [**create_icgw**](docs/ConfigurationMultiCloudApi.md#create_icgw) | **POST** /multicloud/gateway/edge | +*ConfigurationMultiCloudApi* | [**create_virtual_wan**](docs/ConfigurationMultiCloudApi.md#create_virtual_wan) | **POST** /multicloud/vwan | +*ConfigurationMultiCloudApi* | [**delete_account**](docs/ConfigurationMultiCloudApi.md#delete_account) | **DELETE** /multicloud/accounts/{accountId} | +*ConfigurationMultiCloudApi* | [**delete_cgw**](docs/ConfigurationMultiCloudApi.md#delete_cgw) | **DELETE** /multicloud/cloudgateway/{cloudGatewayName} | +*ConfigurationMultiCloudApi* | [**delete_connectivity_gateway**](docs/ConfigurationMultiCloudApi.md#delete_connectivity_gateway) | **DELETE** /multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName} | +*ConfigurationMultiCloudApi* | [**delete_device_link**](docs/ConfigurationMultiCloudApi.md#delete_device_link) | **DELETE** /multicloud/devicelink/edge/{deviceLinkName} | +*ConfigurationMultiCloudApi* | [**delete_edge_account**](docs/ConfigurationMultiCloudApi.md#delete_edge_account) | **DELETE** /multicloud/accounts/edge/{accountId} | +*ConfigurationMultiCloudApi* | [**delete_edge_account1**](docs/ConfigurationMultiCloudApi.md#delete_edge_account1) | **DELETE** /multicloud/locations/edge/{edgeType} | +*ConfigurationMultiCloudApi* | [**delete_edge_connectivity**](docs/ConfigurationMultiCloudApi.md#delete_edge_connectivity) | **DELETE** /multicloud/connectivity/edge/{connectionName} | +*ConfigurationMultiCloudApi* | [**delete_icgw**](docs/ConfigurationMultiCloudApi.md#delete_icgw) | **DELETE** /multicloud/gateway/edge/{edgeGatewayName} | +*ConfigurationMultiCloudApi* | [**delete_virtual_wan**](docs/ConfigurationMultiCloudApi.md#delete_virtual_wan) | **DELETE** /multicloud/vwan/{cloudProvider}/{vWanName} | +*ConfigurationMultiCloudApi* | [**detach_sites1**](docs/ConfigurationMultiCloudApi.md#detach_sites1) | **DELETE** /multicloud/cloudgateway/{cloudGatewayName}/site | +*ConfigurationMultiCloudApi* | [**edge_audit**](docs/ConfigurationMultiCloudApi.md#edge_audit) | **POST** /multicloud/audit/edge | +*ConfigurationMultiCloudApi* | [**edge_audit_dry_run**](docs/ConfigurationMultiCloudApi.md#edge_audit_dry_run) | **GET** /multicloud/audit/edge | +*ConfigurationMultiCloudApi* | [**edit_tag**](docs/ConfigurationMultiCloudApi.md#edit_tag) | **PUT** /multicloud/hostvpc/tags | +*ConfigurationMultiCloudApi* | [**get_all_cloud_accounts**](docs/ConfigurationMultiCloudApi.md#get_all_cloud_accounts) | **GET** /multicloud/accounts | +*ConfigurationMultiCloudApi* | [**get_azure_network_virtual_appliances**](docs/ConfigurationMultiCloudApi.md#get_azure_network_virtual_appliances) | **GET** /multicloud/cloudgateway/nvas | +*ConfigurationMultiCloudApi* | [**get_azure_nva_sku_list**](docs/ConfigurationMultiCloudApi.md#get_azure_nva_sku_list) | **GET** /multicloud/cloudgateway/nvasku | +*ConfigurationMultiCloudApi* | [**get_azure_resource_groups**](docs/ConfigurationMultiCloudApi.md#get_azure_resource_groups) | **GET** /multicloud/cloudgateway/resourceGroups | +*ConfigurationMultiCloudApi* | [**get_azure_virtual_hubs**](docs/ConfigurationMultiCloudApi.md#get_azure_virtual_hubs) | **GET** /multicloud/cloudgateway/vhubs | +*ConfigurationMultiCloudApi* | [**get_azure_virtual_wans**](docs/ConfigurationMultiCloudApi.md#get_azure_virtual_wans) | **GET** /multicloud/cloudgateway/vwans | +*ConfigurationMultiCloudApi* | [**get_cgw_associated_mappings**](docs/ConfigurationMultiCloudApi.md#get_cgw_associated_mappings) | **GET** /multicloud/mapping/{cloudType} | +*ConfigurationMultiCloudApi* | [**get_cgw_custom_setting_details**](docs/ConfigurationMultiCloudApi.md#get_cgw_custom_setting_details) | **GET** /multicloud/cloudgatewaysetting/{cloudGatewayName} | +*ConfigurationMultiCloudApi* | [**get_cgw_details**](docs/ConfigurationMultiCloudApi.md#get_cgw_details) | **GET** /multicloud/cloudgateway/{cloudGatewayName} | +*ConfigurationMultiCloudApi* | [**get_cgw_org_resources**](docs/ConfigurationMultiCloudApi.md#get_cgw_org_resources) | **GET** /multicloud/cloudgateway/resource | +*ConfigurationMultiCloudApi* | [**get_cgw_types**](docs/ConfigurationMultiCloudApi.md#get_cgw_types) | **GET** /multicloud/cloudgatewaytype | +*ConfigurationMultiCloudApi* | [**get_cgws**](docs/ConfigurationMultiCloudApi.md#get_cgws) | **GET** /multicloud/cloudgateway | +*ConfigurationMultiCloudApi* | [**get_cloud_account_details**](docs/ConfigurationMultiCloudApi.md#get_cloud_account_details) | **GET** /multicloud/accounts/{accountId} | +*ConfigurationMultiCloudApi* | [**get_cloud_connected_sites**](docs/ConfigurationMultiCloudApi.md#get_cloud_connected_sites) | **GET** /multicloud/connected-sites/{cloudType} | +*ConfigurationMultiCloudApi* | [**get_cloud_connected_sites1**](docs/ConfigurationMultiCloudApi.md#get_cloud_connected_sites1) | **GET** /multicloud/connected-sites/edge/{edgeType} | +*ConfigurationMultiCloudApi* | [**get_cloud_devices**](docs/ConfigurationMultiCloudApi.md#get_cloud_devices) | **GET** /multicloud/devices/{cloudType} | +*ConfigurationMultiCloudApi* | [**get_cloud_devices1**](docs/ConfigurationMultiCloudApi.md#get_cloud_devices1) | **GET** /multicloud/devices/edge/{edgeType} | +*ConfigurationMultiCloudApi* | [**get_cloud_gateways**](docs/ConfigurationMultiCloudApi.md#get_cloud_gateways) | **GET** /multicloud/cloudgateways/{cloudType} | +*ConfigurationMultiCloudApi* | [**get_cloud_regions**](docs/ConfigurationMultiCloudApi.md#get_cloud_regions) | **GET** /multicloud/regions | +*ConfigurationMultiCloudApi* | [**get_cloud_routers_and_attachments**](docs/ConfigurationMultiCloudApi.md#get_cloud_routers_and_attachments) | **GET** /multicloud/cloudRoutersAndAttachments | +*ConfigurationMultiCloudApi* | [**get_cloud_types**](docs/ConfigurationMultiCloudApi.md#get_cloud_types) | **GET** /multicloud/types | +*ConfigurationMultiCloudApi* | [**get_cloud_widget**](docs/ConfigurationMultiCloudApi.md#get_cloud_widget) | **GET** /multicloud/widget/{cloudType} | +*ConfigurationMultiCloudApi* | [**get_connectivity_gateway_creation_options**](docs/ConfigurationMultiCloudApi.md#get_connectivity_gateway_creation_options) | **GET** /multicloud/connectivitygatewaycreationoptions | +*ConfigurationMultiCloudApi* | [**get_connectivity_gateways**](docs/ConfigurationMultiCloudApi.md#get_connectivity_gateways) | **GET** /multicloud/connectivitygateway | +*ConfigurationMultiCloudApi* | [**get_dashboard_edge_info**](docs/ConfigurationMultiCloudApi.md#get_dashboard_edge_info) | **GET** /multicloud/dashboard/edge | +*ConfigurationMultiCloudApi* | [**get_default_mapping_values**](docs/ConfigurationMultiCloudApi.md#get_default_mapping_values) | **GET** /multicloud/map/defaults | +*ConfigurationMultiCloudApi* | [**get_device_link_metro_speed**](docs/ConfigurationMultiCloudApi.md#get_device_link_metro_speed) | **POST** /multicloud/devicelink/metroSpeed/edge | +*ConfigurationMultiCloudApi* | [**get_device_links**](docs/ConfigurationMultiCloudApi.md#get_device_links) | **GET** /multicloud/devicelink/edge | +*ConfigurationMultiCloudApi* | [**get_dl_port_speed**](docs/ConfigurationMultiCloudApi.md#get_dl_port_speed) | **GET** /multicloud/devicelink/edge/portspeed/{edgeType} | +*ConfigurationMultiCloudApi* | [**get_edge_account_details**](docs/ConfigurationMultiCloudApi.md#get_edge_account_details) | **GET** /multicloud/accounts/edge/{accountId} | +*ConfigurationMultiCloudApi* | [**get_edge_accounts**](docs/ConfigurationMultiCloudApi.md#get_edge_accounts) | **GET** /multicloud/accounts/edge | +*ConfigurationMultiCloudApi* | [**get_edge_billing_accounts**](docs/ConfigurationMultiCloudApi.md#get_edge_billing_accounts) | **GET** /multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId} | +*ConfigurationMultiCloudApi* | [**get_edge_connectivity_detail_by_name**](docs/ConfigurationMultiCloudApi.md#get_edge_connectivity_detail_by_name) | **GET** /multicloud/connectivity/edge/{connectivityName} | +*ConfigurationMultiCloudApi* | [**get_edge_connectivity_details**](docs/ConfigurationMultiCloudApi.md#get_edge_connectivity_details) | **GET** /multicloud/connectivity/edge | +*ConfigurationMultiCloudApi* | [**get_edge_gateways**](docs/ConfigurationMultiCloudApi.md#get_edge_gateways) | **GET** /multicloud/gateways/edge/{edgeType} | +*ConfigurationMultiCloudApi* | [**get_edge_global_settings**](docs/ConfigurationMultiCloudApi.md#get_edge_global_settings) | **GET** /multicloud/settings/edge/global | +*ConfigurationMultiCloudApi* | [**get_edge_locations_info**](docs/ConfigurationMultiCloudApi.md#get_edge_locations_info) | **GET** /multicloud/locations/edge/{edgeType} | +*ConfigurationMultiCloudApi* | [**get_edge_mapping_tags**](docs/ConfigurationMultiCloudApi.md#get_edge_mapping_tags) | **GET** /multicloud/map/tags/edge | +*ConfigurationMultiCloudApi* | [**get_edge_types**](docs/ConfigurationMultiCloudApi.md#get_edge_types) | **GET** /multicloud/types/edge | +*ConfigurationMultiCloudApi* | [**get_edge_wan_devices**](docs/ConfigurationMultiCloudApi.md#get_edge_wan_devices) | **GET** /multicloud/edge/{edgeType}/device | +*ConfigurationMultiCloudApi* | [**get_edge_widget**](docs/ConfigurationMultiCloudApi.md#get_edge_widget) | **GET** /multicloud/widget/edge/{edgeType} | +*ConfigurationMultiCloudApi* | [**get_global_settings**](docs/ConfigurationMultiCloudApi.md#get_global_settings) | **GET** /multicloud/settings/global | +*ConfigurationMultiCloudApi* | [**get_host_vpcs**](docs/ConfigurationMultiCloudApi.md#get_host_vpcs) | **GET** /multicloud/hostvpc | +*ConfigurationMultiCloudApi* | [**get_icgw_custom_setting_details**](docs/ConfigurationMultiCloudApi.md#get_icgw_custom_setting_details) | **GET** /multicloud/gateway/edge/setting/{edgeGatewayName} | +*ConfigurationMultiCloudApi* | [**get_icgw_details**](docs/ConfigurationMultiCloudApi.md#get_icgw_details) | **GET** /multicloud/gateway/edge/{edgeGatewayName} | +*ConfigurationMultiCloudApi* | [**get_icgw_types**](docs/ConfigurationMultiCloudApi.md#get_icgw_types) | **GET** /multicloud/gateway/edge/types | +*ConfigurationMultiCloudApi* | [**get_icgws**](docs/ConfigurationMultiCloudApi.md#get_icgws) | **GET** /multicloud/gateway/edge | +*ConfigurationMultiCloudApi* | [**get_licenses**](docs/ConfigurationMultiCloudApi.md#get_licenses) | **GET** /multicloud/license/edge | +*ConfigurationMultiCloudApi* | [**get_mapping_matrix**](docs/ConfigurationMultiCloudApi.md#get_mapping_matrix) | **GET** /multicloud/map | +*ConfigurationMultiCloudApi* | [**get_mapping_status**](docs/ConfigurationMultiCloudApi.md#get_mapping_status) | **GET** /multicloud/map/status | +*ConfigurationMultiCloudApi* | [**get_mapping_summary**](docs/ConfigurationMultiCloudApi.md#get_mapping_summary) | **GET** /multicloud/map/summary | +*ConfigurationMultiCloudApi* | [**get_mapping_tags**](docs/ConfigurationMultiCloudApi.md#get_mapping_tags) | **GET** /multicloud/map/tags | +*ConfigurationMultiCloudApi* | [**get_mapping_vpns**](docs/ConfigurationMultiCloudApi.md#get_mapping_vpns) | **GET** /multicloud/map/vpns | +*ConfigurationMultiCloudApi* | [**get_nva_security_rules**](docs/ConfigurationMultiCloudApi.md#get_nva_security_rules) | **GET** /multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName} | +*ConfigurationMultiCloudApi* | [**get_partner_ports**](docs/ConfigurationMultiCloudApi.md#get_partner_ports) | **GET** /multicloud/partnerports/edge | +*ConfigurationMultiCloudApi* | [**get_port_speed**](docs/ConfigurationMultiCloudApi.md#get_port_speed) | **GET** /multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType} | +*ConfigurationMultiCloudApi* | [**get_post_aggregation_data_by_query25**](docs/ConfigurationMultiCloudApi.md#get_post_aggregation_data_by_query25) | **POST** /multicloud/statistics/interface/aggregation | +*ConfigurationMultiCloudApi* | [**get_sites**](docs/ConfigurationMultiCloudApi.md#get_sites) | **GET** /multicloud/site | +*ConfigurationMultiCloudApi* | [**get_sites1**](docs/ConfigurationMultiCloudApi.md#get_sites1) | **GET** /multicloud/cloudgateway/{cloudGatewayName}/site | +*ConfigurationMultiCloudApi* | [**get_ssh_key_list**](docs/ConfigurationMultiCloudApi.md#get_ssh_key_list) | **GET** /multicloud/sshkeys | +*ConfigurationMultiCloudApi* | [**get_supported_edge_image_names**](docs/ConfigurationMultiCloudApi.md#get_supported_edge_image_names) | **GET** /multicloud/imagename/edge | +*ConfigurationMultiCloudApi* | [**get_supported_edge_instance_size**](docs/ConfigurationMultiCloudApi.md#get_supported_edge_instance_size) | **GET** /multicloud/instancesize/edge | +*ConfigurationMultiCloudApi* | [**get_supported_instance_size**](docs/ConfigurationMultiCloudApi.md#get_supported_instance_size) | **GET** /multicloud/instancesize | +*ConfigurationMultiCloudApi* | [**get_supported_loopback_cgw_colors**](docs/ConfigurationMultiCloudApi.md#get_supported_loopback_cgw_colors) | **GET** /multicloud/loopbackCGWColor/edge | +*ConfigurationMultiCloudApi* | [**get_supported_loopback_transport_colors**](docs/ConfigurationMultiCloudApi.md#get_supported_loopback_transport_colors) | **GET** /multicloud/loopbacktransportcolor/edge | +*ConfigurationMultiCloudApi* | [**get_supported_software_image_list**](docs/ConfigurationMultiCloudApi.md#get_supported_software_image_list) | **GET** /multicloud/swimages | +*ConfigurationMultiCloudApi* | [**get_tunnel_names**](docs/ConfigurationMultiCloudApi.md#get_tunnel_names) | **GET** /multicloud/tunnels/{cloudType} | +*ConfigurationMultiCloudApi* | [**get_v_hubs**](docs/ConfigurationMultiCloudApi.md#get_v_hubs) | **GET** /multicloud/vhubs | +*ConfigurationMultiCloudApi* | [**get_v_wans**](docs/ConfigurationMultiCloudApi.md#get_v_wans) | **GET** /multicloud/vwans | +*ConfigurationMultiCloudApi* | [**get_vpc_tags**](docs/ConfigurationMultiCloudApi.md#get_vpc_tags) | **GET** /multicloud/hostvpc/tags | +*ConfigurationMultiCloudApi* | [**get_wan_devices**](docs/ConfigurationMultiCloudApi.md#get_wan_devices) | **GET** /multicloud/device | +*ConfigurationMultiCloudApi* | [**get_wan_interface_colors**](docs/ConfigurationMultiCloudApi.md#get_wan_interface_colors) | **GET** /multicloud/interfacecolor | +*ConfigurationMultiCloudApi* | [**hostvpc_tagging**](docs/ConfigurationMultiCloudApi.md#hostvpc_tagging) | **POST** /multicloud/hostvpc/tags | +*ConfigurationMultiCloudApi* | [**process_mapping**](docs/ConfigurationMultiCloudApi.md#process_mapping) | **POST** /multicloud/map | +*ConfigurationMultiCloudApi* | [**telemetry**](docs/ConfigurationMultiCloudApi.md#telemetry) | **POST** /multicloud/telemetry | +*ConfigurationMultiCloudApi* | [**tunnel_scaling**](docs/ConfigurationMultiCloudApi.md#tunnel_scaling) | **PUT** /multicloud/cloudgateway/{cloudGatewayName}/site | +*ConfigurationMultiCloudApi* | [**un_tag**](docs/ConfigurationMultiCloudApi.md#un_tag) | **DELETE** /multicloud/hostvpc/tags/{tagName} | +*ConfigurationMultiCloudApi* | [**update_account**](docs/ConfigurationMultiCloudApi.md#update_account) | **PUT** /multicloud/accounts/{accountId} | +*ConfigurationMultiCloudApi* | [**update_cgw**](docs/ConfigurationMultiCloudApi.md#update_cgw) | **PUT** /multicloud/cloudgateway/{cloudGatewayName} | +*ConfigurationMultiCloudApi* | [**update_device_link**](docs/ConfigurationMultiCloudApi.md#update_device_link) | **PUT** /multicloud/devicelink/edge | +*ConfigurationMultiCloudApi* | [**update_edge_account**](docs/ConfigurationMultiCloudApi.md#update_edge_account) | **PUT** /multicloud/accounts/edge/{accountId} | +*ConfigurationMultiCloudApi* | [**update_edge_connectivity**](docs/ConfigurationMultiCloudApi.md#update_edge_connectivity) | **PUT** /multicloud/connectivity/edge | +*ConfigurationMultiCloudApi* | [**update_edge_global_settings**](docs/ConfigurationMultiCloudApi.md#update_edge_global_settings) | **PUT** /multicloud/settings/edge/global | +*ConfigurationMultiCloudApi* | [**update_edge_locations_info**](docs/ConfigurationMultiCloudApi.md#update_edge_locations_info) | **PUT** /multicloud/locations/edge/{edgeType}/accountId/{accountId} | +*ConfigurationMultiCloudApi* | [**update_global_settings**](docs/ConfigurationMultiCloudApi.md#update_global_settings) | **PUT** /multicloud/settings/global | +*ConfigurationMultiCloudApi* | [**update_icgw**](docs/ConfigurationMultiCloudApi.md#update_icgw) | **PUT** /multicloud/gateway/edge/{edgeGatewayName} | +*ConfigurationMultiCloudApi* | [**update_nva_security_rules**](docs/ConfigurationMultiCloudApi.md#update_nva_security_rules) | **PUT** /multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName} | +*ConfigurationMultiCloudApi* | [**validate_account_add**](docs/ConfigurationMultiCloudApi.md#validate_account_add) | **POST** /multicloud/accounts | +*ConfigurationMultiCloudApi* | [**validate_account_update_credentials**](docs/ConfigurationMultiCloudApi.md#validate_account_update_credentials) | **PUT** /multicloud/accounts/{accountId}/credentials | +*ConfigurationMultiCloudApi* | [**validate_edge_account_add**](docs/ConfigurationMultiCloudApi.md#validate_edge_account_add) | **POST** /multicloud/accounts/edge | +*ConfigurationMultiCloudApi* | [**validate_edge_account_update_credentials**](docs/ConfigurationMultiCloudApi.md#validate_edge_account_update_credentials) | **PUT** /multicloud/accounts/edge/{accountId}/credentials | +*ConfigurationMultidomainPolicyApi* | [**add_internal_policy**](docs/ConfigurationMultidomainPolicyApi.md#add_internal_policy) | **PUT** /mdp/policies/mdpconfig | +*ConfigurationMultidomainPolicyApi* | [**attach_devices**](docs/ConfigurationMultidomainPolicyApi.md#attach_devices) | **POST** /mdp/attachDevices/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**detach_devices**](docs/ConfigurationMultidomainPolicyApi.md#detach_devices) | **POST** /mdp/detachDevices/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**disconnect_from_mdp**](docs/ConfigurationMultidomainPolicyApi.md#disconnect_from_mdp) | **GET** /mdp/disconnect/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**edit_attached_devices**](docs/ConfigurationMultidomainPolicyApi.md#edit_attached_devices) | **PUT** /mdp/attachDevices/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**get_mdp_onboarding_status**](docs/ConfigurationMultidomainPolicyApi.md#get_mdp_onboarding_status) | **GET** /mdp/onboard/status | +*ConfigurationMultidomainPolicyApi* | [**offboard**](docs/ConfigurationMultidomainPolicyApi.md#offboard) | **DELETE** /mdp/onboard/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**onboard_mdp**](docs/ConfigurationMultidomainPolicyApi.md#onboard_mdp) | **POST** /mdp/onboard | +*ConfigurationMultidomainPolicyApi* | [**retrieve_mdp_attached_devices**](docs/ConfigurationMultidomainPolicyApi.md#retrieve_mdp_attached_devices) | **GET** /mdp/attachDevices/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**retrieve_mdp_config_object**](docs/ConfigurationMultidomainPolicyApi.md#retrieve_mdp_config_object) | **GET** /mdp/policies/mdpconfig/{deviceId} | +*ConfigurationMultidomainPolicyApi* | [**retrieve_mdp_policies**](docs/ConfigurationMultidomainPolicyApi.md#retrieve_mdp_policies) | **GET** /mdp/policies/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**retrieve_mdp_supported_devices_**](docs/ConfigurationMultidomainPolicyApi.md#retrieve_mdp_supported_devices_) | **GET** /mdp/devices/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**update_onboarding_payload**](docs/ConfigurationMultidomainPolicyApi.md#update_onboarding_payload) | **PUT** /mdp/onboard/{nmsId} | +*ConfigurationMultidomainPolicyApi* | [**update_policy_status**](docs/ConfigurationMultidomainPolicyApi.md#update_policy_status) | **PUT** /mdp/policies/{nmsId} | +*ConfigurationNetworkDesignApi* | [**acquire_attach_lock**](docs/ConfigurationNetworkDesignApi.md#acquire_attach_lock) | **POST** /networkdesign/profile/lock/{profileId} | +*ConfigurationNetworkDesignApi* | [**acquire_edit_lock**](docs/ConfigurationNetworkDesignApi.md#acquire_edit_lock) | **POST** /networkdesign/lock/edit | +*ConfigurationNetworkDesignApi* | [**create_network_design**](docs/ConfigurationNetworkDesignApi.md#create_network_design) | **POST** /networkdesign | +*ConfigurationNetworkDesignApi* | [**edit_network_design**](docs/ConfigurationNetworkDesignApi.md#edit_network_design) | **PUT** /networkdesign | +*ConfigurationNetworkDesignApi* | [**get_device_profile_config_status**](docs/ConfigurationNetworkDesignApi.md#get_device_profile_config_status) | **GET** /networkdesign/profile/status | +*ConfigurationNetworkDesignApi* | [**get_device_profile_config_status_by_profile_id**](docs/ConfigurationNetworkDesignApi.md#get_device_profile_config_status_by_profile_id) | **GET** /networkdesign/profile/status/{profileId} | +*ConfigurationNetworkDesignApi* | [**get_device_profile_task_count**](docs/ConfigurationNetworkDesignApi.md#get_device_profile_task_count) | **GET** /networkdesign/profile/task/count | +*ConfigurationNetworkDesignApi* | [**get_device_profile_task_status**](docs/ConfigurationNetworkDesignApi.md#get_device_profile_task_status) | **GET** /networkdesign/profile/task/status | +*ConfigurationNetworkDesignApi* | [**get_device_profile_task_status_by_profile_id**](docs/ConfigurationNetworkDesignApi.md#get_device_profile_task_status_by_profile_id) | **GET** /networkdesign/profile/task/status/{profileId} | +*ConfigurationNetworkDesignApi* | [**get_global_parameters**](docs/ConfigurationNetworkDesignApi.md#get_global_parameters) | **GET** /networkdesign/global/parameters | +*ConfigurationNetworkDesignApi* | [**get_network_design**](docs/ConfigurationNetworkDesignApi.md#get_network_design) | **GET** /networkdesign | +*ConfigurationNetworkDesignApi* | [**get_service_profile_config**](docs/ConfigurationNetworkDesignApi.md#get_service_profile_config) | **GET** /networkdesign/serviceProfileConfig/{profileId} | +*ConfigurationNetworkDesignApi* | [**push_device_profile_template**](docs/ConfigurationNetworkDesignApi.md#push_device_profile_template) | **POST** /networkdesign/profile/attachment/{profileId} | +*ConfigurationNetworkDesignApi* | [**push_network_design**](docs/ConfigurationNetworkDesignApi.md#push_network_design) | **POST** /networkdesign/attachment | +*ConfigurationNetworkDesignApi* | [**run_my_test**](docs/ConfigurationNetworkDesignApi.md#run_my_test) | **GET** /networkdesign/mytest/{name} | +*ConfigurationNetworkDesignTemplatesApi* | [**edit_device_profile_template**](docs/ConfigurationNetworkDesignTemplatesApi.md#edit_device_profile_template) | **PUT** /networkdesign/profile/template/{templateId} | +*ConfigurationNetworkDesignTemplatesApi* | [**edit_global_template**](docs/ConfigurationNetworkDesignTemplatesApi.md#edit_global_template) | **PUT** /networkdesign/global/template/{templateId} | +*ConfigurationNetworkDesignTemplatesApi* | [**generate_profile_template_list**](docs/ConfigurationNetworkDesignTemplatesApi.md#generate_profile_template_list) | **GET** /networkdesign/profile/template | +*ConfigurationNetworkDesignTemplatesApi* | [**get_device_profile_feature_template_list**](docs/ConfigurationNetworkDesignTemplatesApi.md#get_device_profile_feature_template_list) | **GET** /networkdesign/profile/feature | +*ConfigurationNetworkDesignTemplatesApi* | [**get_device_profile_template**](docs/ConfigurationNetworkDesignTemplatesApi.md#get_device_profile_template) | **GET** /networkdesign/profile/template/{templateId} | +*ConfigurationNetworkDesignTemplatesApi* | [**get_global_template**](docs/ConfigurationNetworkDesignTemplatesApi.md#get_global_template) | **GET** /networkdesign/global/template/{templateId} | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**create_policy_definition11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#create_policy_definition11) | **POST** /template/policy/definition/advancedMalwareProtection | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**delete_policy_definition11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#delete_policy_definition11) | **DELETE** /template/policy/definition/advancedMalwareProtection/{id} | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**edit_multiple_policy_definition11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#edit_multiple_policy_definition11) | **PUT** /template/policy/definition/advancedMalwareProtection/multiple/{id} | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**edit_policy_definition11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#edit_policy_definition11) | **PUT** /template/policy/definition/advancedMalwareProtection/{id} | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**get_definitions11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#get_definitions11) | **GET** /template/policy/definition/advancedMalwareProtection | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**get_policy_definition11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#get_policy_definition11) | **GET** /template/policy/definition/advancedMalwareProtection/{id} | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**preview_policy_definition11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#preview_policy_definition11) | **POST** /template/policy/definition/advancedMalwareProtection/preview | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**preview_policy_definition_by_id11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#preview_policy_definition_by_id11) | **GET** /template/policy/definition/advancedMalwareProtection/preview/{id} | +*ConfigurationPolicyAMPDefinitionBuilderApi* | [**save_policy_definition_in_bulk11**](docs/ConfigurationPolicyAMPDefinitionBuilderApi.md#save_policy_definition_in_bulk11) | **PUT** /template/policy/definition/advancedMalwareProtection/bulk | +*ConfigurationPolicyASPathListBuilderApi* | [**create_policy_list5**](docs/ConfigurationPolicyASPathListBuilderApi.md#create_policy_list5) | **POST** /template/policy/list/aspath | +*ConfigurationPolicyASPathListBuilderApi* | [**delete_policy_list5**](docs/ConfigurationPolicyASPathListBuilderApi.md#delete_policy_list5) | **DELETE** /template/policy/list/aspath/{id} | +*ConfigurationPolicyASPathListBuilderApi* | [**delete_policy_lists_with_info_tag5**](docs/ConfigurationPolicyASPathListBuilderApi.md#delete_policy_lists_with_info_tag5) | **DELETE** /template/policy/list/aspath | +*ConfigurationPolicyASPathListBuilderApi* | [**edit_policy_list5**](docs/ConfigurationPolicyASPathListBuilderApi.md#edit_policy_list5) | **PUT** /template/policy/list/aspath/{id} | +*ConfigurationPolicyASPathListBuilderApi* | [**get_lists_by_id5**](docs/ConfigurationPolicyASPathListBuilderApi.md#get_lists_by_id5) | **GET** /template/policy/list/aspath/{id} | +*ConfigurationPolicyASPathListBuilderApi* | [**get_policy_lists5**](docs/ConfigurationPolicyASPathListBuilderApi.md#get_policy_lists5) | **GET** /template/policy/list/aspath | +*ConfigurationPolicyASPathListBuilderApi* | [**get_policy_lists_with_info_tag5**](docs/ConfigurationPolicyASPathListBuilderApi.md#get_policy_lists_with_info_tag5) | **GET** /template/policy/list/aspath/filtered | +*ConfigurationPolicyASPathListBuilderApi* | [**preview_policy_list5**](docs/ConfigurationPolicyASPathListBuilderApi.md#preview_policy_list5) | **POST** /template/policy/list/aspath/preview | +*ConfigurationPolicyASPathListBuilderApi* | [**preview_policy_list_by_id5**](docs/ConfigurationPolicyASPathListBuilderApi.md#preview_policy_list_by_id5) | **GET** /template/policy/list/aspath/preview/{id} | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**create_policy_definition8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#create_policy_definition8) | **POST** /template/policy/definition/acl | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**delete_policy_definition8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#delete_policy_definition8) | **DELETE** /template/policy/definition/acl/{id} | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**edit_multiple_policy_definition8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#edit_multiple_policy_definition8) | **PUT** /template/policy/definition/acl/multiple/{id} | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**edit_policy_definition8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#edit_policy_definition8) | **PUT** /template/policy/definition/acl/{id} | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**get_definitions8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#get_definitions8) | **GET** /template/policy/definition/acl | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**get_policy_definition8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#get_policy_definition8) | **GET** /template/policy/definition/acl/{id} | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**preview_policy_definition8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#preview_policy_definition8) | **POST** /template/policy/definition/acl/preview | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**preview_policy_definition_by_id8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#preview_policy_definition_by_id8) | **GET** /template/policy/definition/acl/preview/{id} | +*ConfigurationPolicyAccessListDefinitionBuilderApi* | [**save_policy_definition_in_bulk8**](docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md#save_policy_definition_in_bulk8) | **PUT** /template/policy/definition/acl/bulk | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**create_policy_definition12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#create_policy_definition12) | **POST** /template/policy/definition/approute | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**delete_policy_definition12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#delete_policy_definition12) | **DELETE** /template/policy/definition/approute/{id} | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**edit_multiple_policy_definition12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#edit_multiple_policy_definition12) | **PUT** /template/policy/definition/approute/multiple/{id} | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**edit_policy_definition12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#edit_policy_definition12) | **PUT** /template/policy/definition/approute/{id} | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**get_definitions12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#get_definitions12) | **GET** /template/policy/definition/approute | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**get_policy_definition12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#get_policy_definition12) | **GET** /template/policy/definition/approute/{id} | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**preview_policy_definition12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#preview_policy_definition12) | **POST** /template/policy/definition/approute/preview | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**preview_policy_definition_by_id12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#preview_policy_definition_by_id12) | **GET** /template/policy/definition/approute/preview/{id} | +*ConfigurationPolicyAppRouteDefinitionBuilderApi* | [**save_policy_definition_in_bulk12**](docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md#save_policy_definition_in_bulk12) | **PUT** /template/policy/definition/approute/bulk | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**create_policy_list4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#create_policy_list4) | **POST** /template/policy/list/appprobe | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**delete_policy_list4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#delete_policy_list4) | **DELETE** /template/policy/list/appprobe/{id} | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**delete_policy_lists_with_info_tag4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#delete_policy_lists_with_info_tag4) | **DELETE** /template/policy/list/appprobe | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**edit_policy_list4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#edit_policy_list4) | **PUT** /template/policy/list/appprobe/{id} | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**get_lists_by_id4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#get_lists_by_id4) | **GET** /template/policy/list/appprobe/{id} | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**get_policy_lists4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#get_policy_lists4) | **GET** /template/policy/list/appprobe | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**get_policy_lists_with_info_tag4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#get_policy_lists_with_info_tag4) | **GET** /template/policy/list/appprobe/filtered | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**preview_policy_list4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#preview_policy_list4) | **POST** /template/policy/list/appprobe/preview | +*ConfigurationPolicyAppProbeClassListBuilderApi* | [**preview_policy_list_by_id4**](docs/ConfigurationPolicyAppProbeClassListBuilderApi.md#preview_policy_list_by_id4) | **GET** /template/policy/list/appprobe/preview/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**create_policy_list22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#create_policy_list22) | **POST** /template/policy/list/localapp | +*ConfigurationPolicyApplicationListBuilderApi* | [**create_policy_list3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#create_policy_list3) | **POST** /template/policy/list/app | +*ConfigurationPolicyApplicationListBuilderApi* | [**delete_policy_list22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_list22) | **DELETE** /template/policy/list/localapp/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**delete_policy_list3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_list3) | **DELETE** /template/policy/list/app/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**delete_policy_lists_with_info_tag22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_lists_with_info_tag22) | **DELETE** /template/policy/list/localapp | +*ConfigurationPolicyApplicationListBuilderApi* | [**delete_policy_lists_with_info_tag3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_lists_with_info_tag3) | **DELETE** /template/policy/list/app | +*ConfigurationPolicyApplicationListBuilderApi* | [**edit_policy_list22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#edit_policy_list22) | **PUT** /template/policy/list/localapp/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**edit_policy_list3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#edit_policy_list3) | **PUT** /template/policy/list/app/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**get_lists_by_id22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#get_lists_by_id22) | **GET** /template/policy/list/localapp/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**get_lists_by_id3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#get_lists_by_id3) | **GET** /template/policy/list/app/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**get_policy_lists19**](docs/ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists19) | **GET** /template/policy/list/localapp | +*ConfigurationPolicyApplicationListBuilderApi* | [**get_policy_lists3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists3) | **GET** /template/policy/list/app | +*ConfigurationPolicyApplicationListBuilderApi* | [**get_policy_lists_with_info_tag22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists_with_info_tag22) | **GET** /template/policy/list/localapp/filtered | +*ConfigurationPolicyApplicationListBuilderApi* | [**get_policy_lists_with_info_tag3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists_with_info_tag3) | **GET** /template/policy/list/app/filtered | +*ConfigurationPolicyApplicationListBuilderApi* | [**preview_policy_list22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list22) | **POST** /template/policy/list/localapp/preview | +*ConfigurationPolicyApplicationListBuilderApi* | [**preview_policy_list3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list3) | **POST** /template/policy/list/app/preview | +*ConfigurationPolicyApplicationListBuilderApi* | [**preview_policy_list_by_id22**](docs/ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list_by_id22) | **GET** /template/policy/list/localapp/preview/{id} | +*ConfigurationPolicyApplicationListBuilderApi* | [**preview_policy_list_by_id3**](docs/ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list_by_id3) | **GET** /template/policy/list/app/preview/{id} | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**create_policy_definition13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#create_policy_definition13) | **POST** /template/policy/definition/cflowd | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**delete_policy_definition13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#delete_policy_definition13) | **DELETE** /template/policy/definition/cflowd/{id} | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**edit_multiple_policy_definition13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#edit_multiple_policy_definition13) | **PUT** /template/policy/definition/cflowd/multiple/{id} | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**edit_policy_definition13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#edit_policy_definition13) | **PUT** /template/policy/definition/cflowd/{id} | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**get_definitions13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#get_definitions13) | **GET** /template/policy/definition/cflowd | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**get_policy_definition13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#get_policy_definition13) | **GET** /template/policy/definition/cflowd/{id} | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**preview_policy_definition13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#preview_policy_definition13) | **POST** /template/policy/definition/cflowd/preview | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**preview_policy_definition_by_id13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#preview_policy_definition_by_id13) | **GET** /template/policy/definition/cflowd/preview/{id} | +*ConfigurationPolicyCflowdDefinitionBuilderApi* | [**save_policy_definition_in_bulk13**](docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md#save_policy_definition_in_bulk13) | **PUT** /template/policy/definition/cflowd/bulk | +*ConfigurationPolicyCloudApplicationBuilderApi* | [**get_cloud_discovered_apps**](docs/ConfigurationPolicyCloudApplicationBuilderApi.md#get_cloud_discovered_apps) | **GET** /template/policy/clouddiscoveredapp | +*ConfigurationPolicyColorListBuilderApi* | [**create_policy_list6**](docs/ConfigurationPolicyColorListBuilderApi.md#create_policy_list6) | **POST** /template/policy/list/color | +*ConfigurationPolicyColorListBuilderApi* | [**delete_policy_list6**](docs/ConfigurationPolicyColorListBuilderApi.md#delete_policy_list6) | **DELETE** /template/policy/list/color/{id} | +*ConfigurationPolicyColorListBuilderApi* | [**delete_policy_lists_with_info_tag6**](docs/ConfigurationPolicyColorListBuilderApi.md#delete_policy_lists_with_info_tag6) | **DELETE** /template/policy/list/color | +*ConfigurationPolicyColorListBuilderApi* | [**edit_policy_list6**](docs/ConfigurationPolicyColorListBuilderApi.md#edit_policy_list6) | **PUT** /template/policy/list/color/{id} | +*ConfigurationPolicyColorListBuilderApi* | [**get_lists_by_id6**](docs/ConfigurationPolicyColorListBuilderApi.md#get_lists_by_id6) | **GET** /template/policy/list/color/{id} | +*ConfigurationPolicyColorListBuilderApi* | [**get_policy_lists6**](docs/ConfigurationPolicyColorListBuilderApi.md#get_policy_lists6) | **GET** /template/policy/list/color | +*ConfigurationPolicyColorListBuilderApi* | [**get_policy_lists_with_info_tag6**](docs/ConfigurationPolicyColorListBuilderApi.md#get_policy_lists_with_info_tag6) | **GET** /template/policy/list/color/filtered | +*ConfigurationPolicyColorListBuilderApi* | [**preview_policy_list6**](docs/ConfigurationPolicyColorListBuilderApi.md#preview_policy_list6) | **POST** /template/policy/list/color/preview | +*ConfigurationPolicyColorListBuilderApi* | [**preview_policy_list_by_id6**](docs/ConfigurationPolicyColorListBuilderApi.md#preview_policy_list_by_id6) | **GET** /template/policy/list/color/preview/{id} | +*ConfigurationPolicyCommunityListBuilderApi* | [**create_policy_list7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#create_policy_list7) | **POST** /template/policy/list/community | +*ConfigurationPolicyCommunityListBuilderApi* | [**delete_policy_list7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#delete_policy_list7) | **DELETE** /template/policy/list/community/{id} | +*ConfigurationPolicyCommunityListBuilderApi* | [**delete_policy_lists_with_info_tag7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#delete_policy_lists_with_info_tag7) | **DELETE** /template/policy/list/community | +*ConfigurationPolicyCommunityListBuilderApi* | [**edit_policy_list7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#edit_policy_list7) | **PUT** /template/policy/list/community/{id} | +*ConfigurationPolicyCommunityListBuilderApi* | [**get_lists_by_id7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#get_lists_by_id7) | **GET** /template/policy/list/community/{id} | +*ConfigurationPolicyCommunityListBuilderApi* | [**get_policy_lists7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#get_policy_lists7) | **GET** /template/policy/list/community | +*ConfigurationPolicyCommunityListBuilderApi* | [**get_policy_lists_with_info_tag7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#get_policy_lists_with_info_tag7) | **GET** /template/policy/list/community/filtered | +*ConfigurationPolicyCommunityListBuilderApi* | [**preview_policy_list7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#preview_policy_list7) | **POST** /template/policy/list/community/preview | +*ConfigurationPolicyCommunityListBuilderApi* | [**preview_policy_list_by_id7**](docs/ConfigurationPolicyCommunityListBuilderApi.md#preview_policy_list_by_id7) | **GET** /template/policy/list/community/preview/{id} | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**create_policy_definition14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#create_policy_definition14) | **POST** /template/policy/definition/control | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**delete_policy_definition14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#delete_policy_definition14) | **DELETE** /template/policy/definition/control/{id} | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**edit_multiple_policy_definition14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#edit_multiple_policy_definition14) | **PUT** /template/policy/definition/control/multiple/{id} | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**edit_policy_definition14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#edit_policy_definition14) | **PUT** /template/policy/definition/control/{id} | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**get_definitions14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#get_definitions14) | **GET** /template/policy/definition/control | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**get_policy_definition14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#get_policy_definition14) | **GET** /template/policy/definition/control/{id} | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**preview_policy_definition14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#preview_policy_definition14) | **POST** /template/policy/definition/control/preview | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**preview_policy_definition_by_id14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#preview_policy_definition_by_id14) | **GET** /template/policy/definition/control/preview/{id} | +*ConfigurationPolicyControlDefinitionBuilderApi* | [**save_policy_definition_in_bulk14**](docs/ConfigurationPolicyControlDefinitionBuilderApi.md#save_policy_definition_in_bulk14) | **PUT** /template/policy/definition/control/bulk | +*ConfigurationPolicyCustomApplicationBuilderApi* | [**create_custom_app**](docs/ConfigurationPolicyCustomApplicationBuilderApi.md#create_custom_app) | **POST** /template/policy/customapp | +*ConfigurationPolicyCustomApplicationBuilderApi* | [**delete_custom_app**](docs/ConfigurationPolicyCustomApplicationBuilderApi.md#delete_custom_app) | **DELETE** /template/policy/customapp/{id} | +*ConfigurationPolicyCustomApplicationBuilderApi* | [**edit_custom_app**](docs/ConfigurationPolicyCustomApplicationBuilderApi.md#edit_custom_app) | **PUT** /template/policy/customapp/{id} | +*ConfigurationPolicyCustomApplicationBuilderApi* | [**get_custom_app_by_id**](docs/ConfigurationPolicyCustomApplicationBuilderApi.md#get_custom_app_by_id) | **GET** /template/policy/customapp/{id} | +*ConfigurationPolicyCustomApplicationBuilderApi* | [**get_custom_apps**](docs/ConfigurationPolicyCustomApplicationBuilderApi.md#get_custom_apps) | **GET** /template/policy/customapp | +*ConfigurationPolicyCustomApplicationBuilderApi* | [**map_traffic_profiles**](docs/ConfigurationPolicyCustomApplicationBuilderApi.md#map_traffic_profiles) | **POST** /template/policy/clouddiscoveredapp | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**create_policy_definition15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#create_policy_definition15) | **POST** /template/policy/definition/data | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**delete_policy_definition15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#delete_policy_definition15) | **DELETE** /template/policy/definition/data/{id} | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**edit_multiple_policy_definition15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#edit_multiple_policy_definition15) | **PUT** /template/policy/definition/data/multiple/{id} | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**edit_policy_definition15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#edit_policy_definition15) | **PUT** /template/policy/definition/data/{id} | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**get_definitions15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#get_definitions15) | **GET** /template/policy/definition/data | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**get_policy_definition15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#get_policy_definition15) | **GET** /template/policy/definition/data/{id} | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**preview_policy_definition15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#preview_policy_definition15) | **POST** /template/policy/definition/data/preview | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**preview_policy_definition_by_id15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#preview_policy_definition_by_id15) | **GET** /template/policy/definition/data/preview/{id} | +*ConfigurationPolicyDataDefinitionBuilderApi* | [**save_policy_definition_in_bulk15**](docs/ConfigurationPolicyDataDefinitionBuilderApi.md#save_policy_definition_in_bulk15) | **PUT** /template/policy/definition/data/bulk | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**create_policy_list8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#create_policy_list8) | **POST** /template/policy/list/dataipv6prefix | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**delete_policy_list8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#delete_policy_list8) | **DELETE** /template/policy/list/dataipv6prefix/{id} | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**delete_policy_lists_with_info_tag8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#delete_policy_lists_with_info_tag8) | **DELETE** /template/policy/list/dataipv6prefix | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**edit_policy_list8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#edit_policy_list8) | **PUT** /template/policy/list/dataipv6prefix/{id} | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**get_lists_by_id8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#get_lists_by_id8) | **GET** /template/policy/list/dataipv6prefix/{id} | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**get_policy_lists8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#get_policy_lists8) | **GET** /template/policy/list/dataipv6prefix | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**get_policy_lists_with_info_tag8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#get_policy_lists_with_info_tag8) | **GET** /template/policy/list/dataipv6prefix/filtered | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**preview_policy_list8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#preview_policy_list8) | **POST** /template/policy/list/dataipv6prefix/preview | +*ConfigurationPolicyDataIPV6PrefixListBuilderApi* | [**preview_policy_list_by_id8**](docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#preview_policy_list_by_id8) | **GET** /template/policy/list/dataipv6prefix/preview/{id} | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**create_policy_list9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#create_policy_list9) | **POST** /template/policy/list/dataprefixall | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**delete_policy_list9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#delete_policy_list9) | **DELETE** /template/policy/list/dataprefixall/{id} | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**delete_policy_lists_with_info_tag9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#delete_policy_lists_with_info_tag9) | **DELETE** /template/policy/list/dataprefixall | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**edit_policy_list9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#edit_policy_list9) | **PUT** /template/policy/list/dataprefixall/{id} | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**get_lists_by_id9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#get_lists_by_id9) | **GET** /template/policy/list/dataprefixall/{id} | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**get_lists_for_all_data_prefixes**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#get_lists_for_all_data_prefixes) | **GET** /template/policy/list/dataprefixall | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**get_policy_lists_with_info_tag9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#get_policy_lists_with_info_tag9) | **GET** /template/policy/list/dataprefixall/filtered | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**preview_policy_list9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#preview_policy_list9) | **POST** /template/policy/list/dataprefixall/preview | +*ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi* | [**preview_policy_list_by_id9**](docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#preview_policy_list_by_id9) | **GET** /template/policy/list/dataprefixall/preview/{id} | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**create_policy_list10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#create_policy_list10) | **POST** /template/policy/list/dataprefix | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**delete_policy_list10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#delete_policy_list10) | **DELETE** /template/policy/list/dataprefix/{id} | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**delete_policy_lists_with_info_tag10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#delete_policy_lists_with_info_tag10) | **DELETE** /template/policy/list/dataprefix | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**edit_policy_list10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#edit_policy_list10) | **PUT** /template/policy/list/dataprefix/{id} | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**get_lists_by_id10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#get_lists_by_id10) | **GET** /template/policy/list/dataprefix/{id} | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**get_policy_lists9**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#get_policy_lists9) | **GET** /template/policy/list/dataprefix | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**get_policy_lists_with_info_tag10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#get_policy_lists_with_info_tag10) | **GET** /template/policy/list/dataprefix/filtered | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**preview_policy_list10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#preview_policy_list10) | **POST** /template/policy/list/dataprefix/preview | +*ConfigurationPolicyDataPrefixListBuilderApi* | [**preview_policy_list_by_id10**](docs/ConfigurationPolicyDataPrefixListBuilderApi.md#preview_policy_list_by_id10) | **GET** /template/policy/list/dataprefix/preview/{id} | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**create_policy_list15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#create_policy_list15) | **POST** /template/policy/list/dataprefixfqdn | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**delete_policy_list15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#delete_policy_list15) | **DELETE** /template/policy/list/dataprefixfqdn/{id} | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**delete_policy_lists_with_info_tag15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#delete_policy_lists_with_info_tag15) | **DELETE** /template/policy/list/dataprefixfqdn | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**edit_policy_list15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#edit_policy_list15) | **PUT** /template/policy/list/dataprefixfqdn/{id} | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**get_all_data_prefix_and_fqdn_lists**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#get_all_data_prefix_and_fqdn_lists) | **GET** /template/policy/list/dataprefixfqdn | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**get_lists_by_id15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#get_lists_by_id15) | **GET** /template/policy/list/dataprefixfqdn/{id} | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**get_policy_lists_with_info_tag15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#get_policy_lists_with_info_tag15) | **GET** /template/policy/list/dataprefixfqdn/filtered | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**preview_policy_list15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#preview_policy_list15) | **POST** /template/policy/list/dataprefixfqdn/preview | +*ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi* | [**preview_policy_list_by_id15**](docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#preview_policy_list_by_id15) | **GET** /template/policy/list/dataprefixfqdn/preview/{id} | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**create_policy_definition16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#create_policy_definition16) | **POST** /template/policy/definition/deviceaccesspolicy | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**delete_policy_definition16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#delete_policy_definition16) | **DELETE** /template/policy/definition/deviceaccesspolicy/{id} | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**edit_multiple_policy_definition16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#edit_multiple_policy_definition16) | **PUT** /template/policy/definition/deviceaccesspolicy/multiple/{id} | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**edit_policy_definition16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#edit_policy_definition16) | **PUT** /template/policy/definition/deviceaccesspolicy/{id} | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**get_definitions16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#get_definitions16) | **GET** /template/policy/definition/deviceaccesspolicy | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**get_policy_definition16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#get_policy_definition16) | **GET** /template/policy/definition/deviceaccesspolicy/{id} | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**preview_policy_definition16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#preview_policy_definition16) | **POST** /template/policy/definition/deviceaccesspolicy/preview | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**preview_policy_definition_by_id16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#preview_policy_definition_by_id16) | **GET** /template/policy/definition/deviceaccesspolicy/preview/{id} | +*ConfigurationPolicyDeviceAccessDefinitionBuilderApi* | [**save_policy_definition_in_bulk16**](docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#save_policy_definition_in_bulk16) | **PUT** /template/policy/definition/deviceaccesspolicy/bulk | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**create_policy_definition25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#create_policy_definition25) | **POST** /template/policy/definition/dialpeer | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**create_policy_definition30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#create_policy_definition30) | **POST** /template/policy/definition/srstphoneprofile | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**delete_policy_definition25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#delete_policy_definition25) | **DELETE** /template/policy/definition/dialpeer/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**delete_policy_definition30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#delete_policy_definition30) | **DELETE** /template/policy/definition/srstphoneprofile/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**edit_multiple_policy_definition25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_multiple_policy_definition25) | **PUT** /template/policy/definition/dialpeer/multiple/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**edit_multiple_policy_definition30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_multiple_policy_definition30) | **PUT** /template/policy/definition/srstphoneprofile/multiple/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**edit_policy_definition25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_policy_definition25) | **PUT** /template/policy/definition/dialpeer/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**edit_policy_definition30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_policy_definition30) | **PUT** /template/policy/definition/srstphoneprofile/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**get_definitions25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_definitions25) | **GET** /template/policy/definition/dialpeer | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**get_definitions30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_definitions30) | **GET** /template/policy/definition/srstphoneprofile | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**get_policy_definition25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_policy_definition25) | **GET** /template/policy/definition/dialpeer/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**get_policy_definition30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_policy_definition30) | **GET** /template/policy/definition/srstphoneprofile/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**preview_policy_definition25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition25) | **POST** /template/policy/definition/dialpeer/preview | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**preview_policy_definition30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition30) | **POST** /template/policy/definition/srstphoneprofile/preview | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**preview_policy_definition_by_id25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition_by_id25) | **GET** /template/policy/definition/dialpeer/preview/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**preview_policy_definition_by_id30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition_by_id30) | **GET** /template/policy/definition/srstphoneprofile/preview/{id} | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**save_policy_definition_in_bulk25**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#save_policy_definition_in_bulk25) | **PUT** /template/policy/definition/dialpeer/bulk | +*ConfigurationPolicyDialPeerDefinitionBuilderApi* | [**save_policy_definition_in_bulk30**](docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md#save_policy_definition_in_bulk30) | **PUT** /template/policy/definition/srstphoneprofile/bulk | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**create_policy_list11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#create_policy_list11) | **POST** /template/policy/list/expandedcommunity | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**delete_policy_list11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#delete_policy_list11) | **DELETE** /template/policy/list/expandedcommunity/{id} | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**delete_policy_lists_with_info_tag11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#delete_policy_lists_with_info_tag11) | **DELETE** /template/policy/list/expandedcommunity | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**edit_policy_list11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#edit_policy_list11) | **PUT** /template/policy/list/expandedcommunity/{id} | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**get_lists_by_id11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#get_lists_by_id11) | **GET** /template/policy/list/expandedcommunity/{id} | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**get_policy_lists10**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#get_policy_lists10) | **GET** /template/policy/list/expandedcommunity | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**get_policy_lists_with_info_tag11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#get_policy_lists_with_info_tag11) | **GET** /template/policy/list/expandedcommunity/filtered | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**preview_policy_list11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#preview_policy_list11) | **POST** /template/policy/list/expandedcommunity/preview | +*ConfigurationPolicyExpandedCommunityListBuilderApi* | [**preview_policy_list_by_id11**](docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md#preview_policy_list_by_id11) | **GET** /template/policy/list/expandedcommunity/preview/{id} | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**create_policy_list12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#create_policy_list12) | **POST** /template/policy/list/extcommunity | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**delete_policy_list12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#delete_policy_list12) | **DELETE** /template/policy/list/extcommunity/{id} | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**delete_policy_lists_with_info_tag12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#delete_policy_lists_with_info_tag12) | **DELETE** /template/policy/list/extcommunity | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**edit_policy_list12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#edit_policy_list12) | **PUT** /template/policy/list/extcommunity/{id} | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**get_lists_by_id12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#get_lists_by_id12) | **GET** /template/policy/list/extcommunity/{id} | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**get_policy_lists11**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#get_policy_lists11) | **GET** /template/policy/list/extcommunity | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**get_policy_lists_with_info_tag12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#get_policy_lists_with_info_tag12) | **GET** /template/policy/list/extcommunity/filtered | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**preview_policy_list12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#preview_policy_list12) | **POST** /template/policy/list/extcommunity/preview | +*ConfigurationPolicyExtendedCommunityListBuilderApi* | [**preview_policy_list_by_id12**](docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md#preview_policy_list_by_id12) | **GET** /template/policy/list/extcommunity/preview/{id} | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**create_policy_definition26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#create_policy_definition26) | **POST** /template/policy/definition/fxoport | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**delete_policy_definition26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#delete_policy_definition26) | **DELETE** /template/policy/definition/fxoport/{id} | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**edit_multiple_policy_definition26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#edit_multiple_policy_definition26) | **PUT** /template/policy/definition/fxoport/multiple/{id} | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**edit_policy_definition26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#edit_policy_definition26) | **PUT** /template/policy/definition/fxoport/{id} | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**get_definitions26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#get_definitions26) | **GET** /template/policy/definition/fxoport | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**get_policy_definition26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#get_policy_definition26) | **GET** /template/policy/definition/fxoport/{id} | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**preview_policy_definition26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#preview_policy_definition26) | **POST** /template/policy/definition/fxoport/preview | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**preview_policy_definition_by_id26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#preview_policy_definition_by_id26) | **GET** /template/policy/definition/fxoport/preview/{id} | +*ConfigurationPolicyFXOPortDefinitionBuilderApi* | [**save_policy_definition_in_bulk26**](docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md#save_policy_definition_in_bulk26) | **PUT** /template/policy/definition/fxoport/bulk | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**create_policy_definition28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#create_policy_definition28) | **POST** /template/policy/definition/fxsdidport | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**delete_policy_definition28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#delete_policy_definition28) | **DELETE** /template/policy/definition/fxsdidport/{id} | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**edit_multiple_policy_definition28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#edit_multiple_policy_definition28) | **PUT** /template/policy/definition/fxsdidport/multiple/{id} | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**edit_policy_definition28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#edit_policy_definition28) | **PUT** /template/policy/definition/fxsdidport/{id} | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**get_definitions28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#get_definitions28) | **GET** /template/policy/definition/fxsdidport | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**get_policy_definition28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#get_policy_definition28) | **GET** /template/policy/definition/fxsdidport/{id} | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**preview_policy_definition28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#preview_policy_definition28) | **POST** /template/policy/definition/fxsdidport/preview | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**preview_policy_definition_by_id28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#preview_policy_definition_by_id28) | **GET** /template/policy/definition/fxsdidport/preview/{id} | +*ConfigurationPolicyFXSDIDPortDefinitionBuilderApi* | [**save_policy_definition_in_bulk28**](docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#save_policy_definition_in_bulk28) | **PUT** /template/policy/definition/fxsdidport/bulk | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**create_policy_definition27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#create_policy_definition27) | **POST** /template/policy/definition/fxsport | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**delete_policy_definition27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#delete_policy_definition27) | **DELETE** /template/policy/definition/fxsport/{id} | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**edit_multiple_policy_definition27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#edit_multiple_policy_definition27) | **PUT** /template/policy/definition/fxsport/multiple/{id} | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**edit_policy_definition27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#edit_policy_definition27) | **PUT** /template/policy/definition/fxsport/{id} | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**get_definitions27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#get_definitions27) | **GET** /template/policy/definition/fxsport | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**get_policy_definition27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#get_policy_definition27) | **GET** /template/policy/definition/fxsport/{id} | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**preview_policy_definition27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#preview_policy_definition27) | **POST** /template/policy/definition/fxsport/preview | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**preview_policy_definition_by_id27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#preview_policy_definition_by_id27) | **GET** /template/policy/definition/fxsport/preview/{id} | +*ConfigurationPolicyFXSPortDefinitionBuilderApi* | [**save_policy_definition_in_bulk27**](docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md#save_policy_definition_in_bulk27) | **PUT** /template/policy/definition/fxsport/bulk | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**create_policy_list13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#create_policy_list13) | **POST** /template/policy/list/faxprotocol | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**delete_policy_list13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#delete_policy_list13) | **DELETE** /template/policy/list/faxprotocol/{id} | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**delete_policy_lists_with_info_tag13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#delete_policy_lists_with_info_tag13) | **DELETE** /template/policy/list/faxprotocol | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**edit_policy_list13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#edit_policy_list13) | **PUT** /template/policy/list/faxprotocol/{id} | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**get_lists_by_id13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#get_lists_by_id13) | **GET** /template/policy/list/faxprotocol/{id} | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**get_policy_lists12**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#get_policy_lists12) | **GET** /template/policy/list/faxprotocol | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**get_policy_lists_with_info_tag13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#get_policy_lists_with_info_tag13) | **GET** /template/policy/list/faxprotocol/filtered | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**preview_policy_list13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#preview_policy_list13) | **POST** /template/policy/list/faxprotocol/preview | +*ConfigurationPolicyFaxProtocolListBuilderApi* | [**preview_policy_list_by_id13**](docs/ConfigurationPolicyFaxProtocolListBuilderApi.md#preview_policy_list_by_id13) | **GET** /template/policy/list/faxprotocol/preview/{id} | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**create_policy_list14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#create_policy_list14) | **POST** /template/policy/list/class | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**delete_policy_list14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#delete_policy_list14) | **DELETE** /template/policy/list/class/{id} | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**delete_policy_lists_with_info_tag14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#delete_policy_lists_with_info_tag14) | **DELETE** /template/policy/list/class | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**edit_policy_list14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#edit_policy_list14) | **PUT** /template/policy/list/class/{id} | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**get_lists_by_id14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#get_lists_by_id14) | **GET** /template/policy/list/class/{id} | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**get_policy_lists13**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#get_policy_lists13) | **GET** /template/policy/list/class | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**get_policy_lists_with_info_tag14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#get_policy_lists_with_info_tag14) | **GET** /template/policy/list/class/filtered | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**preview_policy_list14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#preview_policy_list14) | **POST** /template/policy/list/class/preview | +*ConfigurationPolicyForwardingClassListBuilderApi* | [**preview_policy_list_by_id14**](docs/ConfigurationPolicyForwardingClassListBuilderApi.md#preview_policy_list_by_id14) | **GET** /template/policy/list/class/preview/{id} | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**create_policy_list17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#create_policy_list17) | **POST** /template/policy/list/geolocation | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**delete_policy_list17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#delete_policy_list17) | **DELETE** /template/policy/list/geolocation/{id} | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**delete_policy_lists_with_info_tag17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#delete_policy_lists_with_info_tag17) | **DELETE** /template/policy/list/geolocation | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**edit_policy_list17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#edit_policy_list17) | **PUT** /template/policy/list/geolocation/{id} | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**get_geo_location_lists**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#get_geo_location_lists) | **GET** /template/policy/list/geolocation/entries | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**get_lists_by_id17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#get_lists_by_id17) | **GET** /template/policy/list/geolocation/{id} | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**get_policy_lists15**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#get_policy_lists15) | **GET** /template/policy/list/geolocation | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**get_policy_lists_with_info_tag17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#get_policy_lists_with_info_tag17) | **GET** /template/policy/list/geolocation/filtered | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**preview_policy_list17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#preview_policy_list17) | **POST** /template/policy/list/geolocation/preview | +*ConfigurationPolicyGeoLocationListBuilderApi* | [**preview_policy_list_by_id17**](docs/ConfigurationPolicyGeoLocationListBuilderApi.md#preview_policy_list_by_id17) | **GET** /template/policy/list/geolocation/preview/{id} | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**create_policy_definition4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#create_policy_definition4) | **POST** /template/policy/definition/hubandspoke | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**delete_policy_definition4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#delete_policy_definition4) | **DELETE** /template/policy/definition/hubandspoke/{id} | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**edit_multiple_policy_definition4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#edit_multiple_policy_definition4) | **PUT** /template/policy/definition/hubandspoke/multiple/{id} | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**edit_policy_definition4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#edit_policy_definition4) | **PUT** /template/policy/definition/hubandspoke/{id} | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**get_definitions4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#get_definitions4) | **GET** /template/policy/definition/hubandspoke | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**get_policy_definition4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#get_policy_definition4) | **GET** /template/policy/definition/hubandspoke/{id} | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**preview_policy_definition4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#preview_policy_definition4) | **POST** /template/policy/definition/hubandspoke/preview | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**preview_policy_definition_by_id4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#preview_policy_definition_by_id4) | **GET** /template/policy/definition/hubandspoke/preview/{id} | +*ConfigurationPolicyHubAndSpokeDefinitionBuilderApi* | [**save_policy_definition_in_bulk4**](docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#save_policy_definition_in_bulk4) | **PUT** /template/policy/definition/hubandspoke/bulk | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**create_policy_list19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#create_policy_list19) | **POST** /template/policy/list/ipssignature | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**delete_policy_list19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#delete_policy_list19) | **DELETE** /template/policy/list/ipssignature/{id} | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**delete_policy_lists_with_info_tag19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#delete_policy_lists_with_info_tag19) | **DELETE** /template/policy/list/ipssignature | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**edit_policy_list19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#edit_policy_list19) | **PUT** /template/policy/list/ipssignature/{id} | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**get_lists_by_id19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#get_lists_by_id19) | **GET** /template/policy/list/ipssignature/{id} | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**get_policy_lists17**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#get_policy_lists17) | **GET** /template/policy/list/ipssignature | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**get_policy_lists_with_info_tag19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#get_policy_lists_with_info_tag19) | **GET** /template/policy/list/ipssignature/filtered | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**preview_policy_list19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#preview_policy_list19) | **POST** /template/policy/list/ipssignature/preview | +*ConfigurationPolicyIPSSignatureListBuilderApi* | [**preview_policy_list_by_id19**](docs/ConfigurationPolicyIPSSignatureListBuilderApi.md#preview_policy_list_by_id19) | **GET** /template/policy/list/ipssignature/preview/{id} | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**create_policy_definition9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#create_policy_definition9) | **POST** /template/policy/definition/aclv6 | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**delete_policy_definition9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#delete_policy_definition9) | **DELETE** /template/policy/definition/aclv6/{id} | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**edit_multiple_policy_definition9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#edit_multiple_policy_definition9) | **PUT** /template/policy/definition/aclv6/multiple/{id} | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**edit_policy_definition9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#edit_policy_definition9) | **PUT** /template/policy/definition/aclv6/{id} | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**get_definitions9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#get_definitions9) | **GET** /template/policy/definition/aclv6 | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**get_policy_definition9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#get_policy_definition9) | **GET** /template/policy/definition/aclv6/{id} | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**preview_policy_definition9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#preview_policy_definition9) | **POST** /template/policy/definition/aclv6/preview | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**preview_policy_definition_by_id9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#preview_policy_definition_by_id9) | **GET** /template/policy/definition/aclv6/preview/{id} | +*ConfigurationPolicyIPv6AccessDefinitionBuilderApi* | [**save_policy_definition_in_bulk9**](docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#save_policy_definition_in_bulk9) | **PUT** /template/policy/definition/aclv6/bulk | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**create_policy_definition17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#create_policy_definition17) | **POST** /template/policy/definition/deviceaccesspolicyv6 | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**delete_policy_definition17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#delete_policy_definition17) | **DELETE** /template/policy/definition/deviceaccesspolicyv6/{id} | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**edit_multiple_policy_definition17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#edit_multiple_policy_definition17) | **PUT** /template/policy/definition/deviceaccesspolicyv6/multiple/{id} | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**edit_policy_definition17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#edit_policy_definition17) | **PUT** /template/policy/definition/deviceaccesspolicyv6/{id} | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**get_definitions17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#get_definitions17) | **GET** /template/policy/definition/deviceaccesspolicyv6 | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**get_policy_definition17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#get_policy_definition17) | **GET** /template/policy/definition/deviceaccesspolicyv6/{id} | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**preview_policy_definition17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#preview_policy_definition17) | **POST** /template/policy/definition/deviceaccesspolicyv6/preview | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**preview_policy_definition_by_id17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#preview_policy_definition_by_id17) | **GET** /template/policy/definition/deviceaccesspolicyv6/preview/{id} | +*ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi* | [**save_policy_definition_in_bulk17**](docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#save_policy_definition_in_bulk17) | **PUT** /template/policy/definition/deviceaccesspolicyv6/bulk | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**create_policy_list20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#create_policy_list20) | **POST** /template/policy/list/ipv6prefix | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**delete_policy_list20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#delete_policy_list20) | **DELETE** /template/policy/list/ipv6prefix/{id} | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**delete_policy_lists_with_info_tag20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#delete_policy_lists_with_info_tag20) | **DELETE** /template/policy/list/ipv6prefix | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**edit_policy_list20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#edit_policy_list20) | **PUT** /template/policy/list/ipv6prefix/{id} | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**get_lists_by_id20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#get_lists_by_id20) | **GET** /template/policy/list/ipv6prefix/{id} | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**get_policy_lists18**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#get_policy_lists18) | **GET** /template/policy/list/ipv6prefix | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**get_policy_lists_with_info_tag20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#get_policy_lists_with_info_tag20) | **GET** /template/policy/list/ipv6prefix/filtered | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**preview_policy_list20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#preview_policy_list20) | **POST** /template/policy/list/ipv6prefix/preview | +*ConfigurationPolicyIPv6PrefixListBuilderApi* | [**preview_policy_list_by_id20**](docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md#preview_policy_list_by_id20) | **GET** /template/policy/list/ipv6prefix/preview/{id} | +*ConfigurationPolicyIdentityListBuilderApi* | [**create_policy_list18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#create_policy_list18) | **POST** /template/policy/list/identity | +*ConfigurationPolicyIdentityListBuilderApi* | [**delete_policy_list18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#delete_policy_list18) | **DELETE** /template/policy/list/identity/{id} | +*ConfigurationPolicyIdentityListBuilderApi* | [**delete_policy_lists_with_info_tag18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#delete_policy_lists_with_info_tag18) | **DELETE** /template/policy/list/identity | +*ConfigurationPolicyIdentityListBuilderApi* | [**edit_policy_list18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#edit_policy_list18) | **PUT** /template/policy/list/identity/{id} | +*ConfigurationPolicyIdentityListBuilderApi* | [**get_lists_by_id18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#get_lists_by_id18) | **GET** /template/policy/list/identity/{id} | +*ConfigurationPolicyIdentityListBuilderApi* | [**get_policy_lists16**](docs/ConfigurationPolicyIdentityListBuilderApi.md#get_policy_lists16) | **GET** /template/policy/list/identity | +*ConfigurationPolicyIdentityListBuilderApi* | [**get_policy_lists_with_info_tag18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#get_policy_lists_with_info_tag18) | **GET** /template/policy/list/identity/filtered | +*ConfigurationPolicyIdentityListBuilderApi* | [**preview_policy_list18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#preview_policy_list18) | **POST** /template/policy/list/identity/preview | +*ConfigurationPolicyIdentityListBuilderApi* | [**preview_policy_list_by_id18**](docs/ConfigurationPolicyIdentityListBuilderApi.md#preview_policy_list_by_id18) | **GET** /template/policy/list/identity/preview/{id} | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**create_policy_definition18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#create_policy_definition18) | **POST** /template/policy/definition/intrusionprevention | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**delete_policy_definition18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#delete_policy_definition18) | **DELETE** /template/policy/definition/intrusionprevention/{id} | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**edit_multiple_policy_definition18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#edit_multiple_policy_definition18) | **PUT** /template/policy/definition/intrusionprevention/multiple/{id} | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**edit_policy_definition18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#edit_policy_definition18) | **PUT** /template/policy/definition/intrusionprevention/{id} | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**get_definitions18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#get_definitions18) | **GET** /template/policy/definition/intrusionprevention | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**get_policy_definition18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#get_policy_definition18) | **GET** /template/policy/definition/intrusionprevention/{id} | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**preview_policy_definition18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#preview_policy_definition18) | **POST** /template/policy/definition/intrusionprevention/preview | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**preview_policy_definition_by_id18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#preview_policy_definition_by_id18) | **GET** /template/policy/definition/intrusionprevention/preview/{id} | +*ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi* | [**save_policy_definition_in_bulk18**](docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#save_policy_definition_in_bulk18) | **PUT** /template/policy/definition/intrusionprevention/bulk | +*ConfigurationPolicyListBuilderApi* | [**create_webex_prefix_lists**](docs/ConfigurationPolicyListBuilderApi.md#create_webex_prefix_lists) | **POST** /template/policy/list/webex | +*ConfigurationPolicyListBuilderApi* | [**create_webex_prefix_lists1**](docs/ConfigurationPolicyListBuilderApi.md#create_webex_prefix_lists1) | **POST** /template/policy/list/webex/update | +*ConfigurationPolicyListBuilderApi* | [**get_all_policy_lists**](docs/ConfigurationPolicyListBuilderApi.md#get_all_policy_lists) | **GET** /template/policy/list | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**create_policy_definition**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#create_policy_definition) | **POST** /template/policy/definition/dnssecurity | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**delete_policy_definition**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#delete_policy_definition) | **DELETE** /template/policy/definition/dnssecurity/{id} | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**edit_multiple_policy_definition**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#edit_multiple_policy_definition) | **PUT** /template/policy/definition/dnssecurity/multiple/{id} | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**edit_policy_definition**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#edit_policy_definition) | **PUT** /template/policy/definition/dnssecurity/{id} | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**get_definitions**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#get_definitions) | **GET** /template/policy/definition/dnssecurity | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**get_policy_definition**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#get_policy_definition) | **GET** /template/policy/definition/dnssecurity/{id} | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**preview_policy_definition**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#preview_policy_definition) | **POST** /template/policy/definition/dnssecurity/preview | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**preview_policy_definition_by_id**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#preview_policy_definition_by_id) | **GET** /template/policy/definition/dnssecurity/preview/{id} | +*ConfigurationPolicyLocalDomainDefinitionBuilderApi* | [**save_policy_definition_in_bulk**](docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#save_policy_definition_in_bulk) | **PUT** /template/policy/definition/dnssecurity/bulk | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**create_policy_list23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#create_policy_list23) | **POST** /template/policy/list/localdomain | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**delete_policy_list23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#delete_policy_list23) | **DELETE** /template/policy/list/localdomain/{id} | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**delete_policy_lists_with_info_tag23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#delete_policy_lists_with_info_tag23) | **DELETE** /template/policy/list/localdomain | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**edit_policy_list23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#edit_policy_list23) | **PUT** /template/policy/list/localdomain/{id} | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**get_lists_by_id23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#get_lists_by_id23) | **GET** /template/policy/list/localdomain/{id} | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**get_policy_lists20**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#get_policy_lists20) | **GET** /template/policy/list/localdomain | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**get_policy_lists_with_info_tag23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#get_policy_lists_with_info_tag23) | **GET** /template/policy/list/localdomain/filtered | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**preview_policy_list23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#preview_policy_list23) | **POST** /template/policy/list/localdomain/preview | +*ConfigurationPolicyLocalDomainNameListBuilderApi* | [**preview_policy_list_by_id23**](docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md#preview_policy_list_by_id23) | **GET** /template/policy/list/localdomain/preview/{id} | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**create_policy_list**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#create_policy_list) | **POST** /template/policy/list/mediaprofile | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**delete_policy_list**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#delete_policy_list) | **DELETE** /template/policy/list/mediaprofile/{id} | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**delete_policy_lists_with_info_tag**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#delete_policy_lists_with_info_tag) | **DELETE** /template/policy/list/mediaprofile | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**edit_policy_list**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#edit_policy_list) | **PUT** /template/policy/list/mediaprofile/{id} | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**get_lists_by_id**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#get_lists_by_id) | **GET** /template/policy/list/mediaprofile/{id} | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**get_policy_lists**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#get_policy_lists) | **GET** /template/policy/list/mediaprofile | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**get_policy_lists_with_info_tag**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#get_policy_lists_with_info_tag) | **GET** /template/policy/list/mediaprofile/filtered | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**preview_policy_list**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#preview_policy_list) | **POST** /template/policy/list/mediaprofile/preview | +*ConfigurationPolicyMediaProfileListBuilderApi* | [**preview_policy_list_by_id**](docs/ConfigurationPolicyMediaProfileListBuilderApi.md#preview_policy_list_by_id) | **GET** /template/policy/list/mediaprofile/preview/{id} | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**create_policy_definition5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#create_policy_definition5) | **POST** /template/policy/definition/mesh | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**delete_policy_definition5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#delete_policy_definition5) | **DELETE** /template/policy/definition/mesh/{id} | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**edit_multiple_policy_definition5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#edit_multiple_policy_definition5) | **PUT** /template/policy/definition/mesh/multiple/{id} | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**edit_policy_definition5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#edit_policy_definition5) | **PUT** /template/policy/definition/mesh/{id} | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**get_definitions5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#get_definitions5) | **GET** /template/policy/definition/mesh | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**get_policy_definition5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#get_policy_definition5) | **GET** /template/policy/definition/mesh/{id} | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**preview_policy_definition5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#preview_policy_definition5) | **POST** /template/policy/definition/mesh/preview | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**preview_policy_definition_by_id5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#preview_policy_definition_by_id5) | **GET** /template/policy/definition/mesh/preview/{id} | +*ConfigurationPolicyMeshDefinitionBuilderApi* | [**save_policy_definition_in_bulk5**](docs/ConfigurationPolicyMeshDefinitionBuilderApi.md#save_policy_definition_in_bulk5) | **PUT** /template/policy/definition/mesh/bulk | +*ConfigurationPolicyMirrorListBuilderApi* | [**create_policy_list24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#create_policy_list24) | **POST** /template/policy/list/mirror | +*ConfigurationPolicyMirrorListBuilderApi* | [**delete_policy_list24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#delete_policy_list24) | **DELETE** /template/policy/list/mirror/{id} | +*ConfigurationPolicyMirrorListBuilderApi* | [**delete_policy_lists_with_info_tag24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#delete_policy_lists_with_info_tag24) | **DELETE** /template/policy/list/mirror | +*ConfigurationPolicyMirrorListBuilderApi* | [**edit_policy_list24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#edit_policy_list24) | **PUT** /template/policy/list/mirror/{id} | +*ConfigurationPolicyMirrorListBuilderApi* | [**get_lists_by_id24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#get_lists_by_id24) | **GET** /template/policy/list/mirror/{id} | +*ConfigurationPolicyMirrorListBuilderApi* | [**get_policy_lists21**](docs/ConfigurationPolicyMirrorListBuilderApi.md#get_policy_lists21) | **GET** /template/policy/list/mirror | +*ConfigurationPolicyMirrorListBuilderApi* | [**get_policy_lists_with_info_tag24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#get_policy_lists_with_info_tag24) | **GET** /template/policy/list/mirror/filtered | +*ConfigurationPolicyMirrorListBuilderApi* | [**preview_policy_list24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#preview_policy_list24) | **POST** /template/policy/list/mirror/preview | +*ConfigurationPolicyMirrorListBuilderApi* | [**preview_policy_list_by_id24**](docs/ConfigurationPolicyMirrorListBuilderApi.md#preview_policy_list_by_id24) | **GET** /template/policy/list/mirror/preview/{id} | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**create_policy_list25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#create_policy_list25) | **POST** /template/policy/list/modempassthrough | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**delete_policy_list25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#delete_policy_list25) | **DELETE** /template/policy/list/modempassthrough/{id} | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**delete_policy_lists_with_info_tag25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#delete_policy_lists_with_info_tag25) | **DELETE** /template/policy/list/modempassthrough | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**edit_policy_list25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#edit_policy_list25) | **PUT** /template/policy/list/modempassthrough/{id} | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**get_lists_by_id25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#get_lists_by_id25) | **GET** /template/policy/list/modempassthrough/{id} | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**get_policy_lists22**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#get_policy_lists22) | **GET** /template/policy/list/modempassthrough | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**get_policy_lists_with_info_tag25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#get_policy_lists_with_info_tag25) | **GET** /template/policy/list/modempassthrough/filtered | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**preview_policy_list25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#preview_policy_list25) | **POST** /template/policy/list/modempassthrough/preview | +*ConfigurationPolicyModemPassthroughListBuilderApi* | [**preview_policy_list_by_id25**](docs/ConfigurationPolicyModemPassthroughListBuilderApi.md#preview_policy_list_by_id25) | **GET** /template/policy/list/modempassthrough/preview/{id} | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**create_policy_definition29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#create_policy_definition29) | **POST** /template/policy/definition/priisdnport | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**delete_policy_definition29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#delete_policy_definition29) | **DELETE** /template/policy/definition/priisdnport/{id} | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**edit_multiple_policy_definition29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#edit_multiple_policy_definition29) | **PUT** /template/policy/definition/priisdnport/multiple/{id} | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**edit_policy_definition29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#edit_policy_definition29) | **PUT** /template/policy/definition/priisdnport/{id} | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**get_definitions29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#get_definitions29) | **GET** /template/policy/definition/priisdnport | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**get_policy_definition29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#get_policy_definition29) | **GET** /template/policy/definition/priisdnport/{id} | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**preview_policy_definition29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#preview_policy_definition29) | **POST** /template/policy/definition/priisdnport/preview | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**preview_policy_definition_by_id29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#preview_policy_definition_by_id29) | **GET** /template/policy/definition/priisdnport/preview/{id} | +*ConfigurationPolicyPRIISDNPortDefinitionBuilderApi* | [**save_policy_definition_in_bulk29**](docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#save_policy_definition_in_bulk29) | **PUT** /template/policy/definition/priisdnport/bulk | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**create_policy_list26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#create_policy_list26) | **POST** /template/policy/list/policer | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**delete_policy_list26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#delete_policy_list26) | **DELETE** /template/policy/list/policer/{id} | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**delete_policy_lists_with_info_tag26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#delete_policy_lists_with_info_tag26) | **DELETE** /template/policy/list/policer | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**edit_policy_list26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#edit_policy_list26) | **PUT** /template/policy/list/policer/{id} | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**get_lists_by_id26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#get_lists_by_id26) | **GET** /template/policy/list/policer/{id} | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**get_policy_lists23**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#get_policy_lists23) | **GET** /template/policy/list/policer | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**get_policy_lists_with_info_tag26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#get_policy_lists_with_info_tag26) | **GET** /template/policy/list/policer/filtered | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**preview_policy_list26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#preview_policy_list26) | **POST** /template/policy/list/policer/preview | +*ConfigurationPolicyPolicerClassListBuilderApi* | [**preview_policy_list_by_id26**](docs/ConfigurationPolicyPolicerClassListBuilderApi.md#preview_policy_list_by_id26) | **GET** /template/policy/list/policer/preview/{id} | +*ConfigurationPolicyPortListBuilderApi* | [**create_policy_list27**](docs/ConfigurationPolicyPortListBuilderApi.md#create_policy_list27) | **POST** /template/policy/list/port | +*ConfigurationPolicyPortListBuilderApi* | [**delete_policy_list27**](docs/ConfigurationPolicyPortListBuilderApi.md#delete_policy_list27) | **DELETE** /template/policy/list/port/{id} | +*ConfigurationPolicyPortListBuilderApi* | [**delete_policy_lists_with_info_tag27**](docs/ConfigurationPolicyPortListBuilderApi.md#delete_policy_lists_with_info_tag27) | **DELETE** /template/policy/list/port | +*ConfigurationPolicyPortListBuilderApi* | [**edit_policy_list27**](docs/ConfigurationPolicyPortListBuilderApi.md#edit_policy_list27) | **PUT** /template/policy/list/port/{id} | +*ConfigurationPolicyPortListBuilderApi* | [**get_lists_by_id27**](docs/ConfigurationPolicyPortListBuilderApi.md#get_lists_by_id27) | **GET** /template/policy/list/port/{id} | +*ConfigurationPolicyPortListBuilderApi* | [**get_policy_lists24**](docs/ConfigurationPolicyPortListBuilderApi.md#get_policy_lists24) | **GET** /template/policy/list/port | +*ConfigurationPolicyPortListBuilderApi* | [**get_policy_lists_with_info_tag27**](docs/ConfigurationPolicyPortListBuilderApi.md#get_policy_lists_with_info_tag27) | **GET** /template/policy/list/port/filtered | +*ConfigurationPolicyPortListBuilderApi* | [**preview_policy_list27**](docs/ConfigurationPolicyPortListBuilderApi.md#preview_policy_list27) | **POST** /template/policy/list/port/preview | +*ConfigurationPolicyPortListBuilderApi* | [**preview_policy_list_by_id27**](docs/ConfigurationPolicyPortListBuilderApi.md#preview_policy_list_by_id27) | **GET** /template/policy/list/port/preview/{id} | +*ConfigurationPolicyPrefixListBuilderApi* | [**create_policy_list29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#create_policy_list29) | **POST** /template/policy/list/prefix | +*ConfigurationPolicyPrefixListBuilderApi* | [**delete_policy_list29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#delete_policy_list29) | **DELETE** /template/policy/list/prefix/{id} | +*ConfigurationPolicyPrefixListBuilderApi* | [**delete_policy_lists_with_info_tag29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#delete_policy_lists_with_info_tag29) | **DELETE** /template/policy/list/prefix | +*ConfigurationPolicyPrefixListBuilderApi* | [**edit_policy_list29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#edit_policy_list29) | **PUT** /template/policy/list/prefix/{id} | +*ConfigurationPolicyPrefixListBuilderApi* | [**get_lists_by_id29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#get_lists_by_id29) | **GET** /template/policy/list/prefix/{id} | +*ConfigurationPolicyPrefixListBuilderApi* | [**get_policy_lists26**](docs/ConfigurationPolicyPrefixListBuilderApi.md#get_policy_lists26) | **GET** /template/policy/list/prefix | +*ConfigurationPolicyPrefixListBuilderApi* | [**get_policy_lists_with_info_tag29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#get_policy_lists_with_info_tag29) | **GET** /template/policy/list/prefix/filtered | +*ConfigurationPolicyPrefixListBuilderApi* | [**preview_policy_list29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#preview_policy_list29) | **POST** /template/policy/list/prefix/preview | +*ConfigurationPolicyPrefixListBuilderApi* | [**preview_policy_list_by_id29**](docs/ConfigurationPolicyPrefixListBuilderApi.md#preview_policy_list_by_id29) | **GET** /template/policy/list/prefix/preview/{id} | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**create_policy_list21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#create_policy_list21) | **POST** /template/policy/list/ipprefixall | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**delete_policy_list21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#delete_policy_list21) | **DELETE** /template/policy/list/ipprefixall/{id} | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**delete_policy_lists_with_info_tag21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#delete_policy_lists_with_info_tag21) | **DELETE** /template/policy/list/ipprefixall | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**edit_policy_list21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#edit_policy_list21) | **PUT** /template/policy/list/ipprefixall/{id} | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**get_lists_by_id21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#get_lists_by_id21) | **GET** /template/policy/list/ipprefixall/{id} | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**get_lists_for_all_prefixes**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#get_lists_for_all_prefixes) | **GET** /template/policy/list/ipprefixall | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**get_policy_lists_with_info_tag21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#get_policy_lists_with_info_tag21) | **GET** /template/policy/list/ipprefixall/filtered | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**preview_policy_list21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#preview_policy_list21) | **POST** /template/policy/list/ipprefixall/preview | +*ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi* | [**preview_policy_list_by_id21**](docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#preview_policy_list_by_id21) | **GET** /template/policy/list/ipprefixall/preview/{id} | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**create_policy_list30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#create_policy_list30) | **POST** /template/policy/list/protocolname | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**delete_policy_list30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#delete_policy_list30) | **DELETE** /template/policy/list/protocolname/{id} | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**delete_policy_lists_with_info_tag30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#delete_policy_lists_with_info_tag30) | **DELETE** /template/policy/list/protocolname | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**edit_policy_list30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#edit_policy_list30) | **PUT** /template/policy/list/protocolname/{id} | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**get_lists_by_id30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#get_lists_by_id30) | **GET** /template/policy/list/protocolname/{id} | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**get_policy_lists27**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#get_policy_lists27) | **GET** /template/policy/list/protocolname | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**get_policy_lists_with_info_tag30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#get_policy_lists_with_info_tag30) | **GET** /template/policy/list/protocolname/filtered | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**preview_policy_list30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#preview_policy_list30) | **POST** /template/policy/list/protocolname/preview | +*ConfigurationPolicyProtocolNameListBuilderApi* | [**preview_policy_list_by_id30**](docs/ConfigurationPolicyProtocolNameListBuilderApi.md#preview_policy_list_by_id30) | **GET** /template/policy/list/protocolname/preview/{id} | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**create_policy_definition1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#create_policy_definition1) | **POST** /template/policy/definition/qosmap | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**delete_policy_definition1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#delete_policy_definition1) | **DELETE** /template/policy/definition/qosmap/{id} | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**edit_multiple_policy_definition1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#edit_multiple_policy_definition1) | **PUT** /template/policy/definition/qosmap/multiple/{id} | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**edit_policy_definition1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#edit_policy_definition1) | **PUT** /template/policy/definition/qosmap/{id} | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**get_definitions1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#get_definitions1) | **GET** /template/policy/definition/qosmap | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**get_policy_definition1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#get_policy_definition1) | **GET** /template/policy/definition/qosmap/{id} | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**preview_policy_definition1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#preview_policy_definition1) | **POST** /template/policy/definition/qosmap/preview | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**preview_policy_definition_by_id1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#preview_policy_definition_by_id1) | **GET** /template/policy/definition/qosmap/preview/{id} | +*ConfigurationPolicyQosMapDefinitionBuilderApi* | [**save_policy_definition_in_bulk1**](docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md#save_policy_definition_in_bulk1) | **PUT** /template/policy/definition/qosmap/bulk | +*ConfigurationPolicyRegionListBuilderApi* | [**create_policy_list31**](docs/ConfigurationPolicyRegionListBuilderApi.md#create_policy_list31) | **POST** /template/policy/list/region | +*ConfigurationPolicyRegionListBuilderApi* | [**delete_policy_list31**](docs/ConfigurationPolicyRegionListBuilderApi.md#delete_policy_list31) | **DELETE** /template/policy/list/region/{id} | +*ConfigurationPolicyRegionListBuilderApi* | [**delete_policy_lists_with_info_tag31**](docs/ConfigurationPolicyRegionListBuilderApi.md#delete_policy_lists_with_info_tag31) | **DELETE** /template/policy/list/region | +*ConfigurationPolicyRegionListBuilderApi* | [**edit_policy_list31**](docs/ConfigurationPolicyRegionListBuilderApi.md#edit_policy_list31) | **PUT** /template/policy/list/region/{id} | +*ConfigurationPolicyRegionListBuilderApi* | [**get_lists_by_id31**](docs/ConfigurationPolicyRegionListBuilderApi.md#get_lists_by_id31) | **GET** /template/policy/list/region/{id} | +*ConfigurationPolicyRegionListBuilderApi* | [**get_policy_lists28**](docs/ConfigurationPolicyRegionListBuilderApi.md#get_policy_lists28) | **GET** /template/policy/list/region | +*ConfigurationPolicyRegionListBuilderApi* | [**get_policy_lists_with_info_tag31**](docs/ConfigurationPolicyRegionListBuilderApi.md#get_policy_lists_with_info_tag31) | **GET** /template/policy/list/region/filtered | +*ConfigurationPolicyRegionListBuilderApi* | [**preview_policy_list31**](docs/ConfigurationPolicyRegionListBuilderApi.md#preview_policy_list31) | **POST** /template/policy/list/region/preview | +*ConfigurationPolicyRegionListBuilderApi* | [**preview_policy_list_by_id31**](docs/ConfigurationPolicyRegionListBuilderApi.md#preview_policy_list_by_id31) | **GET** /template/policy/list/region/preview/{id} | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**create_policy_definition19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#create_policy_definition19) | **POST** /template/policy/definition/rewriterule | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**delete_policy_definition19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#delete_policy_definition19) | **DELETE** /template/policy/definition/rewriterule/{id} | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**edit_multiple_policy_definition19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#edit_multiple_policy_definition19) | **PUT** /template/policy/definition/rewriterule/multiple/{id} | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**edit_policy_definition19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#edit_policy_definition19) | **PUT** /template/policy/definition/rewriterule/{id} | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**get_definitions19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#get_definitions19) | **GET** /template/policy/definition/rewriterule | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**get_policy_definition19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#get_policy_definition19) | **GET** /template/policy/definition/rewriterule/{id} | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**preview_policy_definition19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#preview_policy_definition19) | **POST** /template/policy/definition/rewriterule/preview | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**preview_policy_definition_by_id19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#preview_policy_definition_by_id19) | **GET** /template/policy/definition/rewriterule/preview/{id} | +*ConfigurationPolicyRewriteRuleDefinitionBuilderApi* | [**save_policy_definition_in_bulk19**](docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#save_policy_definition_in_bulk19) | **PUT** /template/policy/definition/rewriterule/bulk | +*ConfigurationPolicySLAClassListBuilderApi* | [**create_policy_list33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#create_policy_list33) | **POST** /template/policy/list/sla | +*ConfigurationPolicySLAClassListBuilderApi* | [**delete_policy_list33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#delete_policy_list33) | **DELETE** /template/policy/list/sla/{id} | +*ConfigurationPolicySLAClassListBuilderApi* | [**delete_policy_lists_with_info_tag33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#delete_policy_lists_with_info_tag33) | **DELETE** /template/policy/list/sla | +*ConfigurationPolicySLAClassListBuilderApi* | [**edit_policy_list33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#edit_policy_list33) | **PUT** /template/policy/list/sla/{id} | +*ConfigurationPolicySLAClassListBuilderApi* | [**get_lists_by_id33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#get_lists_by_id33) | **GET** /template/policy/list/sla/{id} | +*ConfigurationPolicySLAClassListBuilderApi* | [**get_policy_lists30**](docs/ConfigurationPolicySLAClassListBuilderApi.md#get_policy_lists30) | **GET** /template/policy/list/sla | +*ConfigurationPolicySLAClassListBuilderApi* | [**get_policy_lists_with_info_tag33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#get_policy_lists_with_info_tag33) | **GET** /template/policy/list/sla/filtered | +*ConfigurationPolicySLAClassListBuilderApi* | [**preview_policy_list33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#preview_policy_list33) | **POST** /template/policy/list/sla/preview | +*ConfigurationPolicySLAClassListBuilderApi* | [**preview_policy_list_by_id33**](docs/ConfigurationPolicySLAClassListBuilderApi.md#preview_policy_list_by_id33) | **GET** /template/policy/list/sla/preview/{id} | +*ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi* | [**get_sig_data_center_list**](docs/ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi.md#get_sig_data_center_list) | **GET** /sig/datacenters/{type}/{tunneltype}/{devicetype} | +*ConfigurationPolicySecurityAssemblerApi* | [**preview**](docs/ConfigurationPolicySecurityAssemblerApi.md#preview) | **POST** /template/policy/assembly/security | +*ConfigurationPolicySecurityAssemblerApi* | [**preview_by_id**](docs/ConfigurationPolicySecurityAssemblerApi.md#preview_by_id) | **GET** /template/policy/assembly/security/{id} | +*ConfigurationPolicySiteListBuilderApi* | [**create_default_site_list**](docs/ConfigurationPolicySiteListBuilderApi.md#create_default_site_list) | **POST** /template/policy/list/site/defaultsite | +*ConfigurationPolicySiteListBuilderApi* | [**create_policy_list32**](docs/ConfigurationPolicySiteListBuilderApi.md#create_policy_list32) | **POST** /template/policy/list/site | +*ConfigurationPolicySiteListBuilderApi* | [**delete_policy_list32**](docs/ConfigurationPolicySiteListBuilderApi.md#delete_policy_list32) | **DELETE** /template/policy/list/site/{id} | +*ConfigurationPolicySiteListBuilderApi* | [**delete_policy_lists_with_info_tag32**](docs/ConfigurationPolicySiteListBuilderApi.md#delete_policy_lists_with_info_tag32) | **DELETE** /template/policy/list/site | +*ConfigurationPolicySiteListBuilderApi* | [**edit_policy_list32**](docs/ConfigurationPolicySiteListBuilderApi.md#edit_policy_list32) | **PUT** /template/policy/list/site/{id} | +*ConfigurationPolicySiteListBuilderApi* | [**get_lists_by_id32**](docs/ConfigurationPolicySiteListBuilderApi.md#get_lists_by_id32) | **GET** /template/policy/list/site/{id} | +*ConfigurationPolicySiteListBuilderApi* | [**get_policy_lists29**](docs/ConfigurationPolicySiteListBuilderApi.md#get_policy_lists29) | **GET** /template/policy/list/site | +*ConfigurationPolicySiteListBuilderApi* | [**get_policy_lists_with_info_tag32**](docs/ConfigurationPolicySiteListBuilderApi.md#get_policy_lists_with_info_tag32) | **GET** /template/policy/list/site/filtered | +*ConfigurationPolicySiteListBuilderApi* | [**preview_policy_list32**](docs/ConfigurationPolicySiteListBuilderApi.md#preview_policy_list32) | **POST** /template/policy/list/site/preview | +*ConfigurationPolicySiteListBuilderApi* | [**preview_policy_list_by_id32**](docs/ConfigurationPolicySiteListBuilderApi.md#preview_policy_list_by_id32) | **GET** /template/policy/list/site/preview/{id} | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**create_policy_list34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#create_policy_list34) | **POST** /template/policy/list/supervisorydisc | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**delete_policy_list34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#delete_policy_list34) | **DELETE** /template/policy/list/supervisorydisc/{id} | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**delete_policy_lists_with_info_tag34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#delete_policy_lists_with_info_tag34) | **DELETE** /template/policy/list/supervisorydisc | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**edit_policy_list34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#edit_policy_list34) | **PUT** /template/policy/list/supervisorydisc/{id} | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**get_lists_by_id34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#get_lists_by_id34) | **GET** /template/policy/list/supervisorydisc/{id} | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**get_policy_lists31**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#get_policy_lists31) | **GET** /template/policy/list/supervisorydisc | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**get_policy_lists_with_info_tag34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#get_policy_lists_with_info_tag34) | **GET** /template/policy/list/supervisorydisc/filtered | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**preview_policy_list34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#preview_policy_list34) | **POST** /template/policy/list/supervisorydisc/preview | +*ConfigurationPolicySupervisoryDiscListBuilderApi* | [**preview_policy_list_by_id34**](docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md#preview_policy_list_by_id34) | **GET** /template/policy/list/supervisorydisc/preview/{id} | +*ConfigurationPolicyTLOCListBuilderApi* | [**create_policy_list36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#create_policy_list36) | **POST** /template/policy/list/tloc | +*ConfigurationPolicyTLOCListBuilderApi* | [**delete_policy_list36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#delete_policy_list36) | **DELETE** /template/policy/list/tloc/{id} | +*ConfigurationPolicyTLOCListBuilderApi* | [**delete_policy_lists_with_info_tag36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#delete_policy_lists_with_info_tag36) | **DELETE** /template/policy/list/tloc | +*ConfigurationPolicyTLOCListBuilderApi* | [**edit_policy_list36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#edit_policy_list36) | **PUT** /template/policy/list/tloc/{id} | +*ConfigurationPolicyTLOCListBuilderApi* | [**get_lists_by_id36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#get_lists_by_id36) | **GET** /template/policy/list/tloc/{id} | +*ConfigurationPolicyTLOCListBuilderApi* | [**get_policy_lists33**](docs/ConfigurationPolicyTLOCListBuilderApi.md#get_policy_lists33) | **GET** /template/policy/list/tloc | +*ConfigurationPolicyTLOCListBuilderApi* | [**get_policy_lists_with_info_tag36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#get_policy_lists_with_info_tag36) | **GET** /template/policy/list/tloc/filtered | +*ConfigurationPolicyTLOCListBuilderApi* | [**preview_policy_list36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#preview_policy_list36) | **POST** /template/policy/list/tloc/preview | +*ConfigurationPolicyTLOCListBuilderApi* | [**preview_policy_list_by_id36**](docs/ConfigurationPolicyTLOCListBuilderApi.md#preview_policy_list_by_id36) | **GET** /template/policy/list/tloc/preview/{id} | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**create_policy_list35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#create_policy_list35) | **POST** /template/policy/list/tgapikey | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**delete_policy_list35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#delete_policy_list35) | **DELETE** /template/policy/list/tgapikey/{id} | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**delete_policy_lists_with_info_tag35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#delete_policy_lists_with_info_tag35) | **DELETE** /template/policy/list/tgapikey | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**edit_policy_list35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#edit_policy_list35) | **PUT** /template/policy/list/tgapikey/{id} | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**get_lists_by_id35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#get_lists_by_id35) | **GET** /template/policy/list/tgapikey/{id} | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**get_policy_lists32**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#get_policy_lists32) | **GET** /template/policy/list/tgapikey | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**get_policy_lists_with_info_tag35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#get_policy_lists_with_info_tag35) | **GET** /template/policy/list/tgapikey/filtered | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**preview_policy_list35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#preview_policy_list35) | **POST** /template/policy/list/tgapikey/preview | +*ConfigurationPolicyThreatGridApiKeyListApi* | [**preview_policy_list_by_id35**](docs/ConfigurationPolicyThreatGridApiKeyListApi.md#preview_policy_list_by_id35) | **GET** /template/policy/list/tgapikey/preview/{id} | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**create_policy_list1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#create_policy_list1) | **POST** /template/policy/list/translationprofile | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**delete_policy_list1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#delete_policy_list1) | **DELETE** /template/policy/list/translationprofile/{id} | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**delete_policy_lists_with_info_tag1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#delete_policy_lists_with_info_tag1) | **DELETE** /template/policy/list/translationprofile | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**edit_policy_list1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#edit_policy_list1) | **PUT** /template/policy/list/translationprofile/{id} | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**get_lists_by_id1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#get_lists_by_id1) | **GET** /template/policy/list/translationprofile/{id} | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**get_policy_lists1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#get_policy_lists1) | **GET** /template/policy/list/translationprofile | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**get_policy_lists_with_info_tag1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#get_policy_lists_with_info_tag1) | **GET** /template/policy/list/translationprofile/filtered | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**preview_policy_list1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#preview_policy_list1) | **POST** /template/policy/list/translationprofile/preview | +*ConfigurationPolicyTranslationProfileListBuilderApi* | [**preview_policy_list_by_id1**](docs/ConfigurationPolicyTranslationProfileListBuilderApi.md#preview_policy_list_by_id1) | **GET** /template/policy/list/translationprofile/preview/{id} | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**create_policy_list2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#create_policy_list2) | **POST** /template/policy/list/translationrules | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**delete_policy_list2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#delete_policy_list2) | **DELETE** /template/policy/list/translationrules/{id} | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**delete_policy_lists_with_info_tag2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#delete_policy_lists_with_info_tag2) | **DELETE** /template/policy/list/translationrules | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**edit_policy_list2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#edit_policy_list2) | **PUT** /template/policy/list/translationrules/{id} | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**get_lists_by_id2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#get_lists_by_id2) | **GET** /template/policy/list/translationrules/{id} | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**get_policy_lists2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#get_policy_lists2) | **GET** /template/policy/list/translationrules | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**get_policy_lists_with_info_tag2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#get_policy_lists_with_info_tag2) | **GET** /template/policy/list/translationrules/filtered | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**preview_policy_list2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#preview_policy_list2) | **POST** /template/policy/list/translationrules/preview | +*ConfigurationPolicyTranslationRulesListBuilderApi* | [**preview_policy_list_by_id2**](docs/ConfigurationPolicyTranslationRulesListBuilderApi.md#preview_policy_list_by_id2) | **GET** /template/policy/list/translationrules/preview/{id} | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**create_policy_list37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#create_policy_list37) | **POST** /template/policy/list/trunkgroup | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**delete_policy_list37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#delete_policy_list37) | **DELETE** /template/policy/list/trunkgroup/{id} | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**delete_policy_lists_with_info_tag37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#delete_policy_lists_with_info_tag37) | **DELETE** /template/policy/list/trunkgroup | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**edit_policy_list37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#edit_policy_list37) | **PUT** /template/policy/list/trunkgroup/{id} | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**get_lists_by_id37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#get_lists_by_id37) | **GET** /template/policy/list/trunkgroup/{id} | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**get_policy_lists34**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#get_policy_lists34) | **GET** /template/policy/list/trunkgroup | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**get_policy_lists_with_info_tag37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#get_policy_lists_with_info_tag37) | **GET** /template/policy/list/trunkgroup/filtered | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**preview_policy_list37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#preview_policy_list37) | **POST** /template/policy/list/trunkgroup/preview | +*ConfigurationPolicyTrunkGroupListBuilderApi* | [**preview_policy_list_by_id37**](docs/ConfigurationPolicyTrunkGroupListBuilderApi.md#preview_policy_list_by_id37) | **GET** /template/policy/list/trunkgroup/preview/{id} | +*ConfigurationPolicyURLBlackListBuilderApi* | [**create_policy_list39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#create_policy_list39) | **POST** /template/policy/list/urlblacklist | +*ConfigurationPolicyURLBlackListBuilderApi* | [**delete_policy_list39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#delete_policy_list39) | **DELETE** /template/policy/list/urlblacklist/{id} | +*ConfigurationPolicyURLBlackListBuilderApi* | [**delete_policy_lists_with_info_tag39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#delete_policy_lists_with_info_tag39) | **DELETE** /template/policy/list/urlblacklist | +*ConfigurationPolicyURLBlackListBuilderApi* | [**edit_policy_list39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#edit_policy_list39) | **PUT** /template/policy/list/urlblacklist/{id} | +*ConfigurationPolicyURLBlackListBuilderApi* | [**get_lists_by_id39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#get_lists_by_id39) | **GET** /template/policy/list/urlblacklist/{id} | +*ConfigurationPolicyURLBlackListBuilderApi* | [**get_policy_lists36**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#get_policy_lists36) | **GET** /template/policy/list/urlblacklist | +*ConfigurationPolicyURLBlackListBuilderApi* | [**get_policy_lists_with_info_tag39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#get_policy_lists_with_info_tag39) | **GET** /template/policy/list/urlblacklist/filtered | +*ConfigurationPolicyURLBlackListBuilderApi* | [**preview_policy_list39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#preview_policy_list39) | **POST** /template/policy/list/urlblacklist/preview | +*ConfigurationPolicyURLBlackListBuilderApi* | [**preview_policy_list_by_id39**](docs/ConfigurationPolicyURLBlackListBuilderApi.md#preview_policy_list_by_id39) | **GET** /template/policy/list/urlblacklist/preview/{id} | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**create_policy_definition23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#create_policy_definition23) | **POST** /template/policy/definition/urlfiltering | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**delete_policy_definition23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#delete_policy_definition23) | **DELETE** /template/policy/definition/urlfiltering/{id} | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**edit_multiple_policy_definition23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#edit_multiple_policy_definition23) | **PUT** /template/policy/definition/urlfiltering/multiple/{id} | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**edit_policy_definition23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#edit_policy_definition23) | **PUT** /template/policy/definition/urlfiltering/{id} | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**get_definitions23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#get_definitions23) | **GET** /template/policy/definition/urlfiltering | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**get_policy_definition23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#get_policy_definition23) | **GET** /template/policy/definition/urlfiltering/{id} | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**preview_policy_definition23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#preview_policy_definition23) | **POST** /template/policy/definition/urlfiltering/preview | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**preview_policy_definition_by_id23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#preview_policy_definition_by_id23) | **GET** /template/policy/definition/urlfiltering/preview/{id} | +*ConfigurationPolicyURLFilteringDefinitionBuilderApi* | [**save_policy_definition_in_bulk23**](docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#save_policy_definition_in_bulk23) | **PUT** /template/policy/definition/urlfiltering/bulk | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**create_policy_list40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#create_policy_list40) | **POST** /template/policy/list/urlwhitelist | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**delete_policy_list40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#delete_policy_list40) | **DELETE** /template/policy/list/urlwhitelist/{id} | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**delete_policy_lists_with_info_tag40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#delete_policy_lists_with_info_tag40) | **DELETE** /template/policy/list/urlwhitelist | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**edit_policy_list40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#edit_policy_list40) | **PUT** /template/policy/list/urlwhitelist/{id} | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**get_lists_by_id40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#get_lists_by_id40) | **GET** /template/policy/list/urlwhitelist/{id} | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**get_policy_lists37**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#get_policy_lists37) | **GET** /template/policy/list/urlwhitelist | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**get_policy_lists_with_info_tag40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#get_policy_lists_with_info_tag40) | **GET** /template/policy/list/urlwhitelist/filtered | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**preview_policy_list40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#preview_policy_list40) | **POST** /template/policy/list/urlwhitelist/preview | +*ConfigurationPolicyURLWhiteListBuilderApi* | [**preview_policy_list_by_id40**](docs/ConfigurationPolicyURLWhiteListBuilderApi.md#preview_policy_list_by_id40) | **GET** /template/policy/list/urlwhitelist/preview/{id} | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**create_policy_list38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#create_policy_list38) | **POST** /template/policy/list/umbrelladata | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**delete_policy_list38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#delete_policy_list38) | **DELETE** /template/policy/list/umbrelladata/{id} | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**delete_policy_lists_with_info_tag38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#delete_policy_lists_with_info_tag38) | **DELETE** /template/policy/list/umbrelladata | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**edit_policy_list38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#edit_policy_list38) | **PUT** /template/policy/list/umbrelladata/{id} | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**get_lists_by_id38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#get_lists_by_id38) | **GET** /template/policy/list/umbrelladata/{id} | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**get_policy_lists35**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#get_policy_lists35) | **GET** /template/policy/list/umbrelladata | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**get_policy_lists_with_info_tag38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#get_policy_lists_with_info_tag38) | **GET** /template/policy/list/umbrelladata/filtered | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**preview_policy_list38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#preview_policy_list38) | **POST** /template/policy/list/umbrelladata/preview | +*ConfigurationPolicyUmbrellaDataListBuilderApi* | [**preview_policy_list_by_id38**](docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md#preview_policy_list_by_id38) | **GET** /template/policy/list/umbrelladata/preview/{id} | +*ConfigurationPolicyVPNListBuilderApi* | [**create_policy_list41**](docs/ConfigurationPolicyVPNListBuilderApi.md#create_policy_list41) | **POST** /template/policy/list/vpn | +*ConfigurationPolicyVPNListBuilderApi* | [**delete_policy_list41**](docs/ConfigurationPolicyVPNListBuilderApi.md#delete_policy_list41) | **DELETE** /template/policy/list/vpn/{id} | +*ConfigurationPolicyVPNListBuilderApi* | [**delete_policy_lists_with_info_tag41**](docs/ConfigurationPolicyVPNListBuilderApi.md#delete_policy_lists_with_info_tag41) | **DELETE** /template/policy/list/vpn | +*ConfigurationPolicyVPNListBuilderApi* | [**edit_policy_list41**](docs/ConfigurationPolicyVPNListBuilderApi.md#edit_policy_list41) | **PUT** /template/policy/list/vpn/{id} | +*ConfigurationPolicyVPNListBuilderApi* | [**get_lists_by_id41**](docs/ConfigurationPolicyVPNListBuilderApi.md#get_lists_by_id41) | **GET** /template/policy/list/vpn/{id} | +*ConfigurationPolicyVPNListBuilderApi* | [**get_policy_lists38**](docs/ConfigurationPolicyVPNListBuilderApi.md#get_policy_lists38) | **GET** /template/policy/list/vpn | +*ConfigurationPolicyVPNListBuilderApi* | [**get_policy_lists_with_info_tag41**](docs/ConfigurationPolicyVPNListBuilderApi.md#get_policy_lists_with_info_tag41) | **GET** /template/policy/list/vpn/filtered | +*ConfigurationPolicyVPNListBuilderApi* | [**preview_policy_list41**](docs/ConfigurationPolicyVPNListBuilderApi.md#preview_policy_list41) | **POST** /template/policy/list/vpn/preview | +*ConfigurationPolicyVPNListBuilderApi* | [**preview_policy_list_by_id41**](docs/ConfigurationPolicyVPNListBuilderApi.md#preview_policy_list_by_id41) | **GET** /template/policy/list/vpn/preview/{id} | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**create_policy_definition6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#create_policy_definition6) | **POST** /template/policy/definition/vpnmembershipgroup | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**delete_policy_definition6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#delete_policy_definition6) | **DELETE** /template/policy/definition/vpnmembershipgroup/{id} | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**edit_multiple_policy_definition6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#edit_multiple_policy_definition6) | **PUT** /template/policy/definition/vpnmembershipgroup/multiple/{id} | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**edit_policy_definition6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#edit_policy_definition6) | **PUT** /template/policy/definition/vpnmembershipgroup/{id} | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**get_definitions6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#get_definitions6) | **GET** /template/policy/definition/vpnmembershipgroup | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**get_policy_definition6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#get_policy_definition6) | **GET** /template/policy/definition/vpnmembershipgroup/{id} | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**preview_policy_definition6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#preview_policy_definition6) | **POST** /template/policy/definition/vpnmembershipgroup/preview | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**preview_policy_definition_by_id6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#preview_policy_definition_by_id6) | **GET** /template/policy/definition/vpnmembershipgroup/preview/{id} | +*ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi* | [**save_policy_definition_in_bulk6**](docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#save_policy_definition_in_bulk6) | **PUT** /template/policy/definition/vpnmembershipgroup/bulk | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**create_policy_definition2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#create_policy_definition2) | **POST** /template/policy/definition/vpnqosmap | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**delete_policy_definition2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#delete_policy_definition2) | **DELETE** /template/policy/definition/vpnqosmap/{id} | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**edit_multiple_policy_definition2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#edit_multiple_policy_definition2) | **PUT** /template/policy/definition/vpnqosmap/multiple/{id} | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**edit_policy_definition2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#edit_policy_definition2) | **PUT** /template/policy/definition/vpnqosmap/{id} | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**get_definitions2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#get_definitions2) | **GET** /template/policy/definition/vpnqosmap | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**get_policy_definition2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#get_policy_definition2) | **GET** /template/policy/definition/vpnqosmap/{id} | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**preview_policy_definition2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#preview_policy_definition2) | **POST** /template/policy/definition/vpnqosmap/preview | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**preview_policy_definition_by_id2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#preview_policy_definition_by_id2) | **GET** /template/policy/definition/vpnqosmap/preview/{id} | +*ConfigurationPolicyVPNQosMapDefinitionBuilderApi* | [**save_policy_definition_in_bulk2**](docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#save_policy_definition_in_bulk2) | **PUT** /template/policy/definition/vpnqosmap/bulk | +*ConfigurationPolicyVoiceAssemblerApi* | [**preview2**](docs/ConfigurationPolicyVoiceAssemblerApi.md#preview2) | **POST** /template/policy/assembly/voice | +*ConfigurationPolicyVoiceAssemblerApi* | [**preview_by_id2**](docs/ConfigurationPolicyVoiceAssemblerApi.md#preview_by_id2) | **GET** /template/policy/assembly/voice/{id} | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**create_policy_definition7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#create_policy_definition7) | **POST** /template/policy/definition/zonebasedfw | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**delete_policy_definition7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#delete_policy_definition7) | **DELETE** /template/policy/definition/zonebasedfw/{id} | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**edit_multiple_policy_definition7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#edit_multiple_policy_definition7) | **PUT** /template/policy/definition/zonebasedfw/multiple/{id} | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**edit_policy_definition7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#edit_policy_definition7) | **PUT** /template/policy/definition/zonebasedfw/{id} | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**get_definitions7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#get_definitions7) | **GET** /template/policy/definition/zonebasedfw | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**get_policy_definition7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#get_policy_definition7) | **GET** /template/policy/definition/zonebasedfw/{id} | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**preview_policy_definition7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#preview_policy_definition7) | **POST** /template/policy/definition/zonebasedfw/preview | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**preview_policy_definition_by_id7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#preview_policy_definition_by_id7) | **GET** /template/policy/definition/zonebasedfw/preview/{id} | +*ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi* | [**save_policy_definition_in_bulk7**](docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#save_policy_definition_in_bulk7) | **PUT** /template/policy/definition/zonebasedfw/bulk | +*ConfigurationPolicyZoneListBuilderApi* | [**create_policy_list42**](docs/ConfigurationPolicyZoneListBuilderApi.md#create_policy_list42) | **POST** /template/policy/list/zone | +*ConfigurationPolicyZoneListBuilderApi* | [**delete_policy_list42**](docs/ConfigurationPolicyZoneListBuilderApi.md#delete_policy_list42) | **DELETE** /template/policy/list/zone/{id} | +*ConfigurationPolicyZoneListBuilderApi* | [**delete_policy_lists_with_info_tag42**](docs/ConfigurationPolicyZoneListBuilderApi.md#delete_policy_lists_with_info_tag42) | **DELETE** /template/policy/list/zone | +*ConfigurationPolicyZoneListBuilderApi* | [**edit_policy_list42**](docs/ConfigurationPolicyZoneListBuilderApi.md#edit_policy_list42) | **PUT** /template/policy/list/zone/{id} | +*ConfigurationPolicyZoneListBuilderApi* | [**get_lists_by_id42**](docs/ConfigurationPolicyZoneListBuilderApi.md#get_lists_by_id42) | **GET** /template/policy/list/zone/{id} | +*ConfigurationPolicyZoneListBuilderApi* | [**get_policy_lists39**](docs/ConfigurationPolicyZoneListBuilderApi.md#get_policy_lists39) | **GET** /template/policy/list/zone | +*ConfigurationPolicyZoneListBuilderApi* | [**get_policy_lists_with_info_tag42**](docs/ConfigurationPolicyZoneListBuilderApi.md#get_policy_lists_with_info_tag42) | **GET** /template/policy/list/zone/filtered | +*ConfigurationPolicyZoneListBuilderApi* | [**preview_policy_list42**](docs/ConfigurationPolicyZoneListBuilderApi.md#preview_policy_list42) | **POST** /template/policy/list/zone/preview | +*ConfigurationPolicyZoneListBuilderApi* | [**preview_policy_list_by_id42**](docs/ConfigurationPolicyZoneListBuilderApi.md#preview_policy_list_by_id42) | **GET** /template/policy/list/zone/preview/{id} | +*ConfigurationPolicyVEdgeAssemblerApi* | [**preview1**](docs/ConfigurationPolicyVEdgeAssemblerApi.md#preview1) | **POST** /template/policy/assembly/vedge | +*ConfigurationPolicyVEdgeAssemblerApi* | [**preview_by_id1**](docs/ConfigurationPolicyVEdgeAssemblerApi.md#preview_by_id1) | **GET** /template/policy/assembly/vedge/{id} | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**create_policy_definition24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#create_policy_definition24) | **POST** /template/policy/definition/vedgeroute | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**delete_policy_definition24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#delete_policy_definition24) | **DELETE** /template/policy/definition/vedgeroute/{id} | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**edit_multiple_policy_definition24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#edit_multiple_policy_definition24) | **PUT** /template/policy/definition/vedgeroute/multiple/{id} | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**edit_policy_definition24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#edit_policy_definition24) | **PUT** /template/policy/definition/vedgeroute/{id} | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**get_definitions24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#get_definitions24) | **GET** /template/policy/definition/vedgeroute | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**get_policy_definition24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#get_policy_definition24) | **GET** /template/policy/definition/vedgeroute/{id} | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**preview_policy_definition24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#preview_policy_definition24) | **POST** /template/policy/definition/vedgeroute/preview | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**preview_policy_definition_by_id24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#preview_policy_definition_by_id24) | **GET** /template/policy/definition/vedgeroute/preview/{id} | +*ConfigurationPolicyVEdgeRouteDefinitionBuilderApi* | [**save_policy_definition_in_bulk24**](docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#save_policy_definition_in_bulk24) | **PUT** /template/policy/definition/vedgeroute/bulk | +*ConfigurationPolicyVSmartAssemblerApi* | [**preview3**](docs/ConfigurationPolicyVSmartAssemblerApi.md#preview3) | **POST** /template/policy/assembly/vsmart | +*ConfigurationPolicyVSmartAssemblerApi* | [**preview_by_id3**](docs/ConfigurationPolicyVSmartAssemblerApi.md#preview_by_id3) | **GET** /template/policy/assembly/vsmart/{id} | +*ConfigurationPreUpgradeCheckStatusApi* | [**update_pre_upgrade_check_status**](docs/ConfigurationPreUpgradeCheckStatusApi.md#update_pre_upgrade_check_status) | **PUT** /device/action/status/preupgrade/check | +*ConfigurationPreferredColorGroupListBuilderApi* | [**create_policy_list28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#create_policy_list28) | **POST** /template/policy/list/preferredcolorgroup | +*ConfigurationPreferredColorGroupListBuilderApi* | [**delete_policy_list28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#delete_policy_list28) | **DELETE** /template/policy/list/preferredcolorgroup/{id} | +*ConfigurationPreferredColorGroupListBuilderApi* | [**delete_policy_lists_with_info_tag28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#delete_policy_lists_with_info_tag28) | **DELETE** /template/policy/list/preferredcolorgroup | +*ConfigurationPreferredColorGroupListBuilderApi* | [**edit_policy_list28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#edit_policy_list28) | **PUT** /template/policy/list/preferredcolorgroup/{id} | +*ConfigurationPreferredColorGroupListBuilderApi* | [**get_lists_by_id28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#get_lists_by_id28) | **GET** /template/policy/list/preferredcolorgroup/{id} | +*ConfigurationPreferredColorGroupListBuilderApi* | [**get_policy_lists25**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#get_policy_lists25) | **GET** /template/policy/list/preferredcolorgroup | +*ConfigurationPreferredColorGroupListBuilderApi* | [**get_policy_lists_with_info_tag28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#get_policy_lists_with_info_tag28) | **GET** /template/policy/list/preferredcolorgroup/filtered | +*ConfigurationPreferredColorGroupListBuilderApi* | [**preview_policy_list28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#preview_policy_list28) | **POST** /template/policy/list/preferredcolorgroup/preview | +*ConfigurationPreferredColorGroupListBuilderApi* | [**preview_policy_list_by_id28**](docs/ConfigurationPreferredColorGroupListBuilderApi.md#preview_policy_list_by_id28) | **GET** /template/policy/list/preferredcolorgroup/preview/{id} | +*ConfigurationQuickConnectApi* | [**submit_day0_config**](docs/ConfigurationQuickConnectApi.md#submit_day0_config) | **POST** /template/config/quickConnect/submitDevices | +*ConfigurationRuleSetDefinitionApi* | [**create_policy_definition20**](docs/ConfigurationRuleSetDefinitionApi.md#create_policy_definition20) | **POST** /template/policy/definition/ruleset | +*ConfigurationRuleSetDefinitionApi* | [**delete_policy_definition20**](docs/ConfigurationRuleSetDefinitionApi.md#delete_policy_definition20) | **DELETE** /template/policy/definition/ruleset/{id} | +*ConfigurationRuleSetDefinitionApi* | [**edit_multiple_policy_definition20**](docs/ConfigurationRuleSetDefinitionApi.md#edit_multiple_policy_definition20) | **PUT** /template/policy/definition/ruleset/multiple/{id} | +*ConfigurationRuleSetDefinitionApi* | [**edit_policy_definition20**](docs/ConfigurationRuleSetDefinitionApi.md#edit_policy_definition20) | **PUT** /template/policy/definition/ruleset/{id} | +*ConfigurationRuleSetDefinitionApi* | [**get_definitions20**](docs/ConfigurationRuleSetDefinitionApi.md#get_definitions20) | **GET** /template/policy/definition/ruleset | +*ConfigurationRuleSetDefinitionApi* | [**get_policy_definition20**](docs/ConfigurationRuleSetDefinitionApi.md#get_policy_definition20) | **GET** /template/policy/definition/ruleset/{id} | +*ConfigurationRuleSetDefinitionApi* | [**preview_policy_definition20**](docs/ConfigurationRuleSetDefinitionApi.md#preview_policy_definition20) | **POST** /template/policy/definition/ruleset/preview | +*ConfigurationRuleSetDefinitionApi* | [**preview_policy_definition_by_id20**](docs/ConfigurationRuleSetDefinitionApi.md#preview_policy_definition_by_id20) | **GET** /template/policy/definition/ruleset/preview/{id} | +*ConfigurationRuleSetDefinitionApi* | [**save_policy_definition_in_bulk20**](docs/ConfigurationRuleSetDefinitionApi.md#save_policy_definition_in_bulk20) | **PUT** /template/policy/definition/ruleset/bulk | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**create_policy_definition3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#create_policy_definition3) | **POST** /template/policy/definition/ssldecryption | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**delete_policy_definition3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#delete_policy_definition3) | **DELETE** /template/policy/definition/ssldecryption/{id} | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**edit_multiple_policy_definition3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#edit_multiple_policy_definition3) | **PUT** /template/policy/definition/ssldecryption/multiple/{id} | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**edit_policy_definition3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#edit_policy_definition3) | **PUT** /template/policy/definition/ssldecryption/{id} | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**get_definitions3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#get_definitions3) | **GET** /template/policy/definition/ssldecryption | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**get_policy_definition3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#get_policy_definition3) | **GET** /template/policy/definition/ssldecryption/{id} | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**preview_policy_definition3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#preview_policy_definition3) | **POST** /template/policy/definition/ssldecryption/preview | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**preview_policy_definition_by_id3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#preview_policy_definition_by_id3) | **GET** /template/policy/definition/ssldecryption/preview/{id} | +*ConfigurationSSLDecryptionPolicyDefinitionBuilderApi* | [**save_policy_definition_in_bulk3**](docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#save_policy_definition_in_bulk3) | **PUT** /template/policy/definition/ssldecryption/bulk | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**create_policy_definition22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#create_policy_definition22) | **POST** /template/policy/definition/sslutdprofile | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**delete_policy_definition22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#delete_policy_definition22) | **DELETE** /template/policy/definition/sslutdprofile/{id} | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**edit_multiple_policy_definition22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#edit_multiple_policy_definition22) | **PUT** /template/policy/definition/sslutdprofile/multiple/{id} | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**edit_policy_definition22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#edit_policy_definition22) | **PUT** /template/policy/definition/sslutdprofile/{id} | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**get_definitions22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#get_definitions22) | **GET** /template/policy/definition/sslutdprofile | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**get_policy_definition22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#get_policy_definition22) | **GET** /template/policy/definition/sslutdprofile/{id} | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**preview_policy_definition22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#preview_policy_definition22) | **POST** /template/policy/definition/sslutdprofile/preview | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**preview_policy_definition_by_id22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#preview_policy_definition_by_id22) | **GET** /template/policy/definition/sslutdprofile/preview/{id} | +*ConfigurationSSLDecryptionUTDProfileDefinitionApi* | [**save_policy_definition_in_bulk22**](docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#save_policy_definition_in_bulk22) | **PUT** /template/policy/definition/sslutdprofile/bulk | +*ConfigurationSecureInternetGatewayTunnelsApi* | [**get_sig_tunnel_list1**](docs/ConfigurationSecureInternetGatewayTunnelsApi.md#get_sig_tunnel_list1) | **GET** /template/cloudx/sig_tunnels | +*ConfigurationSecurityGroupDefinitionApi* | [**create_policy_definition21**](docs/ConfigurationSecurityGroupDefinitionApi.md#create_policy_definition21) | **POST** /template/policy/definition/securitygroup | +*ConfigurationSecurityGroupDefinitionApi* | [**delete_policy_definition21**](docs/ConfigurationSecurityGroupDefinitionApi.md#delete_policy_definition21) | **DELETE** /template/policy/definition/securitygroup/{id} | +*ConfigurationSecurityGroupDefinitionApi* | [**edit_multiple_policy_definition21**](docs/ConfigurationSecurityGroupDefinitionApi.md#edit_multiple_policy_definition21) | **PUT** /template/policy/definition/securitygroup/multiple/{id} | +*ConfigurationSecurityGroupDefinitionApi* | [**edit_policy_definition21**](docs/ConfigurationSecurityGroupDefinitionApi.md#edit_policy_definition21) | **PUT** /template/policy/definition/securitygroup/{id} | +*ConfigurationSecurityGroupDefinitionApi* | [**get_definitions21**](docs/ConfigurationSecurityGroupDefinitionApi.md#get_definitions21) | **GET** /template/policy/definition/securitygroup | +*ConfigurationSecurityGroupDefinitionApi* | [**get_policy_definition21**](docs/ConfigurationSecurityGroupDefinitionApi.md#get_policy_definition21) | **GET** /template/policy/definition/securitygroup/{id} | +*ConfigurationSecurityGroupDefinitionApi* | [**preview_policy_definition21**](docs/ConfigurationSecurityGroupDefinitionApi.md#preview_policy_definition21) | **POST** /template/policy/definition/securitygroup/preview | +*ConfigurationSecurityGroupDefinitionApi* | [**preview_policy_definition_by_id21**](docs/ConfigurationSecurityGroupDefinitionApi.md#preview_policy_definition_by_id21) | **GET** /template/policy/definition/securitygroup/preview/{id} | +*ConfigurationSecurityGroupDefinitionApi* | [**save_policy_definition_in_bulk21**](docs/ConfigurationSecurityGroupDefinitionApi.md#save_policy_definition_in_bulk21) | **PUT** /template/policy/definition/securitygroup/bulk | +*ConfigurationSecurityTemplatePolicyApi* | [**create_security_template**](docs/ConfigurationSecurityTemplatePolicyApi.md#create_security_template) | **POST** /template/policy/security | +*ConfigurationSecurityTemplatePolicyApi* | [**delete_security_template**](docs/ConfigurationSecurityTemplatePolicyApi.md#delete_security_template) | **DELETE** /template/policy/security/{policyId} | +*ConfigurationSecurityTemplatePolicyApi* | [**edit_security_template**](docs/ConfigurationSecurityTemplatePolicyApi.md#edit_security_template) | **PUT** /template/policy/security/{policyId} | +*ConfigurationSecurityTemplatePolicyApi* | [**edit_template_with_lenient_lock**](docs/ConfigurationSecurityTemplatePolicyApi.md#edit_template_with_lenient_lock) | **PUT** /template/policy/security/staging/{policyId} | +*ConfigurationSecurityTemplatePolicyApi* | [**generate_security_policy_summary**](docs/ConfigurationSecurityTemplatePolicyApi.md#generate_security_policy_summary) | **GET** /template/policy/security/summary | +*ConfigurationSecurityTemplatePolicyApi* | [**generate_security_template_list**](docs/ConfigurationSecurityTemplatePolicyApi.md#generate_security_template_list) | **GET** /template/policy/security | +*ConfigurationSecurityTemplatePolicyApi* | [**get_device_list_by_id**](docs/ConfigurationSecurityTemplatePolicyApi.md#get_device_list_by_id) | **GET** /template/policy/security/devices/{policyId} | +*ConfigurationSecurityTemplatePolicyApi* | [**get_security_policy_device_list**](docs/ConfigurationSecurityTemplatePolicyApi.md#get_security_policy_device_list) | **GET** /template/policy/security/devices | +*ConfigurationSecurityTemplatePolicyApi* | [**get_security_template**](docs/ConfigurationSecurityTemplatePolicyApi.md#get_security_template) | **GET** /template/policy/security/definition/{policyId} | +*ConfigurationSecurityTemplatePolicyApi* | [**get_security_templates_for_device**](docs/ConfigurationSecurityTemplatePolicyApi.md#get_security_templates_for_device) | **GET** /template/policy/security/{deviceModel} | +*ConfigurationSegmentsApi* | [**create_segment**](docs/ConfigurationSegmentsApi.md#create_segment) | **POST** /segment | +*ConfigurationSegmentsApi* | [**delete_segment**](docs/ConfigurationSegmentsApi.md#delete_segment) | **DELETE** /segment/{id} | +*ConfigurationSegmentsApi* | [**edit_segment**](docs/ConfigurationSegmentsApi.md#edit_segment) | **PUT** /segment/{id} | +*ConfigurationSegmentsApi* | [**get_segment**](docs/ConfigurationSegmentsApi.md#get_segment) | **GET** /segment/{id} | +*ConfigurationSegmentsApi* | [**get_segments**](docs/ConfigurationSegmentsApi.md#get_segments) | **GET** /segment | +*ConfigurationSettingsApi* | [**create_analytics_data_file**](docs/ConfigurationSettingsApi.md#create_analytics_data_file) | **POST** /settings/configuration/analytics/dca | +*ConfigurationSettingsApi* | [**edit_cert_configuration**](docs/ConfigurationSettingsApi.md#edit_cert_configuration) | **PUT** /settings/configuration/certificate/{settingType} | +*ConfigurationSettingsApi* | [**edit_configuration**](docs/ConfigurationSettingsApi.md#edit_configuration) | **PUT** /settings/configuration/{settingType} | +*ConfigurationSettingsApi* | [**get_banner**](docs/ConfigurationSettingsApi.md#get_banner) | **GET** /settings/banner | +*ConfigurationSettingsApi* | [**get_cert_configuration**](docs/ConfigurationSettingsApi.md#get_cert_configuration) | **GET** /settings/configuration/certificate/{settingType} | +*ConfigurationSettingsApi* | [**get_configuration_by_setting_type**](docs/ConfigurationSettingsApi.md#get_configuration_by_setting_type) | **GET** /settings/configuration/{settingType} | +*ConfigurationSettingsApi* | [**get_google_map_key**](docs/ConfigurationSettingsApi.md#get_google_map_key) | **GET** /settings/configuration/googleMapKey | +*ConfigurationSettingsApi* | [**get_maintenance_window**](docs/ConfigurationSettingsApi.md#get_maintenance_window) | **GET** /settings/configuration/maintenanceWindow | +*ConfigurationSettingsApi* | [**get_password_policy**](docs/ConfigurationSettingsApi.md#get_password_policy) | **GET** /settings/passwordPolicy | +*ConfigurationSettingsApi* | [**get_session_timout**](docs/ConfigurationSettingsApi.md#get_session_timout) | **GET** /settings/clientSessionTimeout | +*ConfigurationSettingsApi* | [**new_cert_configuration**](docs/ConfigurationSettingsApi.md#new_cert_configuration) | **POST** /settings/configuration/certificate/{settingType} | +*ConfigurationSettingsApi* | [**new_configuration**](docs/ConfigurationSettingsApi.md#new_configuration) | **POST** /settings/configuration/{settingType} | +*ConfigurationSoftwareActionsApi* | [**add_remote_server**](docs/ConfigurationSoftwareActionsApi.md#add_remote_server) | **POST** /device/action/remote-server | +*ConfigurationSoftwareActionsApi* | [**create_image_url**](docs/ConfigurationSoftwareActionsApi.md#create_image_url) | **POST** /device/action/software | +*ConfigurationSoftwareActionsApi* | [**delete_image_url**](docs/ConfigurationSoftwareActionsApi.md#delete_image_url) | **DELETE** /device/action/software/{versionId} | +*ConfigurationSoftwareActionsApi* | [**delete_remote_server**](docs/ConfigurationSoftwareActionsApi.md#delete_remote_server) | **DELETE** /device/action/remote-server/{id} | +*ConfigurationSoftwareActionsApi* | [**edit_image_remote_server**](docs/ConfigurationSoftwareActionsApi.md#edit_image_remote_server) | **PUT** /device/action/software/remoteserver/{versionId} | +*ConfigurationSoftwareActionsApi* | [**find_software_images**](docs/ConfigurationSoftwareActionsApi.md#find_software_images) | **GET** /device/action/software | +*ConfigurationSoftwareActionsApi* | [**find_software_images_with_filters**](docs/ConfigurationSoftwareActionsApi.md#find_software_images_with_filters) | **GET** /device/action/software/images | +*ConfigurationSoftwareActionsApi* | [**find_software_version**](docs/ConfigurationSoftwareActionsApi.md#find_software_version) | **GET** /device/action/software/version | +*ConfigurationSoftwareActionsApi* | [**find_v_edge_software_version**](docs/ConfigurationSoftwareActionsApi.md#find_v_edge_software_version) | **GET** /device/action/software/vedge/version | +*ConfigurationSoftwareActionsApi* | [**find_ztp_software_version**](docs/ConfigurationSoftwareActionsApi.md#find_ztp_software_version) | **GET** /device/action/software/ztp/version | +*ConfigurationSoftwareActionsApi* | [**get_image_properties**](docs/ConfigurationSoftwareActionsApi.md#get_image_properties) | **GET** /device/action/software/imageProperties/{versionId} | +*ConfigurationSoftwareActionsApi* | [**get_image_remote_server**](docs/ConfigurationSoftwareActionsApi.md#get_image_remote_server) | **GET** /device/action/software/remoteserver/{versionId} | +*ConfigurationSoftwareActionsApi* | [**get_pnf_properties**](docs/ConfigurationSoftwareActionsApi.md#get_pnf_properties) | **GET** /device/action/software/pnfproperties/{pnfType} | +*ConfigurationSoftwareActionsApi* | [**get_remote_server_by_id**](docs/ConfigurationSoftwareActionsApi.md#get_remote_server_by_id) | **GET** /device/action/remote-server/{id} | +*ConfigurationSoftwareActionsApi* | [**get_remote_server_list**](docs/ConfigurationSoftwareActionsApi.md#get_remote_server_list) | **GET** /device/action/remote-server | +*ConfigurationSoftwareActionsApi* | [**get_vnf_properties**](docs/ConfigurationSoftwareActionsApi.md#get_vnf_properties) | **GET** /device/action/software/vnfproperties/{versionId} | +*ConfigurationSoftwareActionsApi* | [**update_image_url**](docs/ConfigurationSoftwareActionsApi.md#update_image_url) | **PUT** /device/action/software/{versionId} | +*ConfigurationSoftwareActionsApi* | [**update_remote_server**](docs/ConfigurationSoftwareActionsApi.md#update_remote_server) | **PUT** /device/action/remote-server/{id} | +*ConfigurationTemplateConfigurationApi* | [**generate_cli_mode_devices**](docs/ConfigurationTemplateConfigurationApi.md#generate_cli_mode_devices) | **GET** /template/config/device/mode/cli | +*ConfigurationTemplateConfigurationApi* | [**generatev_manage_mode_devices**](docs/ConfigurationTemplateConfigurationApi.md#generatev_manage_mode_devices) | **GET** /template/config/device/mode/vmanage | +*ConfigurationTemplateConfigurationApi* | [**get_attached_config**](docs/ConfigurationTemplateConfigurationApi.md#get_attached_config) | **GET** /template/config/attached/{deviceId} | +*ConfigurationTemplateConfigurationApi* | [**get_compatible_devices**](docs/ConfigurationTemplateConfigurationApi.md#get_compatible_devices) | **GET** /template/config/rmalist/{oldDeviceId} | +*ConfigurationTemplateConfigurationApi* | [**get_device_diff**](docs/ConfigurationTemplateConfigurationApi.md#get_device_diff) | **GET** /template/config/diff/{deviceId} | +*ConfigurationTemplateConfigurationApi* | [**get_running_config**](docs/ConfigurationTemplateConfigurationApi.md#get_running_config) | **GET** /template/config/running/{deviceId} | +*ConfigurationTemplateConfigurationApi* | [**get_vpn_for_device**](docs/ConfigurationTemplateConfigurationApi.md#get_vpn_for_device) | **GET** /template/config/vpn/{deviceId} | +*ConfigurationTemplateConfigurationApi* | [**rma_update**](docs/ConfigurationTemplateConfigurationApi.md#rma_update) | **PUT** /template/config/rmaupdate | +*ConfigurationTemplateConfigurationApi* | [**update_device_to_cli_mode**](docs/ConfigurationTemplateConfigurationApi.md#update_device_to_cli_mode) | **POST** /template/config/device/mode/cli | +*ConfigurationTemplateConfigurationApi* | [**upload_config**](docs/ConfigurationTemplateConfigurationApi.md#upload_config) | **PUT** /template/config/attach/{deviceId} | +*ConfigurationTemplateLockApi* | [**remove_lock**](docs/ConfigurationTemplateLockApi.md#remove_lock) | **DELETE** /template/lock/{processId} | +*ConfigurationTemplateLockApi* | [**update_lease_time**](docs/ConfigurationTemplateLockApi.md#update_lease_time) | **PUT** /template/lock/{processId} | +*ConfigurationTemplateMasterApi* | [**change_template_resource_group1**](docs/ConfigurationTemplateMasterApi.md#change_template_resource_group1) | **POST** /template/device/resource-group/{resourceGroupName}/{templateId} | +*ConfigurationTemplateMasterApi* | [**create_cli_template**](docs/ConfigurationTemplateMasterApi.md#create_cli_template) | **POST** /template/device/cli | +*ConfigurationTemplateMasterApi* | [**create_master_template**](docs/ConfigurationTemplateMasterApi.md#create_master_template) | **POST** /template/device/feature | +*ConfigurationTemplateMasterApi* | [**delete_master_template**](docs/ConfigurationTemplateMasterApi.md#delete_master_template) | **DELETE** /template/device/{templateId} | +*ConfigurationTemplateMasterApi* | [**edit_master_template**](docs/ConfigurationTemplateMasterApi.md#edit_master_template) | **PUT** /template/device/{templateId} | +*ConfigurationTemplateMasterApi* | [**generate_master_template_list**](docs/ConfigurationTemplateMasterApi.md#generate_master_template_list) | **GET** /template/device | +*ConfigurationTemplateMasterApi* | [**generate_template_for_migration**](docs/ConfigurationTemplateMasterApi.md#generate_template_for_migration) | **GET** /template/device/migration | +*ConfigurationTemplateMasterApi* | [**get_master_template_definition**](docs/ConfigurationTemplateMasterApi.md#get_master_template_definition) | **GET** /template/device/object/{templateId} | +*ConfigurationTemplateMasterApi* | [**get_out_of_sync_devices**](docs/ConfigurationTemplateMasterApi.md#get_out_of_sync_devices) | **GET** /template/device/syncstatus/{templateId} | +*ConfigurationTemplateMasterApi* | [**get_out_of_sync_templates**](docs/ConfigurationTemplateMasterApi.md#get_out_of_sync_templates) | **GET** /template/device/syncstatus | +*ConfigurationTemplateMasterApi* | [**is_migration_required**](docs/ConfigurationTemplateMasterApi.md#is_migration_required) | **GET** /template/device/is_migration_required | +*ConfigurationTemplateMasterApi* | [**migrate_templates**](docs/ConfigurationTemplateMasterApi.md#migrate_templates) | **POST** /template/device/migration | +*ConfigurationTemplateMasterApi* | [**migration_info**](docs/ConfigurationTemplateMasterApi.md#migration_info) | **GET** /template/device/migration_info | +*ConfigurationTopologyApi* | [**create_device_topology**](docs/ConfigurationTopologyApi.md#create_device_topology) | **GET** /topology/device | +*ConfigurationTopologyApi* | [**create_full_topology**](docs/ConfigurationTopologyApi.md#create_full_topology) | **GET** /topology | +*ConfigurationTopologyApi* | [**create_physical_topology**](docs/ConfigurationTopologyApi.md#create_physical_topology) | **GET** /topology/physical | +*ConfigurationTopologyApi* | [**get_site_topology**](docs/ConfigurationTopologyApi.md#get_site_topology) | **GET** /topology/device/site/{siteId} | +*ConfigurationTopologyApi* | [**get_site_topology_monitor_data**](docs/ConfigurationTopologyApi.md#get_site_topology_monitor_data) | **GET** /topology/monitor/site/{siteId} | +*ConfigurationVoiceTemplatePolicyApi* | [**create_voice_template**](docs/ConfigurationVoiceTemplatePolicyApi.md#create_voice_template) | **POST** /template/policy/voice | +*ConfigurationVoiceTemplatePolicyApi* | [**delete_voice_template**](docs/ConfigurationVoiceTemplatePolicyApi.md#delete_voice_template) | **DELETE** /template/policy/voice/{policyId} | +*ConfigurationVoiceTemplatePolicyApi* | [**edit_voice_template**](docs/ConfigurationVoiceTemplatePolicyApi.md#edit_voice_template) | **PUT** /template/policy/voice/{policyId} | +*ConfigurationVoiceTemplatePolicyApi* | [**generate_voice_policy_summary**](docs/ConfigurationVoiceTemplatePolicyApi.md#generate_voice_policy_summary) | **GET** /template/policy/voice/summary | +*ConfigurationVoiceTemplatePolicyApi* | [**generate_voice_template_list**](docs/ConfigurationVoiceTemplatePolicyApi.md#generate_voice_template_list) | **GET** /template/policy/voice | +*ConfigurationVoiceTemplatePolicyApi* | [**get_device_list_by_policy_id**](docs/ConfigurationVoiceTemplatePolicyApi.md#get_device_list_by_policy_id) | **GET** /template/policy/voice/devices/{policyId} | +*ConfigurationVoiceTemplatePolicyApi* | [**get_template_by_id**](docs/ConfigurationVoiceTemplatePolicyApi.md#get_template_by_id) | **GET** /template/policy/voice/definition/{policyId} | +*ConfigurationVoiceTemplatePolicyApi* | [**get_voice_policy_device_list**](docs/ConfigurationVoiceTemplatePolicyApi.md#get_voice_policy_device_list) | **GET** /template/policy/voice/devices | +*ConfigurationVoiceTemplatePolicyApi* | [**get_voice_templates_for_device**](docs/ConfigurationVoiceTemplatePolicyApi.md#get_voice_templates_for_device) | **GET** /template/policy/voice/{deviceModel} | +*ConfigurationVEdgeTemplatePolicyApi* | [**change_policy_resource_group**](docs/ConfigurationVEdgeTemplatePolicyApi.md#change_policy_resource_group) | **POST** /template/policy/vedge/{resourceGroupName}/{policyId} | +*ConfigurationVEdgeTemplatePolicyApi* | [**create_v_edge_template**](docs/ConfigurationVEdgeTemplatePolicyApi.md#create_v_edge_template) | **POST** /template/policy/vedge | +*ConfigurationVEdgeTemplatePolicyApi* | [**delete_v_edge_template**](docs/ConfigurationVEdgeTemplatePolicyApi.md#delete_v_edge_template) | **DELETE** /template/policy/vedge/{policyId} | +*ConfigurationVEdgeTemplatePolicyApi* | [**edit_v_edge_template**](docs/ConfigurationVEdgeTemplatePolicyApi.md#edit_v_edge_template) | **PUT** /template/policy/vedge/{policyId} | +*ConfigurationVEdgeTemplatePolicyApi* | [**generate_policy_template_list**](docs/ConfigurationVEdgeTemplatePolicyApi.md#generate_policy_template_list) | **GET** /template/policy/vedge | +*ConfigurationVEdgeTemplatePolicyApi* | [**get_device_list_by_policy**](docs/ConfigurationVEdgeTemplatePolicyApi.md#get_device_list_by_policy) | **GET** /template/policy/vedge/devices/{policyId} | +*ConfigurationVEdgeTemplatePolicyApi* | [**get_v_edge_policy_device_list**](docs/ConfigurationVEdgeTemplatePolicyApi.md#get_v_edge_policy_device_list) | **GET** /template/policy/vedge/devices | +*ConfigurationVEdgeTemplatePolicyApi* | [**get_v_edge_template**](docs/ConfigurationVEdgeTemplatePolicyApi.md#get_v_edge_template) | **GET** /template/policy/vedge/definition/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**activate_policy**](docs/ConfigurationVSmartTemplatePolicyApi.md#activate_policy) | **POST** /template/policy/vsmart/activate/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**activate_policy_for_cloud_services**](docs/ConfigurationVSmartTemplatePolicyApi.md#activate_policy_for_cloud_services) | **POST** /template/policy/vsmart/activate/central/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**check_v_smart_connectivity_status**](docs/ConfigurationVSmartTemplatePolicyApi.md#check_v_smart_connectivity_status) | **GET** /template/policy/vsmart/connectivity/status | +*ConfigurationVSmartTemplatePolicyApi* | [**create_v_smart_template**](docs/ConfigurationVSmartTemplatePolicyApi.md#create_v_smart_template) | **POST** /template/policy/vsmart | +*ConfigurationVSmartTemplatePolicyApi* | [**de_activate_policy**](docs/ConfigurationVSmartTemplatePolicyApi.md#de_activate_policy) | **POST** /template/policy/vsmart/deactivate/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**delete_v_smart_template**](docs/ConfigurationVSmartTemplatePolicyApi.md#delete_v_smart_template) | **DELETE** /template/policy/vsmart/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**edit_template_without_lock_checks**](docs/ConfigurationVSmartTemplatePolicyApi.md#edit_template_without_lock_checks) | **PUT** /template/policy/vsmart/central/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**edit_v_smart_template**](docs/ConfigurationVSmartTemplatePolicyApi.md#edit_v_smart_template) | **PUT** /template/policy/vsmart/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**generate_v_smart_policy_template_list**](docs/ConfigurationVSmartTemplatePolicyApi.md#generate_v_smart_policy_template_list) | **GET** /template/policy/vsmart | +*ConfigurationVSmartTemplatePolicyApi* | [**get_template_by_policy_id**](docs/ConfigurationVSmartTemplatePolicyApi.md#get_template_by_policy_id) | **GET** /template/policy/vsmart/definition/{policyId} | +*ConfigurationVSmartTemplatePolicyApi* | [**qosmos_nbar_migration_warning**](docs/ConfigurationVSmartTemplatePolicyApi.md#qosmos_nbar_migration_warning) | **GET** /template/policy/vsmart/qosmos_nbar_migration_warning | +*DataCollectionAgentApi* | [**create_dca_analytics_data_file**](docs/DataCollectionAgentApi.md#create_dca_analytics_data_file) | **POST** /dca/settings/configuration/{type}/dca | +*DataCollectionAgentApi* | [**create_stats**](docs/DataCollectionAgentApi.md#create_stats) | **PUT** /dca/analytics | +*DataCollectionAgentApi* | [**generate_alarm**](docs/DataCollectionAgentApi.md#generate_alarm) | **POST** /dca/cloudservices/alarm | +*DataCollectionAgentApi* | [**generate_dca_device_state_data**](docs/DataCollectionAgentApi.md#generate_dca_device_state_data) | **POST** /dca/data/device/state/{state_data_type} | +*DataCollectionAgentApi* | [**generate_dca_device_statistics_data**](docs/DataCollectionAgentApi.md#generate_dca_device_statistics_data) | **POST** /dca/data/device/statistics/{stats_data_type} | +*DataCollectionAgentApi* | [**get_access_token**](docs/DataCollectionAgentApi.md#get_access_token) | **GET** /dca/cloudservices/accesstoken | +*DataCollectionAgentApi* | [**get_all_stats_data_dca**](docs/DataCollectionAgentApi.md#get_all_stats_data_dca) | **POST** /dca/analytics/all | +*DataCollectionAgentApi* | [**get_cloud_services_configuration_dca**](docs/DataCollectionAgentApi.md#get_cloud_services_configuration_dca) | **GET** /dca/settings/configuration/cloudservices/dca | +*DataCollectionAgentApi* | [**get_crash_logs**](docs/DataCollectionAgentApi.md#get_crash_logs) | **POST** /dca/device/crashlog/details | +*DataCollectionAgentApi* | [**get_crash_logs_synced**](docs/DataCollectionAgentApi.md#get_crash_logs_synced) | **GET** /dca/device/crashlog/synced | +*DataCollectionAgentApi* | [**get_dca_attached_config_to_device**](docs/DataCollectionAgentApi.md#get_dca_attached_config_to_device) | **POST** /dca/template/device/config/attachedconfig | +*DataCollectionAgentApi* | [**get_dca_tenant_owners**](docs/DataCollectionAgentApi.md#get_dca_tenant_owners) | **GET** /dca/dcatenantowners | +*DataCollectionAgentApi* | [**get_devices_details_dca**](docs/DataCollectionAgentApi.md#get_devices_details_dca) | **POST** /dca/system/device | +*DataCollectionAgentApi* | [**get_id_token**](docs/DataCollectionAgentApi.md#get_id_token) | **GET** /dca/cloudservices/idtoken | +*DataCollectionAgentApi* | [**get_stats_db_index_status**](docs/DataCollectionAgentApi.md#get_stats_db_index_status) | **POST** /dca/statistics/settings/status | +*DataCollectionAgentApi* | [**get_telemetry_settings**](docs/DataCollectionAgentApi.md#get_telemetry_settings) | **GET** /dca/cloudservices/telemetry | +*DataCollectionAgentApi* | [**get_template_policy_definitions_dca**](docs/DataCollectionAgentApi.md#get_template_policy_definitions_dca) | **POST** /dca/template/policy/definition/approute | +*DataCollectionAgentApi* | [**get_vedge_template_list_dca**](docs/DataCollectionAgentApi.md#get_vedge_template_list_dca) | **POST** /dca/template/policy/vedge | +*DataCollectionAgentApi* | [**get_vpn_lists_dca**](docs/DataCollectionAgentApi.md#get_vpn_lists_dca) | **POST** /dca/template/policy/list/vpn | +*DataCollectionAgentApi* | [**get_vsmart_template_list_dca**](docs/DataCollectionAgentApi.md#get_vsmart_template_list_dca) | **POST** /dca/template/policy/vsmart | +*DataCollectionAgentApi* | [**list_all_devices_dca**](docs/DataCollectionAgentApi.md#list_all_devices_dca) | **POST** /dca/device | +*DataCollectionAgentApi* | [**store_access_token**](docs/DataCollectionAgentApi.md#store_access_token) | **POST** /dca/cloudservices/accesstoken | +*DataCollectionAgentApi* | [**store_id_token**](docs/DataCollectionAgentApi.md#store_id_token) | **POST** /dca/cloudservices/idtoken | +*DeploymentModeApi* | [**config_fedramp_mode**](docs/DeploymentModeApi.md#config_fedramp_mode) | **POST** /fedramp/status | +*DeploymentModeApi* | [**configure_dns_sec**](docs/DeploymentModeApi.md#configure_dns_sec) | **POST** /fedramp/dnssec/config | +*DeploymentModeApi* | [**configure_wazuh_client**](docs/DeploymentModeApi.md#configure_wazuh_client) | **POST** /fedramp/wazuh/config | +*DeploymentModeApi* | [**get_dns_sec_status**](docs/DeploymentModeApi.md#get_dns_sec_status) | **GET** /fedramp/dnssec/status | +*DeploymentModeApi* | [**get_wazuh_agent_status**](docs/DeploymentModeApi.md#get_wazuh_agent_status) | **GET** /fedramp/wazuh/status | +*DeploymentModeApi* | [**reques_dns_sec_actions**](docs/DeploymentModeApi.md#reques_dns_sec_actions) | **GET** /fedramp/dnssec/actions | +*DeploymentModeApi* | [**request_wazuh_actions**](docs/DeploymentModeApi.md#request_wazuh_actions) | **GET** /fedramp/wazuh/actions | +*DeviceMessagingApi* | [**create_device_vmanage_connection_list**](docs/DeviceMessagingApi.md#create_device_vmanage_connection_list) | **GET** /messaging/device/vmanage | +*DeviceNetworkApi* | [**get_network_issues_summary**](docs/DeviceNetworkApi.md#get_network_issues_summary) | **GET** /network/issues/summary | +*DeviceNetworkApi* | [**get_network_status_summary**](docs/DeviceNetworkApi.md#get_network_status_summary) | **GET** /network/status | +*DeviceNetworkApi* | [**get_reboot_count**](docs/DeviceNetworkApi.md#get_reboot_count) | **GET** /network/issues/rebootcount | +*DeviceNetworkApi* | [**get_vmanage_control_status**](docs/DeviceNetworkApi.md#get_vmanage_control_status) | **GET** /network/connectionssummary | +*HSECApi* | [**assign_slac**](docs/HSECApi.md#assign_slac) | **POST** /hsec/assignSlac | +*HSECApi* | [**device_summmary**](docs/HSECApi.md#device_summmary) | **GET** /hsec/devices | +*HSECApi* | [**device_summmary1**](docs/HSECApi.md#device_summmary1) | **GET** /hsec/devices/install | +*HSECApi* | [**download_slac_request_file**](docs/HSECApi.md#download_slac_request_file) | **POST** /hsec/download | +*HSECApi* | [**fetch_accounts1**](docs/HSECApi.md#fetch_accounts1) | **GET** /hsec/fetchaccounts | +*HSECApi* | [**upload_slac_file**](docs/HSECApi.md#upload_slac_file) | **POST** /hsec/uploadAuth | +*HSECLicenseApi* | [**hsecassign**](docs/HSECLicenseApi.md#hsecassign) | **POST** /hsec/assign | +*HsecActivateApi* | [**activate_hsec_licenses**](docs/HsecActivateApi.md#activate_hsec_licenses) | **POST** /hsec/activate | +*LocaleApi* | [**get_supported_locales**](docs/LocaleApi.md#get_supported_locales) | **GET** /localization/supportedLocales | +*MSLAApi* | [**get_all_template**](docs/MSLAApi.md#get_all_template) | **GET** /msla/template | +*MSLAApi* | [**get_license_and_device_count**](docs/MSLAApi.md#get_license_and_device_count) | **GET** /msla/monitoring/licensedDeviceCount | +*MSLAApi* | [**get_license_and_device_count1**](docs/MSLAApi.md#get_license_and_device_count1) | **GET** /msla/monitoring/licensedDistributionDetails | +*MSLAApi* | [**get_msla_devices**](docs/MSLAApi.md#get_msla_devices) | **GET** /msla/devices | +*MSLAApi* | [**get_packaging_distribution_details**](docs/MSLAApi.md#get_packaging_distribution_details) | **GET** /msla/monitoring/packagingDistributionDetails | +*MSLAApi* | [**get_subscriptions**](docs/MSLAApi.md#get_subscriptions) | **GET** /msla/va/License | +*MSLAApi* | [**get_subscriptions1**](docs/MSLAApi.md#get_subscriptions1) | **POST** /msla/template/licenses | +*MSLAApi* | [**sync_licenses2**](docs/MSLAApi.md#sync_licenses2) | **POST** /msla/licenses/sync | +*MonitoringARTApi* | [**get_aggregation_data_by_query3**](docs/MonitoringARTApi.md#get_aggregation_data_by_query3) | **GET** /statistics/art/aggregation | +*MonitoringARTApi* | [**get_count5**](docs/MonitoringARTApi.md#get_count5) | **GET** /statistics/art/doccount | +*MonitoringARTApi* | [**get_count_post5**](docs/MonitoringARTApi.md#get_count_post5) | **POST** /statistics/art/doccount | +*MonitoringARTApi* | [**get_post_aggregation_app_data_by_query3**](docs/MonitoringARTApi.md#get_post_aggregation_app_data_by_query3) | **POST** /statistics/art/app-agg/aggregation | +*MonitoringARTApi* | [**get_post_aggregation_data_by_query3**](docs/MonitoringARTApi.md#get_post_aggregation_data_by_query3) | **POST** /statistics/art/aggregation | +*MonitoringARTApi* | [**get_post_stat_bulk_raw_data3**](docs/MonitoringARTApi.md#get_post_stat_bulk_raw_data3) | **POST** /statistics/art/page | +*MonitoringARTApi* | [**get_stat_bulk_raw_data3**](docs/MonitoringARTApi.md#get_stat_bulk_raw_data3) | **GET** /statistics/art/page | +*MonitoringARTApi* | [**get_stat_data_fields5**](docs/MonitoringARTApi.md#get_stat_data_fields5) | **GET** /statistics/art/fields | +*MonitoringARTApi* | [**get_stat_data_raw_data3**](docs/MonitoringARTApi.md#get_stat_data_raw_data3) | **GET** /statistics/art | +*MonitoringARTApi* | [**get_stat_data_raw_data_as_csv3**](docs/MonitoringARTApi.md#get_stat_data_raw_data_as_csv3) | **GET** /statistics/art/csv | +*MonitoringARTApi* | [**get_stat_query_fields5**](docs/MonitoringARTApi.md#get_stat_query_fields5) | **GET** /statistics/art/query/fields | +*MonitoringARTApi* | [**get_stats_raw_data3**](docs/MonitoringARTApi.md#get_stats_raw_data3) | **POST** /statistics/art | +*MonitoringAlarmsDetailsApi* | [**clear_stale_alarm**](docs/MonitoringAlarmsDetailsApi.md#clear_stale_alarm) | **POST** /alarms/clear | +*MonitoringAlarmsDetailsApi* | [**correl_anti_entropy**](docs/MonitoringAlarmsDetailsApi.md#correl_anti_entropy) | **GET** /alarms/reset | +*MonitoringAlarmsDetailsApi* | [**create_alarm_query_config**](docs/MonitoringAlarmsDetailsApi.md#create_alarm_query_config) | **GET** /alarms/query/input | +*MonitoringAlarmsDetailsApi* | [**disable_enable_alarm**](docs/MonitoringAlarmsDetailsApi.md#disable_enable_alarm) | **POST** /alarms/disabled | +*MonitoringAlarmsDetailsApi* | [**dump_correlation_engine_data**](docs/MonitoringAlarmsDetailsApi.md#dump_correlation_engine_data) | **POST** /alarms/dump | +*MonitoringAlarmsDetailsApi* | [**enable_disable_link_state_alarm**](docs/MonitoringAlarmsDetailsApi.md#enable_disable_link_state_alarm) | **POST** /alarms/link-state-alarm | +*MonitoringAlarmsDetailsApi* | [**get_alarm_aggregation_data**](docs/MonitoringAlarmsDetailsApi.md#get_alarm_aggregation_data) | **GET** /alarms/aggregation | +*MonitoringAlarmsDetailsApi* | [**get_alarm_details**](docs/MonitoringAlarmsDetailsApi.md#get_alarm_details) | **GET** /alarms/uuid/{alarm_uuid} | +*MonitoringAlarmsDetailsApi* | [**get_alarm_severity_custom_histogram**](docs/MonitoringAlarmsDetailsApi.md#get_alarm_severity_custom_histogram) | **GET** /alarms/severity/summary | +*MonitoringAlarmsDetailsApi* | [**get_alarm_severity_mappings**](docs/MonitoringAlarmsDetailsApi.md#get_alarm_severity_mappings) | **GET** /alarms/severitymappings | +*MonitoringAlarmsDetailsApi* | [**get_alarm_types_as_key_value**](docs/MonitoringAlarmsDetailsApi.md#get_alarm_types_as_key_value) | **GET** /alarms/rulenamedisplay/keyvalue | +*MonitoringAlarmsDetailsApi* | [**get_alarms**](docs/MonitoringAlarmsDetailsApi.md#get_alarms) | **GET** /alarms | +*MonitoringAlarmsDetailsApi* | [**get_alarms_by_severity**](docs/MonitoringAlarmsDetailsApi.md#get_alarms_by_severity) | **GET** /alarms/severity | +*MonitoringAlarmsDetailsApi* | [**get_count1**](docs/MonitoringAlarmsDetailsApi.md#get_count1) | **GET** /alarms/doccount | +*MonitoringAlarmsDetailsApi* | [**get_count_post1**](docs/MonitoringAlarmsDetailsApi.md#get_count_post1) | **POST** /alarms/doccount | +*MonitoringAlarmsDetailsApi* | [**get_device_topic**](docs/MonitoringAlarmsDetailsApi.md#get_device_topic) | **GET** /alarms/topic | +*MonitoringAlarmsDetailsApi* | [**get_link_state_alarm_config**](docs/MonitoringAlarmsDetailsApi.md#get_link_state_alarm_config) | **GET** /alarms/link-state-alarm | +*MonitoringAlarmsDetailsApi* | [**get_master_manager_state**](docs/MonitoringAlarmsDetailsApi.md#get_master_manager_state) | **GET** /alarms/master | +*MonitoringAlarmsDetailsApi* | [**get_non_viewed_active_alarms_count**](docs/MonitoringAlarmsDetailsApi.md#get_non_viewed_active_alarms_count) | **GET** /alarms/count | +*MonitoringAlarmsDetailsApi* | [**get_non_viewed_alarms**](docs/MonitoringAlarmsDetailsApi.md#get_non_viewed_alarms) | **GET** /alarms/notviewed | +*MonitoringAlarmsDetailsApi* | [**get_post_alarm_aggregation_data**](docs/MonitoringAlarmsDetailsApi.md#get_post_alarm_aggregation_data) | **POST** /alarms/aggregation | +*MonitoringAlarmsDetailsApi* | [**get_post_stat_bulk_alarm_raw_data**](docs/MonitoringAlarmsDetailsApi.md#get_post_stat_bulk_alarm_raw_data) | **POST** /alarms/page | +*MonitoringAlarmsDetailsApi* | [**get_raw_alarm_data**](docs/MonitoringAlarmsDetailsApi.md#get_raw_alarm_data) | **POST** /alarms | +*MonitoringAlarmsDetailsApi* | [**get_stat_bulk_alarm_raw_data**](docs/MonitoringAlarmsDetailsApi.md#get_stat_bulk_alarm_raw_data) | **GET** /alarms/page | +*MonitoringAlarmsDetailsApi* | [**get_stat_data_fields1**](docs/MonitoringAlarmsDetailsApi.md#get_stat_data_fields1) | **GET** /alarms/fields | +*MonitoringAlarmsDetailsApi* | [**get_stat_query_fields1**](docs/MonitoringAlarmsDetailsApi.md#get_stat_query_fields1) | **GET** /alarms/query/fields | +*MonitoringAlarmsDetailsApi* | [**get_stats**](docs/MonitoringAlarmsDetailsApi.md#get_stats) | **GET** /alarms/stats | +*MonitoringAlarmsDetailsApi* | [**list_disabled_alarm**](docs/MonitoringAlarmsDetailsApi.md#list_disabled_alarm) | **GET** /alarms/disabled | +*MonitoringAlarmsDetailsApi* | [**mark_alarms_as_viewed**](docs/MonitoringAlarmsDetailsApi.md#mark_alarms_as_viewed) | **POST** /alarms/markviewed | +*MonitoringAlarmsDetailsApi* | [**mark_all_alarms_as_viewed**](docs/MonitoringAlarmsDetailsApi.md#mark_all_alarms_as_viewed) | **POST** /alarms/markallasviewed | +*MonitoringAlarmsDetailsApi* | [**restart_correlation_engine**](docs/MonitoringAlarmsDetailsApi.md#restart_correlation_engine) | **GET** /alarms/restart | +*MonitoringAlarmsDetailsApi* | [**set_periodic_purge_timer**](docs/MonitoringAlarmsDetailsApi.md#set_periodic_purge_timer) | **GET** /alarms/purgefrequency | +*MonitoringAlarmsDetailsApi* | [**start_tracking**](docs/MonitoringAlarmsDetailsApi.md#start_tracking) | **POST** /alarms/starttracking/{testName} | +*MonitoringAlarmsDetailsApi* | [**stop_tracking**](docs/MonitoringAlarmsDetailsApi.md#stop_tracking) | **POST** /alarms/stoptracking/{testName} | +*MonitoringAlarmsNotificationApi* | [**create_notification_rule**](docs/MonitoringAlarmsNotificationApi.md#create_notification_rule) | **POST** /notifications/rule | +*MonitoringAlarmsNotificationApi* | [**delete_notification_rule**](docs/MonitoringAlarmsNotificationApi.md#delete_notification_rule) | **DELETE** /notifications/rules | +*MonitoringAlarmsNotificationApi* | [**get_notification_rule**](docs/MonitoringAlarmsNotificationApi.md#get_notification_rule) | **GET** /notifications/rules | +*MonitoringAlarmsNotificationApi* | [**update_notification_rule**](docs/MonitoringAlarmsNotificationApi.md#update_notification_rule) | **PUT** /notifications/rule | +*MonitoringAppHostingApi* | [**get_aggregation_data_by_query**](docs/MonitoringAppHostingApi.md#get_aggregation_data_by_query) | **GET** /statistics/apphostinginterface/aggregation | +*MonitoringAppHostingApi* | [**get_aggregation_data_by_query1**](docs/MonitoringAppHostingApi.md#get_aggregation_data_by_query1) | **GET** /statistics/apphosting/aggregation | +*MonitoringAppHostingApi* | [**get_count2**](docs/MonitoringAppHostingApi.md#get_count2) | **GET** /statistics/apphostinginterface/doccount | +*MonitoringAppHostingApi* | [**get_count3**](docs/MonitoringAppHostingApi.md#get_count3) | **GET** /statistics/apphosting/doccount | +*MonitoringAppHostingApi* | [**get_count_post2**](docs/MonitoringAppHostingApi.md#get_count_post2) | **POST** /statistics/apphostinginterface/doccount | +*MonitoringAppHostingApi* | [**get_count_post3**](docs/MonitoringAppHostingApi.md#get_count_post3) | **POST** /statistics/apphosting/doccount | +*MonitoringAppHostingApi* | [**get_post_aggregation_app_data_by_query**](docs/MonitoringAppHostingApi.md#get_post_aggregation_app_data_by_query) | **POST** /statistics/apphostinginterface/app-agg/aggregation | +*MonitoringAppHostingApi* | [**get_post_aggregation_app_data_by_query1**](docs/MonitoringAppHostingApi.md#get_post_aggregation_app_data_by_query1) | **POST** /statistics/apphosting/app-agg/aggregation | +*MonitoringAppHostingApi* | [**get_post_aggregation_data_by_query**](docs/MonitoringAppHostingApi.md#get_post_aggregation_data_by_query) | **POST** /statistics/apphostinginterface/aggregation | +*MonitoringAppHostingApi* | [**get_post_aggregation_data_by_query1**](docs/MonitoringAppHostingApi.md#get_post_aggregation_data_by_query1) | **POST** /statistics/apphosting/aggregation | +*MonitoringAppHostingApi* | [**get_post_stat_bulk_raw_data**](docs/MonitoringAppHostingApi.md#get_post_stat_bulk_raw_data) | **POST** /statistics/apphostinginterface/page | +*MonitoringAppHostingApi* | [**get_post_stat_bulk_raw_data1**](docs/MonitoringAppHostingApi.md#get_post_stat_bulk_raw_data1) | **POST** /statistics/apphosting/page | +*MonitoringAppHostingApi* | [**get_stat_bulk_raw_data**](docs/MonitoringAppHostingApi.md#get_stat_bulk_raw_data) | **GET** /statistics/apphostinginterface/page | +*MonitoringAppHostingApi* | [**get_stat_bulk_raw_data1**](docs/MonitoringAppHostingApi.md#get_stat_bulk_raw_data1) | **GET** /statistics/apphosting/page | +*MonitoringAppHostingApi* | [**get_stat_data_fields2**](docs/MonitoringAppHostingApi.md#get_stat_data_fields2) | **GET** /statistics/apphostinginterface/fields | +*MonitoringAppHostingApi* | [**get_stat_data_fields3**](docs/MonitoringAppHostingApi.md#get_stat_data_fields3) | **GET** /statistics/apphosting/fields | +*MonitoringAppHostingApi* | [**get_stat_data_raw_data**](docs/MonitoringAppHostingApi.md#get_stat_data_raw_data) | **GET** /statistics/apphostinginterface | +*MonitoringAppHostingApi* | [**get_stat_data_raw_data1**](docs/MonitoringAppHostingApi.md#get_stat_data_raw_data1) | **GET** /statistics/apphosting | +*MonitoringAppHostingApi* | [**get_stat_data_raw_data_as_csv**](docs/MonitoringAppHostingApi.md#get_stat_data_raw_data_as_csv) | **GET** /statistics/apphostinginterface/csv | +*MonitoringAppHostingApi* | [**get_stat_data_raw_data_as_csv1**](docs/MonitoringAppHostingApi.md#get_stat_data_raw_data_as_csv1) | **GET** /statistics/apphosting/csv | +*MonitoringAppHostingApi* | [**get_stat_query_fields2**](docs/MonitoringAppHostingApi.md#get_stat_query_fields2) | **GET** /statistics/apphostinginterface/query/fields | +*MonitoringAppHostingApi* | [**get_stat_query_fields3**](docs/MonitoringAppHostingApi.md#get_stat_query_fields3) | **GET** /statistics/apphosting/query/fields | +*MonitoringAppHostingApi* | [**get_stats_raw_data**](docs/MonitoringAppHostingApi.md#get_stats_raw_data) | **POST** /statistics/apphostinginterface | +*MonitoringAppHostingApi* | [**get_stats_raw_data1**](docs/MonitoringAppHostingApi.md#get_stats_raw_data1) | **POST** /statistics/apphosting | +*MonitoringApplicationAwareRoutingApi* | [**get_aggregation_data_app_route**](docs/MonitoringApplicationAwareRoutingApi.md#get_aggregation_data_app_route) | **POST** /statistics/approute/fec/aggregation | +*MonitoringApplicationAwareRoutingApi* | [**get_aggregation_data_by_query2**](docs/MonitoringApplicationAwareRoutingApi.md#get_aggregation_data_by_query2) | **GET** /statistics/approute/aggregation | +*MonitoringApplicationAwareRoutingApi* | [**get_approute_grid_stat**](docs/MonitoringApplicationAwareRoutingApi.md#get_approute_grid_stat) | **GET** /statistics/approute/device/tunnel/summary | +*MonitoringApplicationAwareRoutingApi* | [**get_count4**](docs/MonitoringApplicationAwareRoutingApi.md#get_count4) | **GET** /statistics/approute/doccount | +*MonitoringApplicationAwareRoutingApi* | [**get_count_post4**](docs/MonitoringApplicationAwareRoutingApi.md#get_count_post4) | **POST** /statistics/approute/doccount | +*MonitoringApplicationAwareRoutingApi* | [**get_post_aggregation_app_data_by_query2**](docs/MonitoringApplicationAwareRoutingApi.md#get_post_aggregation_app_data_by_query2) | **POST** /statistics/approute/app-agg/aggregation | +*MonitoringApplicationAwareRoutingApi* | [**get_post_aggregation_data_by_query2**](docs/MonitoringApplicationAwareRoutingApi.md#get_post_aggregation_data_by_query2) | **POST** /statistics/approute/aggregation | +*MonitoringApplicationAwareRoutingApi* | [**get_post_stat_bulk_raw_data2**](docs/MonitoringApplicationAwareRoutingApi.md#get_post_stat_bulk_raw_data2) | **POST** /statistics/approute/page | +*MonitoringApplicationAwareRoutingApi* | [**get_stat_bulk_raw_data2**](docs/MonitoringApplicationAwareRoutingApi.md#get_stat_bulk_raw_data2) | **GET** /statistics/approute/page | +*MonitoringApplicationAwareRoutingApi* | [**get_stat_data_fields4**](docs/MonitoringApplicationAwareRoutingApi.md#get_stat_data_fields4) | **GET** /statistics/approute/fields | +*MonitoringApplicationAwareRoutingApi* | [**get_stat_data_raw_data2**](docs/MonitoringApplicationAwareRoutingApi.md#get_stat_data_raw_data2) | **GET** /statistics/approute | +*MonitoringApplicationAwareRoutingApi* | [**get_stat_data_raw_data_as_csv2**](docs/MonitoringApplicationAwareRoutingApi.md#get_stat_data_raw_data_as_csv2) | **GET** /statistics/approute/csv | +*MonitoringApplicationAwareRoutingApi* | [**get_stat_query_fields4**](docs/MonitoringApplicationAwareRoutingApi.md#get_stat_query_fields4) | **GET** /statistics/approute/query/fields | +*MonitoringApplicationAwareRoutingApi* | [**get_stats_raw_data2**](docs/MonitoringApplicationAwareRoutingApi.md#get_stats_raw_data2) | **POST** /statistics/approute | +*MonitoringApplicationAwareRoutingApi* | [**get_transport_health**](docs/MonitoringApplicationAwareRoutingApi.md#get_transport_health) | **GET** /statistics/approute/transport/{type} | +*MonitoringApplicationAwareRoutingApi* | [**get_transport_health_summary**](docs/MonitoringApplicationAwareRoutingApi.md#get_transport_health_summary) | **GET** /statistics/approute/transport/summary/{type} | +*MonitoringApplicationAwareRoutingApi* | [**get_tunnel**](docs/MonitoringApplicationAwareRoutingApi.md#get_tunnel) | **GET** /statistics/approute/device/tunnels | +*MonitoringApplicationAwareRoutingApi* | [**get_tunnel_chart**](docs/MonitoringApplicationAwareRoutingApi.md#get_tunnel_chart) | **GET** /statistics/approute/tunnel/{type}/summary | +*MonitoringApplicationAwareRoutingApi* | [**get_tunnels**](docs/MonitoringApplicationAwareRoutingApi.md#get_tunnels) | **GET** /statistics/approute/tunnels/{type} | +*MonitoringApplicationAwareRoutingApi* | [**get_tunnels_health**](docs/MonitoringApplicationAwareRoutingApi.md#get_tunnels_health) | **GET** /statistics/approute/tunnels/health/{type} | +*MonitoringApplicationAwareRoutingApi* | [**get_tunnels_summary**](docs/MonitoringApplicationAwareRoutingApi.md#get_tunnels_summary) | **GET** /statistics/approute/tunnels/summary/{type} | +*MonitoringApplicationAwareRoutingStatisticsApi* | [**get_transport_health**](docs/MonitoringApplicationAwareRoutingStatisticsApi.md#get_transport_health) | **GET** /statistics/approute/transport/{type} | +*MonitoringApplicationAwareRoutingStatisticsApi* | [**get_transport_health_summary**](docs/MonitoringApplicationAwareRoutingStatisticsApi.md#get_transport_health_summary) | **GET** /statistics/approute/transport/summary/{type} | +*MonitoringBFDApi* | [**get_aggregation_data_by_query4**](docs/MonitoringBFDApi.md#get_aggregation_data_by_query4) | **GET** /statistics/bfd/aggregation | +*MonitoringBFDApi* | [**get_count6**](docs/MonitoringBFDApi.md#get_count6) | **GET** /statistics/bfd/doccount | +*MonitoringBFDApi* | [**get_count_post6**](docs/MonitoringBFDApi.md#get_count_post6) | **POST** /statistics/bfd/doccount | +*MonitoringBFDApi* | [**get_post_aggregation_app_data_by_query4**](docs/MonitoringBFDApi.md#get_post_aggregation_app_data_by_query4) | **POST** /statistics/bfd/app-agg/aggregation | +*MonitoringBFDApi* | [**get_post_aggregation_data_by_query4**](docs/MonitoringBFDApi.md#get_post_aggregation_data_by_query4) | **POST** /statistics/bfd/aggregation | +*MonitoringBFDApi* | [**get_post_stat_bulk_raw_data4**](docs/MonitoringBFDApi.md#get_post_stat_bulk_raw_data4) | **POST** /statistics/bfd/page | +*MonitoringBFDApi* | [**get_stat_bulk_raw_data4**](docs/MonitoringBFDApi.md#get_stat_bulk_raw_data4) | **GET** /statistics/bfd/page | +*MonitoringBFDApi* | [**get_stat_data_fields6**](docs/MonitoringBFDApi.md#get_stat_data_fields6) | **GET** /statistics/bfd/fields | +*MonitoringBFDApi* | [**get_stat_data_raw_data4**](docs/MonitoringBFDApi.md#get_stat_data_raw_data4) | **GET** /statistics/bfd | +*MonitoringBFDApi* | [**get_stat_data_raw_data_as_csv4**](docs/MonitoringBFDApi.md#get_stat_data_raw_data_as_csv4) | **GET** /statistics/bfd/csv | +*MonitoringBFDApi* | [**get_stat_query_fields6**](docs/MonitoringBFDApi.md#get_stat_query_fields6) | **GET** /statistics/bfd/query/fields | +*MonitoringBFDApi* | [**get_stats_raw_data4**](docs/MonitoringBFDApi.md#get_stats_raw_data4) | **POST** /statistics/bfd | +*MonitoringBridgeApi* | [**get_aggregation_data_by_query5**](docs/MonitoringBridgeApi.md#get_aggregation_data_by_query5) | **GET** /statistics/bridgeinterface/aggregation | +*MonitoringBridgeApi* | [**get_aggregation_data_by_query6**](docs/MonitoringBridgeApi.md#get_aggregation_data_by_query6) | **GET** /statistics/bridgemac/aggregation | +*MonitoringBridgeApi* | [**get_count7**](docs/MonitoringBridgeApi.md#get_count7) | **GET** /statistics/bridgeinterface/doccount | +*MonitoringBridgeApi* | [**get_count8**](docs/MonitoringBridgeApi.md#get_count8) | **GET** /statistics/bridgemac/doccount | +*MonitoringBridgeApi* | [**get_count_post7**](docs/MonitoringBridgeApi.md#get_count_post7) | **POST** /statistics/bridgeinterface/doccount | +*MonitoringBridgeApi* | [**get_count_post8**](docs/MonitoringBridgeApi.md#get_count_post8) | **POST** /statistics/bridgemac/doccount | +*MonitoringBridgeApi* | [**get_post_aggregation_app_data_by_query5**](docs/MonitoringBridgeApi.md#get_post_aggregation_app_data_by_query5) | **POST** /statistics/bridgeinterface/app-agg/aggregation | +*MonitoringBridgeApi* | [**get_post_aggregation_app_data_by_query6**](docs/MonitoringBridgeApi.md#get_post_aggregation_app_data_by_query6) | **POST** /statistics/bridgemac/app-agg/aggregation | +*MonitoringBridgeApi* | [**get_post_aggregation_data_by_query5**](docs/MonitoringBridgeApi.md#get_post_aggregation_data_by_query5) | **POST** /statistics/bridgeinterface/aggregation | +*MonitoringBridgeApi* | [**get_post_aggregation_data_by_query6**](docs/MonitoringBridgeApi.md#get_post_aggregation_data_by_query6) | **POST** /statistics/bridgemac/aggregation | +*MonitoringBridgeApi* | [**get_post_stat_bulk_raw_data5**](docs/MonitoringBridgeApi.md#get_post_stat_bulk_raw_data5) | **POST** /statistics/bridgeinterface/page | +*MonitoringBridgeApi* | [**get_post_stat_bulk_raw_data6**](docs/MonitoringBridgeApi.md#get_post_stat_bulk_raw_data6) | **POST** /statistics/bridgemac/page | +*MonitoringBridgeApi* | [**get_stat_bulk_raw_data5**](docs/MonitoringBridgeApi.md#get_stat_bulk_raw_data5) | **GET** /statistics/bridgeinterface/page | +*MonitoringBridgeApi* | [**get_stat_bulk_raw_data6**](docs/MonitoringBridgeApi.md#get_stat_bulk_raw_data6) | **GET** /statistics/bridgemac/page | +*MonitoringBridgeApi* | [**get_stat_data_fields7**](docs/MonitoringBridgeApi.md#get_stat_data_fields7) | **GET** /statistics/bridgeinterface/fields | +*MonitoringBridgeApi* | [**get_stat_data_fields8**](docs/MonitoringBridgeApi.md#get_stat_data_fields8) | **GET** /statistics/bridgemac/fields | +*MonitoringBridgeApi* | [**get_stat_data_raw_data5**](docs/MonitoringBridgeApi.md#get_stat_data_raw_data5) | **GET** /statistics/bridgeinterface | +*MonitoringBridgeApi* | [**get_stat_data_raw_data6**](docs/MonitoringBridgeApi.md#get_stat_data_raw_data6) | **GET** /statistics/bridgemac | +*MonitoringBridgeApi* | [**get_stat_data_raw_data_as_csv5**](docs/MonitoringBridgeApi.md#get_stat_data_raw_data_as_csv5) | **GET** /statistics/bridgeinterface/csv | +*MonitoringBridgeApi* | [**get_stat_data_raw_data_as_csv6**](docs/MonitoringBridgeApi.md#get_stat_data_raw_data_as_csv6) | **GET** /statistics/bridgemac/csv | +*MonitoringBridgeApi* | [**get_stat_query_fields7**](docs/MonitoringBridgeApi.md#get_stat_query_fields7) | **GET** /statistics/bridgeinterface/query/fields | +*MonitoringBridgeApi* | [**get_stat_query_fields8**](docs/MonitoringBridgeApi.md#get_stat_query_fields8) | **GET** /statistics/bridgemac/query/fields | +*MonitoringBridgeApi* | [**get_stats_raw_data5**](docs/MonitoringBridgeApi.md#get_stats_raw_data5) | **POST** /statistics/bridgeinterface | +*MonitoringBridgeApi* | [**get_stats_raw_data6**](docs/MonitoringBridgeApi.md#get_stats_raw_data6) | **POST** /statistics/bridgemac | +*MonitoringCellularEIOLTEApi* | [**get_aggregation_data_by_query7**](docs/MonitoringCellularEIOLTEApi.md#get_aggregation_data_by_query7) | **GET** /statistics/eiolte/aggregation | +*MonitoringCellularEIOLTEApi* | [**get_count9**](docs/MonitoringCellularEIOLTEApi.md#get_count9) | **GET** /statistics/eiolte/doccount | +*MonitoringCellularEIOLTEApi* | [**get_count_post9**](docs/MonitoringCellularEIOLTEApi.md#get_count_post9) | **POST** /statistics/eiolte/doccount | +*MonitoringCellularEIOLTEApi* | [**get_post_aggregation_app_data_by_query7**](docs/MonitoringCellularEIOLTEApi.md#get_post_aggregation_app_data_by_query7) | **POST** /statistics/eiolte/app-agg/aggregation | +*MonitoringCellularEIOLTEApi* | [**get_post_aggregation_data_by_query7**](docs/MonitoringCellularEIOLTEApi.md#get_post_aggregation_data_by_query7) | **POST** /statistics/eiolte/aggregation | +*MonitoringCellularEIOLTEApi* | [**get_post_stat_bulk_raw_data7**](docs/MonitoringCellularEIOLTEApi.md#get_post_stat_bulk_raw_data7) | **POST** /statistics/eiolte/page | +*MonitoringCellularEIOLTEApi* | [**get_stat_bulk_raw_data7**](docs/MonitoringCellularEIOLTEApi.md#get_stat_bulk_raw_data7) | **GET** /statistics/eiolte/page | +*MonitoringCellularEIOLTEApi* | [**get_stat_data_fields9**](docs/MonitoringCellularEIOLTEApi.md#get_stat_data_fields9) | **GET** /statistics/eiolte/fields | +*MonitoringCellularEIOLTEApi* | [**get_stat_data_raw_data7**](docs/MonitoringCellularEIOLTEApi.md#get_stat_data_raw_data7) | **GET** /statistics/eiolte | +*MonitoringCellularEIOLTEApi* | [**get_stat_data_raw_data_as_csv7**](docs/MonitoringCellularEIOLTEApi.md#get_stat_data_raw_data_as_csv7) | **GET** /statistics/eiolte/csv | +*MonitoringCellularEIOLTEApi* | [**get_stat_query_fields9**](docs/MonitoringCellularEIOLTEApi.md#get_stat_query_fields9) | **GET** /statistics/eiolte/query/fields | +*MonitoringCellularEIOLTEApi* | [**get_stats_raw_data7**](docs/MonitoringCellularEIOLTEApi.md#get_stats_raw_data7) | **POST** /statistics/eiolte | +*MonitoringCflowdApi* | [**create_cflow_collector_list**](docs/MonitoringCflowdApi.md#create_cflow_collector_list) | **GET** /device/cflowd/flows | +*MonitoringCflowdApi* | [**create_cflowd_collector_list**](docs/MonitoringCflowdApi.md#create_cflowd_collector_list) | **GET** /device/cflowd/collector | +*MonitoringCflowdApi* | [**create_cflowd_flows_count_list**](docs/MonitoringCflowdApi.md#create_cflowd_flows_count_list) | **GET** /device/cflowd/flows-count | +*MonitoringCflowdApi* | [**create_cflowd_statistics**](docs/MonitoringCflowdApi.md#create_cflowd_statistics) | **GET** /device/cflowd/statistics | +*MonitoringCflowdApi* | [**create_cflowd_template**](docs/MonitoringCflowdApi.md#create_cflowd_template) | **GET** /device/cflowd/template | +*MonitoringCflowdApi* | [**create_flow_device_data**](docs/MonitoringCflowdApi.md#create_flow_device_data) | **GET** /statistics/cflowd/device/applications | +*MonitoringCflowdApi* | [**create_flows_grid**](docs/MonitoringCflowdApi.md#create_flows_grid) | **GET** /statistics/cflowd/applications | +*MonitoringCflowdApi* | [**create_flowssummary**](docs/MonitoringCflowdApi.md#create_flowssummary) | **GET** /statistics/cflowd/applications/summary | +*MonitoringCflowdApi* | [**get_aggregation_data_by_query8**](docs/MonitoringCflowdApi.md#get_aggregation_data_by_query8) | **GET** /statistics/cflowd/aggregation | +*MonitoringCflowdApi* | [**get_cflowd_dpi_device_field_json**](docs/MonitoringCflowdApi.md#get_cflowd_dpi_device_field_json) | **GET** /device/cflowd/application/fields | +*MonitoringCflowdApi* | [**get_cflowd_dpi_field_json**](docs/MonitoringCflowdApi.md#get_cflowd_dpi_field_json) | **GET** /device/cflowd/device/fields | +*MonitoringCflowdApi* | [**get_count10**](docs/MonitoringCflowdApi.md#get_count10) | **GET** /statistics/cflowd/doccount | +*MonitoringCflowdApi* | [**get_count_post10**](docs/MonitoringCflowdApi.md#get_count_post10) | **POST** /statistics/cflowd/doccount | +*MonitoringCflowdApi* | [**get_fn_f_cache_stats**](docs/MonitoringCflowdApi.md#get_fn_f_cache_stats) | **GET** /device/cflowd/fnf/cache-stats | +*MonitoringCflowdApi* | [**get_fn_f_export_client_stats**](docs/MonitoringCflowdApi.md#get_fn_f_export_client_stats) | **GET** /device/cflowd/fnf/export-client-stats | +*MonitoringCflowdApi* | [**get_fn_f_export_stats**](docs/MonitoringCflowdApi.md#get_fn_f_export_stats) | **GET** /device/cflowd/fnf/export-stats | +*MonitoringCflowdApi* | [**get_fn_f_monitor_stats**](docs/MonitoringCflowdApi.md#get_fn_f_monitor_stats) | **GET** /device/cflowd/fnf/monitor-stats | +*MonitoringCflowdApi* | [**get_fnf**](docs/MonitoringCflowdApi.md#get_fnf) | **GET** /device/cflowd/fnf/flow-monitor | +*MonitoringCflowdApi* | [**get_post_aggregation_app_data_by_query8**](docs/MonitoringCflowdApi.md#get_post_aggregation_app_data_by_query8) | **POST** /statistics/cflowd/app-agg/aggregation | +*MonitoringCflowdApi* | [**get_post_aggregation_data_by_query8**](docs/MonitoringCflowdApi.md#get_post_aggregation_data_by_query8) | **POST** /statistics/cflowd/aggregation | +*MonitoringCflowdApi* | [**get_post_stat_bulk_raw_data8**](docs/MonitoringCflowdApi.md#get_post_stat_bulk_raw_data8) | **POST** /statistics/cflowd/page | +*MonitoringCflowdApi* | [**get_stat_bulk_raw_data8**](docs/MonitoringCflowdApi.md#get_stat_bulk_raw_data8) | **GET** /statistics/cflowd/page | +*MonitoringCflowdApi* | [**get_stat_data_fields10**](docs/MonitoringCflowdApi.md#get_stat_data_fields10) | **GET** /statistics/cflowd/fields | +*MonitoringCflowdApi* | [**get_stat_data_raw_data8**](docs/MonitoringCflowdApi.md#get_stat_data_raw_data8) | **GET** /statistics/cflowd | +*MonitoringCflowdApi* | [**get_stat_data_raw_data_as_csv8**](docs/MonitoringCflowdApi.md#get_stat_data_raw_data_as_csv8) | **GET** /statistics/cflowd/csv | +*MonitoringCflowdApi* | [**get_stat_query_fields10**](docs/MonitoringCflowdApi.md#get_stat_query_fields10) | **GET** /statistics/cflowd/query/fields | +*MonitoringCflowdApi* | [**get_stats_raw_data8**](docs/MonitoringCflowdApi.md#get_stats_raw_data8) | **POST** /statistics/cflowd | +*MonitoringCloudExpressApi* | [**get_aggregation_data_by_query9**](docs/MonitoringCloudExpressApi.md#get_aggregation_data_by_query9) | **GET** /statistics/cloudx/aggregation | +*MonitoringCloudExpressApi* | [**get_count11**](docs/MonitoringCloudExpressApi.md#get_count11) | **GET** /statistics/cloudx/doccount | +*MonitoringCloudExpressApi* | [**get_count_post11**](docs/MonitoringCloudExpressApi.md#get_count_post11) | **POST** /statistics/cloudx/doccount | +*MonitoringCloudExpressApi* | [**get_post_aggregation_app_data_by_query9**](docs/MonitoringCloudExpressApi.md#get_post_aggregation_app_data_by_query9) | **POST** /statistics/cloudx/app-agg/aggregation | +*MonitoringCloudExpressApi* | [**get_post_aggregation_data_by_query9**](docs/MonitoringCloudExpressApi.md#get_post_aggregation_data_by_query9) | **POST** /statistics/cloudx/aggregation | +*MonitoringCloudExpressApi* | [**get_post_stat_bulk_raw_data9**](docs/MonitoringCloudExpressApi.md#get_post_stat_bulk_raw_data9) | **POST** /statistics/cloudx/page | +*MonitoringCloudExpressApi* | [**get_stat_bulk_raw_data9**](docs/MonitoringCloudExpressApi.md#get_stat_bulk_raw_data9) | **GET** /statistics/cloudx/page | +*MonitoringCloudExpressApi* | [**get_stat_data_fields11**](docs/MonitoringCloudExpressApi.md#get_stat_data_fields11) | **GET** /statistics/cloudx/fields | +*MonitoringCloudExpressApi* | [**get_stat_data_raw_data9**](docs/MonitoringCloudExpressApi.md#get_stat_data_raw_data9) | **GET** /statistics/cloudx | +*MonitoringCloudExpressApi* | [**get_stat_data_raw_data_as_csv9**](docs/MonitoringCloudExpressApi.md#get_stat_data_raw_data_as_csv9) | **GET** /statistics/cloudx/csv | +*MonitoringCloudExpressApi* | [**get_stat_query_fields11**](docs/MonitoringCloudExpressApi.md#get_stat_query_fields11) | **GET** /statistics/cloudx/query/fields | +*MonitoringCloudExpressApi* | [**get_stats_raw_data9**](docs/MonitoringCloudExpressApi.md#get_stats_raw_data9) | **POST** /statistics/cloudx | +*MonitoringDPIApi* | [**create_dpi_device_and_app_details**](docs/MonitoringDPIApi.md#create_dpi_device_and_app_details) | **GET** /statistics/dpi/device/details/applications | +*MonitoringDPIApi* | [**create_dpi_device_grid_data**](docs/MonitoringDPIApi.md#create_dpi_device_grid_data) | **GET** /statistics/dpi/device/applications | +*MonitoringDPIApi* | [**create_dpi_flows_grid_list_query**](docs/MonitoringDPIApi.md#create_dpi_flows_grid_list_query) | **GET** /statistics/dpi/applications | +*MonitoringDPIApi* | [**create_dpi_summary**](docs/MonitoringDPIApi.md#create_dpi_summary) | **GET** /statistics/dpi/applications/summary | +*MonitoringDPIApi* | [**get_aggregation_data_by_query12**](docs/MonitoringDPIApi.md#get_aggregation_data_by_query12) | **GET** /statistics/dpi/aggregation | +*MonitoringDPIApi* | [**get_aggregation_data_dpi**](docs/MonitoringDPIApi.md#get_aggregation_data_dpi) | **POST** /statistics/dpi/recovery/aggregation | +*MonitoringDPIApi* | [**get_aggregation_data_for_packet_dup**](docs/MonitoringDPIApi.md#get_aggregation_data_for_packet_dup) | **POST** /statistics/dpi/pktdup/aggregation | +*MonitoringDPIApi* | [**get_count14**](docs/MonitoringDPIApi.md#get_count14) | **GET** /statistics/dpi/doccount | +*MonitoringDPIApi* | [**get_count_post14**](docs/MonitoringDPIApi.md#get_count_post14) | **POST** /statistics/dpi/doccount | +*MonitoringDPIApi* | [**get_post_aggregation_app_data**](docs/MonitoringDPIApi.md#get_post_aggregation_app_data) | **POST** /statistics/dpi/agg-app/aggregation | +*MonitoringDPIApi* | [**get_post_aggregation_data**](docs/MonitoringDPIApi.md#get_post_aggregation_data) | **POST** /statistics/dpi/aggregation | +*MonitoringDPIApi* | [**get_post_stat_bulk_raw_data12**](docs/MonitoringDPIApi.md#get_post_stat_bulk_raw_data12) | **POST** /statistics/dpi/page | +*MonitoringDPIApi* | [**get_stat_bulk_raw_data12**](docs/MonitoringDPIApi.md#get_stat_bulk_raw_data12) | **GET** /statistics/dpi/page | +*MonitoringDPIApi* | [**get_stat_data_fields14**](docs/MonitoringDPIApi.md#get_stat_data_fields14) | **GET** /statistics/dpi/fields | +*MonitoringDPIApi* | [**get_stat_data_raw_data12**](docs/MonitoringDPIApi.md#get_stat_data_raw_data12) | **GET** /statistics/dpi | +*MonitoringDPIApi* | [**get_stat_data_raw_data_as_csv12**](docs/MonitoringDPIApi.md#get_stat_data_raw_data_as_csv12) | **GET** /statistics/dpi/csv | +*MonitoringDPIApi* | [**get_stat_query_fields14**](docs/MonitoringDPIApi.md#get_stat_query_fields14) | **GET** /statistics/dpi/query/fields | +*MonitoringDPIApi* | [**get_stats_raw_data12**](docs/MonitoringDPIApi.md#get_stats_raw_data12) | **POST** /statistics/dpi | +*MonitoringDPIApi* | [**get_unique_flow_count**](docs/MonitoringDPIApi.md#get_unique_flow_count) | **GET** /statistics/dpi/device/application/flowcount | +*MonitoringDPIOnDemandTroubleshootingApi* | [**create_queue_entry**](docs/MonitoringDPIOnDemandTroubleshootingApi.md#create_queue_entry) | **POST** /statistics/on-demand/queue | +*MonitoringDPIOnDemandTroubleshootingApi* | [**delete_queue_entry**](docs/MonitoringDPIOnDemandTroubleshootingApi.md#delete_queue_entry) | **DELETE** /statistics/on-demand/queue/{entryId} | +*MonitoringDPIOnDemandTroubleshootingApi* | [**get_queue_entries**](docs/MonitoringDPIOnDemandTroubleshootingApi.md#get_queue_entries) | **GET** /statistics/on-demand/queue | +*MonitoringDPIOnDemandTroubleshootingApi* | [**get_queue_properties**](docs/MonitoringDPIOnDemandTroubleshootingApi.md#get_queue_properties) | **GET** /statistics/on-demand/queue/properties | +*MonitoringDPIOnDemandTroubleshootingApi* | [**update_queue_entry**](docs/MonitoringDPIOnDemandTroubleshootingApi.md#update_queue_entry) | **PUT** /statistics/on-demand/queue/{entryId} | +*MonitoringDeviceDetailsApi* | [**add_tier**](docs/MonitoringDeviceDetailsApi.md#add_tier) | **POST** /device/tier | +*MonitoringDeviceDetailsApi* | [**delete_tier**](docs/MonitoringDeviceDetailsApi.md#delete_tier) | **DELETE** /device/tier/{tierName} | +*MonitoringDeviceDetailsApi* | [**enable_sdavcon_device**](docs/MonitoringDeviceDetailsApi.md#enable_sdavcon_device) | **POST** /device/enableSDAVC/{deviceIP}/{enable} | +*MonitoringDeviceDetailsApi* | [**generate_device_state_data**](docs/MonitoringDeviceDetailsApi.md#generate_device_state_data) | **GET** /data/device/state/{state_data_type} | +*MonitoringDeviceDetailsApi* | [**generate_device_state_data_fields**](docs/MonitoringDeviceDetailsApi.md#generate_device_state_data_fields) | **GET** /data/device/state/{state_data_type}/fields | +*MonitoringDeviceDetailsApi* | [**generate_device_state_data_with_query_string**](docs/MonitoringDeviceDetailsApi.md#generate_device_state_data_with_query_string) | **GET** /data/device/state/{state_data_type}/query | +*MonitoringDeviceDetailsApi* | [**get_all_device_status**](docs/MonitoringDeviceDetailsApi.md#get_all_device_status) | **GET** /device/status | +*MonitoringDeviceDetailsApi* | [**get_device_counters**](docs/MonitoringDeviceDetailsApi.md#get_device_counters) | **GET** /device/counters | +*MonitoringDeviceDetailsApi* | [**get_device_list_as_key_value**](docs/MonitoringDeviceDetailsApi.md#get_device_list_as_key_value) | **GET** /device/keyvalue | +*MonitoringDeviceDetailsApi* | [**get_device_models**](docs/MonitoringDeviceDetailsApi.md#get_device_models) | **GET** /device/models/{uuid} | +*MonitoringDeviceDetailsApi* | [**get_device_only_status**](docs/MonitoringDeviceDetailsApi.md#get_device_only_status) | **GET** /device/devicestatus | +*MonitoringDeviceDetailsApi* | [**get_device_running_config**](docs/MonitoringDeviceDetailsApi.md#get_device_running_config) | **GET** /device/config | +*MonitoringDeviceDetailsApi* | [**get_device_running_config_html**](docs/MonitoringDeviceDetailsApi.md#get_device_running_config_html) | **GET** /device/config/html | +*MonitoringDeviceDetailsApi* | [**get_device_tloc_status**](docs/MonitoringDeviceDetailsApi.md#get_device_tloc_status) | **GET** /device/tloc | +*MonitoringDeviceDetailsApi* | [**get_device_tloc_util**](docs/MonitoringDeviceDetailsApi.md#get_device_tloc_util) | **GET** /device/tlocutil | +*MonitoringDeviceDetailsApi* | [**get_device_tloc_util_details**](docs/MonitoringDeviceDetailsApi.md#get_device_tloc_util_details) | **GET** /device/tlocutil/detail | +*MonitoringDeviceDetailsApi* | [**get_hardware_health_details**](docs/MonitoringDeviceDetailsApi.md#get_hardware_health_details) | **GET** /device/hardwarehealth/detail | +*MonitoringDeviceDetailsApi* | [**get_hardware_health_summary**](docs/MonitoringDeviceDetailsApi.md#get_hardware_health_summary) | **GET** /device/hardwarehealth/summary | +*MonitoringDeviceDetailsApi* | [**get_stats_queues**](docs/MonitoringDeviceDetailsApi.md#get_stats_queues) | **GET** /device/stats | +*MonitoringDeviceDetailsApi* | [**get_sync_queues**](docs/MonitoringDeviceDetailsApi.md#get_sync_queues) | **GET** /device/queues | +*MonitoringDeviceDetailsApi* | [**get_tiers**](docs/MonitoringDeviceDetailsApi.md#get_tiers) | **GET** /device/tier | +*MonitoringDeviceDetailsApi* | [**get_unconfigured**](docs/MonitoringDeviceDetailsApi.md#get_unconfigured) | **GET** /device/unconfigured | +*MonitoringDeviceDetailsApi* | [**get_v_manage_system_ip**](docs/MonitoringDeviceDetailsApi.md#get_v_manage_system_ip) | **GET** /device/vmanage | +*MonitoringDeviceDetailsApi* | [**get_vedge_inventory**](docs/MonitoringDeviceDetailsApi.md#get_vedge_inventory) | **GET** /device/vedgeinventory/detail | +*MonitoringDeviceDetailsApi* | [**get_vedge_inventory_summary**](docs/MonitoringDeviceDetailsApi.md#get_vedge_inventory_summary) | **GET** /device/vedgeinventory/summary | +*MonitoringDeviceDetailsApi* | [**list_all_device_models**](docs/MonitoringDeviceDetailsApi.md#list_all_device_models) | **GET** /device/models | +*MonitoringDeviceDetailsApi* | [**list_all_devices**](docs/MonitoringDeviceDetailsApi.md#list_all_devices) | **GET** /device | +*MonitoringDeviceDetailsApi* | [**list_all_monitor_details_devices**](docs/MonitoringDeviceDetailsApi.md#list_all_monitor_details_devices) | **GET** /device/monitor | +*MonitoringDeviceDetailsApi* | [**list_currently_syncing_devices**](docs/MonitoringDeviceDetailsApi.md#list_currently_syncing_devices) | **GET** /device/sync_status | +*MonitoringDeviceDetailsApi* | [**list_reachable_devices**](docs/MonitoringDeviceDetailsApi.md#list_reachable_devices) | **GET** /device/reachable | +*MonitoringDeviceDetailsApi* | [**list_unreachable_devices**](docs/MonitoringDeviceDetailsApi.md#list_unreachable_devices) | **GET** /device/unreachable | +*MonitoringDeviceDetailsApi* | [**remove_unreachable_device**](docs/MonitoringDeviceDetailsApi.md#remove_unreachable_device) | **DELETE** /device/unreachable/{deviceIP} | +*MonitoringDeviceDetailsApi* | [**set_block_sync**](docs/MonitoringDeviceDetailsApi.md#set_block_sync) | **POST** /device/blockSync | +*MonitoringDeviceDetailsApi* | [**sync_all_devices_mem_db**](docs/MonitoringDeviceDetailsApi.md#sync_all_devices_mem_db) | **POST** /device/syncall/memorydb | +*MonitoringDeviceStatisticsApi* | [**get_aggregation_data_by_query15**](docs/MonitoringDeviceStatisticsApi.md#get_aggregation_data_by_query15) | **GET** /statistics/device/aggregation | +*MonitoringDeviceStatisticsApi* | [**get_count17**](docs/MonitoringDeviceStatisticsApi.md#get_count17) | **GET** /statistics/device/doccount | +*MonitoringDeviceStatisticsApi* | [**get_count_post17**](docs/MonitoringDeviceStatisticsApi.md#get_count_post17) | **POST** /statistics/device/doccount | +*MonitoringDeviceStatisticsApi* | [**get_post_aggregation_app_data_by_query14**](docs/MonitoringDeviceStatisticsApi.md#get_post_aggregation_app_data_by_query14) | **POST** /statistics/device/app-agg/aggregation | +*MonitoringDeviceStatisticsApi* | [**get_post_aggregation_data_by_query14**](docs/MonitoringDeviceStatisticsApi.md#get_post_aggregation_data_by_query14) | **POST** /statistics/device/aggregation | +*MonitoringDeviceStatisticsApi* | [**get_post_stat_bulk_raw_data15**](docs/MonitoringDeviceStatisticsApi.md#get_post_stat_bulk_raw_data15) | **POST** /statistics/device/page | +*MonitoringDeviceStatisticsApi* | [**get_stat_bulk_raw_data15**](docs/MonitoringDeviceStatisticsApi.md#get_stat_bulk_raw_data15) | **GET** /statistics/device/page | +*MonitoringDeviceStatisticsApi* | [**get_stat_data_fields17**](docs/MonitoringDeviceStatisticsApi.md#get_stat_data_fields17) | **GET** /statistics/device/fields | +*MonitoringDeviceStatisticsApi* | [**get_stat_data_raw_data14**](docs/MonitoringDeviceStatisticsApi.md#get_stat_data_raw_data14) | **GET** /statistics/device | +*MonitoringDeviceStatisticsApi* | [**get_stat_data_raw_data_as_csv15**](docs/MonitoringDeviceStatisticsApi.md#get_stat_data_raw_data_as_csv15) | **GET** /statistics/device/csv | +*MonitoringDeviceStatisticsApi* | [**get_stat_query_fields17**](docs/MonitoringDeviceStatisticsApi.md#get_stat_query_fields17) | **GET** /statistics/device/query/fields | +*MonitoringDeviceStatisticsApi* | [**get_stats_raw_data15**](docs/MonitoringDeviceStatisticsApi.md#get_stats_raw_data15) | **POST** /statistics/device | +*MonitoringDeviceStatisticsDetailsApi* | [**generate_device_statistics_data**](docs/MonitoringDeviceStatisticsDetailsApi.md#generate_device_statistics_data) | **GET** /data/device/statistics/{state_data_type} | +*MonitoringDeviceStatisticsDetailsApi* | [**get_active_alarms**](docs/MonitoringDeviceStatisticsDetailsApi.md#get_active_alarms) | **GET** /data/device/statistics/alarm/active | +*MonitoringDeviceStatisticsDetailsApi* | [**get_count_with_state_data_type**](docs/MonitoringDeviceStatisticsDetailsApi.md#get_count_with_state_data_type) | **GET** /data/device/statistics/{state_data_type}/doccount | +*MonitoringDeviceStatisticsDetailsApi* | [**get_stat_data_fields_by_state_data_type**](docs/MonitoringDeviceStatisticsDetailsApi.md#get_stat_data_fields_by_state_data_type) | **GET** /data/device/statistics/{state_data_type}/fields | +*MonitoringDeviceStatisticsDetailsApi* | [**get_statistics_type**](docs/MonitoringDeviceStatisticsDetailsApi.md#get_statistics_type) | **GET** /data/device/statistics | +*MonitoringEndpointTrackerStatusApi* | [**get_aggregation_data_by_query18**](docs/MonitoringEndpointTrackerStatusApi.md#get_aggregation_data_by_query18) | **GET** /statistics/endpointTracker/aggregation | +*MonitoringEndpointTrackerStatusApi* | [**get_count20**](docs/MonitoringEndpointTrackerStatusApi.md#get_count20) | **GET** /statistics/endpointTracker/doccount | +*MonitoringEndpointTrackerStatusApi* | [**get_count_post20**](docs/MonitoringEndpointTrackerStatusApi.md#get_count_post20) | **POST** /statistics/endpointTracker/doccount | +*MonitoringEndpointTrackerStatusApi* | [**get_post_aggregation_app_data_by_query17**](docs/MonitoringEndpointTrackerStatusApi.md#get_post_aggregation_app_data_by_query17) | **POST** /statistics/endpointTracker/app-agg/aggregation | +*MonitoringEndpointTrackerStatusApi* | [**get_post_aggregation_data_by_query17**](docs/MonitoringEndpointTrackerStatusApi.md#get_post_aggregation_data_by_query17) | **POST** /statistics/endpointTracker/aggregation | +*MonitoringEndpointTrackerStatusApi* | [**get_post_stat_bulk_raw_data18**](docs/MonitoringEndpointTrackerStatusApi.md#get_post_stat_bulk_raw_data18) | **POST** /statistics/endpointTracker/page | +*MonitoringEndpointTrackerStatusApi* | [**get_stat_bulk_raw_data18**](docs/MonitoringEndpointTrackerStatusApi.md#get_stat_bulk_raw_data18) | **GET** /statistics/endpointTracker/page | +*MonitoringEndpointTrackerStatusApi* | [**get_stat_data_fields20**](docs/MonitoringEndpointTrackerStatusApi.md#get_stat_data_fields20) | **GET** /statistics/endpointTracker/fields | +*MonitoringEndpointTrackerStatusApi* | [**get_stat_data_raw_data17**](docs/MonitoringEndpointTrackerStatusApi.md#get_stat_data_raw_data17) | **GET** /statistics/endpointTracker | +*MonitoringEndpointTrackerStatusApi* | [**get_stat_data_raw_data_as_csv18**](docs/MonitoringEndpointTrackerStatusApi.md#get_stat_data_raw_data_as_csv18) | **GET** /statistics/endpointTracker/csv | +*MonitoringEndpointTrackerStatusApi* | [**get_stat_query_fields20**](docs/MonitoringEndpointTrackerStatusApi.md#get_stat_query_fields20) | **GET** /statistics/endpointTracker/query/fields | +*MonitoringEndpointTrackerStatusApi* | [**get_stats_raw_data18**](docs/MonitoringEndpointTrackerStatusApi.md#get_stats_raw_data18) | **POST** /statistics/endpointTracker | +*MonitoringEventsApi* | [**create_events_query_config**](docs/MonitoringEventsApi.md#create_events_query_config) | **GET** /event/query/input | +*MonitoringEventsApi* | [**enable_events_from_file**](docs/MonitoringEventsApi.md#enable_events_from_file) | **GET** /event/enable/fileprocess | +*MonitoringEventsApi* | [**find_events**](docs/MonitoringEventsApi.md#find_events) | **GET** /event/severity | +*MonitoringEventsApi* | [**get_aggregation_data_by_query25**](docs/MonitoringEventsApi.md#get_aggregation_data_by_query25) | **GET** /event/aggregation | +*MonitoringEventsApi* | [**get_components_as_key_value**](docs/MonitoringEventsApi.md#get_components_as_key_value) | **GET** /event/component/keyvalue | +*MonitoringEventsApi* | [**get_count27**](docs/MonitoringEventsApi.md#get_count27) | **GET** /event/doccount | +*MonitoringEventsApi* | [**get_count_post27**](docs/MonitoringEventsApi.md#get_count_post27) | **POST** /event/doccount | +*MonitoringEventsApi* | [**get_event_types_as_key_value**](docs/MonitoringEventsApi.md#get_event_types_as_key_value) | **GET** /event/types/keyvalue | +*MonitoringEventsApi* | [**get_events_by_component**](docs/MonitoringEventsApi.md#get_events_by_component) | **GET** /event/getEventsByComponent | +*MonitoringEventsApi* | [**get_listeners_info**](docs/MonitoringEventsApi.md#get_listeners_info) | **GET** /event/listeners | +*MonitoringEventsApi* | [**get_post_aggregation_app_data_by_query24**](docs/MonitoringEventsApi.md#get_post_aggregation_app_data_by_query24) | **POST** /event/app-agg/aggregation | +*MonitoringEventsApi* | [**get_post_aggregation_data_by_query24**](docs/MonitoringEventsApi.md#get_post_aggregation_data_by_query24) | **POST** /event/aggregation | +*MonitoringEventsApi* | [**get_post_stat_bulk_raw_data25**](docs/MonitoringEventsApi.md#get_post_stat_bulk_raw_data25) | **POST** /event/page | +*MonitoringEventsApi* | [**get_severity_histogram**](docs/MonitoringEventsApi.md#get_severity_histogram) | **GET** /event/severity/summary | +*MonitoringEventsApi* | [**get_stat_bulk_raw_data25**](docs/MonitoringEventsApi.md#get_stat_bulk_raw_data25) | **GET** /event/page | +*MonitoringEventsApi* | [**get_stat_data_fields27**](docs/MonitoringEventsApi.md#get_stat_data_fields27) | **GET** /event/fields | +*MonitoringEventsApi* | [**get_stat_data_raw_data24**](docs/MonitoringEventsApi.md#get_stat_data_raw_data24) | **GET** /event | +*MonitoringEventsApi* | [**get_stat_data_raw_data_as_csv25**](docs/MonitoringEventsApi.md#get_stat_data_raw_data_as_csv25) | **GET** /event/csv | +*MonitoringEventsApi* | [**get_stat_query_fields27**](docs/MonitoringEventsApi.md#get_stat_query_fields27) | **GET** /event/query/fields | +*MonitoringEventsApi* | [**get_stats_raw_data25**](docs/MonitoringEventsApi.md#get_stats_raw_data25) | **POST** /event | +*MonitoringFlowlogApi* | [**get_aggregation_data_by_query26**](docs/MonitoringFlowlogApi.md#get_aggregation_data_by_query26) | **GET** /statistics/flowlog/aggregation | +*MonitoringFlowlogApi* | [**get_count28**](docs/MonitoringFlowlogApi.md#get_count28) | **GET** /statistics/flowlog/doccount | +*MonitoringFlowlogApi* | [**get_count_post28**](docs/MonitoringFlowlogApi.md#get_count_post28) | **POST** /statistics/flowlog/doccount | +*MonitoringFlowlogApi* | [**get_post_aggregation_app_data_by_query25**](docs/MonitoringFlowlogApi.md#get_post_aggregation_app_data_by_query25) | **POST** /statistics/flowlog/app-agg/aggregation | +*MonitoringFlowlogApi* | [**get_post_aggregation_data_by_query26**](docs/MonitoringFlowlogApi.md#get_post_aggregation_data_by_query26) | **POST** /statistics/flowlog/aggregation | +*MonitoringFlowlogApi* | [**get_post_stat_bulk_raw_data26**](docs/MonitoringFlowlogApi.md#get_post_stat_bulk_raw_data26) | **POST** /statistics/flowlog/page | +*MonitoringFlowlogApi* | [**get_stat_bulk_raw_data26**](docs/MonitoringFlowlogApi.md#get_stat_bulk_raw_data26) | **GET** /statistics/flowlog/page | +*MonitoringFlowlogApi* | [**get_stat_data_fields28**](docs/MonitoringFlowlogApi.md#get_stat_data_fields28) | **GET** /statistics/flowlog/fields | +*MonitoringFlowlogApi* | [**get_stat_data_raw_data25**](docs/MonitoringFlowlogApi.md#get_stat_data_raw_data25) | **GET** /statistics/flowlog | +*MonitoringFlowlogApi* | [**get_stat_data_raw_data_as_csv26**](docs/MonitoringFlowlogApi.md#get_stat_data_raw_data_as_csv26) | **GET** /statistics/flowlog/csv | +*MonitoringFlowlogApi* | [**get_stat_query_fields28**](docs/MonitoringFlowlogApi.md#get_stat_query_fields28) | **GET** /statistics/flowlog/query/fields | +*MonitoringFlowlogApi* | [**get_stats_raw_data26**](docs/MonitoringFlowlogApi.md#get_stats_raw_data26) | **POST** /statistics/flowlog | +*MonitoringHealthApi* | [**get_devices_health**](docs/MonitoringHealthApi.md#get_devices_health) | **GET** /health/devices | +*MonitoringHealthApi* | [**get_devices_health_overview**](docs/MonitoringHealthApi.md#get_devices_health_overview) | **GET** /health/devices/overview | +*MonitoringIPsAlertApi* | [**get_aggregation_data_by_query21**](docs/MonitoringIPsAlertApi.md#get_aggregation_data_by_query21) | **GET** /statistics/ipsalert/aggregation | +*MonitoringIPsAlertApi* | [**get_count23**](docs/MonitoringIPsAlertApi.md#get_count23) | **GET** /statistics/ipsalert/doccount | +*MonitoringIPsAlertApi* | [**get_count_post23**](docs/MonitoringIPsAlertApi.md#get_count_post23) | **POST** /statistics/ipsalert/doccount | +*MonitoringIPsAlertApi* | [**get_post_aggregation_app_data_by_query20**](docs/MonitoringIPsAlertApi.md#get_post_aggregation_app_data_by_query20) | **POST** /statistics/ipsalert/app-agg/aggregation | +*MonitoringIPsAlertApi* | [**get_post_aggregation_data_by_query20**](docs/MonitoringIPsAlertApi.md#get_post_aggregation_data_by_query20) | **POST** /statistics/ipsalert/aggregation | +*MonitoringIPsAlertApi* | [**get_post_stat_bulk_raw_data21**](docs/MonitoringIPsAlertApi.md#get_post_stat_bulk_raw_data21) | **POST** /statistics/ipsalert/page | +*MonitoringIPsAlertApi* | [**get_stat_bulk_raw_data21**](docs/MonitoringIPsAlertApi.md#get_stat_bulk_raw_data21) | **GET** /statistics/ipsalert/page | +*MonitoringIPsAlertApi* | [**get_stat_data_fields23**](docs/MonitoringIPsAlertApi.md#get_stat_data_fields23) | **GET** /statistics/ipsalert/fields | +*MonitoringIPsAlertApi* | [**get_stat_data_raw_data20**](docs/MonitoringIPsAlertApi.md#get_stat_data_raw_data20) | **GET** /statistics/ipsalert | +*MonitoringIPsAlertApi* | [**get_stat_data_raw_data_as_csv21**](docs/MonitoringIPsAlertApi.md#get_stat_data_raw_data_as_csv21) | **GET** /statistics/ipsalert/csv | +*MonitoringIPsAlertApi* | [**get_stat_query_fields23**](docs/MonitoringIPsAlertApi.md#get_stat_query_fields23) | **GET** /statistics/ipsalert/query/fields | +*MonitoringIPsAlertApi* | [**get_stats_raw_data21**](docs/MonitoringIPsAlertApi.md#get_stats_raw_data21) | **POST** /statistics/ipsalert | +*MonitoringInterfaceStatisticsApi* | [**get_aggregation_data_by_query10**](docs/MonitoringInterfaceStatisticsApi.md#get_aggregation_data_by_query10) | **GET** /statistics/interface/aggregation | +*MonitoringInterfaceStatisticsApi* | [**get_bandwidth_distribution**](docs/MonitoringInterfaceStatisticsApi.md#get_bandwidth_distribution) | **GET** /statistics/interface/ccapacity/distribution | +*MonitoringInterfaceStatisticsApi* | [**get_count12**](docs/MonitoringInterfaceStatisticsApi.md#get_count12) | **GET** /statistics/interface/doccount | +*MonitoringInterfaceStatisticsApi* | [**get_count_post12**](docs/MonitoringInterfaceStatisticsApi.md#get_count_post12) | **POST** /statistics/interface/doccount | +*MonitoringInterfaceStatisticsApi* | [**get_post_aggregation_app_data_by_query10**](docs/MonitoringInterfaceStatisticsApi.md#get_post_aggregation_app_data_by_query10) | **POST** /statistics/interface/app-agg/aggregation | +*MonitoringInterfaceStatisticsApi* | [**get_post_aggregation_data_by_query10**](docs/MonitoringInterfaceStatisticsApi.md#get_post_aggregation_data_by_query10) | **POST** /statistics/interface/aggregation | +*MonitoringInterfaceStatisticsApi* | [**get_post_stat_bulk_raw_data10**](docs/MonitoringInterfaceStatisticsApi.md#get_post_stat_bulk_raw_data10) | **POST** /statistics/interface/page | +*MonitoringInterfaceStatisticsApi* | [**get_stat_bulk_raw_data10**](docs/MonitoringInterfaceStatisticsApi.md#get_stat_bulk_raw_data10) | **GET** /statistics/interface/page | +*MonitoringInterfaceStatisticsApi* | [**get_stat_data_fields12**](docs/MonitoringInterfaceStatisticsApi.md#get_stat_data_fields12) | **GET** /statistics/interface/fields | +*MonitoringInterfaceStatisticsApi* | [**get_stat_data_raw_data10**](docs/MonitoringInterfaceStatisticsApi.md#get_stat_data_raw_data10) | **GET** /statistics/interface | +*MonitoringInterfaceStatisticsApi* | [**get_stat_data_raw_data_as_csv10**](docs/MonitoringInterfaceStatisticsApi.md#get_stat_data_raw_data_as_csv10) | **GET** /statistics/interface/csv | +*MonitoringInterfaceStatisticsApi* | [**get_stat_query_fields12**](docs/MonitoringInterfaceStatisticsApi.md#get_stat_query_fields12) | **GET** /statistics/interface/query/fields | +*MonitoringInterfaceStatisticsApi* | [**get_statistics_per_interface**](docs/MonitoringInterfaceStatisticsApi.md#get_statistics_per_interface) | **GET** /statistics/interface/type | +*MonitoringInterfaceStatisticsApi* | [**get_stats_raw_data10**](docs/MonitoringInterfaceStatisticsApi.md#get_stats_raw_data10) | **POST** /statistics/interface | +*MonitoringQoSApi* | [**get_aggregation_data_by_query13**](docs/MonitoringQoSApi.md#get_aggregation_data_by_query13) | **GET** /statistics/qos/aggregation | +*MonitoringQoSApi* | [**get_count15**](docs/MonitoringQoSApi.md#get_count15) | **GET** /statistics/qos/doccount | +*MonitoringQoSApi* | [**get_count_post15**](docs/MonitoringQoSApi.md#get_count_post15) | **POST** /statistics/qos/doccount | +*MonitoringQoSApi* | [**get_post_aggregation_app_data_by_query12**](docs/MonitoringQoSApi.md#get_post_aggregation_app_data_by_query12) | **POST** /statistics/qos/app-agg/aggregation | +*MonitoringQoSApi* | [**get_post_aggregation_data_by_query12**](docs/MonitoringQoSApi.md#get_post_aggregation_data_by_query12) | **POST** /statistics/qos/aggregation | +*MonitoringQoSApi* | [**get_post_stat_bulk_raw_data13**](docs/MonitoringQoSApi.md#get_post_stat_bulk_raw_data13) | **POST** /statistics/qos/page | +*MonitoringQoSApi* | [**get_stat_bulk_raw_data13**](docs/MonitoringQoSApi.md#get_stat_bulk_raw_data13) | **GET** /statistics/qos/page | +*MonitoringQoSApi* | [**get_stat_data_fields15**](docs/MonitoringQoSApi.md#get_stat_data_fields15) | **GET** /statistics/qos/fields | +*MonitoringQoSApi* | [**get_stat_data_raw_data13**](docs/MonitoringQoSApi.md#get_stat_data_raw_data13) | **GET** /statistics/qos | +*MonitoringQoSApi* | [**get_stat_data_raw_data_as_csv13**](docs/MonitoringQoSApi.md#get_stat_data_raw_data_as_csv13) | **GET** /statistics/qos/csv | +*MonitoringQoSApi* | [**get_stat_query_fields15**](docs/MonitoringQoSApi.md#get_stat_query_fields15) | **GET** /statistics/qos/query/fields | +*MonitoringQoSApi* | [**get_stats_raw_data13**](docs/MonitoringQoSApi.md#get_stats_raw_data13) | **POST** /statistics/qos | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_aggregation_data_by_query14**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_aggregation_data_by_query14) | **GET** /statistics/sul/connections/aggregation | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_count16**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_count16) | **GET** /statistics/sul/connections/doccount | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_count_post16**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_count_post16) | **POST** /statistics/sul/connections/doccount | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_filter_policy_name_list**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_filter_policy_name_list) | **GET** /statistics/sul/connections/filter/policy_name/{policyType} | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_post_aggregation_app_data_by_query13**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_post_aggregation_app_data_by_query13) | **POST** /statistics/sul/connections/app-agg/aggregation | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_post_aggregation_data_by_query13**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_post_aggregation_data_by_query13) | **POST** /statistics/sul/connections/aggregation | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_post_stat_bulk_raw_data14**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_post_stat_bulk_raw_data14) | **POST** /statistics/sul/connections/page | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_stat_bulk_raw_data14**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_bulk_raw_data14) | **GET** /statistics/sul/connections/page | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_stat_data_fields16**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_data_fields16) | **GET** /statistics/sul/connections/fields | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_stat_data_raw_data_as_csv14**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_data_raw_data_as_csv14) | **GET** /statistics/sul/connections/csv | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_stat_query_fields16**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_query_fields16) | **GET** /statistics/sul/connections/query/fields | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_stats_raw_data14**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stats_raw_data14) | **POST** /statistics/sul/connections | +*MonitoringSecurityUnifiedLoggingConnectionEventsApi* | [**get_sul_stat_data_raw_data**](docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_sul_stat_data_raw_data) | **GET** /statistics/sul/connections | +*MonitoringServerInfoApi* | [**create_server_info**](docs/MonitoringServerInfoApi.md#create_server_info) | **GET** /server/info | +*MonitoringStatsDownloadApi* | [**download1**](docs/MonitoringStatsDownloadApi.md#download1) | **GET** /statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName} | +*MonitoringStatsDownloadApi* | [**download_list**](docs/MonitoringStatsDownloadApi.md#download_list) | **POST** /statistics/download/{processType}/filelist | +*MonitoringStatsDownloadApi* | [**fetch_list**](docs/MonitoringStatsDownloadApi.md#fetch_list) | **GET** /statistics/download/{processType}/fetchvManageList | +*MonitoringStatsProcessingApi* | [**enable_statistics_demo_mode**](docs/MonitoringStatsProcessingApi.md#enable_statistics_demo_mode) | **GET** /statistics/demomode | +*MonitoringStatsProcessingApi* | [**generate_stats_collect_thread_report**](docs/MonitoringStatsProcessingApi.md#generate_stats_collect_thread_report) | **GET** /statistics/collect/thread/status | +*MonitoringStatsProcessingApi* | [**generate_stats_process_report**](docs/MonitoringStatsProcessingApi.md#generate_stats_process_report) | **GET** /statistics/process/status | +*MonitoringStatsProcessingApi* | [**generate_stats_process_thread_report**](docs/MonitoringStatsProcessingApi.md#generate_stats_process_thread_report) | **GET** /statistics/process/thread/status | +*MonitoringStatsProcessingApi* | [**get_statistic_type**](docs/MonitoringStatsProcessingApi.md#get_statistic_type) | **GET** /statistics | +*MonitoringStatsProcessingApi* | [**get_statistics_processing_counters**](docs/MonitoringStatsProcessingApi.md#get_statistics_processing_counters) | **GET** /statistics/process/counters | +*MonitoringStatsProcessingApi* | [**process_statistics_data**](docs/MonitoringStatsProcessingApi.md#process_statistics_data) | **GET** /statistics/process | +*MonitoringStatsProcessingApi* | [**reset_stats_collection**](docs/MonitoringStatsProcessingApi.md#reset_stats_collection) | **GET** /statistics/collection/reset/{processQueue} | +*MonitoringStatsProcessingApi* | [**start_stats_collection**](docs/MonitoringStatsProcessingApi.md#start_stats_collection) | **GET** /statistics/collect | +*MonitoringStatusApi* | [**get_disabled_device_list**](docs/MonitoringStatusApi.md#get_disabled_device_list) | **GET** /statistics/settings/disable/devicelist/{indexName} | +*MonitoringStatusApi* | [**get_enabled_index_for_device**](docs/MonitoringStatusApi.md#get_enabled_index_for_device) | **GET** /statistics/settings/status/device | +*MonitoringStatusApi* | [**get_statistics_settings**](docs/MonitoringStatusApi.md#get_statistics_settings) | **GET** /statistics/settings/status | +*MonitoringStatusApi* | [**update_statistics_device_list**](docs/MonitoringStatusApi.md#update_statistics_device_list) | **PUT** /statistics/settings/disable/devicelist/{indexName} | +*MonitoringStatusApi* | [**update_statistics_settings**](docs/MonitoringStatusApi.md#update_statistics_settings) | **PUT** /statistics/settings/status | +*MonitoringSystemStatusStatsApi* | [**get_aggregation_data_by_query17**](docs/MonitoringSystemStatusStatsApi.md#get_aggregation_data_by_query17) | **GET** /statistics/system/stats/aggregation | +*MonitoringSystemStatusStatsApi* | [**get_count19**](docs/MonitoringSystemStatusStatsApi.md#get_count19) | **GET** /statistics/system/stats/doccount | +*MonitoringSystemStatusStatsApi* | [**get_count_post19**](docs/MonitoringSystemStatusStatsApi.md#get_count_post19) | **POST** /statistics/system/stats/doccount | +*MonitoringSystemStatusStatsApi* | [**get_post_aggregation_app_data_by_query16**](docs/MonitoringSystemStatusStatsApi.md#get_post_aggregation_app_data_by_query16) | **POST** /statistics/system/stats/app-agg/aggregation | +*MonitoringSystemStatusStatsApi* | [**get_post_aggregation_data_by_query16**](docs/MonitoringSystemStatusStatsApi.md#get_post_aggregation_data_by_query16) | **POST** /statistics/system/stats/aggregation | +*MonitoringSystemStatusStatsApi* | [**get_post_stat_bulk_raw_data17**](docs/MonitoringSystemStatusStatsApi.md#get_post_stat_bulk_raw_data17) | **POST** /statistics/system/stats/page | +*MonitoringSystemStatusStatsApi* | [**get_stat_bulk_raw_data17**](docs/MonitoringSystemStatusStatsApi.md#get_stat_bulk_raw_data17) | **GET** /statistics/system/stats/page | +*MonitoringSystemStatusStatsApi* | [**get_stat_data_fields19**](docs/MonitoringSystemStatusStatsApi.md#get_stat_data_fields19) | **GET** /statistics/system/stats/fields | +*MonitoringSystemStatusStatsApi* | [**get_stat_data_raw_data16**](docs/MonitoringSystemStatusStatsApi.md#get_stat_data_raw_data16) | **GET** /statistics/system/stats | +*MonitoringSystemStatusStatsApi* | [**get_stat_data_raw_data_as_csv17**](docs/MonitoringSystemStatusStatsApi.md#get_stat_data_raw_data_as_csv17) | **GET** /statistics/system/stats/csv | +*MonitoringSystemStatusStatsApi* | [**get_stat_query_fields19**](docs/MonitoringSystemStatusStatsApi.md#get_stat_query_fields19) | **GET** /statistics/system/stats/query/fields | +*MonitoringSystemStatusStatsApi* | [**get_stats_raw_data17**](docs/MonitoringSystemStatusStatsApi.md#get_stats_raw_data17) | **POST** /statistics/system/stats | +*MonitoringURLFilteringApi* | [**get_aggregation_data_by_query22**](docs/MonitoringURLFilteringApi.md#get_aggregation_data_by_query22) | **GET** /statistics/urlf/aggregation | +*MonitoringURLFilteringApi* | [**get_count24**](docs/MonitoringURLFilteringApi.md#get_count24) | **GET** /statistics/urlf/doccount | +*MonitoringURLFilteringApi* | [**get_count_post24**](docs/MonitoringURLFilteringApi.md#get_count_post24) | **POST** /statistics/urlf/doccount | +*MonitoringURLFilteringApi* | [**get_post_aggregation_app_data_by_query21**](docs/MonitoringURLFilteringApi.md#get_post_aggregation_app_data_by_query21) | **POST** /statistics/urlf/app-agg/aggregation | +*MonitoringURLFilteringApi* | [**get_post_aggregation_data_by_query21**](docs/MonitoringURLFilteringApi.md#get_post_aggregation_data_by_query21) | **POST** /statistics/urlf/aggregation | +*MonitoringURLFilteringApi* | [**get_post_stat_bulk_raw_data22**](docs/MonitoringURLFilteringApi.md#get_post_stat_bulk_raw_data22) | **POST** /statistics/urlf/page | +*MonitoringURLFilteringApi* | [**get_stat_bulk_raw_data22**](docs/MonitoringURLFilteringApi.md#get_stat_bulk_raw_data22) | **GET** /statistics/urlf/page | +*MonitoringURLFilteringApi* | [**get_stat_data_fields24**](docs/MonitoringURLFilteringApi.md#get_stat_data_fields24) | **GET** /statistics/urlf/fields | +*MonitoringURLFilteringApi* | [**get_stat_data_raw_data21**](docs/MonitoringURLFilteringApi.md#get_stat_data_raw_data21) | **GET** /statistics/urlf | +*MonitoringURLFilteringApi* | [**get_stat_data_raw_data_as_csv22**](docs/MonitoringURLFilteringApi.md#get_stat_data_raw_data_as_csv22) | **GET** /statistics/urlf/csv | +*MonitoringURLFilteringApi* | [**get_stat_query_fields24**](docs/MonitoringURLFilteringApi.md#get_stat_query_fields24) | **GET** /statistics/urlf/query/fields | +*MonitoringURLFilteringApi* | [**get_stats_raw_data22**](docs/MonitoringURLFilteringApi.md#get_stats_raw_data22) | **POST** /statistics/urlf | +*MonitoringUmbrellaApi* | [**get_aggregation_data_by_query24**](docs/MonitoringUmbrellaApi.md#get_aggregation_data_by_query24) | **GET** /statistics/umbrella/aggregation | +*MonitoringUmbrellaApi* | [**get_count26**](docs/MonitoringUmbrellaApi.md#get_count26) | **GET** /statistics/umbrella/doccount | +*MonitoringUmbrellaApi* | [**get_count_post26**](docs/MonitoringUmbrellaApi.md#get_count_post26) | **POST** /statistics/umbrella/doccount | +*MonitoringUmbrellaApi* | [**get_post_aggregation_app_data_by_query23**](docs/MonitoringUmbrellaApi.md#get_post_aggregation_app_data_by_query23) | **POST** /statistics/umbrella/app-agg/aggregation | +*MonitoringUmbrellaApi* | [**get_post_aggregation_data_by_query23**](docs/MonitoringUmbrellaApi.md#get_post_aggregation_data_by_query23) | **POST** /statistics/umbrella/aggregation | +*MonitoringUmbrellaApi* | [**get_post_stat_bulk_raw_data24**](docs/MonitoringUmbrellaApi.md#get_post_stat_bulk_raw_data24) | **POST** /statistics/umbrella/page | +*MonitoringUmbrellaApi* | [**get_stat_bulk_raw_data24**](docs/MonitoringUmbrellaApi.md#get_stat_bulk_raw_data24) | **GET** /statistics/umbrella/page | +*MonitoringUmbrellaApi* | [**get_stat_data_fields26**](docs/MonitoringUmbrellaApi.md#get_stat_data_fields26) | **GET** /statistics/umbrella/fields | +*MonitoringUmbrellaApi* | [**get_stat_data_raw_data23**](docs/MonitoringUmbrellaApi.md#get_stat_data_raw_data23) | **GET** /statistics/umbrella | +*MonitoringUmbrellaApi* | [**get_stat_data_raw_data_as_csv24**](docs/MonitoringUmbrellaApi.md#get_stat_data_raw_data_as_csv24) | **GET** /statistics/umbrella/csv | +*MonitoringUmbrellaApi* | [**get_stat_query_fields26**](docs/MonitoringUmbrellaApi.md#get_stat_query_fields26) | **GET** /statistics/umbrella/query/fields | +*MonitoringUmbrellaApi* | [**get_stats_raw_data24**](docs/MonitoringUmbrellaApi.md#get_stats_raw_data24) | **POST** /statistics/umbrella | +*MonitoringUmbrellaPatternsApi* | [**get_aggregation_data_by_query23**](docs/MonitoringUmbrellaPatternsApi.md#get_aggregation_data_by_query23) | **GET** /statistics/fwall/aggregation | +*MonitoringUmbrellaPatternsApi* | [**get_count25**](docs/MonitoringUmbrellaPatternsApi.md#get_count25) | **GET** /statistics/fwall/doccount | +*MonitoringUmbrellaPatternsApi* | [**get_count_post25**](docs/MonitoringUmbrellaPatternsApi.md#get_count_post25) | **POST** /statistics/fwall/doccount | +*MonitoringUmbrellaPatternsApi* | [**get_post_aggregation_app_data_by_query22**](docs/MonitoringUmbrellaPatternsApi.md#get_post_aggregation_app_data_by_query22) | **POST** /statistics/fwall/app-agg/aggregation | +*MonitoringUmbrellaPatternsApi* | [**get_post_aggregation_data_by_query22**](docs/MonitoringUmbrellaPatternsApi.md#get_post_aggregation_data_by_query22) | **POST** /statistics/fwall/aggregation | +*MonitoringUmbrellaPatternsApi* | [**get_post_stat_bulk_raw_data23**](docs/MonitoringUmbrellaPatternsApi.md#get_post_stat_bulk_raw_data23) | **POST** /statistics/fwall/page | +*MonitoringUmbrellaPatternsApi* | [**get_stat_bulk_raw_data23**](docs/MonitoringUmbrellaPatternsApi.md#get_stat_bulk_raw_data23) | **GET** /statistics/fwall/page | +*MonitoringUmbrellaPatternsApi* | [**get_stat_data_fields25**](docs/MonitoringUmbrellaPatternsApi.md#get_stat_data_fields25) | **GET** /statistics/fwall/fields | +*MonitoringUmbrellaPatternsApi* | [**get_stat_data_raw_data22**](docs/MonitoringUmbrellaPatternsApi.md#get_stat_data_raw_data22) | **GET** /statistics/fwall | +*MonitoringUmbrellaPatternsApi* | [**get_stat_data_raw_data_as_csv23**](docs/MonitoringUmbrellaPatternsApi.md#get_stat_data_raw_data_as_csv23) | **GET** /statistics/fwall/csv | +*MonitoringUmbrellaPatternsApi* | [**get_stat_query_fields25**](docs/MonitoringUmbrellaPatternsApi.md#get_stat_query_fields25) | **GET** /statistics/fwall/query/fields | +*MonitoringUmbrellaPatternsApi* | [**get_stats_raw_data23**](docs/MonitoringUmbrellaPatternsApi.md#get_stats_raw_data23) | **POST** /statistics/fwall | +*MonitoringVNFInterfaceStatisticsApi* | [**get_aggregation_data_by_query11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_aggregation_data_by_query11) | **GET** /statistics/vnfstatistics/aggregation | +*MonitoringVNFInterfaceStatisticsApi* | [**get_count13**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_count13) | **GET** /statistics/vnfstatistics/doccount | +*MonitoringVNFInterfaceStatisticsApi* | [**get_count_post13**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_count_post13) | **POST** /statistics/vnfstatistics/doccount | +*MonitoringVNFInterfaceStatisticsApi* | [**get_post_aggregation_app_data_by_query11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_post_aggregation_app_data_by_query11) | **POST** /statistics/vnfstatistics/app-agg/aggregation | +*MonitoringVNFInterfaceStatisticsApi* | [**get_post_aggregation_data_by_query11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_post_aggregation_data_by_query11) | **POST** /statistics/vnfstatistics/aggregation | +*MonitoringVNFInterfaceStatisticsApi* | [**get_post_stat_bulk_raw_data11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_post_stat_bulk_raw_data11) | **POST** /statistics/vnfstatistics/page | +*MonitoringVNFInterfaceStatisticsApi* | [**get_stat_bulk_raw_data11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_stat_bulk_raw_data11) | **GET** /statistics/vnfstatistics/page | +*MonitoringVNFInterfaceStatisticsApi* | [**get_stat_data_fields13**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_stat_data_fields13) | **GET** /statistics/vnfstatistics/fields | +*MonitoringVNFInterfaceStatisticsApi* | [**get_stat_data_raw_data11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_stat_data_raw_data11) | **GET** /statistics/vnfstatistics | +*MonitoringVNFInterfaceStatisticsApi* | [**get_stat_data_raw_data_as_csv11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_stat_data_raw_data_as_csv11) | **GET** /statistics/vnfstatistics/csv | +*MonitoringVNFInterfaceStatisticsApi* | [**get_stat_query_fields13**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_stat_query_fields13) | **GET** /statistics/vnfstatistics/query/fields | +*MonitoringVNFInterfaceStatisticsApi* | [**get_stats_raw_data11**](docs/MonitoringVNFInterfaceStatisticsApi.md#get_stats_raw_data11) | **POST** /statistics/vnfstatistics | +*MonitoringWlanClientInfoApi* | [**get_aggregation_data_by_query19**](docs/MonitoringWlanClientInfoApi.md#get_aggregation_data_by_query19) | **GET** /statistics/wlanclientinfo/aggregation | +*MonitoringWlanClientInfoApi* | [**get_count21**](docs/MonitoringWlanClientInfoApi.md#get_count21) | **GET** /statistics/wlanclientinfo/doccount | +*MonitoringWlanClientInfoApi* | [**get_count_post21**](docs/MonitoringWlanClientInfoApi.md#get_count_post21) | **POST** /statistics/wlanclientinfo/doccount | +*MonitoringWlanClientInfoApi* | [**get_post_aggregation_app_data_by_query18**](docs/MonitoringWlanClientInfoApi.md#get_post_aggregation_app_data_by_query18) | **POST** /statistics/wlanclientinfo/app-agg/aggregation | +*MonitoringWlanClientInfoApi* | [**get_post_aggregation_data_by_query18**](docs/MonitoringWlanClientInfoApi.md#get_post_aggregation_data_by_query18) | **POST** /statistics/wlanclientinfo/aggregation | +*MonitoringWlanClientInfoApi* | [**get_post_stat_bulk_raw_data19**](docs/MonitoringWlanClientInfoApi.md#get_post_stat_bulk_raw_data19) | **POST** /statistics/wlanclientinfo/page | +*MonitoringWlanClientInfoApi* | [**get_stat_bulk_raw_data19**](docs/MonitoringWlanClientInfoApi.md#get_stat_bulk_raw_data19) | **GET** /statistics/wlanclientinfo/page | +*MonitoringWlanClientInfoApi* | [**get_stat_data_fields21**](docs/MonitoringWlanClientInfoApi.md#get_stat_data_fields21) | **GET** /statistics/wlanclientinfo/fields | +*MonitoringWlanClientInfoApi* | [**get_stat_data_raw_data18**](docs/MonitoringWlanClientInfoApi.md#get_stat_data_raw_data18) | **GET** /statistics/wlanclientinfo | +*MonitoringWlanClientInfoApi* | [**get_stat_data_raw_data_as_csv19**](docs/MonitoringWlanClientInfoApi.md#get_stat_data_raw_data_as_csv19) | **GET** /statistics/wlanclientinfo/csv | +*MonitoringWlanClientInfoApi* | [**get_stat_query_fields21**](docs/MonitoringWlanClientInfoApi.md#get_stat_query_fields21) | **GET** /statistics/wlanclientinfo/query/fields | +*MonitoringWlanClientInfoApi* | [**get_stats_raw_data19**](docs/MonitoringWlanClientInfoApi.md#get_stats_raw_data19) | **POST** /statistics/wlanclientinfo | +*MultitenantAPIsProviderApi* | [**create_tenant**](docs/MultitenantAPIsProviderApi.md#create_tenant) | **POST** /tenant | +*MultitenantAPIsProviderApi* | [**create_tenant_async**](docs/MultitenantAPIsProviderApi.md#create_tenant_async) | **POST** /tenant/async | +*MultitenantAPIsProviderApi* | [**create_tenant_async_bulk**](docs/MultitenantAPIsProviderApi.md#create_tenant_async_bulk) | **POST** /tenant/bulk/async | +*MultitenantAPIsProviderApi* | [**delete_tenant**](docs/MultitenantAPIsProviderApi.md#delete_tenant) | **POST** /tenant/{tenantId}/delete | +*MultitenantAPIsProviderApi* | [**delete_tenant_async_bulk**](docs/MultitenantAPIsProviderApi.md#delete_tenant_async_bulk) | **DELETE** /tenant/bulk/async | +*MultitenantAPIsProviderApi* | [**delete_tenant_backup**](docs/MultitenantAPIsProviderApi.md#delete_tenant_backup) | **DELETE** /tenantbackup/delete | +*MultitenantAPIsProviderApi* | [**download_existing_backup_file**](docs/MultitenantAPIsProviderApi.md#download_existing_backup_file) | **GET** /tenantbackup/download/{path} | +*MultitenantAPIsProviderApi* | [**export_tenant_backup**](docs/MultitenantAPIsProviderApi.md#export_tenant_backup) | **GET** /tenantbackup/export | +*MultitenantAPIsProviderApi* | [**force_status_collection**](docs/MultitenantAPIsProviderApi.md#force_status_collection) | **POST** /tenantstatus/force | +*MultitenantAPIsProviderApi* | [**get_all_tenant_statuses**](docs/MultitenantAPIsProviderApi.md#get_all_tenant_statuses) | **GET** /tenantstatus | +*MultitenantAPIsProviderApi* | [**get_all_tenants**](docs/MultitenantAPIsProviderApi.md#get_all_tenants) | **GET** /tenant | +*MultitenantAPIsProviderApi* | [**get_tenant**](docs/MultitenantAPIsProviderApi.md#get_tenant) | **GET** /tenant/{tenantId} | +*MultitenantAPIsProviderApi* | [**get_tenant_hosting_capacity_onv_smarts**](docs/MultitenantAPIsProviderApi.md#get_tenant_hosting_capacity_onv_smarts) | **GET** /tenant/vsmart/capacity | +*MultitenantAPIsProviderApi* | [**get_tenantv_smart_mapping**](docs/MultitenantAPIsProviderApi.md#get_tenantv_smart_mapping) | **GET** /tenant/vsmart | +*MultitenantAPIsProviderApi* | [**import_tenant_backup**](docs/MultitenantAPIsProviderApi.md#import_tenant_backup) | **POST** /tenantbackup/import | +*MultitenantAPIsProviderApi* | [**list_tenant_backup**](docs/MultitenantAPIsProviderApi.md#list_tenant_backup) | **GET** /tenantbackup/list | +*MultitenantAPIsProviderApi* | [**switch_tenant**](docs/MultitenantAPIsProviderApi.md#switch_tenant) | **POST** /tenant/{tenantId}/switch | +*MultitenantAPIsProviderApi* | [**tenantv_smart_mt_migrate**](docs/MultitenantAPIsProviderApi.md#tenantv_smart_mt_migrate) | **POST** /tenant/vsmart-mt/migrate | +*MultitenantAPIsProviderApi* | [**update_tenant**](docs/MultitenantAPIsProviderApi.md#update_tenant) | **PUT** /tenant/{tenantId} | +*MultitenantAPIsProviderApi* | [**update_tenantv_smart_placement**](docs/MultitenantAPIsProviderApi.md#update_tenantv_smart_placement) | **PUT** /tenant/{tenantId}/vsmart | +*MultitenantAPIsProviderApi* | [**v_session_id**](docs/MultitenantAPIsProviderApi.md#v_session_id) | **POST** /tenant/{tenantId}/vsessionid | +*NWPIApi* | [**get_agg_flow**](docs/NWPIApi.md#get_agg_flow) | **GET** /stream/device/nwpi/aggFlow | +*NWPIApi* | [**get_app_qos_data**](docs/NWPIApi.md#get_app_qos_data) | **GET** /stream/device/nwpi/appQosData | +*NWPIApi* | [**get_app_qos_state**](docs/NWPIApi.md#get_app_qos_state) | **GET** /stream/device/nwpi/appQosState | +*NWPIApi* | [**get_concurrent_data**](docs/NWPIApi.md#get_concurrent_data) | **GET** /stream/device/nwpi/concurrentData | +*NWPIApi* | [**get_concurrent_domain_data**](docs/NWPIApi.md#get_concurrent_domain_data) | **GET** /stream/device/nwpi/concurrentDomainData | +*NWPIApi* | [**get_event_app_hop_list**](docs/NWPIApi.md#get_event_app_hop_list) | **GET** /stream/device/nwpi/eventAppHopList | +*NWPIApi* | [**get_event_app_score_bandwidth**](docs/NWPIApi.md#get_event_app_score_bandwidth) | **GET** /stream/device/nwpi/eventAppScoreBandwidth | +*NWPIApi* | [**get_event_flow_from_app_hop**](docs/NWPIApi.md#get_event_flow_from_app_hop) | **GET** /stream/device/nwpi/eventFlowFromAppHop | +*NWPIApi* | [**get_event_readout**](docs/NWPIApi.md#get_event_readout) | **GET** /stream/device/nwpi/eventReadout | +*NWPIApi* | [**get_routing_detail_from_local**](docs/NWPIApi.md#get_routing_detail_from_local) | **GET** /stream/device/nwpi/routingDetail | +*PartnerACIPolicyBuilderApi* | [**create_dscp_mappings**](docs/PartnerACIPolicyBuilderApi.md#create_dscp_mappings) | **POST** /partner/aci/policy/dscpmapping/{partnerId} | +*PartnerACIPolicyBuilderApi* | [**delete_dscp_mappings**](docs/PartnerACIPolicyBuilderApi.md#delete_dscp_mappings) | **DELETE** /partner/aci/policy/dscpmapping/{partnerId} | +*PartnerACIPolicyBuilderApi* | [**get_aci_definitions**](docs/PartnerACIPolicyBuilderApi.md#get_aci_definitions) | **GET** /partner/aci/policy | +*PartnerACIPolicyBuilderApi* | [**get_data_prefix_mappings**](docs/PartnerACIPolicyBuilderApi.md#get_data_prefix_mappings) | **GET** /partner/aci/policy/prefixmapping/{partnerId} | +*PartnerACIPolicyBuilderApi* | [**get_data_prefix_sequences**](docs/PartnerACIPolicyBuilderApi.md#get_data_prefix_sequences) | **GET** /partner/aci/policy/sequences | +*PartnerACIPolicyBuilderApi* | [**get_dscp_mappings**](docs/PartnerACIPolicyBuilderApi.md#get_dscp_mappings) | **GET** /partner/aci/policy/dscpmapping/{partnerId} | +*PartnerACIPolicyBuilderApi* | [**get_events**](docs/PartnerACIPolicyBuilderApi.md#get_events) | **GET** /partner/aci/policy/events/{partnerId} | +*PartnerACIPolicyBuilderApi* | [**set_data_prefix_mappings**](docs/PartnerACIPolicyBuilderApi.md#set_data_prefix_mappings) | **POST** /partner/aci/policy/prefixmapping/{partnerId} | +*PartnerDNACSDAAPIApi* | [**create_sda_config**](docs/PartnerDNACSDAAPIApi.md#create_sda_config) | **POST** /partner/dnac/sda/config/{partnerId} | +*PartnerDNACSDAAPIApi* | [**create_sda_config_from_netconf**](docs/PartnerDNACSDAAPIApi.md#create_sda_config_from_netconf) | **POST** /partner/dnac/sda/netconfconfig/{partnerId} | +*PartnerDNACSDAAPIApi* | [**get_device_details**](docs/PartnerDNACSDAAPIApi.md#get_device_details) | **GET** /partner/dnac/sda/device/{partnerId}/{uuid} | +*PartnerDNACSDAAPIApi* | [**get_overlay_vpn_list**](docs/PartnerDNACSDAAPIApi.md#get_overlay_vpn_list) | **GET** /partner/dnac/sda/vpn | +*PartnerDNACSDAAPIApi* | [**get_sda_enabled_devices**](docs/PartnerDNACSDAAPIApi.md#get_sda_enabled_devices) | **GET** /partner/dnac/sda/device/{partnerId} | +*PartnerDNACSDAAPIApi* | [**get_sites_for_partner**](docs/PartnerDNACSDAAPIApi.md#get_sites_for_partner) | **GET** /partner/dnac/sda/site/{partnerId} | +*PartnerRegistrationApi* | [**delete_device_mapping**](docs/PartnerRegistrationApi.md#delete_device_mapping) | **POST** /partner/{partnerType}/unmap/{nmsId} | +*PartnerRegistrationApi* | [**delete_partner**](docs/PartnerRegistrationApi.md#delete_partner) | **DELETE** /partner/{partnerType}/{nmsId} | +*PartnerRegistrationApi* | [**get_data_change_info**](docs/PartnerRegistrationApi.md#get_data_change_info) | **GET** /serverlongpoll/event/poll/{partnerId} | +*PartnerRegistrationApi* | [**get_partner**](docs/PartnerRegistrationApi.md#get_partner) | **GET** /partner/{partnerType}/{nmsId} | +*PartnerRegistrationApi* | [**get_partner_devices**](docs/PartnerRegistrationApi.md#get_partner_devices) | **GET** /partner/{partnerType}/map/{nmsId} | +*PartnerRegistrationApi* | [**get_partners**](docs/PartnerRegistrationApi.md#get_partners) | **GET** /partner | +*PartnerRegistrationApi* | [**get_partners_by_partner_type**](docs/PartnerRegistrationApi.md#get_partners_by_partner_type) | **GET** /partner/{partnerType} | +*PartnerRegistrationApi* | [**get_vpn_list**](docs/PartnerRegistrationApi.md#get_vpn_list) | **GET** /partner/vpn | +*PartnerRegistrationApi* | [**map_devices**](docs/PartnerRegistrationApi.md#map_devices) | **POST** /partner/{partnerType}/map/{nmsId} | +*PartnerRegistrationApi* | [**register_partner**](docs/PartnerRegistrationApi.md#register_partner) | **POST** /partner/{partnerType} | +*PartnerRegistrationApi* | [**unmap_devices**](docs/PartnerRegistrationApi.md#unmap_devices) | **DELETE** /partner/{partnerType}/map/{nmsId} | +*PartnerRegistrationApi* | [**update_partner**](docs/PartnerRegistrationApi.md#update_partner) | **PUT** /partner/{partnerType}/{nmsId} | +*PartnerWCMConfigsApi* | [**push_netconf_configs**](docs/PartnerWCMConfigsApi.md#push_netconf_configs) | **POST** /partner/wcm/netconf/{nmsId} | +*RealTimeMonitoringAAAApi* | [**get_aa_aservers**](docs/RealTimeMonitoringAAAApi.md#get_aa_aservers) | **GET** /device/aaa/servers | +*RealTimeMonitoringAAAApi* | [**get_aaa_users**](docs/RealTimeMonitoringAAAApi.md#get_aaa_users) | **GET** /device/aaa/users | +*RealTimeMonitoringAAAApi* | [**get_acl_match_counter_users**](docs/RealTimeMonitoringAAAApi.md#get_acl_match_counter_users) | **GET** /device/acl/matchcounter | +*RealTimeMonitoringAAAApi* | [**get_all_device_users**](docs/RealTimeMonitoringAAAApi.md#get_all_device_users) | **GET** /device/users/list | +*RealTimeMonitoringAAAApi* | [**get_logging_from_device**](docs/RealTimeMonitoringAAAApi.md#get_logging_from_device) | **GET** /device/logging | +*RealTimeMonitoringAAAApi* | [**get_unclaimed_vedges**](docs/RealTimeMonitoringAAAApi.md#get_unclaimed_vedges) | **GET** /device/unclaimed/vedges | +*RealTimeMonitoringAAAApi* | [**get_users_from_device**](docs/RealTimeMonitoringAAAApi.md#get_users_from_device) | **GET** /device/users | +*RealTimeMonitoringARPApi* | [**get_arp_interface**](docs/RealTimeMonitoringARPApi.md#get_arp_interface) | **GET** /device/arp | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_attached_devices**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_attached_devices) | **GET** /device/app-hosting/attached-devices | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_details**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_details) | **GET** /device/app-hosting/details | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_guest_routes**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_guest_routes) | **GET** /device/app-hosting/guest-routes | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_network_devices**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_network_devices) | **GET** /device/app-hosting/network-interfaces | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_network_utils**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_network_utils) | **GET** /device/app-hosting/network-utilization | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_processes**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_processes) | **GET** /device/app-hosting/processes | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_storage_utils**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_storage_utils) | **GET** /device/app-hosting/storage-utilization | +*RealTimeMonitoringAppHostingApi* | [**get_app_hosting_utilization**](docs/RealTimeMonitoringAppHostingApi.md#get_app_hosting_utilization) | **GET** /device/app-hosting/utilization | +*RealTimeMonitoringAppLogsApi* | [**get_app_log_flow_count**](docs/RealTimeMonitoringAppLogsApi.md#get_app_log_flow_count) | **GET** /device/app/log/flow-count | +*RealTimeMonitoringAppLogsApi* | [**get_app_log_flows**](docs/RealTimeMonitoringAppLogsApi.md#get_app_log_flows) | **GET** /device/app/log/flows | +*RealTimeMonitoringApplicationAwareRouteApi* | [**create_app_route_sla_class_list**](docs/RealTimeMonitoringApplicationAwareRouteApi.md#create_app_route_sla_class_list) | **GET** /device/app-route/sla-class | +*RealTimeMonitoringApplicationAwareRouteApi* | [**create_app_route_statistics_list**](docs/RealTimeMonitoringApplicationAwareRouteApi.md#create_app_route_statistics_list) | **GET** /device/app-route/statistics | +*RealTimeMonitoringAppqoeApi* | [**create_appqoe_active_flow_id_details**](docs/RealTimeMonitoringAppqoeApi.md#create_appqoe_active_flow_id_details) | **GET** /device/appqoe/active-flow-id | +*RealTimeMonitoringAppqoeApi* | [**create_appqoe_flow_id_expired_details**](docs/RealTimeMonitoringAppqoeApi.md#create_appqoe_flow_id_expired_details) | **GET** /device/appqoe/expired-flow-id | +*RealTimeMonitoringAppqoeApi* | [**create_appqoe_vpn_id_list**](docs/RealTimeMonitoringAppqoeApi.md#create_appqoe_vpn_id_list) | **GET** /device/appqoe/vpn-id | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_cluster_summary**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_cluster_summary) | **GET** /device/appqoe/cluster-summary | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_error_recent**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_error_recent) | **GET** /device/appqoe/error-recent | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_expired**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_expired) | **GET** /device/appqoe/flow-expired | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_flow_closed_error**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_flow_closed_error) | **GET** /device/appqoe/flow-closed-error | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_hput_stats**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_hput_stats) | **GET** /device/appqoe/appqoe-hput-stats | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_nat_stats**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_nat_stats) | **GET** /device/appqoe/appqoe-nat-stats | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_rm_resources**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_rm_resources) | **GET** /device/appqoe/appqoe-rm-resource | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_rm_stats**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_rm_stats) | **GET** /device/appqoe/appqoe-rm-stats | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_service_controllers**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_service_controllers) | **GET** /device/appqoe/service-controllers | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_services_status**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_services_status) | **GET** /device/appqoe/appqoe-services-status | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_sppi_pipe_stats**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_sppi_pipe_stats) | **GET** /device/appqoe/appqoe-sppi-pipe-resource | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_sppi_queue_stats**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_sppi_queue_stats) | **GET** /device/appqoe/appqoe-sppi-queue-resource | +*RealTimeMonitoringAppqoeApi* | [**get_appqoe_status**](docs/RealTimeMonitoringAppqoeApi.md#get_appqoe_status) | **GET** /device/appqoe/status | +*RealTimeMonitoringBFDApi* | [**create_bfd_history_list**](docs/RealTimeMonitoringBFDApi.md#create_bfd_history_list) | **GET** /device/bfd/history | +*RealTimeMonitoringBFDApi* | [**create_bfd_link_list**](docs/RealTimeMonitoringBFDApi.md#create_bfd_link_list) | **GET** /device/bfd/links | +*RealTimeMonitoringBFDApi* | [**create_bfd_sessions**](docs/RealTimeMonitoringBFDApi.md#create_bfd_sessions) | **GET** /device/bfd/sessions | +*RealTimeMonitoringBFDApi* | [**create_bfd_summary**](docs/RealTimeMonitoringBFDApi.md#create_bfd_summary) | **GET** /device/bfd/summary | +*RealTimeMonitoringBFDApi* | [**create_synced_bfd_session**](docs/RealTimeMonitoringBFDApi.md#create_synced_bfd_session) | **GET** /device/bfd/synced/sessions | +*RealTimeMonitoringBFDApi* | [**create_tloc_summary**](docs/RealTimeMonitoringBFDApi.md#create_tloc_summary) | **GET** /device/bfd/tloc | +*RealTimeMonitoringBFDApi* | [**get_bfd_site_state_detail**](docs/RealTimeMonitoringBFDApi.md#get_bfd_site_state_detail) | **GET** /device/bfd/sites/detail | +*RealTimeMonitoringBFDApi* | [**get_bfd_sites_summary**](docs/RealTimeMonitoringBFDApi.md#get_bfd_sites_summary) | **GET** /device/bfd/sites/summary | +*RealTimeMonitoringBFDApi* | [**get_device_bfd_state_summary**](docs/RealTimeMonitoringBFDApi.md#get_device_bfd_state_summary) | **GET** /device/bfd/state/device | +*RealTimeMonitoringBFDApi* | [**get_device_bfd_state_summary_tloc**](docs/RealTimeMonitoringBFDApi.md#get_device_bfd_state_summary_tloc) | **GET** /device/bfd/state/device/tloc | +*RealTimeMonitoringBFDApi* | [**get_device_bfd_status**](docs/RealTimeMonitoringBFDApi.md#get_device_bfd_status) | **GET** /device/bfd/status | +*RealTimeMonitoringBFDApi* | [**get_device_bfd_status_summary**](docs/RealTimeMonitoringBFDApi.md#get_device_bfd_status_summary) | **GET** /device/bfd/summary/device | +*RealTimeMonitoringBFDApi* | [**get_device_tloc_to_intf_list**](docs/RealTimeMonitoringBFDApi.md#get_device_tloc_to_intf_list) | **GET** /device/bfd/state/device/tlocInterfaceMap | +*RealTimeMonitoringBGPApi* | [**create_bgp_neighbors_list**](docs/RealTimeMonitoringBGPApi.md#create_bgp_neighbors_list) | **GET** /device/bgp/neighbors | +*RealTimeMonitoringBGPApi* | [**create_bgp_routes_list**](docs/RealTimeMonitoringBGPApi.md#create_bgp_routes_list) | **GET** /device/bgp/routes | +*RealTimeMonitoringBGPApi* | [**create_bgp_summary**](docs/RealTimeMonitoringBGPApi.md#create_bgp_summary) | **GET** /device/bgp/summary | +*RealTimeMonitoringBridgeApi* | [**get_bridge_interface_list**](docs/RealTimeMonitoringBridgeApi.md#get_bridge_interface_list) | **GET** /device/bridge/interface | +*RealTimeMonitoringBridgeApi* | [**get_bridge_interface_mac**](docs/RealTimeMonitoringBridgeApi.md#get_bridge_interface_mac) | **GET** /device/bridge/mac | +*RealTimeMonitoringBridgeApi* | [**get_bridge_interface_table**](docs/RealTimeMonitoringBridgeApi.md#get_bridge_interface_table) | **GET** /device/bridge/table | +*RealTimeMonitoringCFMApi* | [**get_mp_database**](docs/RealTimeMonitoringCFMApi.md#get_mp_database) | **GET** /device/cfm/mp/database | +*RealTimeMonitoringCFMApi* | [**get_mp_local_mep**](docs/RealTimeMonitoringCFMApi.md#get_mp_local_mep) | **GET** /device/cfm/mp/local/mep | +*RealTimeMonitoringCFMApi* | [**get_mp_local_mip**](docs/RealTimeMonitoringCFMApi.md#get_mp_local_mip) | **GET** /device/cfm/mp/local/mip | +*RealTimeMonitoringCFMApi* | [**get_mp_remote_mep**](docs/RealTimeMonitoringCFMApi.md#get_mp_remote_mep) | **GET** /device/cfm/mp/remotemep | +*RealTimeMonitoringCellularApi* | [**create_cellular_connection_list**](docs/RealTimeMonitoringCellularApi.md#create_cellular_connection_list) | **GET** /device/cellular/connection | +*RealTimeMonitoringCellularApi* | [**create_hardware_list**](docs/RealTimeMonitoringCellularApi.md#create_hardware_list) | **GET** /device/cellular/hardware | +*RealTimeMonitoringCellularApi* | [**create_modem_list**](docs/RealTimeMonitoringCellularApi.md#create_modem_list) | **GET** /device/cellular/modem | +*RealTimeMonitoringCellularApi* | [**create_network_list**](docs/RealTimeMonitoringCellularApi.md#create_network_list) | **GET** /device/cellular/network | +*RealTimeMonitoringCellularApi* | [**create_profile_list**](docs/RealTimeMonitoringCellularApi.md#create_profile_list) | **GET** /device/cellular/profiles | +*RealTimeMonitoringCellularApi* | [**create_radio_list**](docs/RealTimeMonitoringCellularApi.md#create_radio_list) | **GET** /device/cellular/radio | +*RealTimeMonitoringCellularApi* | [**create_sessions_list**](docs/RealTimeMonitoringCellularApi.md#create_sessions_list) | **GET** /device/cellular/sessions | +*RealTimeMonitoringCellularApi* | [**get_cellular_status_list**](docs/RealTimeMonitoringCellularApi.md#get_cellular_status_list) | **GET** /device/cellular/status | +*RealTimeMonitoringCellularAONIpsecInterfaceApi* | [**get_aon_ipsec_interface_counters_info**](docs/RealTimeMonitoringCellularAONIpsecInterfaceApi.md#get_aon_ipsec_interface_counters_info) | **GET** /device/cellularEiolte/ipsec/interface/counters | +*RealTimeMonitoringCellularAONIpsecInterfaceApi* | [**get_aon_ipsec_interface_sessionnfo**](docs/RealTimeMonitoringCellularAONIpsecInterfaceApi.md#get_aon_ipsec_interface_sessionnfo) | **GET** /device/cellularEiolte/ipsec/interface/session | +*RealTimeMonitoringCellularEIOLTEConnectionServiceApi* | [**get_eiolte_connection_info**](docs/RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md#get_eiolte_connection_info) | **GET** /device/cellularEiolte/connections | +*RealTimeMonitoringCellularEIOLTEConnectionServiceApi* | [**get_eiolte_radio_info**](docs/RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md#get_eiolte_radio_info) | **GET** /device/cellularEiolte/radio | +*RealTimeMonitoringCellularEIOLTEHardwareServiceApi* | [**get_eiolte_hardware_info**](docs/RealTimeMonitoringCellularEIOLTEHardwareServiceApi.md#get_eiolte_hardware_info) | **GET** /device/cellularEiolte/hardware | +*RealTimeMonitoringCellularEIOLTENetworkServiceApi* | [**get_eiolte_network_info**](docs/RealTimeMonitoringCellularEIOLTENetworkServiceApi.md#get_eiolte_network_info) | **GET** /device/cellularEiolte/network | +*RealTimeMonitoringCellularEIOLTESimServiceApi* | [**get_eiolte_sim_info**](docs/RealTimeMonitoringCellularEIOLTESimServiceApi.md#get_eiolte_sim_info) | **GET** /device/cellularEiolte/sim | +*RealTimeMonitoringCloudExpressApi* | [**create_applications_detail_list**](docs/RealTimeMonitoringCloudExpressApi.md#create_applications_detail_list) | **GET** /device/cloudx/application/detail | +*RealTimeMonitoringCloudExpressApi* | [**create_applications_list**](docs/RealTimeMonitoringCloudExpressApi.md#create_applications_list) | **GET** /device/cloudx/applications | +*RealTimeMonitoringCloudExpressApi* | [**create_gateway_exits_list**](docs/RealTimeMonitoringCloudExpressApi.md#create_gateway_exits_list) | **GET** /device/cloudx/gatewayexits | +*RealTimeMonitoringCloudExpressApi* | [**create_lb_applications_list**](docs/RealTimeMonitoringCloudExpressApi.md#create_lb_applications_list) | **GET** /device/cloudx/loadbalance | +*RealTimeMonitoringCloudExpressApi* | [**create_local_exits_list**](docs/RealTimeMonitoringCloudExpressApi.md#create_local_exits_list) | **GET** /device/cloudx/localexits | +*RealTimeMonitoringCommitListApi* | [**get_device_configuration_commit_list**](docs/RealTimeMonitoringCommitListApi.md#get_device_configuration_commit_list) | **GET** /device/configuration/commit-list | +*RealTimeMonitoringContainerLifecycleApi* | [**create_device_containers_info**](docs/RealTimeMonitoringContainerLifecycleApi.md#create_device_containers_info) | **GET** /device/csp/containers/container | +*RealTimeMonitoringCrashLogApi* | [**get_all_device_crash_logs**](docs/RealTimeMonitoringCrashLogApi.md#get_all_device_crash_logs) | **GET** /device/crashlog/details | +*RealTimeMonitoringCrashLogApi* | [**get_device_crash_information**](docs/RealTimeMonitoringCrashLogApi.md#get_device_crash_information) | **GET** /device/crashlog/log | +*RealTimeMonitoringCrashLogApi* | [**get_device_crash_logs**](docs/RealTimeMonitoringCrashLogApi.md#get_device_crash_logs) | **GET** /device/crashlog | +*RealTimeMonitoringCrashLogApi* | [**get_device_crash_logs_synced**](docs/RealTimeMonitoringCrashLogApi.md#get_device_crash_logs_synced) | **GET** /device/crashlog/synced | +*RealTimeMonitoringDHCPApi* | [**get_dhcp_client**](docs/RealTimeMonitoringDHCPApi.md#get_dhcp_client) | **GET** /device/dhcp/client | +*RealTimeMonitoringDHCPApi* | [**get_dhcp_interface**](docs/RealTimeMonitoringDHCPApi.md#get_dhcp_interface) | **GET** /device/dhcp/interface | +*RealTimeMonitoringDHCPApi* | [**get_dhcp_server**](docs/RealTimeMonitoringDHCPApi.md#get_dhcp_server) | **GET** /device/dhcp/server | +*RealTimeMonitoringDHCPApi* | [**get_dhcpv6_interface**](docs/RealTimeMonitoringDHCPApi.md#get_dhcpv6_interface) | **GET** /device/dhcpv6/interface | +*RealTimeMonitoringDOT1xApi* | [**get_dot1x_radius**](docs/RealTimeMonitoringDOT1xApi.md#get_dot1x_radius) | **GET** /device/dot1x/radius | +*RealTimeMonitoringDOT1xApi* | [**get_wlandot1x_clients**](docs/RealTimeMonitoringDOT1xApi.md#get_wlandot1x_clients) | **GET** /device/dot1x/clients | +*RealTimeMonitoringDOT1xApi* | [**get_wlandot1x_interfaces**](docs/RealTimeMonitoringDOT1xApi.md#get_wlandot1x_interfaces) | **GET** /device/dot1x/interfaces | +*RealTimeMonitoringDPIApi* | [**create_dpi_collector_list**](docs/RealTimeMonitoringDPIApi.md#create_dpi_collector_list) | **GET** /device/dpi/applications | +*RealTimeMonitoringDPIApi* | [**create_dpi_flows_list**](docs/RealTimeMonitoringDPIApi.md#create_dpi_flows_list) | **GET** /device/dpi/flows | +*RealTimeMonitoringDPIApi* | [**create_dpi_statistics**](docs/RealTimeMonitoringDPIApi.md#create_dpi_statistics) | **GET** /device/dpi/supported-applications | +*RealTimeMonitoringDPIApi* | [**create_dpi_summary_real_time**](docs/RealTimeMonitoringDPIApi.md#create_dpi_summary_real_time) | **GET** /device/dpi/summary | +*RealTimeMonitoringDPIApi* | [**get_common_application_list**](docs/RealTimeMonitoringDPIApi.md#get_common_application_list) | **GET** /device/dpi/common/applications | +*RealTimeMonitoringDPIApi* | [**get_dpi_device_details_field_json**](docs/RealTimeMonitoringDPIApi.md#get_dpi_device_details_field_json) | **GET** /device/dpi/devicedetails/fields | +*RealTimeMonitoringDPIApi* | [**get_dpi_device_field_json**](docs/RealTimeMonitoringDPIApi.md#get_dpi_device_field_json) | **GET** /device/dpi/application/fields | +*RealTimeMonitoringDPIApi* | [**get_dpi_field_json**](docs/RealTimeMonitoringDPIApi.md#get_dpi_field_json) | **GET** /device/dpi/device/fields | +*RealTimeMonitoringDPIApi* | [**get_qosmos_application_list**](docs/RealTimeMonitoringDPIApi.md#get_qosmos_application_list) | **GET** /device/dpi/qosmos/applications | +*RealTimeMonitoringDPIApi* | [**get_qosmos_static_application_list**](docs/RealTimeMonitoringDPIApi.md#get_qosmos_static_application_list) | **GET** /device/dpi/qosmos-static/applications | +*RealTimeMonitoringDPIApi* | [**get_supported_application_list**](docs/RealTimeMonitoringDPIApi.md#get_supported_application_list) | **GET** /device/dpi/application-mapping | +*RealTimeMonitoringDREApi* | [**get_dre_auto_bypass_stats**](docs/RealTimeMonitoringDREApi.md#get_dre_auto_bypass_stats) | **GET** /device/dre/auto-bypass-stats | +*RealTimeMonitoringDREApi* | [**get_dre_peer_stats**](docs/RealTimeMonitoringDREApi.md#get_dre_peer_stats) | **GET** /device/dre/peer-stats | +*RealTimeMonitoringDREApi* | [**get_dre_stats**](docs/RealTimeMonitoringDREApi.md#get_dre_stats) | **GET** /device/dre/dre-stats | +*RealTimeMonitoringDREApi* | [**get_dre_status**](docs/RealTimeMonitoringDREApi.md#get_dre_status) | **GET** /device/dre/dre-status | +*RealTimeMonitoringDeviceApi* | [**get_ipv6_data**](docs/RealTimeMonitoringDeviceApi.md#get_ipv6_data) | **GET** /device/ipv6/nd6 | +*RealTimeMonitoringDeviceControlApi* | [**create_connection_history_list_real_time**](docs/RealTimeMonitoringDeviceControlApi.md#create_connection_history_list_real_time) | **GET** /device/control/connectionshistory | +*RealTimeMonitoringDeviceControlApi* | [**create_connections_summary**](docs/RealTimeMonitoringDeviceControlApi.md#create_connections_summary) | **GET** /device/control/summary | +*RealTimeMonitoringDeviceControlApi* | [**create_link_list**](docs/RealTimeMonitoringDeviceControlApi.md#create_link_list) | **GET** /device/control/links | +*RealTimeMonitoringDeviceControlApi* | [**create_local_properties_list_list_real_t_ime**](docs/RealTimeMonitoringDeviceControlApi.md#create_local_properties_list_list_real_t_ime) | **GET** /device/control/localproperties | +*RealTimeMonitoringDeviceControlApi* | [**create_local_properties_synced_list**](docs/RealTimeMonitoringDeviceControlApi.md#create_local_properties_synced_list) | **GET** /device/control/synced/localproperties | +*RealTimeMonitoringDeviceControlApi* | [**create_real_time_connection_list**](docs/RealTimeMonitoringDeviceControlApi.md#create_real_time_connection_list) | **GET** /device/control/connections | +*RealTimeMonitoringDeviceControlApi* | [**create_real_time_connection_list1**](docs/RealTimeMonitoringDeviceControlApi.md#create_real_time_connection_list1) | **GET** /device/control/connectionsinfo | +*RealTimeMonitoringDeviceControlApi* | [**create_synced_connection_list**](docs/RealTimeMonitoringDeviceControlApi.md#create_synced_connection_list) | **GET** /device/control/synced/connections | +*RealTimeMonitoringDeviceControlApi* | [**create_valid_devices_list_real_time**](docs/RealTimeMonitoringDeviceControlApi.md#create_valid_devices_list_real_time) | **GET** /device/control/validdevices | +*RealTimeMonitoringDeviceControlApi* | [**create_valid_v_smarts_list_real_time**](docs/RealTimeMonitoringDeviceControlApi.md#create_valid_v_smarts_list_real_time) | **GET** /device/control/validvsmarts | +*RealTimeMonitoringDeviceControlApi* | [**create_wan_interface_list_list**](docs/RealTimeMonitoringDeviceControlApi.md#create_wan_interface_list_list) | **GET** /device/control/waninterface | +*RealTimeMonitoringDeviceControlApi* | [**create_wan_interface_synced_list**](docs/RealTimeMonitoringDeviceControlApi.md#create_wan_interface_synced_list) | **GET** /device/control/synced/waninterface | +*RealTimeMonitoringDeviceControlApi* | [**get_affinity_config**](docs/RealTimeMonitoringDeviceControlApi.md#get_affinity_config) | **GET** /device/control/affinity/config | +*RealTimeMonitoringDeviceControlApi* | [**get_affinity_status**](docs/RealTimeMonitoringDeviceControlApi.md#get_affinity_status) | **GET** /device/control/affinity/status | +*RealTimeMonitoringDeviceControlApi* | [**get_connection_statistics**](docs/RealTimeMonitoringDeviceControlApi.md#get_connection_statistics) | **GET** /device/control/statistics | +*RealTimeMonitoringDeviceControlApi* | [**get_device_control_status_summary**](docs/RealTimeMonitoringDeviceControlApi.md#get_device_control_status_summary) | **GET** /device/control/summary/device | +*RealTimeMonitoringDeviceControlApi* | [**get_local_device_status**](docs/RealTimeMonitoringDeviceControlApi.md#get_local_device_status) | **GET** /device/control/status | +*RealTimeMonitoringDeviceControlApi* | [**get_port_hop_color**](docs/RealTimeMonitoringDeviceControlApi.md#get_port_hop_color) | **GET** /device/control/waninterface/color | +*RealTimeMonitoringDeviceControlApi* | [**get_total_count_for_device_states**](docs/RealTimeMonitoringDeviceControlApi.md#get_total_count_for_device_states) | **GET** /device/control/count | +*RealTimeMonitoringDeviceControlApi* | [**get_valid_v_manage_id_real_time**](docs/RealTimeMonitoringDeviceControlApi.md#get_valid_v_manage_id_real_time) | **GET** /device/control/validvmanageid | +*RealTimeMonitoringDeviceControlApi* | [**network_summary**](docs/RealTimeMonitoringDeviceControlApi.md#network_summary) | **GET** /device/control/networksummary | +*RealTimeMonitoringDeviceFeatureListApi* | [**get_feature_list**](docs/RealTimeMonitoringDeviceFeatureListApi.md#get_feature_list) | **GET** /device/featurelist | +*RealTimeMonitoringDeviceFeatureListApi* | [**get_synced_feature_list**](docs/RealTimeMonitoringDeviceFeatureListApi.md#get_synced_feature_list) | **GET** /device/featurelist/synced | +*RealTimeMonitoringDeviceSystemStatsApi* | [**create_device_system_cpu_stat**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#create_device_system_cpu_stat) | **GET** /statistics/system/cpu | +*RealTimeMonitoringDeviceSystemStatsApi* | [**create_device_system_memory_stat**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#create_device_system_memory_stat) | **GET** /statistics/system/memory | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_aggregation_data_by_query16**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_aggregation_data_by_query16) | **GET** /statistics/system/aggregation | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_count18**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_count18) | **GET** /statistics/system/doccount | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_count_post18**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_count_post18) | **POST** /statistics/system/doccount | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_post_aggregation_app_data_by_query15**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_post_aggregation_app_data_by_query15) | **POST** /statistics/system/app-agg/aggregation | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_post_aggregation_data_by_query15**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_post_aggregation_data_by_query15) | **POST** /statistics/system/aggregation | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_post_stat_bulk_raw_data16**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_post_stat_bulk_raw_data16) | **POST** /statistics/system/page | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_stat_bulk_raw_data16**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_bulk_raw_data16) | **GET** /statistics/system/page | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_stat_data_fields18**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_data_fields18) | **GET** /statistics/system/fields | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_stat_data_raw_data15**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_data_raw_data15) | **GET** /statistics/system | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_stat_data_raw_data_as_csv16**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_data_raw_data_as_csv16) | **GET** /statistics/system/csv | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_stat_query_fields18**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_query_fields18) | **GET** /statistics/system/query/fields | +*RealTimeMonitoringDeviceSystemStatsApi* | [**get_stats_raw_data16**](docs/RealTimeMonitoringDeviceSystemStatsApi.md#get_stats_raw_data16) | **POST** /statistics/system | +*RealTimeMonitoringDualStaticRouteTrackerServiceApi* | [**get_dual_static_route_tracker_info**](docs/RealTimeMonitoringDualStaticRouteTrackerServiceApi.md#get_dual_static_route_tracker_info) | **GET** /device/dualStaticRouteTracker | +*RealTimeMonitoringEIGRPApi* | [**create_eigrp_interface**](docs/RealTimeMonitoringEIGRPApi.md#create_eigrp_interface) | **GET** /device/eigrp/interface | +*RealTimeMonitoringEIGRPApi* | [**create_eigrp_route**](docs/RealTimeMonitoringEIGRPApi.md#create_eigrp_route) | **GET** /device/eigrp/route | +*RealTimeMonitoringEIGRPApi* | [**create_eigrp_topology**](docs/RealTimeMonitoringEIGRPApi.md#create_eigrp_topology) | **GET** /device/eigrp/topology | +*RealTimeMonitoringEndpointTrackerGroupServiceApi* | [**get_endpoint_tracker_group_info**](docs/RealTimeMonitoringEndpointTrackerGroupServiceApi.md#get_endpoint_tracker_group_info) | **GET** /device/endpointTrackerGroup | +*RealTimeMonitoringEndpointTrackerServiceApi* | [**get_endpoint_tracker_info**](docs/RealTimeMonitoringEndpointTrackerServiceApi.md#get_endpoint_tracker_info) | **GET** /device/endpointTracker | +*RealTimeMonitoringGeoFencingApi* | [**get_geofence_status**](docs/RealTimeMonitoringGeoFencingApi.md#get_geofence_status) | **GET** /device/geofence/status | +*RealTimeMonitoringHardwareApi* | [**create_alarm_list**](docs/RealTimeMonitoringHardwareApi.md#create_alarm_list) | **GET** /device/hardware/alarms | +*RealTimeMonitoringHardwareApi* | [**create_environment_list**](docs/RealTimeMonitoringHardwareApi.md#create_environment_list) | **GET** /device/hardware/environment | +*RealTimeMonitoringHardwareApi* | [**create_error_alarm_list**](docs/RealTimeMonitoringHardwareApi.md#create_error_alarm_list) | **GET** /device/hardware/errors | +*RealTimeMonitoringHardwareApi* | [**create_inventory_list**](docs/RealTimeMonitoringHardwareApi.md#create_inventory_list) | **GET** /device/hardware/inventory | +*RealTimeMonitoringHardwareApi* | [**create_status_summary**](docs/RealTimeMonitoringHardwareApi.md#create_status_summary) | **GET** /device/hardware/status/summary | +*RealTimeMonitoringHardwareApi* | [**create_synced_alarm_list**](docs/RealTimeMonitoringHardwareApi.md#create_synced_alarm_list) | **GET** /device/hardware/synced/alarms | +*RealTimeMonitoringHardwareApi* | [**create_synced_environment_list**](docs/RealTimeMonitoringHardwareApi.md#create_synced_environment_list) | **GET** /device/hardware/synced/environment | +*RealTimeMonitoringHardwareApi* | [**create_synced_inventory_list**](docs/RealTimeMonitoringHardwareApi.md#create_synced_inventory_list) | **GET** /device/hardware/synced/inventory | +*RealTimeMonitoringHardwareApi* | [**create_system_list**](docs/RealTimeMonitoringHardwareApi.md#create_system_list) | **GET** /device/hardware/system | +*RealTimeMonitoringHardwareApi* | [**create_temp_threshold_list**](docs/RealTimeMonitoringHardwareApi.md#create_temp_threshold_list) | **GET** /device/hardware/threshold | +*RealTimeMonitoringIGMPApi* | [**create_igmp_groups_list**](docs/RealTimeMonitoringIGMPApi.md#create_igmp_groups_list) | **GET** /device/igmp/groups | +*RealTimeMonitoringIGMPApi* | [**create_igmp_interface_list**](docs/RealTimeMonitoringIGMPApi.md#create_igmp_interface_list) | **GET** /device/igmp/interface | +*RealTimeMonitoringIGMPApi* | [**create_igmp_statistics_list**](docs/RealTimeMonitoringIGMPApi.md#create_igmp_statistics_list) | **GET** /device/igmp/statistics | +*RealTimeMonitoringIGMPApi* | [**create_igmp_summary**](docs/RealTimeMonitoringIGMPApi.md#create_igmp_summary) | **GET** /device/igmp/summary | +*RealTimeMonitoringIPApi* | [**create_fib_list**](docs/RealTimeMonitoringIPApi.md#create_fib_list) | **GET** /device/ip/fib | +*RealTimeMonitoringIPApi* | [**create_ietf_routing_list**](docs/RealTimeMonitoringIPApi.md#create_ietf_routing_list) | **GET** /device/ip/ipRoutes | +*RealTimeMonitoringIPApi* | [**create_ip_mfib_oil_list**](docs/RealTimeMonitoringIPApi.md#create_ip_mfib_oil_list) | **GET** /device/ip/mfiboil | +*RealTimeMonitoringIPApi* | [**create_ip_mfib_stats_list**](docs/RealTimeMonitoringIPApi.md#create_ip_mfib_stats_list) | **GET** /device/ip/mfibstats | +*RealTimeMonitoringIPApi* | [**create_ip_mfib_summary_list**](docs/RealTimeMonitoringIPApi.md#create_ip_mfib_summary_list) | **GET** /device/ip/mfibsummary | +*RealTimeMonitoringIPApi* | [**create_nat64_translation_list**](docs/RealTimeMonitoringIPApi.md#create_nat64_translation_list) | **GET** /device/ip/nat64/translation | +*RealTimeMonitoringIPApi* | [**create_nat_filter_list**](docs/RealTimeMonitoringIPApi.md#create_nat_filter_list) | **GET** /device/ip/nat/filter | +*RealTimeMonitoringIPApi* | [**create_nat_interface_list**](docs/RealTimeMonitoringIPApi.md#create_nat_interface_list) | **GET** /device/ip/nat/interface | +*RealTimeMonitoringIPApi* | [**create_nat_interface_statistics_list**](docs/RealTimeMonitoringIPApi.md#create_nat_interface_statistics_list) | **GET** /device/ip/nat/interfacestatistics | +*RealTimeMonitoringIPApi* | [**create_nat_translation_list**](docs/RealTimeMonitoringIPApi.md#create_nat_translation_list) | **GET** /device/ip/nat/translation | +*RealTimeMonitoringIPApi* | [**create_route_table_list**](docs/RealTimeMonitoringIPApi.md#create_route_table_list) | **GET** /device/ip/routetable | +*RealTimeMonitoringIPsecApi* | [**create_crypto_ipsec_identity**](docs/RealTimeMonitoringIPsecApi.md#create_crypto_ipsec_identity) | **GET** /device/ipsec/identity | +*RealTimeMonitoringIPsecApi* | [**create_cryptov1_local_sa_list**](docs/RealTimeMonitoringIPsecApi.md#create_cryptov1_local_sa_list) | **GET** /device/ipsec/ikev1 | +*RealTimeMonitoringIPsecApi* | [**create_cryptov2_local_sa_list**](docs/RealTimeMonitoringIPsecApi.md#create_cryptov2_local_sa_list) | **GET** /device/ipsec/ikev2 | +*RealTimeMonitoringIPsecApi* | [**create_i_psec_pwk_inbound_connections**](docs/RealTimeMonitoringIPsecApi.md#create_i_psec_pwk_inbound_connections) | **GET** /device/ipsec/pwk/inbound | +*RealTimeMonitoringIPsecApi* | [**create_i_psec_pwk_local_sa**](docs/RealTimeMonitoringIPsecApi.md#create_i_psec_pwk_local_sa) | **GET** /device/ipsec/pwk/localsa | +*RealTimeMonitoringIPsecApi* | [**create_i_psec_pwk_outbound_connections**](docs/RealTimeMonitoringIPsecApi.md#create_i_psec_pwk_outbound_connections) | **GET** /device/ipsec/pwk/outbound | +*RealTimeMonitoringIPsecApi* | [**create_ike_inbound_list**](docs/RealTimeMonitoringIPsecApi.md#create_ike_inbound_list) | **GET** /device/ipsec/ike/inbound | +*RealTimeMonitoringIPsecApi* | [**create_ike_outbound_list**](docs/RealTimeMonitoringIPsecApi.md#create_ike_outbound_list) | **GET** /device/ipsec/ike/outbound | +*RealTimeMonitoringIPsecApi* | [**create_ike_sessions**](docs/RealTimeMonitoringIPsecApi.md#create_ike_sessions) | **GET** /device/ipsec/ike/sessions | +*RealTimeMonitoringIPsecApi* | [**create_in_bound_list**](docs/RealTimeMonitoringIPsecApi.md#create_in_bound_list) | **GET** /device/ipsec/inbound | +*RealTimeMonitoringIPsecApi* | [**create_local_sa_list**](docs/RealTimeMonitoringIPsecApi.md#create_local_sa_list) | **GET** /device/ipsec/localsa | +*RealTimeMonitoringIPsecApi* | [**create_out_bound_list**](docs/RealTimeMonitoringIPsecApi.md#create_out_bound_list) | **GET** /device/ipsec/outbound | +*RealTimeMonitoringIPv4FIBApi* | [**create_ipv4_fib_list**](docs/RealTimeMonitoringIPv4FIBApi.md#create_ipv4_fib_list) | **GET** /device/ip/v4fib | +*RealTimeMonitoringIPv6FIBApi* | [**create_ipv6_fib_list**](docs/RealTimeMonitoringIPv6FIBApi.md#create_ipv6_fib_list) | **GET** /device/ip/v6fib | +*RealTimeMonitoringIPv6NeighboursApi* | [**get_ipv6_interface**](docs/RealTimeMonitoringIPv6NeighboursApi.md#get_ipv6_interface) | **GET** /device/ndv6 | +*RealTimeMonitoringInterfaceApi* | [**generate_device_interface_vpn**](docs/RealTimeMonitoringInterfaceApi.md#generate_device_interface_vpn) | **GET** /device/interface/vpn | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface) | **GET** /device/interface | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_arp_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_arp_stats) | **GET** /device/interface/arp_stats | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_error_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_error_stats) | **GET** /device/interface/error_stats | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_ipv6_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_ipv6_stats) | **GET** /device/interface/ipv6Stats | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_pkt_sizes**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_pkt_sizes) | **GET** /device/interface/pkt_size | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_port_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_port_stats) | **GET** /device/interface/port_stats | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_qos_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_qos_stats) | **GET** /device/interface/qosStats | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_queue_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_queue_stats) | **GET** /device/interface/queue_stats | +*RealTimeMonitoringInterfaceApi* | [**get_device_interface_stats**](docs/RealTimeMonitoringInterfaceApi.md#get_device_interface_stats) | **GET** /device/interface/stats | +*RealTimeMonitoringInterfaceApi* | [**get_device_serial_interface**](docs/RealTimeMonitoringInterfaceApi.md#get_device_serial_interface) | **GET** /device/interface/serial | +*RealTimeMonitoringInterfaceApi* | [**get_synced_device_interface**](docs/RealTimeMonitoringInterfaceApi.md#get_synced_device_interface) | **GET** /device/interface/synced | +*RealTimeMonitoringInterfaceApi* | [**trustsec**](docs/RealTimeMonitoringInterfaceApi.md#trustsec) | **GET** /device/interface/trustsec | +*RealTimeMonitoringLicenseInfoApi* | [**get_license_eval_info**](docs/RealTimeMonitoringLicenseInfoApi.md#get_license_eval_info) | **GET** /device/license/evaluation | +*RealTimeMonitoringLicenseInfoApi* | [**get_license_pak_info**](docs/RealTimeMonitoringLicenseInfoApi.md#get_license_pak_info) | **GET** /device/license/pak | +*RealTimeMonitoringLicenseInfoApi* | [**get_license_privacy_info**](docs/RealTimeMonitoringLicenseInfoApi.md#get_license_privacy_info) | **GET** /device/license/privacy | +*RealTimeMonitoringLicenseInfoApi* | [**get_license_reg_info**](docs/RealTimeMonitoringLicenseInfoApi.md#get_license_reg_info) | **GET** /device/license/registration | +*RealTimeMonitoringLicenseInfoApi* | [**get_license_udi_info**](docs/RealTimeMonitoringLicenseInfoApi.md#get_license_udi_info) | **GET** /device/license/udi | +*RealTimeMonitoringLicenseInfoApi* | [**get_license_usage_info**](docs/RealTimeMonitoringLicenseInfoApi.md#get_license_usage_info) | **GET** /device/license/usage | +*RealTimeMonitoringMulticastApi* | [**create_pim_tunnel_list**](docs/RealTimeMonitoringMulticastApi.md#create_pim_tunnel_list) | **GET** /device/multicast/tunnel | +*RealTimeMonitoringMulticastApi* | [**create_replicator_list**](docs/RealTimeMonitoringMulticastApi.md#create_replicator_list) | **GET** /device/multicast/replicator | +*RealTimeMonitoringMulticastApi* | [**create_rpf_list**](docs/RealTimeMonitoringMulticastApi.md#create_rpf_list) | **GET** /device/multicast/rpf | +*RealTimeMonitoringMulticastApi* | [**create_topology_list**](docs/RealTimeMonitoringMulticastApi.md#create_topology_list) | **GET** /device/multicast/topology | +*RealTimeMonitoringNMSApi* | [**get_running**](docs/RealTimeMonitoringNMSApi.md#get_running) | **GET** /device/nms/running | +*RealTimeMonitoringNTPApi* | [**create_associations_list**](docs/RealTimeMonitoringNTPApi.md#create_associations_list) | **GET** /device/ntp/associations | +*RealTimeMonitoringNTPApi* | [**create_ntp_status_list**](docs/RealTimeMonitoringNTPApi.md#create_ntp_status_list) | **GET** /device/ntp/status | +*RealTimeMonitoringNTPApi* | [**create_peer_list**](docs/RealTimeMonitoringNTPApi.md#create_peer_list) | **GET** /device/ntp/peer | +*RealTimeMonitoringNTPApi* | [**create_te_list**](docs/RealTimeMonitoringNTPApi.md#create_te_list) | **GET** /device/virtualApplication/te | +*RealTimeMonitoringNTPApi* | [**create_utd_list**](docs/RealTimeMonitoringNTPApi.md#create_utd_list) | **GET** /device/virtualApplication/utd | +*RealTimeMonitoringNTPApi* | [**create_waas_list**](docs/RealTimeMonitoringNTPApi.md#create_waas_list) | **GET** /device/virtualApplication/waas | +*RealTimeMonitoringNetworkHubResourcesApi* | [**get_allocation_info**](docs/RealTimeMonitoringNetworkHubResourcesApi.md#get_allocation_info) | **GET** /device/csp/resources/cpu-info/allocation | +*RealTimeMonitoringNetworkHubResourcesApi* | [**get_cpu_info**](docs/RealTimeMonitoringNetworkHubResourcesApi.md#get_cpu_info) | **GET** /device/csp/resources/cpu-info/cpus | +*RealTimeMonitoringNetworkHubResourcesApi* | [**get_vnf_info**](docs/RealTimeMonitoringNetworkHubResourcesApi.md#get_vnf_info) | **GET** /device/csp/resources/cpu-info/vnfs | +*RealTimeMonitoringOMPApi* | [**create_advertised_routes_list**](docs/RealTimeMonitoringOMPApi.md#create_advertised_routes_list) | **GET** /device/omp/routes/advertised | +*RealTimeMonitoringOMPApi* | [**create_advertised_routes_list_ipv6**](docs/RealTimeMonitoringOMPApi.md#create_advertised_routes_list_ipv6) | **GET** /device/omp/routes/advertised/ompIpv6 | +*RealTimeMonitoringOMPApi* | [**create_advertised_tlocs_list**](docs/RealTimeMonitoringOMPApi.md#create_advertised_tlocs_list) | **GET** /device/omp/tlocs/advertised | +*RealTimeMonitoringOMPApi* | [**create_omp_cloud_x_recv**](docs/RealTimeMonitoringOMPApi.md#create_omp_cloud_x_recv) | **GET** /device/omp/cloudx | +*RealTimeMonitoringOMPApi* | [**create_omp_link_list**](docs/RealTimeMonitoringOMPApi.md#create_omp_link_list) | **GET** /device/omp/links | +*RealTimeMonitoringOMPApi* | [**create_omp_mcast_auto_discover_advt**](docs/RealTimeMonitoringOMPApi.md#create_omp_mcast_auto_discover_advt) | **GET** /device/omp/mcastautodiscoveradvt | +*RealTimeMonitoringOMPApi* | [**create_omp_mcast_auto_discover_recv**](docs/RealTimeMonitoringOMPApi.md#create_omp_mcast_auto_discover_recv) | **GET** /device/omp/mcastautodiscoverrecv | +*RealTimeMonitoringOMPApi* | [**create_omp_mcast_routes_advt**](docs/RealTimeMonitoringOMPApi.md#create_omp_mcast_routes_advt) | **GET** /device/omp/mcastroutesadvt | +*RealTimeMonitoringOMPApi* | [**create_omp_mcast_routes_recv**](docs/RealTimeMonitoringOMPApi.md#create_omp_mcast_routes_recv) | **GET** /device/omp/mcastroutesrecv | +*RealTimeMonitoringOMPApi* | [**create_omp_services**](docs/RealTimeMonitoringOMPApi.md#create_omp_services) | **GET** /device/omp/services | +*RealTimeMonitoringOMPApi* | [**create_omp_session_list**](docs/RealTimeMonitoringOMPApi.md#create_omp_session_list) | **GET** /device/omp/peers | +*RealTimeMonitoringOMPApi* | [**create_omp_summary**](docs/RealTimeMonitoringOMPApi.md#create_omp_summary) | **GET** /device/omp/summary | +*RealTimeMonitoringOMPApi* | [**create_received_routes_list**](docs/RealTimeMonitoringOMPApi.md#create_received_routes_list) | **GET** /device/omp/routes/received | +*RealTimeMonitoringOMPApi* | [**create_received_routes_list_ipv6**](docs/RealTimeMonitoringOMPApi.md#create_received_routes_list_ipv6) | **GET** /device/omp/routes/received/ompIpv6 | +*RealTimeMonitoringOMPApi* | [**create_received_tlocs_list**](docs/RealTimeMonitoringOMPApi.md#create_received_tlocs_list) | **GET** /device/omp/tlocs/received | +*RealTimeMonitoringOMPApi* | [**create_synced_omp_session_list**](docs/RealTimeMonitoringOMPApi.md#create_synced_omp_session_list) | **GET** /device/omp/synced/peers | +*RealTimeMonitoringOMPApi* | [**get_device_omp_status**](docs/RealTimeMonitoringOMPApi.md#get_device_omp_status) | **GET** /device/omp/status | +*RealTimeMonitoringOSPFApi* | [**create_ospf_database_external**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_database_external) | **GET** /device/ospf/databaseexternal | +*RealTimeMonitoringOSPFApi* | [**create_ospf_database_list**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_database_list) | **GET** /device/ospf/database | +*RealTimeMonitoringOSPFApi* | [**create_ospf_database_summary_list**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_database_summary_list) | **GET** /device/ospf/databasesummary | +*RealTimeMonitoringOSPFApi* | [**create_ospf_interface**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_interface) | **GET** /device/ospf/interface | +*RealTimeMonitoringOSPFApi* | [**create_ospf_neighbors**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_neighbors) | **GET** /device/ospf/neighbor | +*RealTimeMonitoringOSPFApi* | [**create_ospf_process**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_process) | **GET** /device/ospf/process | +*RealTimeMonitoringOSPFApi* | [**create_ospf_routes_list**](docs/RealTimeMonitoringOSPFApi.md#create_ospf_routes_list) | **GET** /device/ospf/routes | +*RealTimeMonitoringOSPFApi* | [**create_ospfv3_interface**](docs/RealTimeMonitoringOSPFApi.md#create_ospfv3_interface) | **GET** /device/ospf/v3interface | +*RealTimeMonitoringOSPFApi* | [**create_ospfv3_neighbors**](docs/RealTimeMonitoringOSPFApi.md#create_ospfv3_neighbors) | **GET** /device/ospf/v3neighbor | +*RealTimeMonitoringOrchestratorApi* | [**create_connection_history_list**](docs/RealTimeMonitoringOrchestratorApi.md#create_connection_history_list) | **GET** /device/orchestrator/connectionshistory | +*RealTimeMonitoringOrchestratorApi* | [**create_connection_list_from_device**](docs/RealTimeMonitoringOrchestratorApi.md#create_connection_list_from_device) | **GET** /device/orchestrator/connections | +*RealTimeMonitoringOrchestratorApi* | [**create_connection_summary**](docs/RealTimeMonitoringOrchestratorApi.md#create_connection_summary) | **GET** /device/orchestrator/summary | +*RealTimeMonitoringOrchestratorApi* | [**create_local_properties_list_list**](docs/RealTimeMonitoringOrchestratorApi.md#create_local_properties_list_list) | **GET** /device/orchestrator/localproperties | +*RealTimeMonitoringOrchestratorApi* | [**create_reverse_proxy_mapping_list**](docs/RealTimeMonitoringOrchestratorApi.md#create_reverse_proxy_mapping_list) | **GET** /device/orchestrator/proxymapping | +*RealTimeMonitoringOrchestratorApi* | [**create_valid_devices_list**](docs/RealTimeMonitoringOrchestratorApi.md#create_valid_devices_list) | **GET** /device/orchestrator/validvedges | +*RealTimeMonitoringOrchestratorApi* | [**create_valid_v_smarts_list**](docs/RealTimeMonitoringOrchestratorApi.md#create_valid_v_smarts_list) | **GET** /device/orchestrator/validvsmarts | +*RealTimeMonitoringOrchestratorApi* | [**get_statistics**](docs/RealTimeMonitoringOrchestratorApi.md#get_statistics) | **GET** /device/orchestrator/statistics | +*RealTimeMonitoringOrchestratorApi* | [**get_valid_v_manage_id**](docs/RealTimeMonitoringOrchestratorApi.md#get_valid_v_manage_id) | **GET** /device/orchestrator/validvmanageid | +*RealTimeMonitoringPIMApi* | [**create_pim_interface_list**](docs/RealTimeMonitoringPIMApi.md#create_pim_interface_list) | **GET** /device/pim/interface | +*RealTimeMonitoringPIMApi* | [**create_pim_neighbor_list**](docs/RealTimeMonitoringPIMApi.md#create_pim_neighbor_list) | **GET** /device/pim/neighbor | +*RealTimeMonitoringPIMApi* | [**create_pim_statistics_list**](docs/RealTimeMonitoringPIMApi.md#create_pim_statistics_list) | **GET** /device/pim/statistics | +*RealTimeMonitoringPIMApi* | [**create_pimrp_mapping_list**](docs/RealTimeMonitoringPIMApi.md#create_pimrp_mapping_list) | **GET** /device/pim/rp-mapping | +*RealTimeMonitoringPIMApi* | [**create_ppp_interface_list**](docs/RealTimeMonitoringPIMApi.md#create_ppp_interface_list) | **GET** /device/ppp/interface | +*RealTimeMonitoringPPPoEApi* | [**create_pppo_e_interface_list**](docs/RealTimeMonitoringPPPoEApi.md#create_pppo_e_interface_list) | **GET** /device/pppoe/session | +*RealTimeMonitoringPPPoEApi* | [**create_pppo_e_neighbor_list**](docs/RealTimeMonitoringPPPoEApi.md#create_pppo_e_neighbor_list) | **GET** /device/pppoe/statistic | +*RealTimeMonitoringPolicerApi* | [**get_policed_interface**](docs/RealTimeMonitoringPolicerApi.md#get_policed_interface) | **GET** /device/policer | +*RealTimeMonitoringPolicyApi* | [**create_polic_data_policy_filter**](docs/RealTimeMonitoringPolicyApi.md#create_polic_data_policy_filter) | **GET** /device/policy/datapolicyfilter | +*RealTimeMonitoringPolicyApi* | [**create_polic_qos_map_info**](docs/RealTimeMonitoringPolicyApi.md#create_polic_qos_map_info) | **GET** /device/policy/qosmapinfo | +*RealTimeMonitoringPolicyApi* | [**create_polic_qos_scheduler_info**](docs/RealTimeMonitoringPolicyApi.md#create_polic_qos_scheduler_info) | **GET** /device/policy/qosschedulerinfo | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_associations**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_associations) | **GET** /device/policy/accesslistassociations | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_associations_ipv6**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_associations_ipv6) | **GET** /device/policy/ipv6/accesslistassociations | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_counters**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_counters) | **GET** /device/policy/accesslistcounters | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_counters_ipv6**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_counters_ipv6) | **GET** /device/policy/ipv6/accesslistcounters | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_names**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_names) | **GET** /device/policy/accesslistnames | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_names_ipv6**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_names_ipv6) | **GET** /device/policy/ipv6/accesslistnames | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_policers**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_policers) | **GET** /device/policy/accesslistpolicers | +*RealTimeMonitoringPolicyApi* | [**create_policy_access_list_policers_ipv6**](docs/RealTimeMonitoringPolicyApi.md#create_policy_access_list_policers_ipv6) | **GET** /device/policy/ipv6/accesslistpolicers | +*RealTimeMonitoringPolicyApi* | [**create_policy_app_route_policy_filter**](docs/RealTimeMonitoringPolicyApi.md#create_policy_app_route_policy_filter) | **GET** /device/policy/approutepolicyfilter | +*RealTimeMonitoringPolicyApi* | [**create_policy_filter_memory_usage**](docs/RealTimeMonitoringPolicyApi.md#create_policy_filter_memory_usage) | **GET** /device/policy/filtermemoryusage | +*RealTimeMonitoringPolicyApi* | [**create_policy_rewrite_associations_info**](docs/RealTimeMonitoringPolicyApi.md#create_policy_rewrite_associations_info) | **GET** /device/policy/rewriteassociations | +*RealTimeMonitoringPolicyApi* | [**get_zbfw_statistics**](docs/RealTimeMonitoringPolicyApi.md#get_zbfw_statistics) | **GET** /device/policy/zbfwstatistics | +*RealTimeMonitoringPolicyApi* | [**get_zone_drop_statistics**](docs/RealTimeMonitoringPolicyApi.md#get_zone_drop_statistics) | **GET** /device/policy/zbfwdropstatistics | +*RealTimeMonitoringPolicyApi* | [**get_zone_pair_sessions**](docs/RealTimeMonitoringPolicyApi.md#get_zone_pair_sessions) | **GET** /device/policy/zonepairsessions | +*RealTimeMonitoringPolicyApi* | [**get_zone_pairs**](docs/RealTimeMonitoringPolicyApi.md#get_zone_pairs) | **GET** /device/policy/zonepairstatistics | +*RealTimeMonitoringPolicyApi* | [**get_zone_policy_filters**](docs/RealTimeMonitoringPolicyApi.md#get_zone_policy_filters) | **GET** /device/policy/zonepolicyfilter | +*RealTimeMonitoringPolicyApi* | [**show_sdwan_policy_from_vsmart**](docs/RealTimeMonitoringPolicyApi.md#show_sdwan_policy_from_vsmart) | **GET** /device/policy/vsmart | +*RealTimeMonitoringPolicyApi* | [**show_vsmart_ipto_user_binding**](docs/RealTimeMonitoringPolicyApi.md#show_vsmart_ipto_user_binding) | **GET** /device/policy/iptouserbindings | +*RealTimeMonitoringPolicyApi* | [**show_vsmart_px_grid_status**](docs/RealTimeMonitoringPolicyApi.md#show_vsmart_px_grid_status) | **GET** /device/policy/pxgridstatus | +*RealTimeMonitoringPolicyApi* | [**show_vsmart_px_grid_user_sessions**](docs/RealTimeMonitoringPolicyApi.md#show_vsmart_px_grid_user_sessions) | **GET** /device/policy/pxgridusersessions | +*RealTimeMonitoringPolicyApi* | [**show_vsmart_user_usergroup_bindings**](docs/RealTimeMonitoringPolicyApi.md#show_vsmart_user_usergroup_bindings) | **GET** /device/policy/userusergroupbindings | +*RealTimeMonitoringRBACApi* | [**get_pnic_stats**](docs/RealTimeMonitoringRBACApi.md#get_pnic_stats) | **GET** /device/csp/pnic | +*RealTimeMonitoringRBACApi* | [**get_pnic_stats_from_device**](docs/RealTimeMonitoringRBACApi.md#get_pnic_stats_from_device) | **GET** /device/csp/pnic/synced | +*RealTimeMonitoringRBACApi* | [**get_rbac_interface**](docs/RealTimeMonitoringRBACApi.md#get_rbac_interface) | **GET** /device/csp/rbac | +*RealTimeMonitoringRebootHistoryApi* | [**create_reboot_history_list**](docs/RealTimeMonitoringRebootHistoryApi.md#create_reboot_history_list) | **GET** /device/reboothistory | +*RealTimeMonitoringRebootHistoryApi* | [**create_synced_reboot_history_list**](docs/RealTimeMonitoringRebootHistoryApi.md#create_synced_reboot_history_list) | **GET** /device/reboothistory/synced | +*RealTimeMonitoringRebootHistoryApi* | [**get_reboot_history_details**](docs/RealTimeMonitoringRebootHistoryApi.md#get_reboot_history_details) | **GET** /device/reboothistory/details | +*RealTimeMonitoringSDWANStatisticsApi* | [**get_sd_wan_global_drop_statistics**](docs/RealTimeMonitoringSDWANStatisticsApi.md#get_sd_wan_global_drop_statistics) | **GET** /device/sdwan-global-drop-statistics | +*RealTimeMonitoringSDWANStatisticsApi* | [**get_sd_wan_stats**](docs/RealTimeMonitoringSDWANStatisticsApi.md#get_sd_wan_stats) | **GET** /device/sdwan-stats | +*RealTimeMonitoringSFPApi* | [**get_detail**](docs/RealTimeMonitoringSFPApi.md#get_detail) | **GET** /device/sfp/detail | +*RealTimeMonitoringSFPApi* | [**get_diagnostic**](docs/RealTimeMonitoringSFPApi.md#get_diagnostic) | **GET** /device/sfp/diagnostic | +*RealTimeMonitoringSFPApi* | [**get_diagnostic_measurement_alarm**](docs/RealTimeMonitoringSFPApi.md#get_diagnostic_measurement_alarm) | **GET** /device/sfp/diagnosticMeasurementAlarm | +*RealTimeMonitoringSFPApi* | [**get_diagnostic_measurement_value**](docs/RealTimeMonitoringSFPApi.md#get_diagnostic_measurement_value) | **GET** /device/sfp/diagnosticMeasurementValue | +*RealTimeMonitoringSIGApi* | [**get_sig_tunnel_list**](docs/RealTimeMonitoringSIGApi.md#get_sig_tunnel_list) | **GET** /device/sig/getSigTunnelList | +*RealTimeMonitoringSIGApi* | [**get_sig_tunnel_total**](docs/RealTimeMonitoringSIGApi.md#get_sig_tunnel_total) | **GET** /device/sig/getSigTunnelTotal | +*RealTimeMonitoringSIGApi* | [**get_sig_umbrella_tunnels**](docs/RealTimeMonitoringSIGApi.md#get_sig_umbrella_tunnels) | **GET** /device/sig/umbrella/tunnels | +*RealTimeMonitoringSIGApi* | [**get_sig_zscaler_tunnels**](docs/RealTimeMonitoringSIGApi.md#get_sig_zscaler_tunnels) | **GET** /device/sig/zscaler/tunnels | +*RealTimeMonitoringSIGApi* | [**tunnel_dashboard**](docs/RealTimeMonitoringSIGApi.md#tunnel_dashboard) | **GET** /device/sig/tunnelDashboard | +*RealTimeMonitoringSecurityApi* | [**create_session_list**](docs/RealTimeMonitoringSecurityApi.md#create_session_list) | **GET** /device/security/information | +*RealTimeMonitoringShowOnDemandLocalApi* | [**get_on_demand_local**](docs/RealTimeMonitoringShowOnDemandLocalApi.md#get_on_demand_local) | **GET** /device/ondemand/local | +*RealTimeMonitoringShowOnDemandRemoteApi* | [**get_on_demand_remote**](docs/RealTimeMonitoringShowOnDemandRemoteApi.md#get_on_demand_remote) | **GET** /device/ondemand/remote | +*RealTimeMonitoringSoftwareApi* | [**create_smu_list**](docs/RealTimeMonitoringSoftwareApi.md#create_smu_list) | **GET** /device/smu | +*RealTimeMonitoringSoftwareApi* | [**create_synced_smu_list**](docs/RealTimeMonitoringSoftwareApi.md#create_synced_smu_list) | **GET** /device/smu/synced | +*RealTimeMonitoringSoftwareApi* | [**create_synced_software_list**](docs/RealTimeMonitoringSoftwareApi.md#create_synced_software_list) | **GET** /device/software/synced | +*RealTimeMonitoringSoftwareApi* | [**get_aaa_ucreate_software_listsers**](docs/RealTimeMonitoringSoftwareApi.md#get_aaa_ucreate_software_listsers) | **GET** /device/software | +*RealTimeMonitoringSslproxyApi* | [**get_ssl_proxy_statistics**](docs/RealTimeMonitoringSslproxyApi.md#get_ssl_proxy_statistics) | **GET** /device/sslproxy/statistics | +*RealTimeMonitoringSslproxyApi* | [**get_ssl_proxy_status**](docs/RealTimeMonitoringSslproxyApi.md#get_ssl_proxy_status) | **GET** /device/sslproxy/status | +*RealTimeMonitoringStaticRouteTrackerServiceApi* | [**get_static_route_tracker_info**](docs/RealTimeMonitoringStaticRouteTrackerServiceApi.md#get_static_route_tracker_info) | **GET** /device/staticRouteTracker | +*RealTimeMonitoringSystemApi* | [**create_device_info_list**](docs/RealTimeMonitoringSystemApi.md#create_device_info_list) | **GET** /device/system/info | +*RealTimeMonitoringSystemApi* | [**create_device_system_process_list**](docs/RealTimeMonitoringSystemApi.md#create_device_system_process_list) | **GET** /device/csp/system/processlist | +*RealTimeMonitoringSystemApi* | [**create_device_system_setting**](docs/RealTimeMonitoringSystemApi.md#create_device_system_setting) | **GET** /device/csp/system/settings | +*RealTimeMonitoringSystemApi* | [**create_device_system_setting_native_info**](docs/RealTimeMonitoringSystemApi.md#create_device_system_setting_native_info) | **GET** /device/csp/system/native | +*RealTimeMonitoringSystemApi* | [**create_device_system_stats_list**](docs/RealTimeMonitoringSystemApi.md#create_device_system_stats_list) | **GET** /device/system/statistics | +*RealTimeMonitoringSystemApi* | [**create_device_system_status**](docs/RealTimeMonitoringSystemApi.md#create_device_system_status) | **GET** /device/csp/system/status | +*RealTimeMonitoringSystemApi* | [**create_device_system_status_list**](docs/RealTimeMonitoringSystemApi.md#create_device_system_status_list) | **GET** /device/system/status | +*RealTimeMonitoringSystemApi* | [**create_synced_device_system_status_list**](docs/RealTimeMonitoringSystemApi.md#create_synced_device_system_status_list) | **GET** /device/system/synced/status | +*RealTimeMonitoringSystemApi* | [**get_device_system_clock**](docs/RealTimeMonitoringSystemApi.md#get_device_system_clock) | **GET** /device/system/clock | +*RealTimeMonitoringTCPOptimizationApi* | [**get_active_tcp_flows**](docs/RealTimeMonitoringTCPOptimizationApi.md#get_active_tcp_flows) | **GET** /device/tcpopt/activeflows | +*RealTimeMonitoringTCPOptimizationApi* | [**get_expired_tcp_flows**](docs/RealTimeMonitoringTCPOptimizationApi.md#get_expired_tcp_flows) | **GET** /device/tcpopt/expiredflows | +*RealTimeMonitoringTCPOptimizationApi* | [**get_tcp_summary**](docs/RealTimeMonitoringTCPOptimizationApi.md#get_tcp_summary) | **GET** /device/tcpopt/summary | +*RealTimeMonitoringTcpproxyApi* | [**get_tcp_proxy_statistics**](docs/RealTimeMonitoringTcpproxyApi.md#get_tcp_proxy_statistics) | **GET** /device/tcpproxy/statistics | +*RealTimeMonitoringTcpproxyApi* | [**get_tcp_proxy_status**](docs/RealTimeMonitoringTcpproxyApi.md#get_tcp_proxy_status) | **GET** /device/tcpproxy/status | +*RealTimeMonitoringToolsApi* | [**get_device_tools_n_slookup**](docs/RealTimeMonitoringToolsApi.md#get_device_tools_n_slookup) | **GET** /device/tools/nslookup | +*RealTimeMonitoringToolsApi* | [**get_device_tools_netstat**](docs/RealTimeMonitoringToolsApi.md#get_device_tools_netstat) | **GET** /device/tools/netstat | +*RealTimeMonitoringToolsApi* | [**get_device_tools_ss**](docs/RealTimeMonitoringToolsApi.md#get_device_tools_ss) | **GET** /device/tools/ss | +*RealTimeMonitoringToolsApi* | [**get_real_timeinfo**](docs/RealTimeMonitoringToolsApi.md#get_real_timeinfo) | **GET** /device/tools/realtimeinfo | +*RealTimeMonitoringToolsApi* | [**get_system_netfilter**](docs/RealTimeMonitoringToolsApi.md#get_system_netfilter) | **GET** /device/tools/system-netfilter | +*RealTimeMonitoringTransportApi* | [**create_transport_connection_list**](docs/RealTimeMonitoringTransportApi.md#create_transport_connection_list) | **GET** /device/transport/connection | +*RealTimeMonitoringTrustsecApi* | [**get_cts_pac**](docs/RealTimeMonitoringTrustsecApi.md#get_cts_pac) | **GET** /device/ctsPac | +*RealTimeMonitoringTrustsecApi* | [**get_environment_data**](docs/RealTimeMonitoringTrustsecApi.md#get_environment_data) | **GET** /device/environmentData | +*RealTimeMonitoringTrustsecApi* | [**get_radius_server**](docs/RealTimeMonitoringTrustsecApi.md#get_radius_server) | **GET** /device/environmentData/radiusServer | +*RealTimeMonitoringTrustsecApi* | [**get_role_based_counters**](docs/RealTimeMonitoringTrustsecApi.md#get_role_based_counters) | **GET** /device/roleBasedCounters | +*RealTimeMonitoringTrustsecApi* | [**get_role_based_ipv6_counters**](docs/RealTimeMonitoringTrustsecApi.md#get_role_based_ipv6_counters) | **GET** /device/roleBasedIpv6Counters | +*RealTimeMonitoringTrustsecApi* | [**get_role_based_ipv6_permissions**](docs/RealTimeMonitoringTrustsecApi.md#get_role_based_ipv6_permissions) | **GET** /device/roleBasedIpv6Permissions | +*RealTimeMonitoringTrustsecApi* | [**get_role_based_permissions**](docs/RealTimeMonitoringTrustsecApi.md#get_role_based_permissions) | **GET** /device/roleBasedPermissions | +*RealTimeMonitoringTrustsecApi* | [**get_role_based_sgt_map**](docs/RealTimeMonitoringTrustsecApi.md#get_role_based_sgt_map) | **GET** /device/roleBasedSgtMap | +*RealTimeMonitoringTrustsecApi* | [**get_sxp_connections**](docs/RealTimeMonitoringTrustsecApi.md#get_sxp_connections) | **GET** /device/sxpConnections | +*RealTimeMonitoringTunnelApi* | [**create_bfd_statistics_list**](docs/RealTimeMonitoringTunnelApi.md#create_bfd_statistics_list) | **GET** /device/tunnel/bfd_statistics | +*RealTimeMonitoringTunnelApi* | [**create_fec_statistics**](docs/RealTimeMonitoringTunnelApi.md#create_fec_statistics) | **GET** /device/tunnel/fec_statistics | +*RealTimeMonitoringTunnelApi* | [**create_gre_keepalives_list**](docs/RealTimeMonitoringTunnelApi.md#create_gre_keepalives_list) | **GET** /device/tunnel/gre-keepalives | +*RealTimeMonitoringTunnelApi* | [**create_ipsec_statistics_list**](docs/RealTimeMonitoringTunnelApi.md#create_ipsec_statistics_list) | **GET** /device/tunnel/ipsec_statistics | +*RealTimeMonitoringTunnelApi* | [**create_packet_duplicate_statistics**](docs/RealTimeMonitoringTunnelApi.md#create_packet_duplicate_statistics) | **GET** /device/tunnel/packet-duplicate | +*RealTimeMonitoringTunnelApi* | [**create_statistics_list**](docs/RealTimeMonitoringTunnelApi.md#create_statistics_list) | **GET** /device/tunnel/statistics | +*RealTimeMonitoringUTDApi* | [**get_signature_version_info**](docs/RealTimeMonitoringUTDApi.md#get_signature_version_info) | **GET** /device/utd/signature/version/details | +*RealTimeMonitoringUTDApi* | [**get_utd_dataplane_config**](docs/RealTimeMonitoringUTDApi.md#get_utd_dataplane_config) | **GET** /device/utd/dataplane-config | +*RealTimeMonitoringUTDApi* | [**get_utd_dataplane_global**](docs/RealTimeMonitoringUTDApi.md#get_utd_dataplane_global) | **GET** /device/utd/dataplane-global | +*RealTimeMonitoringUTDApi* | [**get_utd_dataplane_stats**](docs/RealTimeMonitoringUTDApi.md#get_utd_dataplane_stats) | **GET** /device/utd/dataplane-stats | +*RealTimeMonitoringUTDApi* | [**get_utd_dataplane_stats_summary**](docs/RealTimeMonitoringUTDApi.md#get_utd_dataplane_stats_summary) | **GET** /device/utd/dataplane-stats-summary | +*RealTimeMonitoringUTDApi* | [**get_utd_engine_instance_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_engine_instance_status) | **GET** /device/utd/engine-instance-status | +*RealTimeMonitoringUTDApi* | [**get_utd_engine_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_engine_status) | **GET** /device/utd/engine-status | +*RealTimeMonitoringUTDApi* | [**get_utd_file_analysis_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_file_analysis_status) | **GET** /device/utd/file-analysis-status | +*RealTimeMonitoringUTDApi* | [**get_utd_file_reputation_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_file_reputation_status) | **GET** /device/utd/file-reputation-status | +*RealTimeMonitoringUTDApi* | [**get_utd_ips_update_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_ips_update_status) | **GET** /device/utd/ips-update-status | +*RealTimeMonitoringUTDApi* | [**get_utd_urlf_connection_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_urlf_connection_status) | **GET** /device/utd/urlf-con-status | +*RealTimeMonitoringUTDApi* | [**get_utd_urlf_update_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_urlf_update_status) | **GET** /device/utd/urlf-update-status | +*RealTimeMonitoringUTDApi* | [**get_utd_version_status**](docs/RealTimeMonitoringUTDApi.md#get_utd_version_status) | **GET** /device/utd/version-status | +*RealTimeMonitoringUcseApi* | [**create_ucse_stats**](docs/RealTimeMonitoringUcseApi.md#create_ucse_stats) | **GET** /device/ucse/stats | +*RealTimeMonitoringUmbrellaApi* | [**get_umbrella_config**](docs/RealTimeMonitoringUmbrellaApi.md#get_umbrella_config) | **GET** /device/umbrella/umbrella-config | +*RealTimeMonitoringUmbrellaApi* | [**get_umbrella_dev_reg**](docs/RealTimeMonitoringUmbrellaApi.md#get_umbrella_dev_reg) | **GET** /device/umbrella/device-registration | +*RealTimeMonitoringUmbrellaApi* | [**get_umbrella_dns_crypt**](docs/RealTimeMonitoringUmbrellaApi.md#get_umbrella_dns_crypt) | **GET** /device/umbrella/dnscrypt | +*RealTimeMonitoringUmbrellaApi* | [**get_umbrella_dp_stats**](docs/RealTimeMonitoringUmbrellaApi.md#get_umbrella_dp_stats) | **GET** /device/umbrella/dp-stats | +*RealTimeMonitoringUmbrellaApi* | [**get_umbrella_overview**](docs/RealTimeMonitoringUmbrellaApi.md#get_umbrella_overview) | **GET** /device/umbrella/overview | +*RealTimeMonitoringVDSLServiceApi* | [**get_co_line_specific_stats**](docs/RealTimeMonitoringVDSLServiceApi.md#get_co_line_specific_stats) | **GET** /device/vdslService/coLineSpecificStats | +*RealTimeMonitoringVDSLServiceApi* | [**get_co_stats**](docs/RealTimeMonitoringVDSLServiceApi.md#get_co_stats) | **GET** /device/vdslService/coStats | +*RealTimeMonitoringVDSLServiceApi* | [**get_cpe_line_specific_stats**](docs/RealTimeMonitoringVDSLServiceApi.md#get_cpe_line_specific_stats) | **GET** /device/vdslService/cpeLineSpecificStats | +*RealTimeMonitoringVDSLServiceApi* | [**get_cpe_stats**](docs/RealTimeMonitoringVDSLServiceApi.md#get_cpe_stats) | **GET** /device/vdslService/cpeStats | +*RealTimeMonitoringVDSLServiceApi* | [**get_line_bonding_stats**](docs/RealTimeMonitoringVDSLServiceApi.md#get_line_bonding_stats) | **GET** /device/vdslService/lineBondingStats | +*RealTimeMonitoringVDSLServiceApi* | [**get_line_specific_stats**](docs/RealTimeMonitoringVDSLServiceApi.md#get_line_specific_stats) | **GET** /device/vdslService/lineSpecificStats | +*RealTimeMonitoringVDSLServiceApi* | [**get_vdsl_info**](docs/RealTimeMonitoringVDSLServiceApi.md#get_vdsl_info) | **GET** /device/vdslService/vdslInfo | +*RealTimeMonitoringVMApi* | [**get_cloud_dock_vm_lifecycle_nics**](docs/RealTimeMonitoringVMApi.md#get_cloud_dock_vm_lifecycle_nics) | **GET** /device/vm/notifications | +*RealTimeMonitoringVMApi* | [**get_vbranch_vm_lifecycle**](docs/RealTimeMonitoringVMApi.md#get_vbranch_vm_lifecycle) | **GET** /device/vm/oper/state | +*RealTimeMonitoringVMApi* | [**get_vbranch_vm_lifecycle_nics**](docs/RealTimeMonitoringVMApi.md#get_vbranch_vm_lifecycle_nics) | **GET** /device/vm/nics | +*RealTimeMonitoringVMApi* | [**get_vm_life_cycle_state**](docs/RealTimeMonitoringVMApi.md#get_vm_life_cycle_state) | **GET** /device/vm/state | +*RealTimeMonitoringVPNApi* | [**get_vpn_instances**](docs/RealTimeMonitoringVPNApi.md#get_vpn_instances) | **GET** /device/vpn | +*RealTimeMonitoringVRRPApi* | [**get_vrrp_interface**](docs/RealTimeMonitoringVRRPApi.md#get_vrrp_interface) | **GET** /device/vrrp | +*RealTimeMonitoringVoiceApi* | [**get_controller_t1e1_info_current15_min_stats**](docs/RealTimeMonitoringVoiceApi.md#get_controller_t1e1_info_current15_min_stats) | **GET** /device/voicet1e1controllerinfo/current15minstats | +*RealTimeMonitoringVoiceApi* | [**get_controller_t1e1_info_total_stats**](docs/RealTimeMonitoringVoiceApi.md#get_controller_t1e1_info_total_stats) | **GET** /device/voicet1e1controllerinfo/totalstats | +*RealTimeMonitoringVoiceApi* | [**get_dsp_active**](docs/RealTimeMonitoringVoiceApi.md#get_dsp_active) | **GET** /device/voice/dspActive | +*RealTimeMonitoringVoiceApi* | [**get_dsp_farm_profiles**](docs/RealTimeMonitoringVoiceApi.md#get_dsp_farm_profiles) | **GET** /device/voice/profiles | +*RealTimeMonitoringVoiceApi* | [**get_phone_info**](docs/RealTimeMonitoringVoiceApi.md#get_phone_info) | **GET** /device/voice/phoneInfo | +*RealTimeMonitoringVoiceApi* | [**get_sccp_ccm_groups**](docs/RealTimeMonitoringVoiceApi.md#get_sccp_ccm_groups) | **GET** /device/voice/sccpCcmGroups | +*RealTimeMonitoringVoiceApi* | [**get_sccp_connections**](docs/RealTimeMonitoringVoiceApi.md#get_sccp_connections) | **GET** /device/voice/sccpConnections | +*RealTimeMonitoringVoiceApi* | [**get_t1e1_isdn_status**](docs/RealTimeMonitoringVoiceApi.md#get_t1e1_isdn_status) | **GET** /device/voiceisdninfo/isdnstatus | +*RealTimeMonitoringVoiceApi* | [**get_voice_calls**](docs/RealTimeMonitoringVoiceApi.md#get_voice_calls) | **GET** /device/voice/voiceCalls | +*RealTimeMonitoringVoiceApi* | [**get_voip_calls**](docs/RealTimeMonitoringVoiceApi.md#get_voip_calls) | **GET** /device/voice/voipCalls | +*RealTimeMonitoringWLANApi* | [**get_wlan_clients**](docs/RealTimeMonitoringWLANApi.md#get_wlan_clients) | **GET** /device/wlan/clients | +*RealTimeMonitoringWLANApi* | [**get_wlan_interfaces**](docs/RealTimeMonitoringWLANApi.md#get_wlan_interfaces) | **GET** /device/wlan/interfaces | +*RealTimeMonitoringWLANApi* | [**get_wlan_radios**](docs/RealTimeMonitoringWLANApi.md#get_wlan_radios) | **GET** /device/wlan/radios | +*RealTimeMonitoringWLANApi* | [**get_wlan_radius**](docs/RealTimeMonitoringWLANApi.md#get_wlan_radius) | **GET** /device/wlan/radius | +*RealTimeMonitoringWirelessApi* | [**get_wireless_clients**](docs/RealTimeMonitoringWirelessApi.md#get_wireless_clients) | **GET** /device/wireless/client | +*RealTimeMonitoringWirelessApi* | [**get_wireless_radios**](docs/RealTimeMonitoringWirelessApi.md#get_wireless_radios) | **GET** /device/wireless/radio | +*RealTimeMonitoringWirelessApi* | [**get_wireless_ssid**](docs/RealTimeMonitoringWirelessApi.md#get_wireless_ssid) | **GET** /device/wireless/ssid | +*ResourcePoolApi* | [**create_resources**](docs/ResourcePoolApi.md#create_resources) | **PUT** /resourcepool/resource/vpn | +*ResourcePoolApi* | [**delete_resources**](docs/ResourcePoolApi.md#delete_resources) | **DELETE** /resourcepool/resource/vpn | +*ResourcePoolApi* | [**get_resources**](docs/ResourcePoolApi.md#get_resources) | **GET** /resourcepool/resource/vpn | +*SDAVCCloudConnectorApi* | [**disable_cloud_connector**](docs/SDAVCCloudConnectorApi.md#disable_cloud_connector) | **PUT** /sdavc/cloudconnector | +*SDAVCCloudConnectorApi* | [**enable_cloud_connector**](docs/SDAVCCloudConnectorApi.md#enable_cloud_connector) | **POST** /sdavc/cloudconnector | +*SDAVCCloudConnectorApi* | [**get_cloud_connector**](docs/SDAVCCloudConnectorApi.md#get_cloud_connector) | **GET** /sdavc/cloudconnector | +*SDAVCCloudConnectorApi* | [**get_cloud_connector_status**](docs/SDAVCCloudConnectorApi.md#get_cloud_connector_status) | **GET** /sdavc/cloudconnector/status | +*SDAVCDomainBasedAppRulesApi* | [**get_cloud_connector_domain_app_rules**](docs/SDAVCDomainBasedAppRulesApi.md#get_cloud_connector_domain_app_rules) | **GET** /monitor/sdavccloudconnector/domain | +*SDAVCIPAddressBasedAppRulesApi* | [**get_cloud_connector_ip_address_app_rules**](docs/SDAVCIPAddressBasedAppRulesApi.md#get_cloud_connector_ip_address_app_rules) | **GET** /monitor/sdavccloudconnector/ipaddress | +*ScheduledBackupRestoreApi* | [**delete_schduled_backup**](docs/ScheduledBackupRestoreApi.md#delete_schduled_backup) | **DELETE** /backup/backupinfo | +*ScheduledBackupRestoreApi* | [**delete_schedule**](docs/ScheduledBackupRestoreApi.md#delete_schedule) | **DELETE** /schedule/{schedulerId} | +*ScheduledBackupRestoreApi* | [**download_backup_file**](docs/ScheduledBackupRestoreApi.md#download_backup_file) | **GET** /backup/download/{path} | +*ScheduledBackupRestoreApi* | [**export_backup**](docs/ScheduledBackupRestoreApi.md#export_backup) | **POST** /backup/export | +*ScheduledBackupRestoreApi* | [**get_local_backup_info**](docs/ScheduledBackupRestoreApi.md#get_local_backup_info) | **GET** /backup/backupinfo/{localBackupInfoId} | +*ScheduledBackupRestoreApi* | [**get_schedule_record_for_backup**](docs/ScheduledBackupRestoreApi.md#get_schedule_record_for_backup) | **GET** /schedule/{schedulerId} | +*ScheduledBackupRestoreApi* | [**import_scheduled_backup**](docs/ScheduledBackupRestoreApi.md#import_scheduled_backup) | **POST** /restore/import | +*ScheduledBackupRestoreApi* | [**list_backup**](docs/ScheduledBackupRestoreApi.md#list_backup) | **GET** /backup/list | +*ScheduledBackupRestoreApi* | [**list_schedules**](docs/ScheduledBackupRestoreApi.md#list_schedules) | **GET** /schedule/list | +*ScheduledBackupRestoreApi* | [**remote_import_backup**](docs/ScheduledBackupRestoreApi.md#remote_import_backup) | **POST** /restore/remoteimport | +*ScheduledBackupRestoreApi* | [**schedule_backup**](docs/ScheduledBackupRestoreApi.md#schedule_backup) | **POST** /schedule/create | +*SmartLicenseApi* | [**fetch_accounts**](docs/SmartLicenseApi.md#fetch_accounts) | **GET** /smartLicensing/fetchAccounts | +*SmartLicenseApi* | [**fetch_reports**](docs/SmartLicenseApi.md#fetch_reports) | **GET** /smartLicensing/fetchReportsForSa | +*SmartLicenseApi* | [**fetch_reports1**](docs/SmartLicenseApi.md#fetch_reports1) | **GET** /smartLicensing/fetchAllSa | +*SmartLicenseApi* | [**get_settings**](docs/SmartLicenseApi.md#get_settings) | **GET** /smartLicensing/getUserSettings | +*SmartLicenseApi* | [**sleauthenticate**](docs/SmartLicenseApi.md#sleauthenticate) | **POST** /smartLicensing/authenticate | +*SmartLicenseApi* | [**sync_licenses**](docs/SmartLicenseApi.md#sync_licenses) | **POST** /smartLicensing/syncLicenses | +*SmartLicenseApi* | [**sync_licenses1**](docs/SmartLicenseApi.md#sync_licenses1) | **POST** /smartLicensing/removeSaVaSelection | +*SmartLicenseApi* | [**upload_ack**](docs/SmartLicenseApi.md#upload_ack) | **POST** /smartLicensing/uploadAck | +*SystemCloudServiceApi* | [**add_cloud_credentials**](docs/SystemCloudServiceApi.md#add_cloud_credentials) | **POST** /cloudservices/credentials | +*SystemCloudServiceApi* | [**connect**](docs/SystemCloudServiceApi.md#connect) | **GET** /cloudservices/connect | +*SystemCloudServiceApi* | [**delete_webex_data_centers**](docs/SystemCloudServiceApi.md#delete_webex_data_centers) | **DELETE** /webex/datacenter | +*SystemCloudServiceApi* | [**entity_ownership_info**](docs/SystemCloudServiceApi.md#entity_ownership_info) | **GET** /entityownership/tree | +*SystemCloudServiceApi* | [**get_access_tokenfor_device**](docs/SystemCloudServiceApi.md#get_access_tokenfor_device) | **GET** /cloudservices/accesstoken | +*SystemCloudServiceApi* | [**get_azure_token**](docs/SystemCloudServiceApi.md#get_azure_token) | **POST** /cloudservices/authtoken | +*SystemCloudServiceApi* | [**get_cloud_credentials**](docs/SystemCloudServiceApi.md#get_cloud_credentials) | **GET** /cloudservices/credentials | +*SystemCloudServiceApi* | [**get_cloud_settings**](docs/SystemCloudServiceApi.md#get_cloud_settings) | **GET** /dca/cloudservices | +*SystemCloudServiceApi* | [**get_device_code**](docs/SystemCloudServiceApi.md#get_device_code) | **POST** /cloudservices/devicecode | +*SystemCloudServiceApi* | [**get_o365_preferred_path_from_v_analytics**](docs/SystemCloudServiceApi.md#get_o365_preferred_path_from_v_analytics) | **POST** /cloudservices/m365/preferredpath | +*SystemCloudServiceApi* | [**get_otp**](docs/SystemCloudServiceApi.md#get_otp) | **GET** /dca/cloudservices/otp | +*SystemCloudServiceApi* | [**get_telemetry_state**](docs/SystemCloudServiceApi.md#get_telemetry_state) | **GET** /cloudservices/telemetry | +*SystemCloudServiceApi* | [**getv_analytics**](docs/SystemCloudServiceApi.md#getv_analytics) | **POST** /dca/cloudservices/vanalytics | +*SystemCloudServiceApi* | [**is_staging**](docs/SystemCloudServiceApi.md#is_staging) | **GET** /cloudservices/staging | +*SystemCloudServiceApi* | [**list_entity_ownership_info**](docs/SystemCloudServiceApi.md#list_entity_ownership_info) | **GET** /entityownership/list | +*SystemCloudServiceApi* | [**opt_in**](docs/SystemCloudServiceApi.md#opt_in) | **PUT** /cloudservices/telemetry/optin | +*SystemCloudServiceApi* | [**opt_out**](docs/SystemCloudServiceApi.md#opt_out) | **DELETE** /cloudservices/telemetry/optout | +*SystemCloudServiceApi* | [**set_webex_data_centers_sync_status**](docs/SystemCloudServiceApi.md#set_webex_data_centers_sync_status) | **PUT** /webex/datacenter/syncstatus | +*SystemCloudServiceApi* | [**update_webex_data_centers**](docs/SystemCloudServiceApi.md#update_webex_data_centers) | **POST** /webex/datacenter/sync | +*SystemCloudServiceApi* | [**updatet_otp**](docs/SystemCloudServiceApi.md#updatet_otp) | **PUT** /dca/cloudservices/otp | +*SystemCloudServiceWebexApi* | [**get_webex_data_centers**](docs/SystemCloudServiceWebexApi.md#get_webex_data_centers) | **POST** /webex/datacenter | +*SystemCloudServiceWebexApi* | [**get_webex_data_centers_sync_status**](docs/SystemCloudServiceWebexApi.md#get_webex_data_centers_sync_status) | **GET** /webex/datacenter/syncstatus | +*SystemContainerApi* | [**activate_container**](docs/SystemContainerApi.md#activate_container) | **POST** /sdavc/task/{taskId} | +*SystemContainerApi* | [**activate_container_on_remote_host**](docs/SystemContainerApi.md#activate_container_on_remote_host) | **POST** /container-manager/activate/{containerName} | +*SystemContainerApi* | [**de_activate_container**](docs/SystemContainerApi.md#de_activate_container) | **POST** /container-manager/deactivate/{containerName} | +*SystemContainerApi* | [**does_valid_image_exist**](docs/SystemContainerApi.md#does_valid_image_exist) | **GET** /container-manager/doesValidImageExist/{containerName} | +*SystemContainerApi* | [**get_container_inspect_data**](docs/SystemContainerApi.md#get_container_inspect_data) | **GET** /container-manager/inspect/{containerName} | +*SystemContainerApi* | [**get_container_settings**](docs/SystemContainerApi.md#get_container_settings) | **GET** /container-manager/settings/{containerName} | +*SystemContainerApi* | [**get_custom_app**](docs/SystemContainerApi.md#get_custom_app) | **GET** /sdavc/customapps | +*SystemContainerApi* | [**test_load_balancer**](docs/SystemContainerApi.md#test_load_balancer) | **POST** /sdavc/test | +*SystemReverseProxyApi* | [**create_reverse_proxy_mappings**](docs/SystemReverseProxyApi.md#create_reverse_proxy_mappings) | **POST** /system/reverseproxy/{uuid} | +*SystemReverseProxyApi* | [**get_reverse_proxy_mappings**](docs/SystemReverseProxyApi.md#get_reverse_proxy_mappings) | **GET** /system/reverseproxy/{uuid} | +*TagApi* | [**check_for_conflicts_when_tagging**](docs/TagApi.md#check_for_conflicts_when_tagging) | **POST** /tag/conflictCheck | +*TagApi* | [**check_rules**](docs/TagApi.md#check_rules) | **POST** /tag/checkRules | +*TagApi* | [**create_tag**](docs/TagApi.md#create_tag) | **POST** /tag | +*TagApi* | [**create_tag_rule**](docs/TagApi.md#create_tag_rule) | **POST** /tag/tagRules | +*TagApi* | [**delete_tag**](docs/TagApi.md#delete_tag) | **POST** /tag/remove | +*TagApi* | [**delete_tag_rule**](docs/TagApi.md#delete_tag_rule) | **DELETE** /tag/tagRules/{tagRuleId} | +*TagApi* | [**edit_tag_rule**](docs/TagApi.md#edit_tag_rule) | **PUT** /tag/tagRules | +*TagApi* | [**get_tag**](docs/TagApi.md#get_tag) | **GET** /tag | +*TagApi* | [**get_tag_rules**](docs/TagApi.md#get_tag_rules) | **GET** /tag/tagRules/{configGroupId} | +*TagApi* | [**reindex_tag**](docs/TagApi.md#reindex_tag) | **GET** /tag/reindex | +*TenantBackupRestoreApi* | [**delete_tenant_backup**](docs/TenantBackupRestoreApi.md#delete_tenant_backup) | **DELETE** /tenantbackup/delete | +*TenantBackupRestoreApi* | [**download_existing_backup_file**](docs/TenantBackupRestoreApi.md#download_existing_backup_file) | **GET** /tenantbackup/download/{path} | +*TenantBackupRestoreApi* | [**export_tenant_backup**](docs/TenantBackupRestoreApi.md#export_tenant_backup) | **GET** /tenantbackup/export | +*TenantBackupRestoreApi* | [**import_tenant_backup**](docs/TenantBackupRestoreApi.md#import_tenant_backup) | **POST** /tenantbackup/import | +*TenantBackupRestoreApi* | [**list_tenant_backup**](docs/TenantBackupRestoreApi.md#list_tenant_backup) | **GET** /tenantbackup/list | +*TenantManagementApi* | [**create_tenant**](docs/TenantManagementApi.md#create_tenant) | **POST** /tenant | +*TenantManagementApi* | [**create_tenant_async**](docs/TenantManagementApi.md#create_tenant_async) | **POST** /tenant/async | +*TenantManagementApi* | [**create_tenant_async_bulk**](docs/TenantManagementApi.md#create_tenant_async_bulk) | **POST** /tenant/bulk/async | +*TenantManagementApi* | [**delete_tenant**](docs/TenantManagementApi.md#delete_tenant) | **POST** /tenant/{tenantId}/delete | +*TenantManagementApi* | [**delete_tenant_async_bulk**](docs/TenantManagementApi.md#delete_tenant_async_bulk) | **DELETE** /tenant/bulk/async | +*TenantManagementApi* | [**force_status_collection**](docs/TenantManagementApi.md#force_status_collection) | **POST** /tenantstatus/force | +*TenantManagementApi* | [**get_all_tenant_statuses**](docs/TenantManagementApi.md#get_all_tenant_statuses) | **GET** /tenantstatus | +*TenantManagementApi* | [**get_all_tenants**](docs/TenantManagementApi.md#get_all_tenants) | **GET** /tenant | +*TenantManagementApi* | [**get_tenant**](docs/TenantManagementApi.md#get_tenant) | **GET** /tenant/{tenantId} | +*TenantManagementApi* | [**get_tenant_hosting_capacity_onv_smarts**](docs/TenantManagementApi.md#get_tenant_hosting_capacity_onv_smarts) | **GET** /tenant/vsmart/capacity | +*TenantManagementApi* | [**get_tenantv_smart_mapping**](docs/TenantManagementApi.md#get_tenantv_smart_mapping) | **GET** /tenant/vsmart | +*TenantManagementApi* | [**switch_tenant**](docs/TenantManagementApi.md#switch_tenant) | **POST** /tenant/{tenantId}/switch | +*TenantManagementApi* | [**tenantv_smart_mt_migrate**](docs/TenantManagementApi.md#tenantv_smart_mt_migrate) | **POST** /tenant/vsmart-mt/migrate | +*TenantManagementApi* | [**update_tenant**](docs/TenantManagementApi.md#update_tenant) | **PUT** /tenant/{tenantId} | +*TenantManagementApi* | [**update_tenantv_smart_placement**](docs/TenantManagementApi.md#update_tenantv_smart_placement) | **PUT** /tenant/{tenantId}/vsmart | +*TenantManagementApi* | [**v_session_id**](docs/TenantManagementApi.md#v_session_id) | **POST** /tenant/{tenantId}/vsessionid | +*TenantMigrationApi* | [**download_tenant_data**](docs/TenantMigrationApi.md#download_tenant_data) | **GET** /tenantmigration/download/{path} | +*TenantMigrationApi* | [**export_tenant_data**](docs/TenantMigrationApi.md#export_tenant_data) | **POST** /tenantmigration/export | +*TenantMigrationApi* | [**get_migration_token**](docs/TenantMigrationApi.md#get_migration_token) | **GET** /tenantmigration/migrationToken | +*TenantMigrationApi* | [**import_tenant_data**](docs/TenantMigrationApi.md#import_tenant_data) | **POST** /tenantmigration/import | +*TenantMigrationApi* | [**migrate_network**](docs/TenantMigrationApi.md#migrate_network) | **POST** /tenantmigration/networkMigration | +*TenantMigrationApi* | [**re_trigger_network_migration**](docs/TenantMigrationApi.md#re_trigger_network_migration) | **GET** /tenantmigration/networkMigration | +*ToolsTACCasesApi* | [**delete_call**](docs/ToolsTACCasesApi.md#delete_call) | **DELETE** /opentaccase/scmwidget | +*ToolsTACCasesApi* | [**get_call**](docs/ToolsTACCasesApi.md#get_call) | **GET** /opentaccase/scmwidget | +*ToolsTACCasesApi* | [**get_client_id**](docs/ToolsTACCasesApi.md#get_client_id) | **GET** /opentaccase/getClientID | +*ToolsTACCasesApi* | [**oauth_access**](docs/ToolsTACCasesApi.md#oauth_access) | **GET** /opentaccase/authcode | +*ToolsTACCasesApi* | [**post_call**](docs/ToolsTACCasesApi.md#post_call) | **POST** /opentaccase/scmwidget | +*TroubleshootingToolsDeviceConnectivityApi* | [**copy_admin_tech_on_device**](docs/TroubleshootingToolsDeviceConnectivityApi.md#copy_admin_tech_on_device) | **POST** /device/tools/admintech/copy | +*TroubleshootingToolsDeviceConnectivityApi* | [**create_admin_tech**](docs/TroubleshootingToolsDeviceConnectivityApi.md#create_admin_tech) | **POST** /device/tools/admintech | +*TroubleshootingToolsDeviceConnectivityApi* | [**delete_admin_tech_file**](docs/TroubleshootingToolsDeviceConnectivityApi.md#delete_admin_tech_file) | **DELETE** /device/tools/admintech/{requestID} | +*TroubleshootingToolsDeviceConnectivityApi* | [**delete_admin_tech_on_device**](docs/TroubleshootingToolsDeviceConnectivityApi.md#delete_admin_tech_on_device) | **DELETE** /device/tools/admintech/delete | +*TroubleshootingToolsDeviceConnectivityApi* | [**download_admin_tech_file**](docs/TroubleshootingToolsDeviceConnectivityApi.md#download_admin_tech_file) | **GET** /device/tools/admintech/download/{filename} | +*TroubleshootingToolsDeviceConnectivityApi* | [**factory_reset**](docs/TroubleshootingToolsDeviceConnectivityApi.md#factory_reset) | **POST** /device/tools/factoryreset | +*TroubleshootingToolsDeviceConnectivityApi* | [**get_control_connections**](docs/TroubleshootingToolsDeviceConnectivityApi.md#get_control_connections) | **GET** /troubleshooting/control/{uuid} | +*TroubleshootingToolsDeviceConnectivityApi* | [**get_device_configuration**](docs/TroubleshootingToolsDeviceConnectivityApi.md#get_device_configuration) | **GET** /troubleshooting/devicebringup | +*TroubleshootingToolsDeviceConnectivityApi* | [**get_in_progress_count**](docs/TroubleshootingToolsDeviceConnectivityApi.md#get_in_progress_count) | **GET** /device/tools/admintechs/inprogress | +*TroubleshootingToolsDeviceConnectivityApi* | [**list_admin_techs**](docs/TroubleshootingToolsDeviceConnectivityApi.md#list_admin_techs) | **GET** /device/tools/admintechs | +*TroubleshootingToolsDeviceConnectivityApi* | [**list_admin_techs_on_device**](docs/TroubleshootingToolsDeviceConnectivityApi.md#list_admin_techs_on_device) | **POST** /device/tools/admintechlist | +*TroubleshootingToolsDeviceConnectivityApi* | [**nping_device**](docs/TroubleshootingToolsDeviceConnectivityApi.md#nping_device) | **POST** /device/tools/nping/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**ping_device**](docs/TroubleshootingToolsDeviceConnectivityApi.md#ping_device) | **POST** /device/tools/ping/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**process_interface_reset**](docs/TroubleshootingToolsDeviceConnectivityApi.md#process_interface_reset) | **POST** /device/tools/reset/interface/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**process_port_hop_color**](docs/TroubleshootingToolsDeviceConnectivityApi.md#process_port_hop_color) | **POST** /device/tools/porthopcolor/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**process_reset_user**](docs/TroubleshootingToolsDeviceConnectivityApi.md#process_reset_user) | **POST** /device/tools/resetuser/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**service_path**](docs/TroubleshootingToolsDeviceConnectivityApi.md#service_path) | **POST** /device/tools/servicepath/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**traceroute_device**](docs/TroubleshootingToolsDeviceConnectivityApi.md#traceroute_device) | **POST** /device/tools/traceroute/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**tunnel_path**](docs/TroubleshootingToolsDeviceConnectivityApi.md#tunnel_path) | **POST** /device/tools/tunnelpath/{deviceIP} | +*TroubleshootingToolsDeviceConnectivityApi* | [**upload_admin_tech**](docs/TroubleshootingToolsDeviceConnectivityApi.md#upload_admin_tech) | **POST** /device/tools/admintechs/upload | +*TroubleshootingToolsDeviceGroupApi* | [**list_device_group_list**](docs/TroubleshootingToolsDeviceGroupApi.md#list_device_group_list) | **GET** /group | +*TroubleshootingToolsDeviceGroupApi* | [**list_device_groups**](docs/TroubleshootingToolsDeviceGroupApi.md#list_device_groups) | **GET** /group/device | +*TroubleshootingToolsDeviceGroupApi* | [**list_group_devices**](docs/TroubleshootingToolsDeviceGroupApi.md#list_group_devices) | **GET** /group/devices | +*TroubleshootingToolsDeviceGroupApi* | [**list_group_devices_for_map**](docs/TroubleshootingToolsDeviceGroupApi.md#list_group_devices_for_map) | **GET** /group/map/devices | +*TroubleshootingToolsDeviceGroupApi* | [**list_group_links_for_map**](docs/TroubleshootingToolsDeviceGroupApi.md#list_group_links_for_map) | **GET** /group/map/devices/links | +*TroubleshootingToolsDiagnosticsApi* | [**clear_session**](docs/TroubleshootingToolsDiagnosticsApi.md#clear_session) | **GET** /stream/device/log/sessions/clear/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**disable_device_log**](docs/TroubleshootingToolsDiagnosticsApi.md#disable_device_log) | **GET** /stream/device/log/disable/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**disable_packet_capture_session**](docs/TroubleshootingToolsDiagnosticsApi.md#disable_packet_capture_session) | **GET** /stream/device/capture/disable/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**disable_speed_test_session**](docs/TroubleshootingToolsDiagnosticsApi.md#disable_speed_test_session) | **GET** /stream/device/speed/disable/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**download_debug_log**](docs/TroubleshootingToolsDiagnosticsApi.md#download_debug_log) | **GET** /stream/device/log/download/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**download_file**](docs/TroubleshootingToolsDiagnosticsApi.md#download_file) | **GET** /stream/device/capture/download/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**force_stop_pcap_session**](docs/TroubleshootingToolsDiagnosticsApi.md#force_stop_pcap_session) | **GET** /stream/device/capture/forcedisbale/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**form_post_packet_capture**](docs/TroubleshootingToolsDiagnosticsApi.md#form_post_packet_capture) | **POST** /stream/device/capture/{deviceUUID}/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**get_agg_flow**](docs/TroubleshootingToolsDiagnosticsApi.md#get_agg_flow) | **GET** /stream/device/nwpi/aggFlow | +*TroubleshootingToolsDiagnosticsApi* | [**get_aggregation_data_by_query27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_aggregation_data_by_query27) | **GET** /stream/device/nwpi/aggregation | +*TroubleshootingToolsDiagnosticsApi* | [**get_aggregation_data_by_query28**](docs/TroubleshootingToolsDiagnosticsApi.md#get_aggregation_data_by_query28) | **GET** /statistics/speedtest/aggregation | +*TroubleshootingToolsDiagnosticsApi* | [**get_app_qos_data**](docs/TroubleshootingToolsDiagnosticsApi.md#get_app_qos_data) | **GET** /stream/device/nwpi/appQosData | +*TroubleshootingToolsDiagnosticsApi* | [**get_app_qos_state**](docs/TroubleshootingToolsDiagnosticsApi.md#get_app_qos_state) | **GET** /stream/device/nwpi/appQosState | +*TroubleshootingToolsDiagnosticsApi* | [**get_concurrent_data**](docs/TroubleshootingToolsDiagnosticsApi.md#get_concurrent_data) | **GET** /stream/device/nwpi/concurrentData | +*TroubleshootingToolsDiagnosticsApi* | [**get_concurrent_domain_data**](docs/TroubleshootingToolsDiagnosticsApi.md#get_concurrent_domain_data) | **GET** /stream/device/nwpi/concurrentDomainData | +*TroubleshootingToolsDiagnosticsApi* | [**get_count29**](docs/TroubleshootingToolsDiagnosticsApi.md#get_count29) | **GET** /stream/device/nwpi/doccount | +*TroubleshootingToolsDiagnosticsApi* | [**get_count30**](docs/TroubleshootingToolsDiagnosticsApi.md#get_count30) | **GET** /statistics/speedtest/doccount | +*TroubleshootingToolsDiagnosticsApi* | [**get_count_post29**](docs/TroubleshootingToolsDiagnosticsApi.md#get_count_post29) | **POST** /stream/device/nwpi/doccount | +*TroubleshootingToolsDiagnosticsApi* | [**get_count_post30**](docs/TroubleshootingToolsDiagnosticsApi.md#get_count_post30) | **POST** /statistics/speedtest/doccount | +*TroubleshootingToolsDiagnosticsApi* | [**get_current_timestamp**](docs/TroubleshootingToolsDiagnosticsApi.md#get_current_timestamp) | **GET** /stream/device/nwpi/currentTimestamp | +*TroubleshootingToolsDiagnosticsApi* | [**get_db_schema**](docs/TroubleshootingToolsDiagnosticsApi.md#get_db_schema) | **GET** /diagnostics/dbschema | +*TroubleshootingToolsDiagnosticsApi* | [**get_device_log**](docs/TroubleshootingToolsDiagnosticsApi.md#get_device_log) | **GET** /stream/device/log/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**get_domain_metric**](docs/TroubleshootingToolsDiagnosticsApi.md#get_domain_metric) | **GET** /stream/device/nwpi/domainMetric | +*TroubleshootingToolsDiagnosticsApi* | [**get_event_app_hop_list**](docs/TroubleshootingToolsDiagnosticsApi.md#get_event_app_hop_list) | **GET** /stream/device/nwpi/eventAppHopList | +*TroubleshootingToolsDiagnosticsApi* | [**get_event_app_score_bandwidth**](docs/TroubleshootingToolsDiagnosticsApi.md#get_event_app_score_bandwidth) | **GET** /stream/device/nwpi/eventAppScoreBandwidth | +*TroubleshootingToolsDiagnosticsApi* | [**get_event_flow_from_app_hop**](docs/TroubleshootingToolsDiagnosticsApi.md#get_event_flow_from_app_hop) | **GET** /stream/device/nwpi/eventFlowFromAppHop | +*TroubleshootingToolsDiagnosticsApi* | [**get_event_readout**](docs/TroubleshootingToolsDiagnosticsApi.md#get_event_readout) | **GET** /stream/device/nwpi/eventReadout | +*TroubleshootingToolsDiagnosticsApi* | [**get_file_download_status**](docs/TroubleshootingToolsDiagnosticsApi.md#get_file_download_status) | **GET** /stream/device/capture/status/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**get_fin_flow_time_range**](docs/TroubleshootingToolsDiagnosticsApi.md#get_fin_flow_time_range) | **GET** /stream/device/nwpi/traceFinFlowTimeRange | +*TroubleshootingToolsDiagnosticsApi* | [**get_finalized_data**](docs/TroubleshootingToolsDiagnosticsApi.md#get_finalized_data) | **GET** /stream/device/nwpi/finalizedData | +*TroubleshootingToolsDiagnosticsApi* | [**get_finalized_domain_data**](docs/TroubleshootingToolsDiagnosticsApi.md#get_finalized_domain_data) | **GET** /stream/device/nwpi/finalizedDomainData | +*TroubleshootingToolsDiagnosticsApi* | [**get_finalized_flow_count**](docs/TroubleshootingToolsDiagnosticsApi.md#get_finalized_flow_count) | **GET** /stream/device/nwpi/traceFinFlowCount | +*TroubleshootingToolsDiagnosticsApi* | [**get_flow_detail**](docs/TroubleshootingToolsDiagnosticsApi.md#get_flow_detail) | **GET** /stream/device/nwpi/flowDetail | +*TroubleshootingToolsDiagnosticsApi* | [**get_flow_metric**](docs/TroubleshootingToolsDiagnosticsApi.md#get_flow_metric) | **GET** /stream/device/nwpi/flowMetric | +*TroubleshootingToolsDiagnosticsApi* | [**get_interface_bandwidth**](docs/TroubleshootingToolsDiagnosticsApi.md#get_interface_bandwidth) | **GET** /stream/device/speed/interface/bandwidth | +*TroubleshootingToolsDiagnosticsApi* | [**get_log_type**](docs/TroubleshootingToolsDiagnosticsApi.md#get_log_type) | **GET** /stream/device/log/type | +*TroubleshootingToolsDiagnosticsApi* | [**get_monitor_state**](docs/TroubleshootingToolsDiagnosticsApi.md#get_monitor_state) | **GET** /stream/device/nwpi/getMonitorState | +*TroubleshootingToolsDiagnosticsApi* | [**get_nwpi_dscp**](docs/TroubleshootingToolsDiagnosticsApi.md#get_nwpi_dscp) | **GET** /stream/device/nwpi/nwpiDSCP | +*TroubleshootingToolsDiagnosticsApi* | [**get_nwpi_nbar_app_group**](docs/TroubleshootingToolsDiagnosticsApi.md#get_nwpi_nbar_app_group) | **GET** /stream/device/nwpi/nwpiNbarAppGroup | +*TroubleshootingToolsDiagnosticsApi* | [**get_nwpi_protocol**](docs/TroubleshootingToolsDiagnosticsApi.md#get_nwpi_protocol) | **GET** /stream/device/nwpi/nwpiProtocol | +*TroubleshootingToolsDiagnosticsApi* | [**get_packet_features**](docs/TroubleshootingToolsDiagnosticsApi.md#get_packet_features) | **GET** /stream/device/nwpi/packetFeatures | +*TroubleshootingToolsDiagnosticsApi* | [**get_post_aggregation_app_data_by_query26**](docs/TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_app_data_by_query26) | **POST** /stream/device/nwpi/app-agg/aggregation | +*TroubleshootingToolsDiagnosticsApi* | [**get_post_aggregation_app_data_by_query27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_app_data_by_query27) | **POST** /statistics/speedtest/app-agg/aggregation | +*TroubleshootingToolsDiagnosticsApi* | [**get_post_aggregation_data_by_query27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_data_by_query27) | **POST** /stream/device/nwpi/aggregation | +*TroubleshootingToolsDiagnosticsApi* | [**get_post_aggregation_data_by_query28**](docs/TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_data_by_query28) | **POST** /statistics/speedtest/aggregation | +*TroubleshootingToolsDiagnosticsApi* | [**get_post_stat_bulk_raw_data27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_post_stat_bulk_raw_data27) | **POST** /stream/device/nwpi/page | +*TroubleshootingToolsDiagnosticsApi* | [**get_post_stat_bulk_raw_data28**](docs/TroubleshootingToolsDiagnosticsApi.md#get_post_stat_bulk_raw_data28) | **POST** /statistics/speedtest/page | +*TroubleshootingToolsDiagnosticsApi* | [**get_preload_info**](docs/TroubleshootingToolsDiagnosticsApi.md#get_preload_info) | **GET** /stream/device/nwpi/preloadinfo | +*TroubleshootingToolsDiagnosticsApi* | [**get_routing_detail_from_local**](docs/TroubleshootingToolsDiagnosticsApi.md#get_routing_detail_from_local) | **GET** /stream/device/nwpi/routingDetail | +*TroubleshootingToolsDiagnosticsApi* | [**get_session**](docs/TroubleshootingToolsDiagnosticsApi.md#get_session) | **POST** /stream/device/speed | +*TroubleshootingToolsDiagnosticsApi* | [**get_session_info_capture**](docs/TroubleshootingToolsDiagnosticsApi.md#get_session_info_capture) | **POST** /stream/device/capture | +*TroubleshootingToolsDiagnosticsApi* | [**get_session_info_log**](docs/TroubleshootingToolsDiagnosticsApi.md#get_session_info_log) | **POST** /stream/device/log | +*TroubleshootingToolsDiagnosticsApi* | [**get_sessions**](docs/TroubleshootingToolsDiagnosticsApi.md#get_sessions) | **GET** /stream/device/log/sessions | +*TroubleshootingToolsDiagnosticsApi* | [**get_speed_test**](docs/TroubleshootingToolsDiagnosticsApi.md#get_speed_test) | **GET** /stream/device/speed/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**get_speed_test_status**](docs/TroubleshootingToolsDiagnosticsApi.md#get_speed_test_status) | **GET** /stream/device/speed/status/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_bulk_raw_data27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_bulk_raw_data27) | **GET** /stream/device/nwpi/page | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_bulk_raw_data28**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_bulk_raw_data28) | **GET** /statistics/speedtest/page | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_data_fields29**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_data_fields29) | **GET** /stream/device/nwpi/fields | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_data_fields30**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_data_fields30) | **GET** /statistics/speedtest/fields | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_data_raw_data26**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data26) | **GET** /stream/device/nwpi | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_data_raw_data27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data27) | **GET** /statistics/speedtest | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_data_raw_data_as_csv27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data_as_csv27) | **GET** /stream/device/nwpi/csv | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_data_raw_data_as_csv28**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data_as_csv28) | **GET** /statistics/speedtest/csv | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_query_fields29**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_query_fields29) | **GET** /stream/device/nwpi/query/fields | +*TroubleshootingToolsDiagnosticsApi* | [**get_stat_query_fields30**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stat_query_fields30) | **GET** /statistics/speedtest/query/fields | +*TroubleshootingToolsDiagnosticsApi* | [**get_stats_raw_data27**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stats_raw_data27) | **POST** /stream/device/nwpi | +*TroubleshootingToolsDiagnosticsApi* | [**get_stats_raw_data28**](docs/TroubleshootingToolsDiagnosticsApi.md#get_stats_raw_data28) | **POST** /statistics/speedtest | +*TroubleshootingToolsDiagnosticsApi* | [**get_thread_pools**](docs/TroubleshootingToolsDiagnosticsApi.md#get_thread_pools) | **GET** /diagnostics/threadpools | +*TroubleshootingToolsDiagnosticsApi* | [**get_trace_flow**](docs/TroubleshootingToolsDiagnosticsApi.md#get_trace_flow) | **GET** /stream/device/nwpi/traceFlow | +*TroubleshootingToolsDiagnosticsApi* | [**get_trace_history**](docs/TroubleshootingToolsDiagnosticsApi.md#get_trace_history) | **GET** /stream/device/nwpi/traceHistory | +*TroubleshootingToolsDiagnosticsApi* | [**get_vnic_info_by_vnf_id**](docs/TroubleshootingToolsDiagnosticsApi.md#get_vnic_info_by_vnf_id) | **GET** /stream/device/capture/vnicsInfo/{vnfId} | +*TroubleshootingToolsDiagnosticsApi* | [**monitor_override_start**](docs/TroubleshootingToolsDiagnosticsApi.md#monitor_override_start) | **POST** /stream/device/nwpi/monitor/overrideStart | +*TroubleshootingToolsDiagnosticsApi* | [**monitor_start**](docs/TroubleshootingToolsDiagnosticsApi.md#monitor_start) | **POST** /stream/device/nwpi/monitor/start | +*TroubleshootingToolsDiagnosticsApi* | [**monitor_stop**](docs/TroubleshootingToolsDiagnosticsApi.md#monitor_stop) | **POST** /stream/device/nwpi/monitor/stop | +*TroubleshootingToolsDiagnosticsApi* | [**nwpi_post_flow_data**](docs/TroubleshootingToolsDiagnosticsApi.md#nwpi_post_flow_data) | **POST** /stream/device/nwpi/trace/record/{deviceUUID} | +*TroubleshootingToolsDiagnosticsApi* | [**process_device_status**](docs/TroubleshootingToolsDiagnosticsApi.md#process_device_status) | **POST** /stream/device/status/{deviceUUID} | +*TroubleshootingToolsDiagnosticsApi* | [**renew_session_info**](docs/TroubleshootingToolsDiagnosticsApi.md#renew_session_info) | **GET** /stream/device/log/renew/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**save_speed_test_results**](docs/TroubleshootingToolsDiagnosticsApi.md#save_speed_test_results) | **POST** /stream/device/speed/{deviceUUID}/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**search_device_log**](docs/TroubleshootingToolsDiagnosticsApi.md#search_device_log) | **POST** /stream/device/log/search/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**start_pcap_session**](docs/TroubleshootingToolsDiagnosticsApi.md#start_pcap_session) | **GET** /stream/device/capture/start/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**start_speed_test**](docs/TroubleshootingToolsDiagnosticsApi.md#start_speed_test) | **GET** /stream/device/speed/start/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**stop_pcap_session**](docs/TroubleshootingToolsDiagnosticsApi.md#stop_pcap_session) | **GET** /stream/device/capture/stop/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**stop_speed_test**](docs/TroubleshootingToolsDiagnosticsApi.md#stop_speed_test) | **GET** /stream/device/speed/stop/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**stream_log**](docs/TroubleshootingToolsDiagnosticsApi.md#stream_log) | **POST** /stream/device/log/{logType}/{deviceUUID}/{sessionId} | +*TroubleshootingToolsDiagnosticsApi* | [**trace_delete**](docs/TroubleshootingToolsDiagnosticsApi.md#trace_delete) | **DELETE** /stream/device/nwpi/trace/delete | +*TroubleshootingToolsDiagnosticsApi* | [**trace_fin_flow_with_query**](docs/TroubleshootingToolsDiagnosticsApi.md#trace_fin_flow_with_query) | **GET** /stream/device/nwpi/traceFinFlowWithQuery | +*TroubleshootingToolsDiagnosticsApi* | [**trace_start**](docs/TroubleshootingToolsDiagnosticsApi.md#trace_start) | **POST** /stream/device/nwpi/trace/start | +*TroubleshootingToolsDiagnosticsApi* | [**trace_stop**](docs/TroubleshootingToolsDiagnosticsApi.md#trace_stop) | **POST** /stream/device/nwpi/trace/stop/{traceId} | +*UmbrellaApi* | [**get_all_keys_from_umbrella**](docs/UmbrellaApi.md#get_all_keys_from_umbrella) | **GET** /umbrella/getkeys | +*UmbrellaApi* | [**get_management_keys_from_umbrella**](docs/UmbrellaApi.md#get_management_keys_from_umbrella) | **GET** /umbrella/getkeys/management | +*UmbrellaApi* | [**get_network_keys_from_umbrella**](docs/UmbrellaApi.md#get_network_keys_from_umbrella) | **GET** /umbrella/getkeys/networkdevices | +*UmbrellaApi* | [**get_reporting_keys_from_umbrella**](docs/UmbrellaApi.md#get_reporting_keys_from_umbrella) | **GET** /umbrella/getkeys/reporting | +*UtilityConfigurationDBApi* | [**get_db_size_on_file**](docs/UtilityConfigurationDBApi.md#get_db_size_on_file) | **GET** /util/configdb/size | +*UtilityLoggingApi* | [**debug_log**](docs/UtilityLoggingApi.md#debug_log) | **POST** /util/logging/debuglog | +*UtilityLoggingApi* | [**list_log_file_details**](docs/UtilityLoggingApi.md#list_log_file_details) | **GET** /util/logfile/appserver | +*UtilityLoggingApi* | [**list_loggers**](docs/UtilityLoggingApi.md#list_loggers) | **GET** /util/logging/loggers | +*UtilityLoggingApi* | [**list_v_manage_server_log_last_n_lines**](docs/UtilityLoggingApi.md#list_v_manage_server_log_last_n_lines) | **GET** /util/logfile/appserver/lastnlines | +*UtilityLoggingApi* | [**set_log_level**](docs/UtilityLoggingApi.md#set_log_level) | **POST** /util/logging/level | +*UtilitySecurityApi* | [**check_given_ip_list**](docs/UtilitySecurityApi.md#check_given_ip_list) | **POST** /software/compliance/ip/origin/check | +*WorkflowManagementApi* | [**create_workflow**](docs/WorkflowManagementApi.md#create_workflow) | **POST** /workflow | +*WorkflowManagementApi* | [**delete_workflow**](docs/WorkflowManagementApi.md#delete_workflow) | **DELETE** /workflow | +*WorkflowManagementApi* | [**get_workflows**](docs/WorkflowManagementApi.md#get_workflows) | **GET** /workflow | +*WorkflowManagementApi* | [**save_workflow**](docs/WorkflowManagementApi.md#save_workflow) | **PUT** /workflow | + + +## Documentation For Models + + - [AdvancedRadioSetting](docs/AdvancedRadioSetting.md) + - [ApiReKeyDevice](docs/ApiReKeyDevice.md) + - [ApiReKeyDeviceList](docs/ApiReKeyDeviceList.md) + - [AwsIamCredentials](docs/AwsIamCredentials.md) + - [AwsKeyCredentials](docs/AwsKeyCredentials.md) + - [AzureCredentials](docs/AzureCredentials.md) + - [Banner](docs/Banner.md) + - [Bfd](docs/Bfd.md) + - [BfdTimerOnTransportTunnels](docs/BfdTimerOnTransportTunnels.md) + - [BizInternetTimer](docs/BizInternetTimer.md) + - [Cellular](docs/Cellular.md) + - [CellularAllOf](docs/CellularAllOf.md) + - [CellularProfile](docs/CellularProfile.md) + - [CertificateStates](docs/CertificateStates.md) + - [CertificateValidity](docs/CertificateValidity.md) + - [ChannelPowerSettings](docs/ChannelPowerSettings.md) + - [ConfigGroup](docs/ConfigGroup.md) + - [ConnectToNtpServer](docs/ConnectToNtpServer.md) + - [ControlStatus](docs/ControlStatus.md) + - [CorporateWifi](docs/CorporateWifi.md) + - [CountryRegionSettings](docs/CountryRegionSettings.md) + - [CreateDeviceParams](docs/CreateDeviceParams.md) + - [CreateTenantModel](docs/CreateTenantModel.md) + - [DHCPPool](docs/DHCPPool.md) + - [DataCenter](docs/DataCenter.md) + - [DataCenterRegistration](docs/DataCenterRegistration.md) + - [DeleteTenantBulkModel](docs/DeleteTenantBulkModel.md) + - [DeleteTenantModel](docs/DeleteTenantModel.md) + - [Device](docs/Device.md) + - [DeviceHealthDetails](docs/DeviceHealthDetails.md) + - [DeviceIP](docs/DeviceIP.md) + - [DeviceModel](docs/DeviceModel.md) + - [DeviceType](docs/DeviceType.md) + - [DeviceUuid](docs/DeviceUuid.md) + - [DevicesHealth](docs/DevicesHealth.md) + - [DevicesHealthOverview](docs/DevicesHealthOverview.md) + - [DisasterRecoverySettings](docs/DisasterRecoverySettings.md) + - [DomainDetail](docs/DomainDetail.md) + - [EntityOwnershipInfo](docs/EntityOwnershipInfo.md) + - [EquinixCredentials](docs/EquinixCredentials.md) + - [EquinixLocationInfo](docs/EquinixLocationInfo.md) + - [EquinixNEInfo](docs/EquinixNEInfo.md) + - [EquinixPartnerPort](docs/EquinixPartnerPort.md) + - [Ethernet](docs/Ethernet.md) + - [EthernetAllOf](docs/EthernetAllOf.md) + - [EthernetInterface](docs/EthernetInterface.md) + - [EventName](docs/EventName.md) + - [FeatureProfile](docs/FeatureProfile.md) + - [GcpCredentials](docs/GcpCredentials.md) + - [GetO365PreferredPathFromVAnalyticsRequest](docs/GetO365PreferredPathFromVAnalyticsRequest.md) + - [GetO365PreferredPathFromVAnalyticsRequestValue](docs/GetO365PreferredPathFromVAnalyticsRequestValue.md) + - [GlobalSettings](docs/GlobalSettings.md) + - [GlobalSettingsAllOf](docs/GlobalSettingsAllOf.md) + - [GroupId](docs/GroupId.md) + - [GuestWifi](docs/GuestWifi.md) + - [Header](docs/Header.md) + - [HeaderElement](docs/HeaderElement.md) + - [Host](docs/Host.md) + - [IkePhase](docs/IkePhase.md) + - [IpSecPolicy](docs/IpSecPolicy.md) + - [IpSecSecurity](docs/IpSecSecurity.md) + - [LoggingSystemMessages](docs/LoggingSystemMessages.md) + - [LoginAccessToRouter](docs/LoginAccessToRouter.md) + - [LteTimer](docs/LteTimer.md) + - [MegaportCredentials](docs/MegaportCredentials.md) + - [MegaportLocationInfo](docs/MegaportLocationInfo.md) + - [MegaportMVEInfo](docs/MegaportMVEInfo.md) + - [MegaportPartnerPort](docs/MegaportPartnerPort.md) + - [MplsTimer](docs/MplsTimer.md) + - [MultiCloudAccountInfo](docs/MultiCloudAccountInfo.md) + - [MultiCloudEdgeAccountInfo](docs/MultiCloudEdgeAccountInfo.md) + - [MultiCloudEdgeBillingAccountInfo](docs/MultiCloudEdgeBillingAccountInfo.md) + - [MultiCloudEdgeLocationInfo](docs/MultiCloudEdgeLocationInfo.md) + - [MultiCloudEdgePartnerPort](docs/MultiCloudEdgePartnerPort.md) + - [NATRule](docs/NATRule.md) + - [NameValuePair](docs/NameValuePair.md) + - [NetworkProtocol](docs/NetworkProtocol.md) + - [NetworkProtocolAllOf](docs/NetworkProtocolAllOf.md) + - [Node](docs/Node.md) + - [NwpiDomainMonitor](docs/NwpiDomainMonitor.md) + - [OMP](docs/OMP.md) + - [OnDemandQueueEntry](docs/OnDemandQueueEntry.md) + - [PartnerType](docs/PartnerType.md) + - [PolicyRule](docs/PolicyRule.md) + - [ProfileParcel](docs/ProfileParcel.md) + - [PropertyDefinition](docs/PropertyDefinition.md) + - [PublicInternetTimer](docs/PublicInternetTimer.md) + - [QueueEntries](docs/QueueEntries.md) + - [QueueProperties](docs/QueueProperties.md) + - [RadioBandSetting24G](docs/RadioBandSetting24G.md) + - [RadioBandSetting5G](docs/RadioBandSetting5G.md) + - [RadiusServer](docs/RadiusServer.md) + - [ResourceGroup](docs/ResourceGroup.md) + - [SSIDConfig](docs/SSIDConfig.md) + - [SchemaDefinition](docs/SchemaDefinition.md) + - [SecurityPolicy](docs/SecurityPolicy.md) + - [SecurityPolicyAllOf](docs/SecurityPolicyAllOf.md) + - [SimSlotConfig](docs/SimSlotConfig.md) + - [SiteHealth](docs/SiteHealth.md) + - [SiteToSiteVpn](docs/SiteToSiteVpn.md) + - [SmartAccountModel](docs/SmartAccountModel.md) + - [SoftwareUploadFileData](docs/SoftwareUploadFileData.md) + - [StatisticsProcessingCounters](docs/StatisticsProcessingCounters.md) + - [StatsTypeProcessingCounters](docs/StatsTypeProcessingCounters.md) + - [Systems](docs/Systems.md) + - [TagRestfulResource](docs/TagRestfulResource.md) + - [TenantStatus](docs/TenantStatus.md) + - [TenantStatusListModel](docs/TenantStatusListModel.md) + - [ThreadPoolDefinition](docs/ThreadPoolDefinition.md) + - [ThreadPoolsDefinition](docs/ThreadPoolsDefinition.md) + - [UpdateTenantModel](docs/UpdateTenantModel.md) + - [UpdateTenantvSmartModel](docs/UpdateTenantvSmartModel.md) + - [Uuid](docs/Uuid.md) + - [UuidToDomainId](docs/UuidToDomainId.md) + - [UuidToDomainIdMapping](docs/UuidToDomainIdMapping.md) + - [VEdgeBootstrapConfig](docs/VEdgeBootstrapConfig.md) + - [VEdgeHealth](docs/VEdgeHealth.md) + - [VPNID](docs/VPNID.md) + - [VResourceGroupNameModel](docs/VResourceGroupNameModel.md) + - [VSmartStatus](docs/VSmartStatus.md) + - [Variable](docs/Variable.md) + - [VertexDefinition](docs/VertexDefinition.md) + - [Vpn](docs/Vpn.md) + - [VpnAllOf](docs/VpnAllOf.md) + - [WanSpec](docs/WanSpec.md) + - [Wifi](docs/Wifi.md) + - [WifiAllOf](docs/WifiAllOf.md) + + +## Documentation For Authorization + + All endpoints do not require authorization. + +## Author + +vmanage@cisco.com + + +## Notes for Large OpenAPI documents +If the OpenAPI document is large, imports in openapi_client.apis and openapi_client.models may fail with a +RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: + +Solution 1: +Use specific imports for apis and models like: +- `from openapi_client.api.default_api import DefaultApi` +- `from openapi_client.model.pet import Pet` + +Solution 2: +Before importing the package, adjust the maximum recursion limit as shown below: +``` +import sys +sys.setrecursionlimit(1500) +import openapi_client +from openapi_client.apis import * +from openapi_client.models import * +``` + diff --git a/docs/AdministrationAuditLogApi.md b/docs/AdministrationAuditLogApi.md new file mode 100644 index 0000000..9997614 --- /dev/null +++ b/docs/AdministrationAuditLogApi.md @@ -0,0 +1,858 @@ +# openapi_client.AdministrationAuditLogApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**generate_audit_log**](AdministrationAuditLogApi.md#generate_audit_log) | **GET** /auditlog/severity | +[**get_audit_severity_custom_histogram**](AdministrationAuditLogApi.md#get_audit_severity_custom_histogram) | **GET** /auditlog/severity/summary | +[**get_count**](AdministrationAuditLogApi.md#get_count) | **GET** /auditlog/doccount | +[**get_count_post**](AdministrationAuditLogApi.md#get_count_post) | **POST** /auditlog/doccount | +[**get_post_property_aggregation_data**](AdministrationAuditLogApi.md#get_post_property_aggregation_data) | **POST** /auditlog/aggregation | +[**get_post_stat_bulk_raw_property_data**](AdministrationAuditLogApi.md#get_post_stat_bulk_raw_property_data) | **POST** /auditlog/page | +[**get_property_aggregation_data**](AdministrationAuditLogApi.md#get_property_aggregation_data) | **GET** /auditlog/aggregation | +[**get_raw_property_data**](AdministrationAuditLogApi.md#get_raw_property_data) | **POST** /auditlog | +[**get_stat_bulk_raw_property_data**](AdministrationAuditLogApi.md#get_stat_bulk_raw_property_data) | **GET** /auditlog/page | +[**get_stat_data_fields**](AdministrationAuditLogApi.md#get_stat_data_fields) | **GET** /auditlog/fields | +[**get_stat_data_raw_audit_log_data**](AdministrationAuditLogApi.md#get_stat_data_raw_audit_log_data) | **GET** /auditlog | +[**get_stat_query_fields**](AdministrationAuditLogApi.md#get_stat_query_fields) | **GET** /auditlog/query/fields | + + +# **generate_audit_log** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_audit_log() + + + +Get audit logs for last 3 hours + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + query = "query_example" # str | Query filter (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_audit_log(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->generate_audit_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_audit_severity_custom_histogram** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_audit_severity_custom_histogram() + + + +Get audit log severity histogram + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_audit_severity_custom_histogram(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_audit_severity_custom_histogram: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_count_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_property_aggregation_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_property_aggregation_data(body) + + + +Get raw property data aggregated with post action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + body = "body_example" # str | Query filter for getting stat raw data + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_post_property_aggregation_data(body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_post_property_aggregation_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| Query filter for getting stat raw data | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_property_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_property_data(body) + + + +Get raw property data in bulk with post action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + body = "body_example" # str | Query filter for getting stat raw data + scroll_id = "scrollId_example" # str | Offset of the query result (optional) + count = "count_example" # str | Size of the query result (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_post_stat_bulk_raw_property_data(body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_post_stat_bulk_raw_property_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_property_data(body, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_post_stat_bulk_raw_property_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| Query filter for getting stat raw data | + **scroll_id** | **str**| Offset of the query result | [optional] + **count** | **str**| Size of the query result | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_property_aggregation_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_property_aggregation_data() + + + +Get raw property data aggregated + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + input_query = "inputQuery_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_property_aggregation_data(input_query=input_query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_property_aggregation_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **input_query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_raw_property_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_raw_property_data(body) + + + +Get raw property data with post action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + body = "body_example" # str | Query filter for getting stat raw data + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_raw_property_data(body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_raw_property_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| Query filter for getting stat raw data | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_property_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_property_data() + + + +Get raw property data in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + input_query = "inputQuery_example" # str | Query filter (optional) + scroll_id = "scrollId_example" # str | Offset of the query result (optional) + count = "count_example" # str | size of the query result (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_property_data(input_query=input_query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_stat_bulk_raw_property_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **input_query** | **str**| Query filter | [optional] + **scroll_id** | **str**| Offset of the query result | [optional] + **count** | **str**| size of the query result | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_stat_data_fields: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_audit_log_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_audit_log_data() + + + +Get stat raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + input_query = "inputQuery_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_audit_log_data(input_query=input_query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_stat_data_raw_audit_log_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **input_query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_audit_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_audit_log_api.AdministrationAuditLogApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationAuditLogApi->get_stat_query_fields: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/AdministrationUserAndGroupApi.md b/docs/AdministrationUserAndGroupApi.md new file mode 100644 index 0000000..92bf101 --- /dev/null +++ b/docs/AdministrationUserAndGroupApi.md @@ -0,0 +1,2389 @@ +# openapi_client.AdministrationUserAndGroupApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_colo_group**](AdministrationUserAndGroupApi.md#create_colo_group) | **POST** /admin/cologroup | +[**create_group_grid_columns**](AdministrationUserAndGroupApi.md#create_group_grid_columns) | **GET** /admin/usergroup/definition | +[**create_user**](AdministrationUserAndGroupApi.md#create_user) | **POST** /admin/user | +[**create_user_group**](AdministrationUserAndGroupApi.md#create_user_group) | **POST** /admin/usergroup | +[**create_vpn_group**](AdministrationUserAndGroupApi.md#create_vpn_group) | **POST** /admin/vpngroup | +[**delete_colo_group**](AdministrationUserAndGroupApi.md#delete_colo_group) | **DELETE** /admin/cologroup/{id} | +[**delete_user**](AdministrationUserAndGroupApi.md#delete_user) | **DELETE** /admin/user/{userName} | +[**delete_user_group**](AdministrationUserAndGroupApi.md#delete_user_group) | **DELETE** /admin/usergroup/{userGroupId} | +[**delete_vpn_group**](AdministrationUserAndGroupApi.md#delete_vpn_group) | **DELETE** /admin/vpngroup/{id} | +[**edit_colo_group**](AdministrationUserAndGroupApi.md#edit_colo_group) | **PUT** /admin/cologroup/{id} | +[**edit_vpn_group**](AdministrationUserAndGroupApi.md#edit_vpn_group) | **PUT** /admin/vpngroup/{id} | +[**find_user_auth_type**](AdministrationUserAndGroupApi.md#find_user_auth_type) | **GET** /admin/user/userAuthType | +[**find_user_groups**](AdministrationUserAndGroupApi.md#find_user_groups) | **GET** /admin/usergroup | +[**find_user_groups_as_key_value**](AdministrationUserAndGroupApi.md#find_user_groups_as_key_value) | **GET** /admin/usergroup/keyvalue | +[**find_user_role**](AdministrationUserAndGroupApi.md#find_user_role) | **GET** /admin/user/role | +[**find_users**](AdministrationUserAndGroupApi.md#find_users) | **GET** /admin/user | +[**get_active_sessions**](AdministrationUserAndGroupApi.md#get_active_sessions) | **GET** /admin/user/activeSessions | +[**get_colo_groups**](AdministrationUserAndGroupApi.md#get_colo_groups) | **GET** /admin/cologroup | +[**get_vpn_groups**](AdministrationUserAndGroupApi.md#get_vpn_groups) | **GET** /admin/vpngroup | +[**remove_sessions**](AdministrationUserAndGroupApi.md#remove_sessions) | **DELETE** /admin/user/removeSessions | +[**reset_user**](AdministrationUserAndGroupApi.md#reset_user) | **POST** /admin/user/reset | +[**resource_group**](AdministrationUserAndGroupApi.md#resource_group) | **GET** /admin/resourcegroup | +[**resource_group1**](AdministrationUserAndGroupApi.md#resource_group1) | **POST** /admin/resourcegroup/switch | +[**resource_group2**](AdministrationUserAndGroupApi.md#resource_group2) | **PUT** /admin/resourcegroup/{groupId} | +[**resource_group3**](AdministrationUserAndGroupApi.md#resource_group3) | **DELETE** /admin/resourcegroup/{groupId} | +[**resource_group4**](AdministrationUserAndGroupApi.md#resource_group4) | **POST** /admin/resourcegroup | +[**resource_group_name**](AdministrationUserAndGroupApi.md#resource_group_name) | **GET** /admin/user/resourceGroupName | +[**update_admin_password**](AdministrationUserAndGroupApi.md#update_admin_password) | **POST** /admin/user/admin/password | +[**update_password**](AdministrationUserAndGroupApi.md#update_password) | **PUT** /admin/user/password/{userName} | +[**update_profile_locale**](AdministrationUserAndGroupApi.md#update_profile_locale) | **PUT** /admin/user/profile/locale | +[**update_profile_password**](AdministrationUserAndGroupApi.md#update_profile_password) | **PUT** /admin/user/profile/password | +[**update_user**](AdministrationUserAndGroupApi.md#update_user) | **PUT** /admin/user/{userName} | +[**update_user_group**](AdministrationUserAndGroupApi.md#update_user_group) | **PUT** /admin/usergroup/{userGroupId} | +[**validate_password**](AdministrationUserAndGroupApi.md#validate_password) | **POST** /admin/user/password/validate | + + +# **create_colo_group** +> create_colo_group() + + + +Add COLO group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Colocation group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_colo_group(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->create_colo_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Colocation group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_group_grid_columns** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_group_grid_columns() + + + +Get user groups in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_group_grid_columns() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->create_group_grid_columns: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_user** +> create_user() + + + +Create a user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_user(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->create_user: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_user_group** +> create_user_group() + + + +Create user group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_user_group(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->create_user_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_vpn_group** +> create_vpn_group() + + + +Add VPN group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPN group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_vpn_group(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->create_vpn_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPN group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_colo_group** +> delete_colo_group(id) + + + +Delete COLO group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + id = "id_example" # str | Colocation group Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_colo_group(id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->delete_colo_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Colocation group Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_user** +> delete_user(user_name) + + + +Delete user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + user_name = "userName_example" # str | User name + + # example passing only required values which don't have defaults set + try: + api_instance.delete_user(user_name) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->delete_user: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_name** | **str**| User name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_user_group** +> delete_user_group(user_group_id) + + + +Delete user group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + user_group_id = "userGroupId_example" # str | User group Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_user_group(user_group_id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->delete_user_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_group_id** | **str**| User group Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_vpn_group** +> delete_vpn_group(id) + + + +Delete VPN group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + id = "id_example" # str | VPN group Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_vpn_group(id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->delete_vpn_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| VPN group Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_colo_group** +> edit_colo_group(id) + + + +Update COLO group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + id = "id_example" # str | Colocation group Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Colocation group (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_colo_group(id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->edit_colo_group: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_colo_group(id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->edit_colo_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Colocation group Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Colocation group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_vpn_group** +> edit_vpn_group(id) + + + +Update VPN group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + id = "id_example" # str | VPN group Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPN group (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_vpn_group(id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->edit_vpn_group: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_vpn_group(id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->edit_vpn_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| VPN group Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPN group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_user_auth_type** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_user_auth_type() + + + +Find user authentication type, whether it is SAML enabled + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_user_auth_type() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->find_user_auth_type: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_user_groups** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] find_user_groups() + + + +Get all user groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_user_groups() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->find_user_groups: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_user_groups_as_key_value** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] find_user_groups_as_key_value() + + + +Get user groups as key value map + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_user_groups_as_key_value() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->find_user_groups_as_key_value: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_user_role** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_user_role() + + + +Check whether a user has admin role + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_user_role() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->find_user_role: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_users** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] find_users() + + + +Get all users + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_users() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->find_users: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_active_sessions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_active_sessions() + + + +Get active sessions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_active_sessions() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->get_active_sessions: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_colo_groups** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_colo_groups() + + + +Get COLO groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_colo_groups() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->get_colo_groups: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpn_groups** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vpn_groups() + + + +Get VPN groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_vpn_groups() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->get_vpn_groups: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_sessions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} remove_sessions() + + + +Remove sessions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + request_body = [] # [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] | User (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.remove_sessions(request_body=request_body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->remove_sessions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]**| User | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reset_user** +> reset_user() + + + +Unlock a user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.reset_user(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->reset_user: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resource_group** +> [ResourceGroup] resource_group() + + + +Get all groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from openapi_client.model.resource_group import ResourceGroup +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.resource_group() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**[ResourceGroup]**](ResourceGroup.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resource_group1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} resource_group1(body) + + + +Global netadmin switches to a different resource group view + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global netadmin switches to a different resource group view + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.resource_group1(body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global netadmin switches to a different resource group view | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resource_group2** +> resource_group2(group_id) + + + +Update a group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from openapi_client.model.resource_group import ResourceGroup +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + group_id = "groupId_example" # str | + resource_group = ResourceGroup( + desc="desc_example", + device_ips=[ + "device_ips_example", + ], + device_ips=[ + "device_ips_example", + ], + id={}, + mgmt_sytem_ips_map={ + "key": "key_example", + }, + name="name_example", + site_ids=[ + 1, + ], + uuid_sytem_ips_map={ + "key": "key_example", + }, + ) # ResourceGroup | Update group description (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.resource_group2(group_id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group2: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.resource_group2(group_id, resource_group=resource_group) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group_id** | **str**| | + **resource_group** | [**ResourceGroup**](ResourceGroup.md)| Update group description | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resource_group3** +> resource_group3(group_id) + + + +Delete a group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + group_id = "groupId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.resource_group3(group_id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resource_group4** +> resource_group4(resource_group) + + + +Create a group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from openapi_client.model.resource_group import ResourceGroup +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + resource_group = ResourceGroup( + desc="desc_example", + device_ips=[ + "device_ips_example", + ], + device_ips=[ + "device_ips_example", + ], + id={}, + mgmt_sytem_ips_map={ + "key": "key_example", + }, + name="name_example", + site_ids=[ + 1, + ], + uuid_sytem_ips_map={ + "key": "key_example", + }, + ) # ResourceGroup | Create a group + + # example passing only required values which don't have defaults set + try: + api_instance.resource_group4(resource_group) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **resource_group** | [**ResourceGroup**](ResourceGroup.md)| Create a group | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resource_group_name** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] resource_group_name() + + + +Get the name of the resource group associated with the current logged in user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.resource_group_name() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->resource_group_name: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_admin_password** +> update_admin_password() + + + +Update admin default password + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_admin_password(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_admin_password: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_password** +> update_password(user_name) + + + +Update user password + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + user_name = "userName_example" # str | User name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_password(user_name) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_password: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_password(user_name, body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_password: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_name** | **str**| User name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_profile_locale** +> update_profile_locale() + + + +Update profile locale + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_profile_locale(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_profile_locale: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_profile_password** +> update_profile_password() + + + +Update profile password + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_profile_password(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_profile_password: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_user** +> update_user(user_name) + + + +Update user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + user_name = "userName_example" # str | User name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_user(user_name) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_user: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_user(user_name, body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_user: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_name** | **str**| User name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_user_group** +> update_user_group(user_group_id) + + + +Update user group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + user_group_id = "userGroupId_example" # str | User group Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User group (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_user_group(user_group_id) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_user_group: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_user_group(user_group_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->update_user_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_group_id** | **str**| User group Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_password** +> validate_password() + + + +Validate user password + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import administration_user_and_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = administration_user_and_group_api.AdministrationUserAndGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User password (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.validate_password(body=body) + except openapi_client.ApiException as e: + print("Exception when calling AdministrationUserAndGroupApi->validate_password: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User password | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/AdvancedRadioSetting.md b/docs/AdvancedRadioSetting.md new file mode 100644 index 0000000..8120b5f --- /dev/null +++ b/docs/AdvancedRadioSetting.md @@ -0,0 +1,13 @@ +# AdvancedRadioSetting + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**channel_power_settings** | [**ChannelPowerSettings**](ChannelPowerSettings.md) | | [optional] +**country_region_settings** | [**CountryRegionSettings**](CountryRegionSettings.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiReKeyDevice.md b/docs/ApiReKeyDevice.md new file mode 100644 index 0000000..a8258ab --- /dev/null +++ b/docs/ApiReKeyDevice.md @@ -0,0 +1,12 @@ +# ApiReKeyDevice + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiReKeyDeviceList.md b/docs/ApiReKeyDeviceList.md new file mode 100644 index 0000000..e293e09 --- /dev/null +++ b/docs/ApiReKeyDeviceList.md @@ -0,0 +1,12 @@ +# ApiReKeyDeviceList + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_list** | [**[ApiReKeyDevice]**](ApiReKeyDevice.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AwsIamCredentials.md b/docs/AwsIamCredentials.md new file mode 100644 index 0000000..50b45af --- /dev/null +++ b/docs/AwsIamCredentials.md @@ -0,0 +1,13 @@ +# AwsIamCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_id** | **str** | | [optional] +**role_arn** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AwsKeyCredentials.md b/docs/AwsKeyCredentials.md new file mode 100644 index 0000000..3c30586 --- /dev/null +++ b/docs/AwsKeyCredentials.md @@ -0,0 +1,13 @@ +# AwsKeyCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**api_key** | **str** | | [optional] +**secret_key** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AzureCredentials.md b/docs/AzureCredentials.md new file mode 100644 index 0000000..83f226c --- /dev/null +++ b/docs/AzureCredentials.md @@ -0,0 +1,15 @@ +# AzureCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | | [optional] +**cloud_tenant_id** | **str** | | [optional] +**secret_key** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Banner.md b/docs/Banner.md new file mode 100644 index 0000000..9537087 --- /dev/null +++ b/docs/Banner.md @@ -0,0 +1,13 @@ +# Banner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**login_message** | **str** | | [optional] +**motd** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Bfd.md b/docs/Bfd.md new file mode 100644 index 0000000..27d7b17 --- /dev/null +++ b/docs/Bfd.md @@ -0,0 +1,15 @@ +# Bfd + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bfd_timer_on_transport_tunnels** | [**BfdTimerOnTransportTunnels**](BfdTimerOnTransportTunnels.md) | | [optional] +**dscp_for_bfd_packets** | **int** | | [optional] +**multiplier** | **int** | | [optional] +**poll_interval** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/BfdTimerOnTransportTunnels.md b/docs/BfdTimerOnTransportTunnels.md new file mode 100644 index 0000000..08f3a78 --- /dev/null +++ b/docs/BfdTimerOnTransportTunnels.md @@ -0,0 +1,15 @@ +# BfdTimerOnTransportTunnels + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**biz_internet_timer** | [**BizInternetTimer**](BizInternetTimer.md) | | [optional] +**lte_timer** | [**LteTimer**](LteTimer.md) | | [optional] +**mpls_timer** | [**MplsTimer**](MplsTimer.md) | | [optional] +**public_internet_timer** | [**PublicInternetTimer**](PublicInternetTimer.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/BizInternetTimer.md b/docs/BizInternetTimer.md new file mode 100644 index 0000000..403f6f6 --- /dev/null +++ b/docs/BizInternetTimer.md @@ -0,0 +1,15 @@ +# BizInternetTimer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dscp** | **int** | | [optional] +**hello_interval** | **int** | | [optional] +**multiplier** | **int** | | [optional] +**path_mtu** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Cellular.md b/docs/Cellular.md new file mode 100644 index 0000000..05a296f --- /dev/null +++ b/docs/Cellular.md @@ -0,0 +1,23 @@ +# Cellular + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**primary_slot** | **int** | | +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**sim_slot0** | [**SimSlotConfig**](SimSlotConfig.md) | | [optional] +**sim_slot1** | [**SimSlotConfig**](SimSlotConfig.md) | | [optional] +**wan_config** | **str** | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CellularAllOf.md b/docs/CellularAllOf.md new file mode 100644 index 0000000..095718e --- /dev/null +++ b/docs/CellularAllOf.md @@ -0,0 +1,15 @@ +# CellularAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sim_slot0** | [**SimSlotConfig**](SimSlotConfig.md) | | [optional] +**sim_slot1** | [**SimSlotConfig**](SimSlotConfig.md) | | [optional] +**primary_slot** | **int** | | [optional] +**wan_config** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CellularProfile.md b/docs/CellularProfile.md new file mode 100644 index 0000000..af8f210 --- /dev/null +++ b/docs/CellularProfile.md @@ -0,0 +1,17 @@ +# CellularProfile + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**apn** | **str** | | [optional] +**auth_method** | **str** | | [optional] +**id** | **int** | | [optional] +**password** | **str** | | [optional] +**pdn_type** | **str** | | [optional] +**user_name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CertificateManagementDeviceApi.md b/docs/CertificateManagementDeviceApi.md new file mode 100644 index 0000000..da98879 --- /dev/null +++ b/docs/CertificateManagementDeviceApi.md @@ -0,0 +1,2119 @@ +# openapi_client.CertificateManagementDeviceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**decommission_enterprise_csr_for_vedge**](CertificateManagementDeviceApi.md#decommission_enterprise_csr_for_vedge) | **POST** /certificate/revoke/enterprise/certificate | +[**delete_configuration**](CertificateManagementDeviceApi.md#delete_configuration) | **DELETE** /certificate/{uuid} | +[**force_sync_root_cert**](CertificateManagementDeviceApi.md#force_sync_root_cert) | **POST** /certificate/forcesync/rootCert | +[**generate_csr**](CertificateManagementDeviceApi.md#generate_csr) | **POST** /certificate/generate/csr | +[**generate_edge_device_csr**](CertificateManagementDeviceApi.md#generate_edge_device_csr) | **POST** /certificate/generate/wanedge/csr | +[**generate_enterprise_csr**](CertificateManagementDeviceApi.md#generate_enterprise_csr) | **POST** /certificate/generate/enterprise/csr/vedge | +[**get_cert_details**](CertificateManagementDeviceApi.md#get_cert_details) | **POST** /certificate/certdetails | +[**get_certificate_data**](CertificateManagementDeviceApi.md#get_certificate_data) | **GET** /certificate/record | +[**get_certificate_detail**](CertificateManagementDeviceApi.md#get_certificate_detail) | **GET** /certificate/stats/detail | +[**get_certificate_stats**](CertificateManagementDeviceApi.md#get_certificate_stats) | **GET** /certificate/stats/summary | +[**get_csr_view_right_menus**](CertificateManagementDeviceApi.md#get_csr_view_right_menus) | **GET** /certificate/csr/details | +[**get_device_view_right_menus**](CertificateManagementDeviceApi.md#get_device_view_right_menus) | **GET** /certificate/device/details | +[**get_devices_list**](CertificateManagementDeviceApi.md#get_devices_list) | **GET** /certificate/device/list | +[**get_installed_cert**](CertificateManagementDeviceApi.md#get_installed_cert) | **GET** /certificate/vedge | +[**get_list_status**](CertificateManagementDeviceApi.md#get_list_status) | **GET** /certificate/list/status | +[**get_root_cert_chains**](CertificateManagementDeviceApi.md#get_root_cert_chains) | **GET** /certificate/rootcertchains | +[**get_root_certificate**](CertificateManagementDeviceApi.md#get_root_certificate) | **GET** /certificate/rootcertificate | +[**get_view**](CertificateManagementDeviceApi.md#get_view) | **GET** /certificate/view | +[**getc_edge_list**](CertificateManagementDeviceApi.md#getc_edge_list) | **GET** /certificate/tokengeneratedlist | +[**getv_edge_csr**](CertificateManagementDeviceApi.md#getv_edge_csr) | **GET** /certificate/vedge/csr | +[**getv_edge_list**](CertificateManagementDeviceApi.md#getv_edge_list) | **GET** /certificate/vedge/list | +[**getv_smart_list**](CertificateManagementDeviceApi.md#getv_smart_list) | **GET** /certificate/vsmart/list | +[**install_certificate**](CertificateManagementDeviceApi.md#install_certificate) | **POST** /certificate/install/signedCert | +[**reset_rsa**](CertificateManagementDeviceApi.md#reset_rsa) | **POST** /certificate/reset/rsa | +[**save_root_cert_chain**](CertificateManagementDeviceApi.md#save_root_cert_chain) | **PUT** /certificate/rootcertchains | +[**save_v_edge_list**](CertificateManagementDeviceApi.md#save_v_edge_list) | **POST** /certificate/save/vedge/list | +[**setv_edge_list**](CertificateManagementDeviceApi.md#setv_edge_list) | **POST** /certificate/vedge/list | +[**setv_smart_list**](CertificateManagementDeviceApi.md#setv_smart_list) | **POST** /certificate/vsmart/list | +[**setv_smart_list1**](CertificateManagementDeviceApi.md#setv_smart_list1) | **GET** /certificate/mthub/list | +[**syncv_bond**](CertificateManagementDeviceApi.md#syncv_bond) | **GET** /certificate/syncvbond | +[**update_jks**](CertificateManagementDeviceApi.md#update_jks) | **PUT** /certificate/jks | + + +# **decommission_enterprise_csr_for_vedge** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} decommission_enterprise_csr_for_vedge() + + + +Revoking enterprise CSR for hardware vEdge


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Revoking CSR for hardware vEdge (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.decommission_enterprise_csr_for_vedge(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->decommission_enterprise_csr_for_vedge: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Revoking CSR for hardware vEdge | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_configuration(uuid) + + + +Invalidate device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + uuid = "uuid_example" # str | Device uuid + replace_controller = False # bool | Replace a vSmart in Multi-tenant setup with a new vSmart (optional) if omitted the server will use the default value of False + device_id = "deviceId_example" # str | uuid of new vSmart (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_configuration(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->delete_configuration: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_configuration(uuid, replace_controller=replace_controller, device_id=device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->delete_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + **replace_controller** | **bool**| Replace a vSmart in Multi-tenant setup with a new vSmart | [optional] if omitted the server will use the default value of False + **device_id** | **str**| uuid of new vSmart | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **force_sync_root_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} force_sync_root_cert() + + + +Force sync root certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Singed certificate (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.force_sync_root_cert(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->force_sync_root_cert: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Singed certificate | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_csr** +> str generate_csr() + + + +Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request for device (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_csr(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->generate_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request for device | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_edge_device_csr** +> str generate_edge_device_csr() + + + +Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request for device (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_edge_device_csr(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->generate_edge_device_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request for device | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_enterprise_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_enterprise_csr() + + + +Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request for hardware device (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_enterprise_csr(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->generate_enterprise_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request for hardware device | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cert_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cert_details() + + + +Get cert details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | parse cert (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cert_details(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_cert_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| parse cert | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_certificate_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_certificate_data() + + + +Get certificate chain + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_certificate_data() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_certificate_data: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_certificate_detail** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_certificate_detail() + + + +Get certificate detail + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_certificate_detail() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_certificate_detail: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_certificate_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_certificate_stats() + + + +Get certificate expiration status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_certificate_stats() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_certificate_stats: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csr_view_right_menus** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_csr_view_right_menus() + + + +Get CSR detail view + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_csr_view_right_menus() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_csr_view_right_menus: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_view_right_menus** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_view_right_menus() + + + +Get device detail view + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_view_right_menus() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_device_view_right_menus: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_devices_list() + + + +Get vEdge list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_devices_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_devices_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_installed_cert** +> str get_installed_cert(uuid) + + + +Get Installed Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_installed_cert(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_installed_cert: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_list_status** +> get_list_status() + + + +get certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_list_status() + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_list_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_root_cert_chains** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_root_cert_chains(action) + + + +Get root cert chain + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + action = "get" # str | Action + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_root_cert_chains(action) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_root_cert_chains: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **action** | **str**| Action | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_root_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_root_certificate() + + + +Get device root certificate detail view + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_root_certificate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_root_certificate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_view** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_view() + + + +Get certificate UI view + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_view() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->get_view: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getc_edge_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getc_edge_list() + + + +Get cEdge list with tokengenerated list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.getc_edge_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->getc_edge_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_edge_csr** +> str getv_edge_csr(uuid) + + + +Get vEdge CSR Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.getv_edge_csr(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->getv_edge_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_edge_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getv_edge_list() + + + +Get vEdge list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + model = "vedge-cloud" # str | Device model (optional) + state = [ + "state_example", + ] # [str] | Device state (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.getv_edge_list(model=model, state=state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->getv_edge_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **model** | **str**| Device model | [optional] + **state** | **[str]**| Device state | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_smart_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getv_smart_list() + + + +Get vSmart list


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.getv_smart_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->getv_smart_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **install_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} install_certificate() + + + +Install singed certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Singed certificate (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.install_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->install_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Singed certificate | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reset_rsa** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} reset_rsa() + + + +Register CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request for vEdge (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.reset_rsa(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->reset_rsa: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request for vEdge | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_root_cert_chain** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_root_cert_chain() + + + +Save root cert chain


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Save root cert chain (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_root_cert_chain(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->save_root_cert_chain: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Save root cert chain | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_v_edge_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_v_edge_list() + + + +Save vEdge device list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vEdge device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_v_edge_list(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->save_v_edge_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vEdge device list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setv_edge_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} setv_edge_list() + + + +Save vEdge list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vEdge device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.setv_edge_list(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->setv_edge_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vEdge device list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setv_smart_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} setv_smart_list() + + + +Save vSmart list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.setv_smart_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->setv_smart_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setv_smart_list1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} setv_smart_list1() + + + +Save vSmart list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.setv_smart_list1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->setv_smart_list1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **syncv_bond** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} syncv_bond() + + + +sync vManage UUID to all vBond + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.syncv_bond() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->syncv_bond: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_jks** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_jks() + + + +update JKS


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_device_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_device_api.CertificateManagementDeviceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update JKS (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_jks(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementDeviceApi->update_jks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update JKS | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CertificateManagementVManageApi.md b/docs/CertificateManagementVManageApi.md new file mode 100644 index 0000000..8125d1d --- /dev/null +++ b/docs/CertificateManagementVManageApi.md @@ -0,0 +1,416 @@ +# openapi_client.CertificateManagementVManageApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**dump_certificate**](CertificateManagementVManageApi.md#dump_certificate) | **GET** /setting/configuration/webserver/certificate/certificate | +[**get_certificate**](CertificateManagementVManageApi.md#get_certificate) | **GET** /setting/configuration/webserver/certificate/getcertificate | +[**get_csr**](CertificateManagementVManageApi.md#get_csr) | **POST** /setting/configuration/webserver/certificate | +[**import_certificate**](CertificateManagementVManageApi.md#import_certificate) | **PUT** /setting/configuration/webserver/certificate | +[**rollback**](CertificateManagementVManageApi.md#rollback) | **GET** /setting/configuration/webserver/certificate/rollback | +[**show_info**](CertificateManagementVManageApi.md#show_info) | **GET** /setting/configuration/webserver/certificate | + + +# **dump_certificate** +> str dump_certificate(type) + + + +Get certificate with alias name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_v_manage_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_v_manage_api.CertificateManagementVManageApi(api_client) + type = "type_example" # str | Key alias + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.dump_certificate(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementVManageApi->dump_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Key alias | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_certificate** +> str get_certificate() + + + +Get certificate for alias server + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_v_manage_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_v_manage_api.CertificateManagementVManageApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_certificate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementVManageApi->get_certificate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_csr() + + + +Generate Certificate Signing Request + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_v_manage_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_v_manage_api.CertificateManagementVManageApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR signing request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_csr(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementVManageApi->get_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR signing request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **import_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} import_certificate() + + + +Import a signed web server certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_v_manage_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_v_manage_api.CertificateManagementVManageApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Singed certificate (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.import_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementVManageApi->import_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Singed certificate | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rollback** +> str rollback(type) + + + +Rollback certificate with alias name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_v_manage_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_v_manage_api.CertificateManagementVManageApi(api_client) + type = "type_example" # str | Key alias + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.rollback(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementVManageApi->rollback: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Key alias | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **show_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} show_info() + + + +Retrieves Certificate Signing Request information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import certificate_management_v_manage_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certificate_management_v_manage_api.CertificateManagementVManageApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.show_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling CertificateManagementVManageApi->show_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CertificateStates.md b/docs/CertificateStates.md new file mode 100644 index 0000000..cc0e183 --- /dev/null +++ b/docs/CertificateStates.md @@ -0,0 +1,13 @@ +# CertificateStates + +This is valid Certificate States + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certificate_types** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CertificateValidity.md b/docs/CertificateValidity.md new file mode 100644 index 0000000..eb2d5aa --- /dev/null +++ b/docs/CertificateValidity.md @@ -0,0 +1,13 @@ +# CertificateValidity + +This is Certificate Validity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certificate_validity** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ChannelPowerSettings.md b/docs/ChannelPowerSettings.md new file mode 100644 index 0000000..051785c --- /dev/null +++ b/docs/ChannelPowerSettings.md @@ -0,0 +1,13 @@ +# ChannelPowerSettings + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**radio_band2_dot4_ghz** | [**RadioBandSetting24G**](RadioBandSetting24G.md) | | [optional] +**radio_band5_ghz** | [**RadioBandSetting5G**](RadioBandSetting5G.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ClusterManagementApi.md b/docs/ClusterManagementApi.md new file mode 100644 index 0000000..e90bb51 --- /dev/null +++ b/docs/ClusterManagementApi.md @@ -0,0 +1,1418 @@ +# openapi_client.ClusterManagementApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_or_update_user_credentials**](ClusterManagementApi.md#add_or_update_user_credentials) | **POST** /clusterManagement/userCreds | +[**add_vmanage**](ClusterManagementApi.md#add_vmanage) | **POST** /clusterManagement/setup | +[**check_if_cluster_locked**](ClusterManagementApi.md#check_if_cluster_locked) | **GET** /clusterManagement/clusterLocked | +[**configure_vmanage**](ClusterManagementApi.md#configure_vmanage) | **POST** /clusterManagement/configure | +[**edit_vmanage**](ClusterManagementApi.md#edit_vmanage) | **PUT** /clusterManagement/setup | +[**get_cluster_workflow_version**](ClusterManagementApi.md#get_cluster_workflow_version) | **GET** /clusterManagement/clusterworkflow/version | +[**get_configured_ip_list**](ClusterManagementApi.md#get_configured_ip_list) | **GET** /clusterManagement/iplist/{vmanageID} | +[**get_connected_devices**](ClusterManagementApi.md#get_connected_devices) | **GET** /clusterManagement/connectedDevices/{vmanageIP} | +[**get_connected_devices_per_tenant**](ClusterManagementApi.md#get_connected_devices_per_tenant) | **GET** /clusterManagement/{tenantId}/connectedDevices/{vmanageIP} | +[**get_tenancy_mode**](ClusterManagementApi.md#get_tenancy_mode) | **GET** /clusterManagement/tenancy/mode | +[**get_tenants_list**](ClusterManagementApi.md#get_tenants_list) | **GET** /clusterManagement/tenantList | +[**get_v_manage_details**](ClusterManagementApi.md#get_v_manage_details) | **GET** /clusterManagement/vManage/details/{vmanageIP} | +[**health_details**](ClusterManagementApi.md#health_details) | **GET** /clusterManagement/health/details | +[**health_status_info**](ClusterManagementApi.md#health_status_info) | **GET** /clusterManagement/health/status | +[**health_summary**](ClusterManagementApi.md#health_summary) | **GET** /clusterManagement/health/summary | +[**is_cluster_ready**](ClusterManagementApi.md#is_cluster_ready) | **GET** /clusterManagement/isready | +[**list_vmanages**](ClusterManagementApi.md#list_vmanages) | **GET** /clusterManagement/list | +[**node_properties**](ClusterManagementApi.md#node_properties) | **GET** /clusterManagement/nodeProperties | +[**perform_replication_and_rebalance_of_kafka_partitions**](ClusterManagementApi.md#perform_replication_and_rebalance_of_kafka_partitions) | **PUT** /clusterManagement/replicateAndRebalance | +[**remove_vmanage**](ClusterManagementApi.md#remove_vmanage) | **POST** /clusterManagement/remove | +[**set_tenancy_mode**](ClusterManagementApi.md#set_tenancy_mode) | **POST** /clusterManagement/tenancy/mode | + + +# **add_or_update_user_credentials** +> add_or_update_user_credentials() + + + +Add or update user credentials for cluster operations


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User credential (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_or_update_user_credentials(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->add_or_update_user_credentials: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| User credential | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_vmanage** +> add_vmanage() + + + +Add vManage to cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vManage cluster config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_vmanage(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->add_vmanage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vManage cluster config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **check_if_cluster_locked** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} check_if_cluster_locked() + + + +Check whether cluster is locked


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.check_if_cluster_locked() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->check_if_cluster_locked: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **configure_vmanage** +> configure_vmanage() + + + +Configure vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vManage server config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.configure_vmanage(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->configure_vmanage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vManage server config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_vmanage** +> edit_vmanage() + + + +Update vManage cluster info


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vManage cluster config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_vmanage(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->edit_vmanage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vManage cluster config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cluster_workflow_version** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cluster_workflow_version() + + + +List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cluster_workflow_version() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_cluster_workflow_version: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_configured_ip_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_configured_ip_list(vmanage_id) + + + +Get configured IP addresses


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + vmanage_id = "vmanageID_example" # str | vManage Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_configured_ip_list(vmanage_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_configured_ip_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vmanage_id** | **str**| vManage Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_connected_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_connected_devices(vmanage_ip) + + + +Get connected device for vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + vmanage_ip = "vmanageIP_example" # str | vManage IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_connected_devices(vmanage_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_connected_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vmanage_ip** | **str**| vManage IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_connected_devices_per_tenant** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_connected_devices_per_tenant(tenant_id, vmanage_ip) + + + +Get connected device for vManage for a tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + vmanage_ip = "vmanageIP_example" # str | vManage IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_connected_devices_per_tenant(tenant_id, vmanage_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_connected_devices_per_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **vmanage_ip** | **str**| vManage IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenancy_mode** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tenancy_mode() + + + +Get vManage tenancy mode


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenancy_mode() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_tenancy_mode: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenants_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_tenants_list() + + + +Get tenant list


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenants_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_tenants_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_manage_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_v_manage_details(vmanage_ip) + + + +Get vManage detail


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + vmanage_ip = "vmanageIP_example" # str | vManage IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_v_manage_details(vmanage_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->get_v_manage_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vmanage_ip** | **str**| vManage IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **health_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} health_details() + + + +Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.health_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->health_details: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **health_status_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} health_status_info() + + + +Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.health_status_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->health_status_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **health_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} health_summary() + + + +Get cluster health check summary


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + is_cached = False # bool | Flag to enable cached result (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.health_summary(is_cached=is_cached) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->health_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_cached** | **bool**| Flag to enable cached result | [optional] if omitted the server will use the default value of False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **is_cluster_ready** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} is_cluster_ready() + + + +Is cluster ready


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.is_cluster_ready() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->is_cluster_ready: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_vmanages** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_vmanages() + + + +List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_vmanages() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->list_vmanages: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **node_properties** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} node_properties() + + + +Get properties of vManage being added to cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.node_properties() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->node_properties: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **perform_replication_and_rebalance_of_kafka_partitions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} perform_replication_and_rebalance_of_kafka_partitions() + + + +Initiate replication and rebalance of kafka topics


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.perform_replication_and_rebalance_of_kafka_partitions() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->perform_replication_and_rebalance_of_kafka_partitions: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_vmanage** +> remove_vmanage() + + + +Remove vManage from cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vManage server info (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.remove_vmanage(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->remove_vmanage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vManage server info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_tenancy_mode** +> set_tenancy_mode() + + + +Update vManage tenancy mode + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import cluster_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = cluster_management_api.ClusterManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenancy mode setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.set_tenancy_mode(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ClusterManagementApi->set_tenancy_mode: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenancy mode setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ColocationApi.md b/docs/ColocationApi.md new file mode 100644 index 0000000..1ebbe3f --- /dev/null +++ b/docs/ColocationApi.md @@ -0,0 +1,2451 @@ +# openapi_client.ColocationApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**acitvate_cloud_dock_cluster**](ColocationApi.md#acitvate_cloud_dock_cluster) | **POST** /colocation/cluster/activate | +[**attach_service_chain**](ColocationApi.md#attach_service_chain) | **POST** /colocation/servicechain/attach | +[**attach_service_chain1**](ColocationApi.md#attach_service_chain1) | **POST** /colocation/servicechain/autoattach | +[**cancel_button**](ColocationApi.md#cancel_button) | **POST** /colocation/servicechain/cancel | +[**cloud_dock_cluster_preview**](ColocationApi.md#cloud_dock_cluster_preview) | **GET** /colocation/cluster/config | +[**create_cloud_dock_cluster**](ColocationApi.md#create_cloud_dock_cluster) | **POST** /colocation/cluster | +[**de_acitvate_cloud_dock_cluster**](ColocationApi.md#de_acitvate_cloud_dock_cluster) | **POST** /colocation/cluster/deactivate | +[**delete_cloud_dock_cluster_by_name**](ColocationApi.md#delete_cloud_dock_cluster_by_name) | **DELETE** /colocation/cluster/{clustername} | +[**detach_service_chain**](ColocationApi.md#detach_service_chain) | **PUT** /colocation/servicechain/detach | +[**dummyccm**](ColocationApi.md#dummyccm) | **GET** /colocation/cluster/activateClusterDummy | +[**dummycsp_state**](ColocationApi.md#dummycsp_state) | **GET** /colocation/cluster/activateClusterDummyState | +[**get_cloud_dock_cluster_detail**](ColocationApi.md#get_cloud_dock_cluster_detail) | **GET** /colocation/cluster | +[**get_cloud_dock_cluster_detail_by_id**](ColocationApi.md#get_cloud_dock_cluster_detail_by_id) | **GET** /colocation/cluster/id | +[**get_cluster_config_by_cluster_id**](ColocationApi.md#get_cluster_config_by_cluster_id) | **GET** /colocation/monitor/cluster/config | +[**get_cluster_details_by_cluster_id**](ColocationApi.md#get_cluster_details_by_cluster_id) | **GET** /colocation/monitor/cluster | +[**get_cluster_port_mapping_by_cluster_id**](ColocationApi.md#get_cluster_port_mapping_by_cluster_id) | **GET** /colocation/monitor/cluster/portView | +[**get_device_detail_by_device_id**](ColocationApi.md#get_device_detail_by_device_id) | **GET** /colocation/monitor/device | +[**get_edge_devices**](ColocationApi.md#get_edge_devices) | **GET** /colocation/servicechain/edge/devices | +[**get_pnf_config**](ColocationApi.md#get_pnf_config) | **GET** /colocation/monitor/pnf/configuration | +[**get_service_chain_details**](ColocationApi.md#get_service_chain_details) | **GET** /colocation/monitor/servicechain | +[**get_service_group_by_cluster_id**](ColocationApi.md#get_service_group_by_cluster_id) | **GET** /colocation/monitor/servicegroup | +[**get_system_status_by_device_id**](ColocationApi.md#get_system_status_by_device_id) | **GET** /colocation/monitor/device/system | +[**get_vnf_alarm_count**](ColocationApi.md#get_vnf_alarm_count) | **GET** /colocation/monitor/vnf/alarms/count | +[**get_vnf_events_count_detail**](ColocationApi.md#get_vnf_events_count_detail) | **GET** /colocation/monitor/vnf/alarms | +[**get_vnf_events_detail**](ColocationApi.md#get_vnf_events_detail) | **GET** /colocation/monitor/vnf/events | +[**get_vnf_interface_detail**](ColocationApi.md#get_vnf_interface_detail) | **GET** /colocation/monitor/vnf/interface | +[**getpnf_details**](ColocationApi.md#getpnf_details) | **GET** /colocation/monitor/pnf | +[**getpnf_devices**](ColocationApi.md#getpnf_devices) | **GET** /colocation/servicechain/edge/pnfdevices | +[**getvnf_by_device_id**](ColocationApi.md#getvnf_by_device_id) | **GET** /colocation/monitor/device/vnf | +[**getvnf_details**](ColocationApi.md#getvnf_details) | **GET** /colocation/monitor/vnf | +[**list_network_function_map**](ColocationApi.md#list_network_function_map) | **GET** /colocation/monitor/networkfunction/listmap | +[**rma_cloud_dock_csp**](ColocationApi.md#rma_cloud_dock_csp) | **POST** /colocation/cluster/rma | +[**update_cloud_dock_cluster**](ColocationApi.md#update_cloud_dock_cluster) | **PUT** /colocation/cluster | +[**update_csp_to_cluster**](ColocationApi.md#update_csp_to_cluster) | **PUT** /colocation/cluster/attached/csp | +[**vnf_actions**](ColocationApi.md#vnf_actions) | **POST** /colocation/monitor/vnf/action | + + +# **acitvate_cloud_dock_cluster** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} acitvate_cloud_dock_cluster(cluster_name) + + + +Activate a cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_name = "clusterName_example" # str | Cluster name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.acitvate_cloud_dock_cluster(cluster_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->acitvate_cloud_dock_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_name** | **str**| Cluster name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **attach_service_chain** +> attach_service_chain() + + + +Attach service chain to cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Attach service chain request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.attach_service_chain(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->attach_service_chain: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Attach service chain request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **attach_service_chain1** +> attach_service_chain1() + + + +Attach service chain to cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Attach service chain request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.attach_service_chain1(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->attach_service_chain1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Attach service chain request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cancel_button** +> cancel_button() + + + +Cancel button to cancel configuring devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cancel configuring devices (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.cancel_button(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->cancel_button: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cancel configuring devices | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloud_dock_cluster_preview** +> str cloud_dock_cluster_preview(serial_number) + + + +Clouddock cluster preview + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + serial_number = "serialNumber_example" # str | Serial number + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.cloud_dock_cluster_preview(serial_number) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->cloud_dock_cluster_preview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **serial_number** | **str**| Serial number | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cloud_dock_cluster** +> create_cloud_dock_cluster() + + + +Add a new cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cluster config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_cloud_dock_cluster(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->create_cloud_dock_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cluster config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **de_acitvate_cloud_dock_cluster** +> de_acitvate_cloud_dock_cluster(cluster_id) + + + +Deactivate clouddock cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id + + # example passing only required values which don't have defaults set + try: + api_instance.de_acitvate_cloud_dock_cluster(cluster_id) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->de_acitvate_cloud_dock_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_cloud_dock_cluster_by_name** +> delete_cloud_dock_cluster_by_name(clustername) + + + +Delete cluster by name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + clustername = "clustername_example" # str | Cluster name + + # example passing only required values which don't have defaults set + try: + api_instance.delete_cloud_dock_cluster_by_name(clustername) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->delete_cloud_dock_cluster_by_name: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **clustername** | **str**| Cluster name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **detach_service_chain** +> detach_service_chain() + + + +Detach service chain + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Detach service chain request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.detach_service_chain(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->detach_service_chain: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Detach service chain request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **dummyccm** +> dummyccm(cluster_name) + + + +Activate dummp cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_name = "clusterName_example" # str | Cluster name + + # example passing only required values which don't have defaults set + try: + api_instance.dummyccm(cluster_name) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->dummyccm: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_name** | **str**| Cluster name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **dummycsp_state** +> dummycsp_state(cluster_name, state) + + + +Activate cluster in a state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_name = "clusterName_example" # str | Cluster name + state = "state_example" # str | Cluster state + + # example passing only required values which don't have defaults set + try: + api_instance.dummycsp_state(cluster_name, state) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->dummycsp_state: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_name** | **str**| Cluster name | + **state** | **str**| Cluster state | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_dock_cluster_detail** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_dock_cluster_detail(cluster_name) + + + +Get details of all existing Clusters + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_name = "clusterName_example" # str | Cluster name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_dock_cluster_detail(cluster_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_cloud_dock_cluster_detail: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_name** | **str**| Cluster name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_dock_cluster_detail_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_dock_cluster_detail_by_id(cluster_id) + + + +Get cluster by Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_dock_cluster_detail_by_id(cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_cloud_dock_cluster_detail_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cluster_config_by_cluster_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cluster_config_by_cluster_id(cluster_id) + + + +Provide details of devices of clusters + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cluster_config_by_cluster_id(cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_cluster_config_by_cluster_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cluster_details_by_cluster_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cluster_details_by_cluster_id(cluster_id) + + + +Provide details of ids of existing clusters + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cluster_details_by_cluster_id(cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_cluster_details_by_cluster_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cluster_port_mapping_by_cluster_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cluster_port_mapping_by_cluster_id(cluster_id) + + + +Provide details of port mappings in the cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cluster_port_mapping_by_cluster_id(cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_cluster_port_mapping_by_cluster_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_detail_by_device_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_detail_by_device_id() + + + +List details for Device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + device_id = "deviceId_example" # str | Device Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_detail_by_device_id(device_id=device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_device_detail_by_device_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_edge_devices() + + + +Get edge devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_edge_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_edge_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pnf_config** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_pnf_config() + + + +List configuration of PNF + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + pnf_serial_number = "pnfSerialNumber_example" # str | PNF serial number (optional) + cluster_id = "clusterId_example" # str | Cluster Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_pnf_config(pnf_serial_number=pnf_serial_number, cluster_id=cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_pnf_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pnf_serial_number** | **str**| PNF serial number | [optional] + **cluster_id** | **str**| Cluster Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_service_chain_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_service_chain_details() + + + +List all service chain or service chains by Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id (optional) + user_group_name = "userGroupName_example" # str | UserGroup Name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_service_chain_details(cluster_id=cluster_id, user_group_name=user_group_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_service_chain_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | [optional] + **user_group_name** | **str**| UserGroup Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_service_group_by_cluster_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_service_group_by_cluster_id() + + + +List all attached serviceGroups to cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_service_group_by_cluster_id(cluster_id=cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_service_group_by_cluster_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_system_status_by_device_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_system_status_by_device_id() + + + +List all connected VNF to a device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + device_id = "deviceId_example" # str | Device Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_system_status_by_device_id(device_id=device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_system_status_by_device_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnf_alarm_count** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vnf_alarm_count() + + + +Get event detail of VNF + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + user_group = "user_group_example" # str | user group name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vnf_alarm_count(user_group=user_group) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_vnf_alarm_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_group** | **str**| user group name | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnf_events_count_detail** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vnf_events_count_detail() + + + +Get event detail of VNF + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + user_group = "user_group_example" # str | user group name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vnf_events_count_detail(user_group=user_group) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_vnf_events_count_detail: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_group** | **str**| user group name | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnf_events_detail** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vnf_events_detail() + + + +Get event detail of VNF + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + vnf_name = "vnfName_example" # str | VNF name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vnf_events_detail(vnf_name=vnf_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_vnf_events_detail: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vnf_name** | **str**| VNF name | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnf_interface_detail** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vnf_interface_detail() + + + +Get interface detail of VNF + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + vnf_name = "vnfName_example" # str | VNF name (optional) + device_ip = "deviceIp_example" # str | Device IP (optional) + device_class = "deviceClass_example" # str | Device class (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vnf_interface_detail(vnf_name=vnf_name, device_ip=device_ip, device_class=device_class) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->get_vnf_interface_detail: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vnf_name** | **str**| VNF name | [optional] + **device_ip** | **str**| Device IP | [optional] + **device_class** | **str**| Device class | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getpnf_details** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] getpnf_details() + + + +List all PNF by cluster Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.getpnf_details(cluster_id=cluster_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->getpnf_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getpnf_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] getpnf_devices(pnf_device_type) + + + +Get PNF edge devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + pnf_device_type = "pnfDeviceType_example" # str | PNF device type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.getpnf_devices(pnf_device_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->getpnf_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pnf_device_type** | **str**| PNF device type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getvnf_by_device_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] getvnf_by_device_id() + + + +List all VNF attached with Device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + device_id = "deviceId_example" # str | Device Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.getvnf_by_device_id(device_id=device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->getvnf_by_device_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getvnf_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getvnf_details() + + + +Provide details of all existing VNF + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_id = "clusterId_example" # str | Cluster Id (optional) + user_group_name = "userGroupName_example" # str | UserGroup Name (optional) + vnf_name = "vnfName_example" # str | VNF Name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.getvnf_details(cluster_id=cluster_id, user_group_name=user_group_name, vnf_name=vnf_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->getvnf_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | [optional] + **user_group_name** | **str**| UserGroup Name | [optional] + **vnf_name** | **str**| VNF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_network_function_map** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_network_function_map() + + + +Retrieve network function listing + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_network_function_map() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->list_network_function_map: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rma_cloud_dock_csp** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} rma_cloud_dock_csp(cluster_name) + + + +RMA operation for CSP device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + cluster_name = "clusterName_example" # str | Cluster name + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.rma_cloud_dock_csp(cluster_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->rma_cloud_dock_csp: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.rma_cloud_dock_csp(cluster_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->rma_cloud_dock_csp: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_name** | **str**| Cluster name | + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_cloud_dock_cluster** +> update_cloud_dock_cluster() + + + +Update a existing cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cluster config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_cloud_dock_cluster(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->update_cloud_dock_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cluster config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_csp_to_cluster** +> update_csp_to_cluster() + + + +Update attached csp to cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSP config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_csp_to_cluster(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->update_csp_to_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSP config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **vnf_actions** +> vnf_actions() + + + +VNF action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_api.ColocationApi(api_client) + vm_name = "vmName_example" # str | VM Name (optional) + device_id = "deviceId_example" # str | Device Id (optional) + action = "action_example" # str | Action (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.vnf_actions(vm_name=vm_name, device_id=device_id, action=action) + except openapi_client.ApiException as e: + print("Exception when calling ColocationApi->vnf_actions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vm_name** | **str**| VM Name | [optional] + **device_id** | **str**| Device Id | [optional] + **action** | **str**| Action | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ColocationServiceGroupApi.md b/docs/ColocationServiceGroupApi.md new file mode 100644 index 0000000..2367801 --- /dev/null +++ b/docs/ColocationServiceGroupApi.md @@ -0,0 +1,485 @@ +# openapi_client.ColocationServiceGroupApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_service_group_cluster**](ColocationServiceGroupApi.md#create_service_group_cluster) | **POST** /colocation/servicegroup | +[**delete_service_group_cluster**](ColocationServiceGroupApi.md#delete_service_group_cluster) | **DELETE** /colocation/servicegroup/{name} | +[**get_available_chains**](ColocationServiceGroupApi.md#get_available_chains) | **GET** /colocation/servicegroup/servicechains | +[**get_default_chain**](ColocationServiceGroupApi.md#get_default_chain) | **GET** /colocation/servicegroup/servicechain/default | +[**get_service_chain**](ColocationServiceGroupApi.md#get_service_chain) | **GET** /colocation/servicegroup | +[**get_service_group_in_cluster**](ColocationServiceGroupApi.md#get_service_group_in_cluster) | **GET** /colocation/servicegroup/attached | +[**update_service_group_cluster**](ColocationServiceGroupApi.md#update_service_group_cluster) | **PUT** /colocation/servicegroup | + + +# **create_service_group_cluster** +> create_service_group_cluster() + + + +Add new service group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Service group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_service_group_cluster(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->create_service_group_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Service group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_service_group_cluster** +> delete_service_group_cluster(name) + + + +Delete service group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + name = "name_example" # str | Service group name + + # example passing only required values which don't have defaults set + try: + api_instance.delete_service_group_cluster(name) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->delete_service_group_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| Service group name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_available_chains** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_available_chains() + + + +Get all service chains + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_available_chains() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->get_available_chains: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_default_chain** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_default_chain() + + + +Get default service chains + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_default_chain() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->get_default_chain: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_service_chain** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_service_chain(service_group_name) + + + +Get service chain by name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + service_group_name = "serviceGroupName_example" # str | Service group name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_service_chain(service_group_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->get_service_chain: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_group_name** | **str**| Service group name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_service_group_in_cluster** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_service_group_in_cluster() + + + +Get service chains in cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + cluster_id = "ClusterId_example" # str | Cluster Id (optional) + user_group_name = "UserGroupName_example" # str | UserGroup Name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_service_group_in_cluster(cluster_id=cluster_id, user_group_name=user_group_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->get_service_group_in_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cluster_id** | **str**| Cluster Id | [optional] + **user_group_name** | **str**| UserGroup Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_service_group_cluster** +> update_service_group_cluster() + + + +Update service group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import colocation_service_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = colocation_service_group_api.ColocationServiceGroupApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Service group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_service_group_cluster(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ColocationServiceGroupApi->update_service_group_cluster: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Service group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigGroup.md b/docs/ConfigGroup.md new file mode 100644 index 0000000..beabff3 --- /dev/null +++ b/docs/ConfigGroup.md @@ -0,0 +1,26 @@ +# ConfigGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Config Group. Must be unique. | +**solution** | **str** | Specify one of the device platform solution | +**state** | **str** | Config Group Deployment state | +**version** | **int** | Config Group Version Flag | +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**description** | **str** | Description of the Config Group. | [optional] +**devices** | **[str]** | | [optional] +**id** | **str** | System generated unique identifier of the Config Group in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**number_of_devices** | **int** | | [optional] +**number_of_devices_up_to_date** | **int** | | [optional] +**profiles** | [**[FeatureProfile]**](FeatureProfile.md) | List of devices UUIDs associated with this config group | [optional] +**source** | **str** | Source of config-group | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md b/docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md new file mode 100644 index 0000000..3142064 --- /dev/null +++ b/docs/ConfigurationAdvancedInspectionProfileDefinitionApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationAdvancedInspectionProfileDefinitionApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#create_policy_definition10) | **POST** /template/policy/definition/advancedinspectionprofile | +[**delete_policy_definition10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#delete_policy_definition10) | **DELETE** /template/policy/definition/advancedinspectionprofile/{id} | +[**edit_multiple_policy_definition10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#edit_multiple_policy_definition10) | **PUT** /template/policy/definition/advancedinspectionprofile/multiple/{id} | +[**edit_policy_definition10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#edit_policy_definition10) | **PUT** /template/policy/definition/advancedinspectionprofile/{id} | +[**get_definitions10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#get_definitions10) | **GET** /template/policy/definition/advancedinspectionprofile | +[**get_policy_definition10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#get_policy_definition10) | **GET** /template/policy/definition/advancedinspectionprofile/{id} | +[**preview_policy_definition10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#preview_policy_definition10) | **POST** /template/policy/definition/advancedinspectionprofile/preview | +[**preview_policy_definition_by_id10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#preview_policy_definition_by_id10) | **GET** /template/policy/definition/advancedinspectionprofile/preview/{id} | +[**save_policy_definition_in_bulk10**](ConfigurationAdvancedInspectionProfileDefinitionApi.md#save_policy_definition_in_bulk10) | **PUT** /template/policy/definition/advancedinspectionprofile/bulk | + + +# **create_policy_definition10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition10() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->create_policy_definition10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition10** +> delete_policy_definition10(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition10(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->delete_policy_definition10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition10(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->edit_multiple_policy_definition10: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition10(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->edit_multiple_policy_definition10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition10(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->edit_policy_definition10: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition10(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->edit_policy_definition10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions10() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions10() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->get_definitions10: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition10(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->get_policy_definition10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition10() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->preview_policy_definition10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id10(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->preview_policy_definition_by_id10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk10() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_advanced_inspection_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_advanced_inspection_profile_definition_api.ConfigurationAdvancedInspectionProfileDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAdvancedInspectionProfileDefinitionApi->save_policy_definition_in_bulk10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationAzureConnectApi.md b/docs/ConfigurationAzureConnectApi.md new file mode 100644 index 0000000..225b1aa --- /dev/null +++ b/docs/ConfigurationAzureConnectApi.md @@ -0,0 +1,561 @@ +# openapi_client.ConfigurationAzureConnectApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**authenticate_azure_connect_cred_and_add**](ConfigurationAzureConnectApi.md#authenticate_azure_connect_cred_and_add) | **POST** /template/cortex/cloud/authenticate | +[**delete_wan_resource_groups**](ConfigurationAzureConnectApi.md#delete_wan_resource_groups) | **DELETE** /template/cortex/wanrg | +[**edit_wan_resource_groups**](ConfigurationAzureConnectApi.md#edit_wan_resource_groups) | **PUT** /template/cortex/wanrg | +[**get_cortex_status**](ConfigurationAzureConnectApi.md#get_cortex_status) | **GET** /template/cortex | +[**get_mapped_wan_resource_groups**](ConfigurationAzureConnectApi.md#get_mapped_wan_resource_groups) | **GET** /template/cortex/map | +[**get_wan_resource_groups**](ConfigurationAzureConnectApi.md#get_wan_resource_groups) | **GET** /template/cortex/wanrg | +[**save_wan_resource_groups**](ConfigurationAzureConnectApi.md#save_wan_resource_groups) | **POST** /template/cortex/wanrg | +[**sync_wan_resource_groups**](ConfigurationAzureConnectApi.md#sync_wan_resource_groups) | **POST** /template/cortex/sync | + + +# **authenticate_azure_connect_cred_and_add** +> authenticate_azure_connect_cred_and_add() + + + +Authenticate Cloud Account Credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Credential (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.authenticate_azure_connect_cred_and_add(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->authenticate_azure_connect_cred_and_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Credential | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_resource_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_wan_resource_groups() + + + +Delete WAN Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | WAN resource group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_wan_resource_groups(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->delete_wan_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| WAN resource group | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_resource_groups** +> edit_wan_resource_groups() + + + +Edit WAN Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | WAN resource group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_wan_resource_groups(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->edit_wan_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| WAN resource group | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cortex_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cortex_status() + + + +Get Cortex List + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cortex_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->get_cortex_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapped_wan_resource_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapped_wan_resource_groups(accountid, cloudregion) + + + +Get Mapped WAN Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudregion = "cloudregion_example" # str | Cloud region + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mapped_wan_resource_groups(accountid, cloudregion) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->get_mapped_wan_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudregion** | **str**| Cloud region | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_resource_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wan_resource_groups(accountid) + + + +Get WAN Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + accountid = "accountid_example" # str | Account Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_resource_groups(accountid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->get_wan_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_wan_resource_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_wan_resource_groups() + + + +Create WAN Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | WAN resource group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_wan_resource_groups(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->save_wan_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| WAN resource group | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_wan_resource_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sync_wan_resource_groups() + + + +Sync WAN Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_azure_connect_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_azure_connect_api.ConfigurationAzureConnectApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | WAN resource group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.sync_wan_resource_groups(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationAzureConnectApi->sync_wan_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| WAN resource group | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationCircuitsApi.md b/docs/ConfigurationCircuitsApi.md new file mode 100644 index 0000000..40cd734 --- /dev/null +++ b/docs/ConfigurationCircuitsApi.md @@ -0,0 +1,288 @@ +# openapi_client.ConfigurationCircuitsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_circuit**](ConfigurationCircuitsApi.md#create_circuit) | **POST** /networkdesign/circuit | +[**delete_circuit**](ConfigurationCircuitsApi.md#delete_circuit) | **DELETE** /networkdesign/circuit/{id} | +[**edit_circuit**](ConfigurationCircuitsApi.md#edit_circuit) | **PUT** /networkdesign/circuit/{id} | +[**get_circuits**](ConfigurationCircuitsApi.md#get_circuits) | **GET** /networkdesign/circuit | + + +# **create_circuit** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_circuit() + + + +Create network circuits + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_circuits_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_circuits_api.ConfigurationCircuitsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network circuit (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_circuit(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCircuitsApi->create_circuit: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network circuit | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_circuit** +> delete_circuit(id) + + + +Delete network circuits + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_circuits_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_circuits_api.ConfigurationCircuitsApi(api_client) + id = "id_example" # str | Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_circuit(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCircuitsApi->delete_circuit: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_circuit** +> edit_circuit(id) + + + +Edit network circuits + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_circuits_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_circuits_api.ConfigurationCircuitsApi(api_client) + id = "id_example" # str | Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network circuit (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_circuit(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCircuitsApi->edit_circuit: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_circuit(id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCircuitsApi->edit_circuit: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network circuit | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_circuits** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_circuits() + + + +Get network circuits + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_circuits_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_circuits_api.ConfigurationCircuitsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_circuits() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCircuitsApi->get_circuits: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationCloudExpressApi.md b/docs/ConfigurationCloudExpressApi.md new file mode 100644 index 0000000..3daf3c0 --- /dev/null +++ b/docs/ConfigurationCloudExpressApi.md @@ -0,0 +1,1168 @@ +# openapi_client.ConfigurationCloudExpressApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_apps**](ConfigurationCloudExpressApi.md#add_apps) | **POST** /template/cloudx/manage/apps | +[**add_cloudx_interfaces**](ConfigurationCloudExpressApi.md#add_cloudx_interfaces) | **POST** /template/cloudx/interfaces | +[**add_cloudx_type**](ConfigurationCloudExpressApi.md#add_cloudx_type) | **POST** /template/cloudx/addcloudx/{type} | +[**delete_webex_prefix_lists**](ConfigurationCloudExpressApi.md#delete_webex_prefix_lists) | **DELETE** /cloudservices/app/webex | +[**edit_apps**](ConfigurationCloudExpressApi.md#edit_apps) | **PUT** /template/cloudx/manage/apps | +[**enable_webex**](ConfigurationCloudExpressApi.md#enable_webex) | **POST** /cloudservices/app/webex | +[**enable_webex1**](ConfigurationCloudExpressApi.md#enable_webex1) | **PUT** /cloudservices/app/webex | +[**get_apps**](ConfigurationCloudExpressApi.md#get_apps) | **GET** /template/cloudx/manage/apps | +[**get_attached_client_list**](ConfigurationCloudExpressApi.md#get_attached_client_list) | **GET** /template/cloudx/attachedclient | +[**get_attached_dia_list**](ConfigurationCloudExpressApi.md#get_attached_dia_list) | **GET** /template/cloudx/attacheddia | +[**get_attached_gateway_list**](ConfigurationCloudExpressApi.md#get_attached_gateway_list) | **GET** /template/cloudx/attachedgateway | +[**get_cloud_x_available_apps**](ConfigurationCloudExpressApi.md#get_cloud_x_available_apps) | **GET** /template/cloudx/availableapps | +[**get_cloud_x_status**](ConfigurationCloudExpressApi.md#get_cloud_x_status) | **GET** /template/cloudx | +[**get_dia_list**](ConfigurationCloudExpressApi.md#get_dia_list) | **GET** /template/cloudx/dialist | +[**get_gateway_list**](ConfigurationCloudExpressApi.md#get_gateway_list) | **GET** /template/cloudx/gatewaylist | +[**get_site_list**](ConfigurationCloudExpressApi.md#get_site_list) | **GET** /template/cloudx/clientlist | +[**site_per_app**](ConfigurationCloudExpressApi.md#site_per_app) | **GET** /template/cloudx/status | + + +# **add_apps** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] add_apps() + + + +Add apps and vpns + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloudx apps and vpns (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_apps(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->add_apps: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloudx apps and vpns | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_cloudx_interfaces** +> add_cloudx_interfaces() + + + +Enable cloudx gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloudx (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_cloudx_interfaces(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->add_cloudx_interfaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloudx | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_cloudx_type** +> add_cloudx_type(type) + + + +Add cloudx gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + type = "type_example" # str | Cloudx type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloudx (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.add_cloudx_type(type) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->add_cloudx_type: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_cloudx_type(type, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->add_cloudx_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Cloudx type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloudx | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_webex_prefix_lists** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_webex_prefix_lists() + + + +deleteWebexPrefixLists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | TMP-Cloudx apps and vpns (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_webex_prefix_lists(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->delete_webex_prefix_lists: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| TMP-Cloudx apps and vpns | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_apps** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_apps() + + + +Edit apps and vpns + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloudx apps and vpns (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_apps(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->edit_apps: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloudx apps and vpns | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable_webex** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] enable_webex() + + + +Add Webex App + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloudx apps and vpns (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.enable_webex(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->enable_webex: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloudx apps and vpns | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable_webex1** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] enable_webex1() + + + +Day N- Update Webex App + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloudx apps and vpns (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.enable_webex1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->enable_webex1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloudx apps and vpns | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_apps** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_apps() + + + +Get apps and vpns + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_apps() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_apps: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_attached_client_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_attached_client_list() + + + +Get attached client site list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_attached_client_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_attached_client_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_attached_dia_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_attached_dia_list() + + + +Get attached Dia site list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_attached_dia_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_attached_dia_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_attached_gateway_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_attached_gateway_list() + + + +Get attached gateway list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_attached_gateway_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_attached_gateway_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_x_available_apps** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_x_available_apps() + + + +Get CloudX available apps list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_x_available_apps() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_cloud_x_available_apps: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_x_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_x_status() + + + +Get CloudX feature list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_x_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_cloud_x_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dia_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_dia_list() + + + +Get Dia site list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_dia_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_dia_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_gateway_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_gateway_list() + + + +Get gateway list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_gateway_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_gateway_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_site_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_site_list() + + + +Get site list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_site_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->get_site_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **site_per_app** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] site_per_app(app_name) + + + +Get sites per application per vpn + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_express_api.ConfigurationCloudExpressApi(api_client) + app_name = "appName_example" # str | App name + vpn_id = 1 # int | VPN Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.site_per_app(app_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->site_per_app: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.site_per_app(app_name, vpn_id=vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudExpressApi->site_per_app: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_name** | **str**| App name | + **vpn_id** | **int**| VPN Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationCloudOnRampApi.md b/docs/ConfigurationCloudOnRampApi.md new file mode 100644 index 0000000..a06563f --- /dev/null +++ b/docs/ConfigurationCloudOnRampApi.md @@ -0,0 +1,2228 @@ +# openapi_client.ConfigurationCloudOnRampApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**acquire_resource_pool**](ConfigurationCloudOnRampApi.md#acquire_resource_pool) | **POST** /template/cor/acquireResourcePool | +[**add_device_pair**](ConfigurationCloudOnRampApi.md#add_device_pair) | **POST** /template/cor/devicepair | +[**add_transit_vpc**](ConfigurationCloudOnRampApi.md#add_transit_vpc) | **POST** /template/cor/transitvpc | +[**authenticate_cloud_on_ramp_cred_and_add**](ConfigurationCloudOnRampApi.md#authenticate_cloud_on_ramp_cred_and_add) | **POST** /template/cor/cloud/authenticate | +[**authenticate_cred_and_update**](ConfigurationCloudOnRampApi.md#authenticate_cred_and_update) | **PUT** /template/cor/cloud/authenticate | +[**create_and_map**](ConfigurationCloudOnRampApi.md#create_and_map) | **POST** /template/cor | +[**create_resource_pool**](ConfigurationCloudOnRampApi.md#create_resource_pool) | **POST** /template/cor/createResourcePool | +[**get_ami_list**](ConfigurationCloudOnRampApi.md#get_ami_list) | **GET** /template/cor/ami | +[**get_cloud_accounts**](ConfigurationCloudOnRampApi.md#get_cloud_accounts) | **GET** /template/cor/cloud/account | +[**get_cloud_host_vpc_account_details**](ConfigurationCloudOnRampApi.md#get_cloud_host_vpc_account_details) | **GET** /template/cor/cloud/host/accountdetails | +[**get_cloud_host_vpcs**](ConfigurationCloudOnRampApi.md#get_cloud_host_vpcs) | **GET** /template/cor/hostvpc | +[**get_cloud_list**](ConfigurationCloudOnRampApi.md#get_cloud_list) | **GET** /template/cor/cloud | +[**get_cloud_mapped_host_accounts**](ConfigurationCloudOnRampApi.md#get_cloud_mapped_host_accounts) | **GET** /template/cor/cloud/mappedhostaccounts | +[**get_cloud_on_ramp_devices**](ConfigurationCloudOnRampApi.md#get_cloud_on_ramp_devices) | **GET** /template/cor/device | +[**get_cor_status**](ConfigurationCloudOnRampApi.md#get_cor_status) | **GET** /template/cor | +[**get_external_id**](ConfigurationCloudOnRampApi.md#get_external_id) | **GET** /template/cor/externalId | +[**get_host_vpcs**](ConfigurationCloudOnRampApi.md#get_host_vpcs) | **GET** /template/cor/devicepair/hostvpc | +[**get_mapped_vpcs**](ConfigurationCloudOnRampApi.md#get_mapped_vpcs) | **GET** /template/cor/map | +[**get_pem_key_list**](ConfigurationCloudOnRampApi.md#get_pem_key_list) | **GET** /template/cor/pem | +[**get_transit_device_pair_and_host_list**](ConfigurationCloudOnRampApi.md#get_transit_device_pair_and_host_list) | **GET** /template/cor/getTransitDevicePairAndHostList | +[**get_transit_vpc_supported_size**](ConfigurationCloudOnRampApi.md#get_transit_vpc_supported_size) | **GET** /template/cor/transitvpc/size | +[**get_transit_vpc_vpn_list**](ConfigurationCloudOnRampApi.md#get_transit_vpc_vpn_list) | **GET** /template/cor/getTransitVpnList | +[**get_transit_vpcs**](ConfigurationCloudOnRampApi.md#get_transit_vpcs) | **GET** /template/cor/transitvpc | +[**map_vpcs**](ConfigurationCloudOnRampApi.md#map_vpcs) | **POST** /template/cor/map | +[**remove_device_id**](ConfigurationCloudOnRampApi.md#remove_device_id) | **DELETE** /template/cor/deleteDevicepair | +[**remove_transit_vpc**](ConfigurationCloudOnRampApi.md#remove_transit_vpc) | **DELETE** /template/cor/accountid/{accountid} | +[**scale_down**](ConfigurationCloudOnRampApi.md#scale_down) | **POST** /template/cor/scale/down | +[**scale_up**](ConfigurationCloudOnRampApi.md#scale_up) | **POST** /template/cor/scale/up | +[**unmap_vpcs**](ConfigurationCloudOnRampApi.md#unmap_vpcs) | **DELETE** /template/cor/map | +[**update_transit_vpc**](ConfigurationCloudOnRampApi.md#update_transit_vpc) | **PUT** /template/cor/transitvpc | +[**update_transit_vpc_autoscale_properties**](ConfigurationCloudOnRampApi.md#update_transit_vpc_autoscale_properties) | **PUT** /template/cor/transitvpc/autoscale-properties | + + +# **acquire_resource_pool** +> acquire_resource_pool() + + + +Acquire IP from resource pool + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Add IP from resource pool request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.acquire_resource_pool(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->acquire_resource_pool: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Add IP from resource pool request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_device_pair** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} add_device_pair() + + + +Add device pair + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Add device pair request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_device_pair(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->add_device_pair: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Add device pair request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_transit_vpc** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} add_transit_vpc() + + + +Create transit VPC/VNet + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPC (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_transit_vpc(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->add_transit_vpc: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPC | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **authenticate_cloud_on_ramp_cred_and_add** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} authenticate_cloud_on_ramp_cred_and_add() + + + +Authenticate cloud account credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloud account credential (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.authenticate_cloud_on_ramp_cred_and_add(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->authenticate_cloud_on_ramp_cred_and_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloud account credential | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **authenticate_cred_and_update** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} authenticate_cred_and_update() + + + +Authenticate and update cloud account credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloud account credential (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.authenticate_cred_and_update(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->authenticate_cred_and_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloud account credential | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_and_map** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_and_map() + + + +Map Host to Transit VPC/VNet + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Map host to transit VPC request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_and_map(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->create_and_map: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Map host to transit VPC request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_resource_pool** +> create_resource_pool() + + + +Add resource pool + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Add resource pool request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_resource_pool(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->create_resource_pool: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Add resource pool request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ami_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_ami_list(accountid, cloudregion) + + + +Get AMI list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudregion = "cloudregion_example" # str | Cloud region + cloudtype = "AWS" # str | Cloud type (optional) if omitted the server will use the default value of "AWS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ami_list(accountid, cloudregion) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_ami_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_ami_list(accountid, cloudregion, cloudtype=cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_ami_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudregion** | **str**| Cloud region | + **cloudtype** | **str**| Cloud type | [optional] if omitted the server will use the default value of "AWS" + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_accounts** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_accounts(cloudtype, cloud_environment) + + + +Get cloud accounts + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + cloudtype = "cloudtype_example" # str | Cloud type + cloud_environment = "cloudEnvironment_example" # str | Cloud environment + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_accounts(cloudtype, cloud_environment) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_accounts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloudtype** | **str**| Cloud type | + **cloud_environment** | **str**| Cloud environment | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_host_vpc_account_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_host_vpc_account_details() + + + +Get cloud host VPC account details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_host_vpc_account_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_host_vpc_account_details: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_host_vpcs** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_host_vpcs(accountid, cloudregion) + + + +Get host VPC/VNet list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudregion = "cloudregion_example" # str | Cloud region + cloudtype = "AWS" # str | Cloud type (optional) if omitted the server will use the default value of "AWS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_host_vpcs(accountid, cloudregion) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_host_vpcs: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_host_vpcs(accountid, cloudregion, cloudtype=cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_host_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudregion** | **str**| Cloud region | + **cloudtype** | **str**| Cloud type | [optional] if omitted the server will use the default value of "AWS" + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_list() + + + +Get cloud list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_mapped_host_accounts** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_mapped_host_accounts(accountid, cloudtype) + + + +Get cloud mapped accounts view + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudtype = "cloudtype_example" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_mapped_host_accounts(accountid, cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_mapped_host_accounts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudtype** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_on_ramp_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_on_ramp_devices() + + + +Get available device list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_on_ramp_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cloud_on_ramp_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cor_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cor_status() + + + +Get Cloud On Ramp list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cor_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_cor_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_external_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_external_id() + + + +Get the vManage external ID for AWS + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_external_id() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_external_id: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_host_vpcs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_host_vpcs(transit_vpc_id, device_pair_id) + + + +Get host VPC details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + transit_vpc_id = "transitVpcId_example" # str | Transit VPC Id + device_pair_id = "devicePairId_example" # str | Device pair Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_host_vpcs(transit_vpc_id, device_pair_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_host_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transit_vpc_id** | **str**| Transit VPC Id | + **device_pair_id** | **str**| Device pair Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapped_vpcs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapped_vpcs(accountid, cloudregion) + + + +Get mapped VPC/VNet list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudregion = "cloudregion_example" # str | Cloud region + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mapped_vpcs(accountid, cloudregion) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_mapped_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudregion** | **str**| Cloud region | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pem_key_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_pem_key_list(accountid, cloudregion, cloudtype) + + + +Get transit VPC PEM key list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudregion = "cloudregion_example" # str | Cloud region + cloudtype = "cloudtype_example" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_pem_key_list(accountid, cloudregion, cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_pem_key_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudregion** | **str**| Cloud region | + **cloudtype** | **str**| Cloud type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transit_device_pair_and_host_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_transit_device_pair_and_host_list(account_id, cloud_region) + + + +Get device and host details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + account_id = "accountId_example" # str | Account Id + cloud_region = "cloudRegion_example" # str | Cloud region + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transit_device_pair_and_host_list(account_id, cloud_region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_transit_device_pair_and_host_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | + **cloud_region** | **str**| Cloud region | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transit_vpc_supported_size** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_transit_vpc_supported_size(cloud_environment) + + + +Get transit VPC supported size + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + cloud_environment = "cloudEnvironment_example" # str | Cloud environment + cloudtype = "AWS" # str | Cloud type (optional) if omitted the server will use the default value of "AWS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transit_vpc_supported_size(cloud_environment) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_transit_vpc_supported_size: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transit_vpc_supported_size(cloud_environment, cloudtype=cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_transit_vpc_supported_size: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_environment** | **str**| Cloud environment | + **cloudtype** | **str**| Cloud type | [optional] if omitted the server will use the default value of "AWS" + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transit_vpc_vpn_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_transit_vpc_vpn_list(account_id) + + + +Get transit VPN list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + account_id = "accountId_example" # str | Account Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transit_vpc_vpn_list(account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_transit_vpc_vpn_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transit_vpcs** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_transit_vpcs(accountid, cloudregion) + + + +Get transit VPC/VNet list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + cloudregion = "cloudregion_example" # str | Cloud region + cloudtype = "AWS" # str | Cloud type (optional) if omitted the server will use the default value of "AWS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transit_vpcs(accountid, cloudregion) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_transit_vpcs: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transit_vpcs(accountid, cloudregion, cloudtype=cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->get_transit_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **cloudregion** | **str**| Cloud region | + **cloudtype** | **str**| Cloud type | [optional] if omitted the server will use the default value of "AWS" + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **map_vpcs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} map_vpcs() + + + +Map host to transit VPC/VNet + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Map host to VPC/VNet (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.map_vpcs(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->map_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Map host to VPC/VNet | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_device_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} remove_device_id(accountid, transitvpcid, transitvpcname, cloudregion, device_pair_id) + + + +Remove device pair + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + transitvpcid = "transitvpcid_example" # str | VPC Id + transitvpcname = "transitvpcname_example" # str | VPC Name + cloudregion = "cloudregion_example" # str | Cloud region + device_pair_id = "devicePairId_example" # str | Device pair Id + cloudtype = "AWS" # str | Cloud type (optional) if omitted the server will use the default value of "AWS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.remove_device_id(accountid, transitvpcid, transitvpcname, cloudregion, device_pair_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->remove_device_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.remove_device_id(accountid, transitvpcid, transitvpcname, cloudregion, device_pair_id, cloudtype=cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->remove_device_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **transitvpcid** | **str**| VPC Id | + **transitvpcname** | **str**| VPC Name | + **cloudregion** | **str**| Cloud region | + **device_pair_id** | **str**| Device pair Id | + **cloudtype** | **str**| Cloud type | [optional] if omitted the server will use the default value of "AWS" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_transit_vpc** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} remove_transit_vpc(accountid, transitvpcid, cloudregion) + + + +Delete transit VPC/VNet + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + accountid = "accountid_example" # str | Account Id + transitvpcid = "transitvpcid_example" # str | Cloud VPC Id + cloudregion = "cloudregion_example" # str | Cloud region + cloudtype = "AWS" # str | Cloud type (optional) if omitted the server will use the default value of "AWS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.remove_transit_vpc(accountid, transitvpcid, cloudregion) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->remove_transit_vpc: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.remove_transit_vpc(accountid, transitvpcid, cloudregion, cloudtype=cloudtype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->remove_transit_vpc: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountid** | **str**| Account Id | + **transitvpcid** | **str**| Cloud VPC Id | + **cloudregion** | **str**| Cloud region | + **cloudtype** | **str**| Cloud type | [optional] if omitted the server will use the default value of "AWS" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **scale_down** +> scale_down() + + + +Scale down cloud on ramp + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update VPC (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.scale_down(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->scale_down: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update VPC | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **scale_up** +> scale_up() + + + +Scale up cloud on ramp + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update VPC (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.scale_up(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->scale_up: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update VPC | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unmap_vpcs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} unmap_vpcs() + + + +Unmap host from transit VPC/VNet + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Unmap host to VPC/VNet (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.unmap_vpcs(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->unmap_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Unmap host to VPC/VNet | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_transit_vpc** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_transit_vpc() + + + +Update transit VPC/VNet + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPC (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_transit_vpc(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->update_transit_vpc: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPC | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_transit_vpc_autoscale_properties** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_transit_vpc_autoscale_properties() + + + +Update transit VPC autoscale properties + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_cloud_on_ramp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_cloud_on_ramp_api.ConfigurationCloudOnRampApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPC (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_transit_vpc_autoscale_properties(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationCloudOnRampApi->update_transit_vpc_autoscale_properties: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPC | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationConfigurationGroupApi.md b/docs/ConfigurationConfigurationGroupApi.md new file mode 100644 index 0000000..1a2434d --- /dev/null +++ b/docs/ConfigurationConfigurationGroupApi.md @@ -0,0 +1,1128 @@ +# openapi_client.ConfigurationConfigurationGroupApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_config_group**](ConfigurationConfigurationGroupApi.md#create_config_group) | **POST** /v1/config-group | +[**create_config_group_association**](ConfigurationConfigurationGroupApi.md#create_config_group_association) | **POST** /v1/config-group/{configGroupId}/device/associate | +[**create_config_group_device_variables**](ConfigurationConfigurationGroupApi.md#create_config_group_device_variables) | **PUT** /v1/config-group/{configGroupId}/device/variables | +[**create_config_group_device_variables1**](ConfigurationConfigurationGroupApi.md#create_config_group_device_variables1) | **GET** /v1/config-group/{configGroupId}/device/variables/schema | +[**delete_config_group**](ConfigurationConfigurationGroupApi.md#delete_config_group) | **DELETE** /v1/config-group/{configGroupId} | +[**delete_config_group_association**](ConfigurationConfigurationGroupApi.md#delete_config_group_association) | **DELETE** /v1/config-group/{configGroupId}/device/associate | +[**deploy_config_group**](ConfigurationConfigurationGroupApi.md#deploy_config_group) | **POST** /v1/config-group/{configGroupId}/device/deploy | +[**edit_config_group**](ConfigurationConfigurationGroupApi.md#edit_config_group) | **PUT** /v1/config-group/{configGroupId} | +[**get_cedge_config_group_schema_by_schema_type**](ConfigurationConfigurationGroupApi.md#get_cedge_config_group_schema_by_schema_type) | **GET** /v1/config-group/schema/sdwan | +[**get_config_group**](ConfigurationConfigurationGroupApi.md#get_config_group) | **GET** /v1/config-group/{configGroupId} | +[**get_config_group_association**](ConfigurationConfigurationGroupApi.md#get_config_group_association) | **GET** /v1/config-group/{configGroupId}/device/associate | +[**get_config_group_by_solution**](ConfigurationConfigurationGroupApi.md#get_config_group_by_solution) | **GET** /v1/config-group | +[**get_config_group_device_configuration_preview**](ConfigurationConfigurationGroupApi.md#get_config_group_device_configuration_preview) | **POST** /v1/config-group/{configGroupId}/device/{deviceId}/preview | +[**get_config_group_device_variables**](ConfigurationConfigurationGroupApi.md#get_config_group_device_variables) | **GET** /v1/config-group/{configGroupId}/device/variables | +[**update_config_group_association**](ConfigurationConfigurationGroupApi.md#update_config_group_association) | **PUT** /v1/config-group/{configGroupId}/device/associate | + + +# **create_config_group** +> bool, date, datetime, dict, float, int, list, str, none_type create_config_group() + + + +Create a new Configuration Group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Config Group (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_config_group(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->create_config_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Config Group | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_config_group_association** +> create_config_group_association(config_group_id) + + + +Create associations with device and a config group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + body = None # bool, date, datetime, dict, float, int, list, str, none_type | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.create_config_group_association(config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->create_config_group_association: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_config_group_association(config_group_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->create_config_group_association: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_config_group_device_variables** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_config_group_device_variables(config_group_id) + + + +assign values to device variables + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | Config Group Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_config_group_device_variables(config_group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->create_config_group_device_variables: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_config_group_device_variables(config_group_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->create_config_group_device_variables: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| Config Group Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_config_group_device_variables1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_config_group_device_variables1(config_group_id) + + + +assign values to device variables + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | Config Group Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_config_group_device_variables1(config_group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->create_config_group_device_variables1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| Config Group Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_config_group** +> delete_config_group(config_group_id) + + + +Delete Config Group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.delete_config_group(config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->delete_config_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_config_group_association** +> delete_config_group_association(config_group_id) + + + +Delete Config Group Association from devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + body = None # bool, date, datetime, dict, float, int, list, str, none_type | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.delete_config_group_association(config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->delete_config_group_association: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_config_group_association(config_group_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->delete_config_group_association: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deploy_config_group** +> bool, date, datetime, dict, float, int, list, str, none_type deploy_config_group(config_group_id) + + + +deploy config group to devices


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | Config Group Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.deploy_config_group(config_group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->deploy_config_group: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.deploy_config_group(config_group_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->deploy_config_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| Config Group Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_config_group** +> bool, date, datetime, dict, float, int, list, str, none_type edit_config_group(config_group_id) + + + +Edit a Configuration Group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Config Group (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_config_group(config_group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->edit_config_group: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_config_group(config_group_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->edit_config_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Config Group | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cedge_config_group_schema_by_schema_type** +> str get_cedge_config_group_schema_by_schema_type() + + + +Get a Cedge famiy Configuration Group Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + schema_type = "post" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cedge_config_group_schema_by_schema_type(schema_type=schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_cedge_config_group_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_group** +> ConfigGroup get_config_group(config_group_id) + + + +Get a Configuration Group by ID + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from openapi_client.model.config_group import ConfigGroup +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_config_group(config_group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + +### Return type + +[**ConfigGroup**](ConfigGroup.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_group_association** +> get_config_group_association(config_group_id) + + + +Get devices association with a config group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.get_config_group_association(config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group_association: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_group_by_solution** +> str get_config_group_by_solution() + + + +Get a Configuration Group by Solution + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + solution = "solution_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_config_group_by_solution(solution=solution) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group_by_solution: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **solution** | **str**| | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_group_device_configuration_preview** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_config_group_device_configuration_preview(config_group_id, device_id) + + + +Get a preview of the configuration for a device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | Config Group Id + device_id = "deviceId_example" # str | Device Id + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_config_group_device_configuration_preview(config_group_id, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group_device_configuration_preview: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_config_group_device_configuration_preview(config_group_id, device_id, get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group_device_configuration_preview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| Config Group Id | + **device_id** | **str**| Device Id | + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_group_device_variables** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_config_group_device_variables(config_group_id) + + + +Get device variables + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | Config Group Id + device_id = "device-id_example" # str | Comma separated device id's like d1,d2 (optional) + suggestions = True # bool | Suggestions for possible values (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_config_group_device_variables(config_group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group_device_variables: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_config_group_device_variables(config_group_id, device_id=device_id, suggestions=suggestions) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->get_config_group_device_variables: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| Config Group Id | + **device_id** | **str**| Comma separated device id's like d1,d2 | [optional] + **suggestions** | **bool**| Suggestions for possible values | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_config_group_association** +> update_config_group_association(config_group_id) + + + +Move the devices from one config group to another + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_configuration_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_configuration_group_api.ConfigurationConfigurationGroupApi(api_client) + config_group_id = "configGroupId_example" # str | + body = None # bool, date, datetime, dict, float, int, list, str, none_type | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_config_group_association(config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->update_config_group_association: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_config_group_association(config_group_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationConfigurationGroupApi->update_config_group_association: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDashboardStatusApi.md b/docs/ConfigurationDashboardStatusApi.md new file mode 100644 index 0000000..b04ca4a --- /dev/null +++ b/docs/ConfigurationDashboardStatusApi.md @@ -0,0 +1,546 @@ +# openapi_client.ConfigurationDashboardStatusApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel_pending_tasks**](ConfigurationDashboardStatusApi.md#cancel_pending_tasks) | **POST** /device/action/status/cancel/{processId} | +[**clean_status**](ConfigurationDashboardStatusApi.md#clean_status) | **GET** /device/action/status/clean | +[**delete_status**](ConfigurationDashboardStatusApi.md#delete_status) | **DELETE** /device/action/status/clear | +[**find_running_tasks**](ConfigurationDashboardStatusApi.md#find_running_tasks) | **GET** /device/action/status/tasks | +[**find_status**](ConfigurationDashboardStatusApi.md#find_status) | **GET** /device/action/status/{actionName} | +[**get_active_task_count**](ConfigurationDashboardStatusApi.md#get_active_task_count) | **GET** /device/action/status/tasks/activeCount | +[**get_clean_status**](ConfigurationDashboardStatusApi.md#get_clean_status) | **GET** /device/action/status/tasks/clean | +[**update_device_action_status**](ConfigurationDashboardStatusApi.md#update_device_action_status) | **PUT** /device/action/status | + + +# **cancel_pending_tasks** +> cancel_pending_tasks(process_id) + + + +Bulk cancel task status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + process_id = "processId_example" # str | Process Id + + # example passing only required values which don't have defaults set + try: + api_instance.cancel_pending_tasks(process_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->cancel_pending_tasks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_id** | **str**| Process Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **clean_status** +> clean_status(clean_status) + + + +Delete task and status vertex + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + clean_status = True # bool | Clear status flag + + # example passing only required values which don't have defaults set + try: + api_instance.clean_status(clean_status) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->clean_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **clean_status** | **bool**| Clear status flag | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_status** +> delete_status(process_id) + + + +Delete status of action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + process_id = "processId_example" # str | Process Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_status(process_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->delete_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_id** | **str**| Process Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_running_tasks** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_running_tasks() + + + +Find running tasks + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_running_tasks() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->find_running_tasks: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_status(action_name) + + + +Find status of action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + action_name = "push_feature_template_configuration-01232017T154359940" # str | Action name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.find_status(action_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->find_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **action_name** | **str**| Action name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_active_task_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_active_task_count() + + + +Get active task count + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_active_task_count() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->get_active_task_count: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_clean_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_clean_status(process_id) + + + +Delete task and status vertex + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + process_id = "processId_example" # str | Process Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_clean_status(process_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->get_clean_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_id** | **str**| Process Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_device_action_status** +> update_device_action_status() + + + +Update device action status. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_dashboard_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_dashboard_status_api.ConfigurationDashboardStatusApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update device action status (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_device_action_status(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDashboardStatusApi->update_device_action_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update device action status | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceActionsApi.md b/docs/ConfigurationDeviceActionsApi.md new file mode 100644 index 0000000..8210c15 --- /dev/null +++ b/docs/ConfigurationDeviceActionsApi.md @@ -0,0 +1,2800 @@ +# openapi_client.ConfigurationDeviceActionsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_filter_vpn_list**](ConfigurationDeviceActionsApi.md#create_filter_vpn_list) | **GET** /device/action/filter/vpn | +[**create_unique_vpn_list**](ConfigurationDeviceActionsApi.md#create_unique_vpn_list) | **POST** /device/action/uniquevpnlist | +[**create_vpn_list**](ConfigurationDeviceActionsApi.md#create_vpn_list) | **GET** /device/action/vpn | +[**generate_change_partition_info**](ConfigurationDeviceActionsApi.md#generate_change_partition_info) | **GET** /device/action/changepartition | +[**generate_deactivate_info**](ConfigurationDeviceActionsApi.md#generate_deactivate_info) | **GET** /device/action/deactivate | +[**generate_device_action_list**](ConfigurationDeviceActionsApi.md#generate_device_action_list) | **GET** /device/action/list | +[**generate_device_list**](ConfigurationDeviceActionsApi.md#generate_device_list) | **GET** /device/action/install/devices/{deviceType} | +[**generate_install_info**](ConfigurationDeviceActionsApi.md#generate_install_info) | **GET** /device/action/install | +[**generate_reboot_device_list**](ConfigurationDeviceActionsApi.md#generate_reboot_device_list) | **GET** /device/action/reboot/devices/{deviceType} | +[**generate_reboot_info**](ConfigurationDeviceActionsApi.md#generate_reboot_info) | **GET** /device/action/reboot | +[**generate_rediscover_info**](ConfigurationDeviceActionsApi.md#generate_rediscover_info) | **GET** /device/action/rediscover | +[**generate_remove_partition_info**](ConfigurationDeviceActionsApi.md#generate_remove_partition_info) | **GET** /device/action/removepartition | +[**generate_security_devices_list**](ConfigurationDeviceActionsApi.md#generate_security_devices_list) | **GET** /device/action/security/devices/{policyType} | +[**get_ztp_upgrade_config**](ConfigurationDeviceActionsApi.md#get_ztp_upgrade_config) | **GET** /device/action/ztp/upgrade | +[**get_ztp_upgrade_config_setting**](ConfigurationDeviceActionsApi.md#get_ztp_upgrade_config_setting) | **GET** /device/action/ztp/upgrade/setting | +[**initiate_image_download**](ConfigurationDeviceActionsApi.md#initiate_image_download) | **POST** /device/action/image-download | +[**process_amp_api_re_key**](ConfigurationDeviceActionsApi.md#process_amp_api_re_key) | **POST** /device/action/security/amp/rekey | +[**process_cancel_task**](ConfigurationDeviceActionsApi.md#process_cancel_task) | **POST** /device/action/cancel | +[**process_change_partition**](ConfigurationDeviceActionsApi.md#process_change_partition) | **POST** /device/action/changepartition | +[**process_deactivate_smu**](ConfigurationDeviceActionsApi.md#process_deactivate_smu) | **POST** /device/action/deactivate | +[**process_default_partition**](ConfigurationDeviceActionsApi.md#process_default_partition) | **POST** /device/action/defaultpartition | +[**process_delete_amp_api_key**](ConfigurationDeviceActionsApi.md#process_delete_amp_api_key) | **DELETE** /device/action/security/amp/apikey/{uuid} | +[**process_install**](ConfigurationDeviceActionsApi.md#process_install) | **POST** /device/action/install | +[**process_lxc_activate**](ConfigurationDeviceActionsApi.md#process_lxc_activate) | **POST** /device/action/lxcactivate | +[**process_lxc_delete**](ConfigurationDeviceActionsApi.md#process_lxc_delete) | **POST** /device/action/lxcdelete | +[**process_lxc_install**](ConfigurationDeviceActionsApi.md#process_lxc_install) | **POST** /device/action/lxcinstall | +[**process_lxc_reload**](ConfigurationDeviceActionsApi.md#process_lxc_reload) | **POST** /device/action/lxcreload | +[**process_lxc_reset**](ConfigurationDeviceActionsApi.md#process_lxc_reset) | **POST** /device/action/lxcreset | +[**process_lxc_upgrade**](ConfigurationDeviceActionsApi.md#process_lxc_upgrade) | **POST** /device/action/lxcupgrade | +[**process_reboot**](ConfigurationDeviceActionsApi.md#process_reboot) | **POST** /device/action/reboot | +[**process_remove_partition**](ConfigurationDeviceActionsApi.md#process_remove_partition) | **POST** /device/action/removepartition | +[**process_remove_software_image**](ConfigurationDeviceActionsApi.md#process_remove_software_image) | **POST** /device/action/image-remove | +[**process_vnf_install**](ConfigurationDeviceActionsApi.md#process_vnf_install) | **POST** /device/action/vnfinstall | +[**process_ztp_upgrade_config**](ConfigurationDeviceActionsApi.md#process_ztp_upgrade_config) | **POST** /device/action/ztp/upgrade | +[**process_ztp_upgrade_config_setting**](ConfigurationDeviceActionsApi.md#process_ztp_upgrade_config_setting) | **POST** /device/action/ztp/upgrade/setting | +[**re_discover_all_device**](ConfigurationDeviceActionsApi.md#re_discover_all_device) | **POST** /device/action/rediscoverall | +[**re_discover_devices**](ConfigurationDeviceActionsApi.md#re_discover_devices) | **POST** /device/action/rediscover | +[**test_api_key**](ConfigurationDeviceActionsApi.md#test_api_key) | **GET** /device/action/security/apikey/{uuid} | +[**test_iox_config**](ConfigurationDeviceActionsApi.md#test_iox_config) | **GET** /device/action/test/ioxconfig/{deviceIP} | +[**trigger_pending_tasks_monitoring**](ConfigurationDeviceActionsApi.md#trigger_pending_tasks_monitoring) | **GET** /device/action/startmonitor | + + +# **create_filter_vpn_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_filter_vpn_list() + + + +Get filter VPN list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_filter_vpn_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->create_filter_vpn_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_unique_vpn_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_unique_vpn_list() + + + +Create unique VPN list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device IPs (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_unique_vpn_list(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->create_unique_vpn_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device IPs | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_vpn_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_vpn_list() + + + +Create VPN list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_vpn_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->create_vpn_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_change_partition_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_change_partition_info(device_id) + + + +Get change partition information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_id = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_change_partition_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_change_partition_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | [**[DeviceIP]**](DeviceIP.md)| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_deactivate_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_deactivate_info(device_id) + + + +Get deactivate partition information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_id = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_deactivate_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_deactivate_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | [**[DeviceIP]**](DeviceIP.md)| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_device_action_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_device_action_list() + + + +Get device action list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_device_action_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_device_action_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_device_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_device_list(device_type, group_id) + + + +Get list of installed devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.group_id import GroupId +from openapi_client.model.device_type import DeviceType +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_type = DeviceType( + device_type="device_type_example", + ) # DeviceType | Device type + group_id = GroupId( + group_id="group_id_example", + ) # GroupId | Group Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_device_list(device_type, group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_device_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_type** | **DeviceType**| Device type | + **group_id** | **GroupId**| Group Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_install_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_install_info(device_id) + + + +Generate install info + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_id = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_install_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_install_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | [**[DeviceIP]**](DeviceIP.md)| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_reboot_device_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_reboot_device_list(device_type, device_id) + + + +Get list of rebooted devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.group_id import GroupId +from openapi_client.model.device_type import DeviceType +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_type = DeviceType( + device_type="device_type_example", + ) # DeviceType | Device type + device_id = GroupId( + group_id="group_id_example", + ) # GroupId | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_reboot_device_list(device_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_reboot_device_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_type** | **DeviceType**| Device type | + **device_id** | **GroupId**| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_reboot_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_reboot_info(device_id) + + + +Get device reboot information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_id = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_reboot_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_reboot_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | [**[DeviceIP]**](DeviceIP.md)| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_rediscover_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_rediscover_info() + + + +Get rediscover operation information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_rediscover_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_rediscover_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_remove_partition_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_remove_partition_info(device_id) + + + +Get remove partition information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_remove_partition_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_remove_partition_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_security_devices_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_security_devices_list(policy_type, group_id) + + + +Get list of devices by security policy type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.group_id import GroupId +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + policy_type = "zoneBasedFW" # str | Policy type + group_id = GroupId( + group_id="group_id_example", + ) # GroupId | Group Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_security_devices_list(policy_type, group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->generate_security_devices_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_type** | **str**| Policy type | + **group_id** | **GroupId**| Group Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ztp_upgrade_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ztp_upgrade_config() + + + +Get ZTP upgrade configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_ztp_upgrade_config() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->get_ztp_upgrade_config: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ztp_upgrade_config_setting** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ztp_upgrade_config_setting() + + + +Get ZTP upgrade configuration setting + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_ztp_upgrade_config_setting() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->get_ztp_upgrade_config_setting: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **initiate_image_download** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} initiate_image_download() + + + +Intitate image download on the given device. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Image download request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.initiate_image_download(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->initiate_image_download: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Image download request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_amp_api_re_key** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_amp_api_re_key() + + + +Process amp api re-key operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | AMP API re-key request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_amp_api_re_key(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_amp_api_re_key: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| AMP API re-key request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_cancel_task** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_cancel_task() + + + +Cancel tasks + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cancel task payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_cancel_task(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_cancel_task: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cancel task payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_change_partition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_change_partition() + + + +Process change partition operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device change partition request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_change_partition(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_change_partition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device change partition request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_deactivate_smu** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_deactivate_smu() + + + +Process deactivate operation for smu image + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device smu image deactivate request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_deactivate_smu(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_deactivate_smu: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device smu image deactivate request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_default_partition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_default_partition() + + + +Process marking default partition operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Marking default partition request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_default_partition(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_default_partition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Marking default partition request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_delete_amp_api_key** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_delete_amp_api_key(uuid) + + + +Process amp api key deletion operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + uuid = "uuid_example" # str | Uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.process_delete_amp_api_key(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_delete_amp_api_key: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_install** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_install() + + + +Process an installation operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Installation payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_install(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_install: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Installation payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_lxc_activate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_lxc_activate() + + + +Process an activation operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Activation request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_lxc_activate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_lxc_activate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Activation request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_lxc_delete** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_lxc_delete() + + + +Process a delete operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Delete request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_lxc_delete(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_lxc_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Delete request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_lxc_install** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_lxc_install() + + + +Process an installation operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Installation request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_lxc_install(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_lxc_install: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Installation request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_lxc_reload** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_lxc_reload() + + + +Process a reload operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Reload request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_lxc_reload(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_lxc_reload: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Reload request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_lxc_reset** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_lxc_reset() + + + +Process a reset operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Reset request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_lxc_reset(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_lxc_reset: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Reset request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_lxc_upgrade** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_lxc_upgrade() + + + +Process an upgrade operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Upgrade request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_lxc_upgrade(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_lxc_upgrade: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Upgrade request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_reboot** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_reboot() + + + +Process a reboot operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device reboot request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_reboot(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_reboot: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device reboot request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_remove_partition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_remove_partition() + + + +Process remove partition operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device remove partition request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_remove_partition(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_remove_partition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device remove partition request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_remove_software_image** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_remove_software_image() + + + +Process remove software image operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device remove software image request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_remove_software_image(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_remove_software_image: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device remove software image request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_vnf_install** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_vnf_install() + + + +Process an installation operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Installation request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_vnf_install(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_vnf_install: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Installation request payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_ztp_upgrade_config** +> process_ztp_upgrade_config() + + + +Process ZTP upgrade configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | ZTP upgrade config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_ztp_upgrade_config(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_ztp_upgrade_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| ZTP upgrade config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_ztp_upgrade_config_setting** +> process_ztp_upgrade_config_setting() + + + +Process ZTP upgrade configuration setting + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | ZTP upgrade setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_ztp_upgrade_config_setting(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->process_ztp_upgrade_config_setting: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| ZTP upgrade setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **re_discover_all_device** +> re_discover_all_device() + + + +Rediscover all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Rediscover device request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.re_discover_all_device(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->re_discover_all_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Rediscover device request payload | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **re_discover_devices** +> re_discover_devices() + + + +Rediscover device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Rediscover device request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.re_discover_devices(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->re_discover_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Rediscover device request payload | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **test_api_key** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} test_api_key(uuid) + + + +Get API key from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.test_api_key(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->test_api_key: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **test_iox_config** +> test_iox_config(device_ip) + + + +testIoxConfig + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + device_ip = DeviceIP( + device_ip="device_ip_example", + ) # DeviceIP | Device IP + + # example passing only required values which don't have defaults set + try: + api_instance.test_iox_config(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->test_iox_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **DeviceIP**| Device IP | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trigger_pending_tasks_monitoring** +> trigger_pending_tasks_monitoring() + + + +Triggers global monitoring thread + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_actions_api.ConfigurationDeviceActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.trigger_pending_tasks_monitoring() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceActionsApi->trigger_pending_tasks_monitoring: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceConfigHistoryApi.md b/docs/ConfigurationDeviceConfigHistoryApi.md new file mode 100644 index 0000000..b7d99fc --- /dev/null +++ b/docs/ConfigurationDeviceConfigHistoryApi.md @@ -0,0 +1,1072 @@ +# openapi_client.ConfigurationDeviceConfigHistoryApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query20**](ConfigurationDeviceConfigHistoryApi.md#get_aggregation_data_by_query20) | **GET** /device/history/aggregation | +[**get_config_diff**](ConfigurationDeviceConfigHistoryApi.md#get_config_diff) | **GET** /device/history/config/diff/list | +[**get_count22**](ConfigurationDeviceConfigHistoryApi.md#get_count22) | **GET** /device/history/doccount | +[**get_count_post22**](ConfigurationDeviceConfigHistoryApi.md#get_count_post22) | **POST** /device/history/doccount | +[**get_device_config**](ConfigurationDeviceConfigHistoryApi.md#get_device_config) | **GET** /device/history/config/{config_id} | +[**get_last_thousand_config_list**](ConfigurationDeviceConfigHistoryApi.md#get_last_thousand_config_list) | **GET** /device/history/config | +[**get_post_aggregation_app_data_by_query19**](ConfigurationDeviceConfigHistoryApi.md#get_post_aggregation_app_data_by_query19) | **POST** /device/history/app-agg/aggregation | +[**get_post_aggregation_data_by_query19**](ConfigurationDeviceConfigHistoryApi.md#get_post_aggregation_data_by_query19) | **POST** /device/history/aggregation | +[**get_post_stat_bulk_raw_data20**](ConfigurationDeviceConfigHistoryApi.md#get_post_stat_bulk_raw_data20) | **POST** /device/history/page | +[**get_stat_bulk_raw_data20**](ConfigurationDeviceConfigHistoryApi.md#get_stat_bulk_raw_data20) | **GET** /device/history/page | +[**get_stat_data_fields22**](ConfigurationDeviceConfigHistoryApi.md#get_stat_data_fields22) | **GET** /device/history/fields | +[**get_stat_data_raw_data19**](ConfigurationDeviceConfigHistoryApi.md#get_stat_data_raw_data19) | **GET** /device/history | +[**get_stat_data_raw_data_as_csv20**](ConfigurationDeviceConfigHistoryApi.md#get_stat_data_raw_data_as_csv20) | **GET** /device/history/csv | +[**get_stat_query_fields22**](ConfigurationDeviceConfigHistoryApi.md#get_stat_query_fields22) | **GET** /device/history/query/fields | +[**get_stats_raw_data20**](ConfigurationDeviceConfigHistoryApi.md#get_stats_raw_data20) | **POST** /device/history | + + +# **get_aggregation_data_by_query20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query20() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query20(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_aggregation_data_by_query20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_diff** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_config_diff(config_id1, config_id2) + + + +Get diff of two configs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + config_id1 = "config_id1_example" # str | Config Id one + config_id2 = "config_id2_example" # str | Config Id two + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_config_diff(config_id1, config_id2) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_config_diff: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_id1** | **str**| Config Id one | + **config_id2** | **str**| Config Id two | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count22(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count22(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_count22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post22() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_count_post22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_config(config_id) + + + +Get device config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + config_id = "config_id_example" # str | Config Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_config(config_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_device_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_id** | **str**| Config Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_last_thousand_config_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_last_thousand_config_list(device_id, query) + + + +Get device config history + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + device_id = "deviceId_example" # str | Device Id + query = "query_example" # str | Query filter + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_last_thousand_config_list(device_id, query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_last_thousand_config_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + **query** | **str**| Query filter | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query19() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_post_aggregation_app_data_by_query19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query19() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_post_aggregation_data_by_query19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data20() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data20(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_post_stat_bulk_raw_data20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data20() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data20(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_stat_bulk_raw_data20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields22() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields22() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_stat_data_fields22: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data19() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data19(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_stat_data_raw_data19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv20** +> str get_stat_data_raw_data_as_csv20() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv20(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_stat_data_raw_data_as_csv20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields22() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields22() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_stat_query_fields22: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data20() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_config_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_config_history_api.ConfigurationDeviceConfigHistoryApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data20(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConfigHistoryApi->get_stats_raw_data20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceConnectivityApi.md b/docs/ConfigurationDeviceConnectivityApi.md new file mode 100644 index 0000000..4de8904 --- /dev/null +++ b/docs/ConfigurationDeviceConnectivityApi.md @@ -0,0 +1,148 @@ +# openapi_client.ConfigurationDeviceConnectivityApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**invalidate_device**](ConfigurationDeviceConnectivityApi.md#invalidate_device) | **POST** /certificate/device/invalidate | +[**stage_device**](ConfigurationDeviceConnectivityApi.md#stage_device) | **POST** /certificate/device/stage | + + +# **invalidate_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} invalidate_device() + + + +invalidate the device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_connectivity_api.ConfigurationDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vEdge device info (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.invalidate_device(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConnectivityApi->invalidate_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vEdge device info | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stage_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} stage_device() + + + +Stop data traffic to device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_connectivity_api.ConfigurationDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | vEdge device info (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.stage_device(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceConnectivityApi->stage_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| vEdge device info | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceFirmwareUpdateApi.md b/docs/ConfigurationDeviceFirmwareUpdateApi.md new file mode 100644 index 0000000..c3b09b6 --- /dev/null +++ b/docs/ConfigurationDeviceFirmwareUpdateApi.md @@ -0,0 +1,543 @@ +# openapi_client.ConfigurationDeviceFirmwareUpdateApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activate_firmware_image**](ConfigurationDeviceFirmwareUpdateApi.md#activate_firmware_image) | **POST** /device/action/firmware/activate | +[**delete_firmware_image**](ConfigurationDeviceFirmwareUpdateApi.md#delete_firmware_image) | **DELETE** /device/action/firmware/{versionId} | +[**get_devices_fw_upgrade**](ConfigurationDeviceFirmwareUpdateApi.md#get_devices_fw_upgrade) | **GET** /device/action/firmware/devices | +[**get_firmware_image_details**](ConfigurationDeviceFirmwareUpdateApi.md#get_firmware_image_details) | **GET** /device/action/firmware/{versionId} | +[**get_firmware_images**](ConfigurationDeviceFirmwareUpdateApi.md#get_firmware_images) | **GET** /device/action/firmware | +[**install_firmware_image**](ConfigurationDeviceFirmwareUpdateApi.md#install_firmware_image) | **POST** /device/action/firmware/install | +[**process_firmware_image**](ConfigurationDeviceFirmwareUpdateApi.md#process_firmware_image) | **POST** /device/action/firmware | +[**remove_firmware_image**](ConfigurationDeviceFirmwareUpdateApi.md#remove_firmware_image) | **POST** /device/action/firmware/remove | + + +# **activate_firmware_image** +> activate_firmware_image() + + + +Activate firmware on device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.activate_firmware_image(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->activate_firmware_image: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_firmware_image** +> delete_firmware_image(version_id) + + + +Delete firmware image package + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + version_id = "versionId_example" # str | Firmware image version + + # example passing only required values which don't have defaults set + try: + api_instance.delete_firmware_image(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->delete_firmware_image: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Firmware image version | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_fw_upgrade** +> get_devices_fw_upgrade() + + + +Get list of devices that support firmware upgrade + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_devices_fw_upgrade() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->get_devices_fw_upgrade: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_firmware_image_details** +> get_firmware_image_details(version_id) + + + +Get firmware image details for a given version + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + version_id = "versionId_example" # str | Firmware image version + + # example passing only required values which don't have defaults set + try: + api_instance.get_firmware_image_details(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->get_firmware_image_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Firmware image version | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_firmware_images** +> get_firmware_images() + + + +Get list of firmware images in the repository + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_firmware_images() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->get_firmware_images: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **install_firmware_image** +> install_firmware_image() + + + +Install firmware on device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.install_firmware_image(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->install_firmware_image: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_firmware_image** +> process_firmware_image() + + + +Upload firmware image package + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.process_firmware_image() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->process_firmware_image: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_firmware_image** +> remove_firmware_image() + + + +Remove firmware on device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_firmware_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_firmware_update_api.ConfigurationDeviceFirmwareUpdateApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.remove_firmware_image(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceFirmwareUpdateApi->remove_firmware_image: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceInventoryApi.md b/docs/ConfigurationDeviceInventoryApi.md new file mode 100644 index 0000000..8fd636a --- /dev/null +++ b/docs/ConfigurationDeviceInventoryApi.md @@ -0,0 +1,2146 @@ +# openapi_client.ConfigurationDeviceInventoryApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**check_self_signed_cert**](ConfigurationDeviceInventoryApi.md#check_self_signed_cert) | **GET** /system/device/selfsignedcert/iscreated | +[**claim_devices**](ConfigurationDeviceInventoryApi.md#claim_devices) | **POST** /system/device/claimDevices | +[**create_device**](ConfigurationDeviceInventoryApi.md#create_device) | **POST** /system/device | +[**decommission_vedge_cloud**](ConfigurationDeviceInventoryApi.md#decommission_vedge_cloud) | **PUT** /system/device/decommission/{uuid} | +[**delete_device**](ConfigurationDeviceInventoryApi.md#delete_device) | **DELETE** /system/device/{uuid} | +[**devices_without_subject_sudi**](ConfigurationDeviceInventoryApi.md#devices_without_subject_sudi) | **GET** /system/device/devicesWithoutSubjectSudi | +[**edit_device**](ConfigurationDeviceInventoryApi.md#edit_device) | **PUT** /system/device/{uuid} | +[**form_post**](ConfigurationDeviceInventoryApi.md#form_post) | **POST** /system/device/fileupload | +[**generate_bootstrap_config_for_vedge**](ConfigurationDeviceInventoryApi.md#generate_bootstrap_config_for_vedge) | **GET** /system/device/bootstrap/device/{uuid} | +[**generate_bootstrap_config_for_vedges**](ConfigurationDeviceInventoryApi.md#generate_bootstrap_config_for_vedges) | **POST** /system/device/bootstrap/devices | +[**generate_generic_bootstrap_config_for_vedges**](ConfigurationDeviceInventoryApi.md#generate_generic_bootstrap_config_for_vedges) | **GET** /system/device/bootstrap/generic/devices | +[**get_all_unclaimed_devices**](ConfigurationDeviceInventoryApi.md#get_all_unclaimed_devices) | **GET** /system/device/unclaimedDevices | +[**get_bootstrap_config_zip**](ConfigurationDeviceInventoryApi.md#get_bootstrap_config_zip) | **GET** /system/device/bootstrap/download/{id} | +[**get_cloud_dock_data_based_on_device_type**](ConfigurationDeviceInventoryApi.md#get_cloud_dock_data_based_on_device_type) | **GET** /system/device/type/{deviceCategory} | +[**get_cloud_dock_default_config_based_on_device_type**](ConfigurationDeviceInventoryApi.md#get_cloud_dock_default_config_based_on_device_type) | **GET** /system/device/type/{deviceCategory}/defaultConfig | +[**get_controller_v_edge_sync_status**](ConfigurationDeviceInventoryApi.md#get_controller_v_edge_sync_status) | **GET** /system/device/controllers/vedge/status | +[**get_devices_details**](ConfigurationDeviceInventoryApi.md#get_devices_details) | **GET** /system/device/{deviceCategory} | +[**get_management_system_ip_info**](ConfigurationDeviceInventoryApi.md#get_management_system_ip_info) | **GET** /system/device/management/systemip | +[**get_rma_candidates**](ConfigurationDeviceInventoryApi.md#get_rma_candidates) | **GET** /system/device/rma/candidates/{deviceType} | +[**get_root_cert_status_all**](ConfigurationDeviceInventoryApi.md#get_root_cert_status_all) | **GET** /system/device/rootcertchain/status | +[**get_tenant_management_system_ips**](ConfigurationDeviceInventoryApi.md#get_tenant_management_system_ips) | **GET** /system/device/tenant/management/systemip | +[**invalidate_vmanage_root_ca**](ConfigurationDeviceInventoryApi.md#invalidate_vmanage_root_ca) | **DELETE** /system/device/vmanagerootca/{uuid} | +[**migrate_device**](ConfigurationDeviceInventoryApi.md#migrate_device) | **PUT** /system/device/migrateDevice/{uuid} | +[**reset_vedge_cloud**](ConfigurationDeviceInventoryApi.md#reset_vedge_cloud) | **PUT** /system/device/reset/{uuid} | +[**set_life_cycle**](ConfigurationDeviceInventoryApi.md#set_life_cycle) | **POST** /system/device/lifecycle/management/{uuid} | +[**sync_devices**](ConfigurationDeviceInventoryApi.md#sync_devices) | **POST** /system/device/smartaccount/sync | +[**sync_root_cert_chain**](ConfigurationDeviceInventoryApi.md#sync_root_cert_chain) | **GET** /system/device/sync/rootcertchain | +[**update_device_subject_sudi**](ConfigurationDeviceInventoryApi.md#update_device_subject_sudi) | **PUT** /system/device/updateDeviceSubjectSUDI/{uuid} | +[**validate_user**](ConfigurationDeviceInventoryApi.md#validate_user) | **POST** /system/device/smartaccount/authenticate | +[**validate_user1**](ConfigurationDeviceInventoryApi.md#validate_user1) | **POST** /system/device/generate-payg | + + +# **check_self_signed_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} check_self_signed_cert() + + + +Whether self signed certificate created + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.check_self_signed_cert() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->check_self_signed_cert: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **claim_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] claim_devices() + + + +Claim the selected unclaimed devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Claim device request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.claim_devices(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->claim_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Claim device request | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device** +> create_device() + + + +Create new device


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Create device request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_device(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->create_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Create device request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **decommission_vedge_cloud** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} decommission_vedge_cloud(uuid) + + + +Decomission vEdge device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.decommission_vedge_cloud(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->decommission_vedge_cloud: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_device** +> delete_device(uuid) + + + +Delete vEdges + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_instance.delete_device(uuid) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->delete_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **devices_without_subject_sudi** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] devices_without_subject_sudi() + + + +retrieve devices without subject sudi + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.devices_without_subject_sudi() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->devices_without_subject_sudi: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_device** +> edit_device(uuid) + + + +Edit device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device config (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_device(uuid) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->edit_device: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_device(uuid, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->edit_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **form_post** +> form_post() + + + +Upload file to vEdge + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.form_post() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->form_post: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_bootstrap_config_for_vedge** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_bootstrap_config_for_vedge(uuid, configtype, ) + + + +Create vEdge device config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + configtype = "configtype_example" # str | Device config type + version = "v1" # str | cloud-init format version (optional) if omitted the server will use the default value of "v1" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_bootstrap_config_for_vedge(uuid, configtype, ) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->generate_bootstrap_config_for_vedge: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_bootstrap_config_for_vedge(uuid, configtype, version=version) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->generate_bootstrap_config_for_vedge: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + **configtype** | **str**| Device config type | + **incl_def_root_cert** | **bool**| Include default root certs flag | defaults to True + **version** | **str**| cloud-init format version | [optional] if omitted the server will use the default value of "v1" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_bootstrap_config_for_vedges** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_bootstrap_config_for_vedges() + + + +Create bootstrap config for software vEdges + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device bootstrap type and id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_bootstrap_config_for_vedges(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->generate_bootstrap_config_for_vedges: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device bootstrap type and id | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_generic_bootstrap_config_for_vedges** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_generic_bootstrap_config_for_vedges() + + + +Create bootstrap config for software vEdges + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + wanif = "wanif_example" # str | Device WAN interface (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_generic_bootstrap_config_for_vedges(wanif=wanif) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->generate_generic_bootstrap_config_for_vedges: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **wanif** | **str**| Device WAN interface | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_unclaimed_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_unclaimed_devices() + + + +Get list of all unclaimed devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_unclaimed_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_all_unclaimed_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bootstrap_config_zip** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bootstrap_config_zip(id) + + + +Download vEdge device config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + id = "id_example" # str | Bootstrap config id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bootstrap_config_zip(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_bootstrap_config_zip: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Bootstrap config id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_dock_data_based_on_device_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_dock_data_based_on_device_type(device_category) + + + +Get devices details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + device_category = "vedges" # str | Device category + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_dock_data_based_on_device_type(device_category) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_cloud_dock_data_based_on_device_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_category** | **str**| Device category | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_dock_default_config_based_on_device_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_dock_default_config_based_on_device_type(device_category) + + + +Get devices default config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + device_category = "vedges" # str | Device category + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_dock_default_config_based_on_device_type(device_category) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_cloud_dock_default_config_based_on_device_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_category** | **str**| Device category | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_controller_v_edge_sync_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_controller_v_edge_sync_status() + + + +Get controllers vEdge sync status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_controller_v_edge_sync_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_controller_v_edge_sync_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_details** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_devices_details(device_category) + + + +Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from openapi_client.model.device_ip import DeviceIP +from openapi_client.model.device_uuid import DeviceUuid +from openapi_client.model.certificate_states import CertificateStates +from openapi_client.model.certificate_validity import CertificateValidity +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + device_category = "deviceCategory_example" # str | Device category + model = "vedge-cloud" # str | Device model (optional) + state = [ + CertificateStates( + certificate_types="certificate_types_example", + ), + ] # [CertificateStates] | List of states (optional) + uuid = [ + DeviceUuid( + device_uuid="device_uuid_example", + ), + ] # [DeviceUuid] | List of device uuid (optional) + device_ip = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | List of device system IP (optional) + validity = [ + CertificateValidity( + certificate_validity="certificate_validity_example", + ), + ] # [CertificateValidity] | List of device validity (optional) + family = "aon" # str | The platform family to filter for (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_devices_details(device_category) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_devices_details: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_devices_details(device_category, model=model, state=state, uuid=uuid, device_ip=device_ip, validity=validity, family=family) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_devices_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_category** | **str**| Device category | + **model** | **str**| Device model | [optional] + **state** | [**[CertificateStates]**](CertificateStates.md)| List of states | [optional] + **uuid** | [**[DeviceUuid]**](DeviceUuid.md)| List of device uuid | [optional] + **device_ip** | [**[DeviceIP]**](DeviceIP.md)| List of device system IP | [optional] + **validity** | [**[CertificateValidity]**](CertificateValidity.md)| List of device validity | [optional] + **family** | **str**| The platform family to filter for | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_management_system_ip_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_management_system_ip_info() + + + +Get management system IP mapping + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_management_system_ip_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_management_system_ip_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_rma_candidates** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_rma_candidates() + + + +Get RMA candidates by device type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Excluded currently selected uuid (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_rma_candidates() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_rma_candidates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_rma_candidates(uuid=uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_rma_candidates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_type** | **str**| Device Type | defaults to "vsmart" + **uuid** | **str**| Excluded currently selected uuid | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_root_cert_status_all** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_root_cert_status_all(state) + + + +Get controllers vEdge sync status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + state = "pending" # str | Root certificate state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_root_cert_status_all(state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_root_cert_status_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state** | **str**| Root certificate state | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenant_management_system_ips** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_tenant_management_system_ips() + + + +Get management system IP


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenant_management_system_ips() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->get_tenant_management_system_ips: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **invalidate_vmanage_root_ca** +> invalidate_vmanage_root_ca(uuid) + + + +Invalidate vManage root CA + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_instance.invalidate_vmanage_root_ca(uuid) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->invalidate_vmanage_root_ca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **migrate_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} migrate_device(uuid) + + + +Migrate device software to vedge/cedge + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.migrate_device(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->migrate_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reset_vedge_cloud** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} reset_vedge_cloud(uuid) + + + +Reset vEdge device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.reset_vedge_cloud(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->reset_vedge_cloud: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_life_cycle** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_life_cycle(uuid) + + + +Set device lifecycle needed flag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + enable = True # bool | lifecycle needed flag (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.set_life_cycle(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->set_life_cycle: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.set_life_cycle(uuid, enable=enable) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->set_life_cycle: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + **enable** | **bool**| lifecycle needed flag | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sync_devices() + + + +Sync devices from Smart-Account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from openapi_client.model.smart_account_model import SmartAccountModel +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + smart_account_model = SmartAccountModel( + env="env_example", + organization_name="organization_name_example", + password="password_example", + username="username_example", + validity_string="validity_string_example", + ) # SmartAccountModel | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.sync_devices(smart_account_model=smart_account_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->sync_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **smart_account_model** | [**SmartAccountModel**](SmartAccountModel.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_root_cert_chain** +> sync_root_cert_chain() + + + +Sync root certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.sync_root_cert_chain() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->sync_root_cert_chain: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_device_subject_sudi** +> update_device_subject_sudi(uuid) + + + +update subject sudi value of given device uuid + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_instance.update_device_subject_sudi(uuid) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->update_device_subject_sudi: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_user** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} validate_user() + + + +Authenticate vSmart user account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from openapi_client.model.smart_account_model import SmartAccountModel +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + smart_account_model = SmartAccountModel( + env="env_example", + organization_name="organization_name_example", + password="password_example", + username="username_example", + validity_string="validity_string_example", + ) # SmartAccountModel | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.validate_user(smart_account_model=smart_account_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->validate_user: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **smart_account_model** | [**SmartAccountModel**](SmartAccountModel.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_user1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} validate_user1() + + + +Authenticate vSmart user account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_inventory_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_inventory_api.ConfigurationDeviceInventoryApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.validate_user1(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceInventoryApi->validate_user1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md b/docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md new file mode 100644 index 0000000..4e3d0e5 --- /dev/null +++ b/docs/ConfigurationDeviceSSLProxyCertificateManagementApi.md @@ -0,0 +1,1647 @@ +# openapi_client.ConfigurationDeviceSSLProxyCertificateManagementApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_wan_edge**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#add_wan_edge) | **POST** /sslproxy/certificate/wanedge/{deviceId} | +[**generate_ssl_proxy_csr**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#generate_ssl_proxy_csr) | **POST** /sslproxy/generate/csr/sslproxy | +[**generate_ssl_proxy_csr_0**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#generate_ssl_proxy_csr_0) | **POST** /sslproxy/generate/vmanage/csr | +[**get_all_device_certificates**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_all_device_certificates) | **POST** /sslproxy/devicecertificates | +[**get_all_device_csr**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_all_device_csr) | **POST** /sslproxy/devicecsr | +[**get_certificate_state**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_certificate_state) | **GET** /sslproxy/settings/certificate | +[**get_enterprise_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_enterprise_certificate) | **GET** /sslproxy/settings/enterprise/certificate | +[**get_proxy_cert_of_edge**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_proxy_cert_of_edge) | **GET** /sslproxy/certificate | +[**get_self_signed_cert**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_self_signed_cert) | **GET** /certificate/vmanage/selfsignedcert | +[**get_ssl_proxy_csr**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_ssl_proxy_csr) | **GET** /sslproxy/csr | +[**get_ssl_proxy_list**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_ssl_proxy_list) | **GET** /sslproxy/list | +[**get_v_manage_enterprise_root_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#get_v_manage_enterprise_root_certificate) | **GET** /sslproxy/settings/enterprise/rootca | +[**getv_manage_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#getv_manage_certificate) | **GET** /sslproxy/settings/vmanage/certificate | +[**getv_manage_csr**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#getv_manage_csr) | **GET** /sslproxy/settings/vmanage/csr | +[**getv_manage_root_ca**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#getv_manage_root_ca) | **GET** /sslproxy/settings/vmanage/rootca | +[**renew_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#renew_certificate) | **POST** /sslproxy/renew | +[**revoke_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#revoke_certificate) | **POST** /sslproxy/revoke | +[**revoke_renew_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#revoke_renew_certificate) | **POST** /sslproxy/revokerenew | +[**set_enterprise_cert**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#set_enterprise_cert) | **POST** /sslproxy/settings/enterprise/certificate | +[**set_enterprise_root_ca_cert**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#set_enterprise_root_ca_cert) | **POST** /sslproxy/settings/enterprise/rootca | +[**setv_manage_root_ca**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#setv_manage_root_ca) | **POST** /sslproxy/settings/vmanage/rootca | +[**setv_manageintermediate_cert**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#setv_manageintermediate_cert) | **POST** /sslproxy/settings/vmanage/certificate | +[**update_certificate**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#update_certificate) | **PUT** /sslproxy/certificate | +[**upload_certificiates**](ConfigurationDeviceSSLProxyCertificateManagementApi.md#upload_certificiates) | **POST** /sslproxy/certificates | + + +# **add_wan_edge** +> add_wan_edge(device_id) + + + +Add SSL proxy wan edge + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + device_id = "deviceId_example" # str | Device Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cert state (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.add_wan_edge(device_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->add_wan_edge: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_wan_edge(device_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->add_wan_edge: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cert state | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_ssl_proxy_csr** +> generate_ssl_proxy_csr() + + + +CSR request SSL proxy for edge + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request for edge (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.generate_ssl_proxy_csr(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->generate_ssl_proxy_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request for edge | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_ssl_proxy_csr_0** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_ssl_proxy_csr_0() + + + +Generate CSR + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_ssl_proxy_csr_0(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->generate_ssl_proxy_csr_0: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_device_certificates** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_device_certificates() + + + +Get certificate for all cEdges + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_all_device_certificates(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_all_device_certificates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_device_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_device_csr() + + + +Get CSR for all cEdges + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_all_device_csr(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_all_device_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_certificate_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_certificate_state() + + + +Get certificate state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_certificate_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_certificate_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_enterprise_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_enterprise_certificate() + + + +Get enterprise certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_enterprise_certificate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_enterprise_certificate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_proxy_cert_of_edge** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_proxy_cert_of_edge(device_id) + + + +Get edge proxy certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_proxy_cert_of_edge(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_proxy_cert_of_edge: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_self_signed_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_self_signed_cert() + + + +get self signed certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_self_signed_cert() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_self_signed_cert: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ssl_proxy_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ssl_proxy_csr(device_id) + + + +Get SSL proxy CSR + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + device_id = "8d86d8b2-2239-402e-9fef-467f7bad3f2f" # str | device UUID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ssl_proxy_csr(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_ssl_proxy_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| device UUID | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ssl_proxy_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_ssl_proxy_list() + + + +Get SSL proxy certificate list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_ssl_proxy_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_ssl_proxy_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_manage_enterprise_root_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_v_manage_enterprise_root_certificate() + + + +Get vManage enterprise root certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_v_manage_enterprise_root_certificate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->get_v_manage_enterprise_root_certificate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_manage_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getv_manage_certificate() + + + +Get vManage intermediate certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.getv_manage_certificate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->getv_manage_certificate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_manage_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getv_manage_csr() + + + +Get vManage CSR + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.getv_manage_csr() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->getv_manage_csr: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_manage_root_ca** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getv_manage_root_ca() + + + +Get vManage root certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.getv_manage_root_ca() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->getv_manage_root_ca: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **renew_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} renew_certificate() + + + +Renew device certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Renew device certificate request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.renew_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->renew_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Renew device certificate request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **revoke_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} revoke_certificate() + + + +Revoke device certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Revoke device certificate request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.revoke_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->revoke_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Revoke device certificate request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **revoke_renew_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} revoke_renew_certificate() + + + +Revoke and renew device certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Revoke device certificate request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.revoke_renew_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->revoke_renew_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Revoke device certificate request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_enterprise_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_enterprise_cert() + + + +Configure enterprise certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Config enterprise certificate request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.set_enterprise_cert(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->set_enterprise_cert: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Config enterprise certificate request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_enterprise_root_ca_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_enterprise_root_ca_cert() + + + +Set vManage enterprise root certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Set enterprise root CA request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.set_enterprise_root_ca_cert(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->set_enterprise_root_ca_cert: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Set enterprise root CA request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setv_manage_root_ca** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} setv_manage_root_ca() + + + +Set vManage root certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Set vManage root CA request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.setv_manage_root_ca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->setv_manage_root_ca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Set vManage root CA request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setv_manageintermediate_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} setv_manageintermediate_cert() + + + +Set vManage root certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Set vManage intermediate CA request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.setv_manageintermediate_cert(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->setv_manageintermediate_cert: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Set vManage intermediate CA request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_certificate() + + + +Upload device certificate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Upload device certificate (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->update_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Upload device certificate | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_certificiates** +> upload_certificiates() + + + +Upload device certificates + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_ssl_proxy_certificate_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_ssl_proxy_certificate_management_api.ConfigurationDeviceSSLProxyCertificateManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.upload_certificiates() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSSLProxyCertificateManagementApi->upload_certificiates: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**207** | Multi-status | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceSoftwarePackageApi.md b/docs/ConfigurationDeviceSoftwarePackageApi.md new file mode 100644 index 0000000..6a5b3b9 --- /dev/null +++ b/docs/ConfigurationDeviceSoftwarePackageApi.md @@ -0,0 +1,295 @@ +# openapi_client.ConfigurationDeviceSoftwarePackageApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_vnf_package**](ConfigurationDeviceSoftwarePackageApi.md#create_vnf_package) | **POST** /device/action/software/package/custom/vnfPackage | +[**edit_config_file**](ConfigurationDeviceSoftwarePackageApi.md#edit_config_file) | **PUT** /device/action/software/package/custom/file/{uuid} | +[**get_file_contents**](ConfigurationDeviceSoftwarePackageApi.md#get_file_contents) | **GET** /device/action/software/package/custom/file/{uuid} | +[**upload_image_file**](ConfigurationDeviceSoftwarePackageApi.md#upload_image_file) | **POST** /device/action/software/package/custom/uploads/{type} | + + +# **create_vnf_package** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_vnf_package() + + + +Create VNF custom package + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_package_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_package_api.ConfigurationDeviceSoftwarePackageApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Custom package (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_vnf_package(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwarePackageApi->create_vnf_package: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Custom package | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_config_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_config_file(uuid) + + + +Edit bootstrap file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_package_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_package_api.ConfigurationDeviceSoftwarePackageApi(api_client) + uuid = "uuid_example" # str | File uuid + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Bootstrap file (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_config_file(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwarePackageApi->edit_config_file: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_config_file(uuid, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwarePackageApi->edit_config_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| File uuid | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Bootstrap file | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_file_contents** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_file_contents(uuid) + + + +Get bootstrap file contents + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_package_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_package_api.ConfigurationDeviceSoftwarePackageApi(api_client) + uuid = "uuid_example" # str | File uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_file_contents(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwarePackageApi->get_file_contents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| File uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_image_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} upload_image_file(type) + + + +Upload virtual image/bootstrap file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_package_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_package_api.ConfigurationDeviceSoftwarePackageApi(api_client) + type = "image" # str | Upload file type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.upload_image_file(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwarePackageApi->upload_image_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Upload file type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceSoftwareUpdateApi.md b/docs/ConfigurationDeviceSoftwareUpdateApi.md new file mode 100644 index 0000000..686d085 --- /dev/null +++ b/docs/ConfigurationDeviceSoftwareUpdateApi.md @@ -0,0 +1,454 @@ +# openapi_client.ConfigurationDeviceSoftwareUpdateApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**download_package_file**](ConfigurationDeviceSoftwareUpdateApi.md#download_package_file) | **GET** /device/action/software/package/{fileName} | +[**edit_image_metadata**](ConfigurationDeviceSoftwareUpdateApi.md#edit_image_metadata) | **PUT** /device/action/software/package/{versionId}/metadata | +[**get_image_metadata**](ConfigurationDeviceSoftwareUpdateApi.md#get_image_metadata) | **GET** /device/action/software/package/{versionId}/metadata | +[**get_upload_images_count**](ConfigurationDeviceSoftwareUpdateApi.md#get_upload_images_count) | **GET** /device/action/software/package/imageCount | +[**install_pkg**](ConfigurationDeviceSoftwareUpdateApi.md#install_pkg) | **POST** /device/action/software/package | +[**process_software_image**](ConfigurationDeviceSoftwareUpdateApi.md#process_software_image) | **POST** /device/action/software/package/{imageType} | + + +# **download_package_file** +> download_package_file(file_name, ) + + + +Download software package file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client) + file_name = "fileName_example" # str | Pakcage file name + + # example passing only required values which don't have defaults set + try: + api_instance.download_package_file(file_name, ) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->download_package_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file_name** | **str**| Pakcage file name | + **image_type** | **str**| Image type | defaults to "software" + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_image_metadata** +> edit_image_metadata(version_id) + + + +Update Package Metadata + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client) + version_id = "versionId_example" # str | Image ID + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_image_metadata(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->edit_image_metadata: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_image_metadata(version_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->edit_image_metadata: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Image ID | + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_image_metadata** +> get_image_metadata(version_id) + + + +Update Package Metadata + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client) + version_id = "versionId_example" # str | Image ID + + # example passing only required values which don't have defaults set + try: + api_instance.get_image_metadata(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->get_image_metadata: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Image ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_upload_images_count** +> get_upload_images_count(image_type) + + + +Number of software image presented in vManage repository + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_update_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client) + image_type = [ + "software", + ] # [str] | Image type + + # example passing only required values which don't have defaults set + try: + api_instance.get_upload_images_count(image_type) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->get_upload_images_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **image_type** | **[str]**| Image type | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **install_pkg** +> install_pkg() + + + +Install software package + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_update_api +from openapi_client.model.software_upload_file_data import SoftwareUploadFileData +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client) + data = SoftwareUploadFileData( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # SoftwareUploadFileData | (optional) + file = open('/path/to/file', 'rb') # file_type | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.install_pkg(data=data, file=file) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->install_pkg: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | [**SoftwareUploadFileData**](SoftwareUploadFileData.md)| | [optional] + **file** | **file_type**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**415** | Unsupported Media Type | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_software_image** +> process_software_image(image_type) + + + +Install software image package + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_software_update_api +from openapi_client.model.software_upload_file_data import SoftwareUploadFileData +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_software_update_api.ConfigurationDeviceSoftwareUpdateApi(api_client) + image_type = "imageType_example" # str | Image type + data = SoftwareUploadFileData( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # SoftwareUploadFileData | (optional) + file = open('/path/to/file', 'rb') # file_type | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.process_software_image(image_type) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->process_software_image: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_software_image(image_type, data=data, file=file) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceSoftwareUpdateApi->process_software_image: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **image_type** | **str**| Image type | + **data** | [**SoftwareUploadFileData**](SoftwareUploadFileData.md)| | [optional] + **file** | **file_type**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**415** | Unsupported Media Type | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDeviceTemplateApi.md b/docs/ConfigurationDeviceTemplateApi.md new file mode 100644 index 0000000..49009d2 --- /dev/null +++ b/docs/ConfigurationDeviceTemplateApi.md @@ -0,0 +1,1405 @@ +# openapi_client.ConfigurationDeviceTemplateApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**attach_device_template**](ConfigurationDeviceTemplateApi.md#attach_device_template) | **POST** /template/device/config/attachment | +[**check_vbond**](ConfigurationDeviceTemplateApi.md#check_vbond) | **GET** /template/device/config/vbond | +[**create_device_input**](ConfigurationDeviceTemplateApi.md#create_device_input) | **POST** /template/device/config/input | +[**create_input_without_device**](ConfigurationDeviceTemplateApi.md#create_input_without_device) | **POST** /template/device/config/exportcsv | +[**detach_device_template**](ConfigurationDeviceTemplateApi.md#detach_device_template) | **POST** /template/device/config/detach | +[**detach_sites**](ConfigurationDeviceTemplateApi.md#detach_sites) | **POST** /template/device/config/detachcloudx | +[**edit_cloudx_config**](ConfigurationDeviceTemplateApi.md#edit_cloudx_config) | **PUT** /template/device/config/attachcloudx | +[**get_attached_config_to_device**](ConfigurationDeviceTemplateApi.md#get_attached_config_to_device) | **GET** /template/device/config/attachedconfig | +[**get_attached_device_list**](ConfigurationDeviceTemplateApi.md#get_attached_device_list) | **GET** /template/device/config/attached/{masterTemplateId} | +[**get_device_configuration_preview**](ConfigurationDeviceTemplateApi.md#get_device_configuration_preview) | **POST** /template/device/config/config | +[**get_device_list_by_master_template_id**](ConfigurationDeviceTemplateApi.md#get_device_list_by_master_template_id) | **GET** /template/device/config/available/{masterTemplateId} | +[**get_devices_with_duplicate_ip**](ConfigurationDeviceTemplateApi.md#get_devices_with_duplicate_ip) | **POST** /template/device/config/duplicateip | +[**get_devices_with_duplicate_location_name**](ConfigurationDeviceTemplateApi.md#get_devices_with_duplicate_location_name) | **POST** /template/device/config/duplicatelocationname | +[**get_quick_connect_variables**](ConfigurationDeviceTemplateApi.md#get_quick_connect_variables) | **POST** /template/device/config/quickconnectvariable | +[**process_input_comma_sep_file**](ConfigurationDeviceTemplateApi.md#process_input_comma_sep_file) | **POST** /template/device/config/process/input/file | +[**push_cli_template**](ConfigurationDeviceTemplateApi.md#push_cli_template) | **POST** /template/device/config/attachcli | +[**push_cloudx_config**](ConfigurationDeviceTemplateApi.md#push_cloudx_config) | **POST** /template/device/config/attachcloudx | +[**push_master_template**](ConfigurationDeviceTemplateApi.md#push_master_template) | **POST** /template/device/config/attachfeature | +[**push_master_template1**](ConfigurationDeviceTemplateApi.md#push_master_template1) | **POST** /template/device/config/attachBootStrap | +[**validate_template**](ConfigurationDeviceTemplateApi.md#validate_template) | **POST** /template/device/config/verify | + + +# **attach_device_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} attach_device_template() + + + +Attach device template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.attach_device_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->attach_device_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **check_vbond** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} check_vbond() + + + +Check if vBond is configured


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.check_vbond() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->check_vbond: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_input** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_input() + + + +Create device input


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template device input (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_device_input(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->create_device_input: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template device input | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_input_without_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_input_without_device() + + + +Export the device template to CSV format for given template id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_input_without_device(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->create_input_without_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **detach_device_template** +> detach_device_template() + + + +Detach device template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.detach_device_template(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->detach_device_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **detach_sites** +> str detach_sites() + + + +Disable enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CloudX config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.detach_sites(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->detach_sites: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CloudX config | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_cloudx_config** +> str edit_cloudx_config() + + + +Edit already enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CloudX config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_cloudx_config(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->edit_cloudx_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CloudX config | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_attached_config_to_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_attached_config_to_device(device_id) + + + +Get attached config to device


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + device_id = "deviceId_example" # str | Device Model ID + policy_id = "policyId_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_attached_config_to_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_attached_config_to_device: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_attached_config_to_device(device_id, policy_id=policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_attached_config_to_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Model ID | + **policy_id** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_attached_device_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_attached_device_list(master_template_id) + + + +Get attached device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + master_template_id = "masterTemplateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_attached_device_list(master_template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_attached_device_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **master_template_id** | **str**| Template Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_configuration_preview** +> str get_device_configuration_preview() + + + +Get device configuration


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_configuration_preview(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_device_configuration_preview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_list_by_master_template_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_list_by_master_template_id(master_template_id) + + + +Get possible device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + master_template_id = "masterTemplateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_list_by_master_template_id(master_template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_device_list_by_master_template_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **master_template_id** | **str**| Template Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_with_duplicate_ip** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_devices_with_duplicate_ip() + + + +Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_devices_with_duplicate_ip(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_devices_with_duplicate_ip: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device list | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_with_duplicate_location_name** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_devices_with_duplicate_location_name() + + + +Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_devices_with_duplicate_location_name(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_devices_with_duplicate_location_name: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device list | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_quick_connect_variables** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_quick_connect_variables() + + + +Get connection variables to be configured + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device List (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_quick_connect_variables(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->get_quick_connect_variables: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device List | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_input_comma_sep_file** +> str process_input_comma_sep_file() + + + +Process input comma separated file


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.process_input_comma_sep_file() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->process_input_comma_sep_file: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **push_cli_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} push_cli_template() + + + +Attach CLI device template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_cli_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->push_cli_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **push_cloudx_config** +> str push_cloudx_config() + + + +Enable gateways, clients, dias + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CloudX config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_cloudx_config(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->push_cloudx_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CloudX config | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **push_master_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} push_master_template() + + + +Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_master_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->push_master_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **push_master_template1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} push_master_template1() + + + +Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_master_template1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->push_master_template1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_template** +> validate_template() + + + +Validate full template\"


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_device_template_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_device_template_api.ConfigurationDeviceTemplateApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.validate_template(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDeviceTemplateApi->validate_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDisasterRecoveryApi.md b/docs/ConfigurationDisasterRecoveryApi.md new file mode 100644 index 0000000..541446a --- /dev/null +++ b/docs/ConfigurationDisasterRecoveryApi.md @@ -0,0 +1,2669 @@ +# openapi_client.ConfigurationDisasterRecoveryApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activate**](ConfigurationDisasterRecoveryApi.md#activate) | **POST** /disasterrecovery/activate | +[**delete**](ConfigurationDisasterRecoveryApi.md#delete) | **POST** /disasterrecovery/deregister | +[**delete_dc**](ConfigurationDisasterRecoveryApi.md#delete_dc) | **POST** /disasterrecovery/deleteRemoteDataCenter | +[**delete_local_dc**](ConfigurationDisasterRecoveryApi.md#delete_local_dc) | **POST** /disasterrecovery/deleteLocalDataCenter | +[**disaster_recovery_pause_replication**](ConfigurationDisasterRecoveryApi.md#disaster_recovery_pause_replication) | **POST** /disasterrecovery/pausereplication | +[**disaster_recovery_replication_request**](ConfigurationDisasterRecoveryApi.md#disaster_recovery_replication_request) | **POST** /disasterrecovery/requestimport | +[**disaster_recovery_un_pause_replication**](ConfigurationDisasterRecoveryApi.md#disaster_recovery_un_pause_replication) | **POST** /disasterrecovery/unpausereplication | +[**download**](ConfigurationDisasterRecoveryApi.md#download) | **GET** /disasterrecovery/download/backup/{token}/db_bkp.tar.gz | +[**download_replication_data**](ConfigurationDisasterRecoveryApi.md#download_replication_data) | **GET** /disasterrecovery/download/{token}/{fileName} | +[**get**](ConfigurationDisasterRecoveryApi.md#get) | **GET** /disasterrecovery/usernames | +[**get_cluster_info**](ConfigurationDisasterRecoveryApi.md#get_cluster_info) | **GET** /disasterrecovery/clusterInfo | +[**get_config_db_restore_status**](ConfigurationDisasterRecoveryApi.md#get_config_db_restore_status) | **GET** /disasterrecovery/dbrestorestatus | +[**get_details**](ConfigurationDisasterRecoveryApi.md#get_details) | **GET** /disasterrecovery/details | +[**get_disaster_recovery_local_replication_schedule**](ConfigurationDisasterRecoveryApi.md#get_disaster_recovery_local_replication_schedule) | **GET** /disasterrecovery/schedule | +[**get_disaster_recovery_status**](ConfigurationDisasterRecoveryApi.md#get_disaster_recovery_status) | **GET** /disasterrecovery/drstatus | +[**get_history**](ConfigurationDisasterRecoveryApi.md#get_history) | **GET** /disasterrecovery/history | +[**get_local_data_center_state**](ConfigurationDisasterRecoveryApi.md#get_local_data_center_state) | **GET** /disasterrecovery/localdc | +[**get_local_history**](ConfigurationDisasterRecoveryApi.md#get_local_history) | **GET** /disasterrecovery/localLatestHistory | +[**get_reachability_info**](ConfigurationDisasterRecoveryApi.md#get_reachability_info) | **POST** /disasterrecovery/validateNodes | +[**get_remote_data_center_state**](ConfigurationDisasterRecoveryApi.md#get_remote_data_center_state) | **GET** /disasterrecovery/remotedc | +[**get_remote_data_center_version**](ConfigurationDisasterRecoveryApi.md#get_remote_data_center_version) | **GET** /disasterrecovery/remotedc/swversion | +[**get_remote_dc_members_state**](ConfigurationDisasterRecoveryApi.md#get_remote_dc_members_state) | **GET** /disasterrecovery/remoteDcState | +[**getdr_status**](ConfigurationDisasterRecoveryApi.md#getdr_status) | **GET** /disasterrecovery/status | +[**pause_dr**](ConfigurationDisasterRecoveryApi.md#pause_dr) | **POST** /disasterrecovery/pause | +[**pause_local_arbitrator**](ConfigurationDisasterRecoveryApi.md#pause_local_arbitrator) | **POST** /disasterrecovery/pauseLocalArbitrator | +[**pause_local_dc_for_dr**](ConfigurationDisasterRecoveryApi.md#pause_local_dc_for_dr) | **POST** /disasterrecovery/pauseLocalDC | +[**pause_local_dc_replication**](ConfigurationDisasterRecoveryApi.md#pause_local_dc_replication) | **POST** /disasterrecovery/pauseLocalReplication | +[**register**](ConfigurationDisasterRecoveryApi.md#register) | **POST** /disasterrecovery/register | +[**restart_data_center**](ConfigurationDisasterRecoveryApi.md#restart_data_center) | **POST** /disasterrecovery/restartDataCenter | +[**restore_config_db**](ConfigurationDisasterRecoveryApi.md#restore_config_db) | **POST** /disasterrecovery/dbrestore | +[**unpause_dr**](ConfigurationDisasterRecoveryApi.md#unpause_dr) | **POST** /disasterrecovery/unpause | +[**unpause_local_arbitrator**](ConfigurationDisasterRecoveryApi.md#unpause_local_arbitrator) | **POST** /disasterrecovery/unpauseLocalArbitrator | +[**unpause_local_dc_for_dr**](ConfigurationDisasterRecoveryApi.md#unpause_local_dc_for_dr) | **POST** /disasterrecovery/unpauseLocalDC | +[**unpause_local_dc_replication**](ConfigurationDisasterRecoveryApi.md#unpause_local_dc_replication) | **POST** /disasterrecovery/unpauseLocalReplication | +[**update**](ConfigurationDisasterRecoveryApi.md#update) | **POST** /disasterrecovery/password | +[**update1**](ConfigurationDisasterRecoveryApi.md#update1) | **PUT** /disasterrecovery/register | +[**update_disaster_recovery_state**](ConfigurationDisasterRecoveryApi.md#update_disaster_recovery_state) | **POST** /disasterrecovery/remotePassword | +[**update_disaster_recovery_state1**](ConfigurationDisasterRecoveryApi.md#update_disaster_recovery_state1) | **POST** /disasterrecovery/remotedc | +[**update_dr_state**](ConfigurationDisasterRecoveryApi.md#update_dr_state) | **POST** /disasterrecovery/updateDRConfigOnArbitrator | +[**update_replication**](ConfigurationDisasterRecoveryApi.md#update_replication) | **POST** /disasterrecovery/updateReplication | + + +# **activate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} activate() + + + +Activate cluster to start working as primary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.activate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->activate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete() + + + +Delete disaster recovery + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->delete: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_dc** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_dc() + + + +Delete data center + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete_dc() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->delete_dc: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_local_dc** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_local_dc() + + + +Delete local data center + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete_local_dc() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->delete_local_dc: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disaster_recovery_pause_replication** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} disaster_recovery_pause_replication() + + + +Pause DR data replication + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.disaster_recovery_pause_replication() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->disaster_recovery_pause_replication: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disaster_recovery_replication_request** +> disaster_recovery_replication_request() + + + +Replication Request message sent from primary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | DR request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.disaster_recovery_replication_request(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->disaster_recovery_replication_request: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| DR request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disaster_recovery_un_pause_replication** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} disaster_recovery_un_pause_replication() + + + +Un-Pause DR data replication + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.disaster_recovery_un_pause_replication() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->disaster_recovery_un_pause_replication: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download(token) + + + +Downloading stats file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + token = "token_example" # str | Token + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download(token) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->download: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **token** | **str**| Token | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_replication_data** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] download_replication_data(token, file_name) + + + +Download replication data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + token = "token_example" # str | Token + file_name = "fileName_example" # str | File name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download_replication_data(token, file_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->download_replication_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **token** | **str**| Token | + **file_name** | **str**| File name | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get() + + + +Fetch data centers and vBonds usernames for disaster recovery + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter/vBond password update request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter/vBond password update request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cluster_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cluster_info() + + + +Get disaster recovery cluster info + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cluster_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_cluster_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_db_restore_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_config_db_restore_status() + + + +Config-db restore status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_config_db_restore_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_config_db_restore_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_details() + + + +Get disaster recovery details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_details: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_disaster_recovery_local_replication_schedule** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_disaster_recovery_local_replication_schedule() + + + +Get disaster recovery local replication schedule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_disaster_recovery_local_replication_schedule() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_disaster_recovery_local_replication_schedule: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_disaster_recovery_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_disaster_recovery_status() + + + +Disaster recovery status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_disaster_recovery_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_disaster_recovery_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_history** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_history() + + + +Get disaster recovery switchover history + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_history() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_history: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_local_data_center_state** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_local_data_center_state() + + + +Get local data center details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_local_data_center_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_local_data_center_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_local_history** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_local_history() + + + +Get disaster recovery local switchover history + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_local_history() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_local_history: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reachability_info** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_reachability_info() + + + +Validate a list of nodes + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + request_body = [] # [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] | Node list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_reachability_info(request_body=request_body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_reachability_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]**| Node list | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_remote_data_center_state** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_remote_data_center_state() + + + +Get remote data center details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_remote_data_center_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_remote_data_center_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_remote_data_center_version** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_remote_data_center_version() + + + +Get remote data center vManage version + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_remote_data_center_version() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_remote_data_center_version: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_remote_dc_members_state** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_remote_dc_members_state() + + + +Gets remote data center member state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_remote_dc_members_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->get_remote_dc_members_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getdr_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getdr_status() + + + +Get disaster recovery status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.getdr_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->getdr_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_dr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} pause_dr() + + + +Pause DR + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.pause_dr() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->pause_dr: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_local_arbitrator** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} pause_local_arbitrator() + + + +Pause DR for Local Arbitrator + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.pause_local_arbitrator() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->pause_local_arbitrator: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_local_dc_for_dr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} pause_local_dc_for_dr() + + + +Pause DR for Local datacenter + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.pause_local_dc_for_dr() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->pause_local_dc_for_dr: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_local_dc_replication** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} pause_local_dc_replication() + + + +Pause DR replication for Local datacenter + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.pause_local_dc_replication() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->pause_local_dc_replication: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **register** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} register() + + + +Register data centers for disaster recovery + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter registration request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.register(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->register: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter registration request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restart_data_center** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} restart_data_center() + + + +Restart data center + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter registration (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.restart_data_center(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->restart_data_center: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter registration | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restore_config_db** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} restore_config_db() + + + +Signal vManage to initiate configuration-db restore operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Config-db meta payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.restore_config_db(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->restore_config_db: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Config-db meta payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unpause_dr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} unpause_dr() + + + +Unpause DR + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.unpause_dr() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->unpause_dr: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unpause_local_arbitrator** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} unpause_local_arbitrator() + + + +Unpause DR for Local Arbitrator + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.unpause_local_arbitrator() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->unpause_local_arbitrator: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unpause_local_dc_for_dr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} unpause_local_dc_for_dr() + + + +Unpause DR for Local datacenter + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.unpause_local_dc_for_dr() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->unpause_local_dc_for_dr: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unpause_local_dc_replication** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} unpause_local_dc_replication() + + + +Unpause DR replication for local datacenter + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.unpause_local_dc_replication() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->unpause_local_dc_replication: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update() + + + +Update data centers and vBonds passwords for disaster recovery + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter/vBond password update request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter/vBond password update request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update1() + + + +Update data centers for disaster recovery + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter registration request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->update1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter registration request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_disaster_recovery_state** +> update_disaster_recovery_state() + + + +Update disaster recovery information with updated password to remote data center + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter registration (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_disaster_recovery_state(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->update_disaster_recovery_state: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter registration | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_disaster_recovery_state1** +> update_disaster_recovery_state1() + + + +Update complete disaster recovery information to remote data center + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Datacenter registration (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_disaster_recovery_state1(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->update_disaster_recovery_state1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Datacenter registration | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_dr_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_dr_state() + + + +Update arbitrator with primary and secondary states cluster + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.update_dr_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->update_dr_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_replication** +> update_replication() + + + +Update DR replication status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_disaster_recovery_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_disaster_recovery_api.ConfigurationDisasterRecoveryApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Replication status (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_replication(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDisasterRecoveryApi->update_replication: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Replication status | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationDownloadedImagesApi.md b/docs/ConfigurationDownloadedImagesApi.md new file mode 100644 index 0000000..694221b --- /dev/null +++ b/docs/ConfigurationDownloadedImagesApi.md @@ -0,0 +1,77 @@ +# openapi_client.ConfigurationDownloadedImagesApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_software_list**](ConfigurationDownloadedImagesApi.md#create_software_list) | **GET** /device/downloadedImages | + + +# **create_software_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_software_list(device_id) + + + +Get images list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_downloaded_images_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_downloaded_images_api.ConfigurationDownloadedImagesApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_software_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationDownloadedImagesApi->create_software_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationFQDNListBuilderApi.md b/docs/ConfigurationFQDNListBuilderApi.md new file mode 100644 index 0000000..ff50351 --- /dev/null +++ b/docs/ConfigurationFQDNListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationFQDNListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list16**](ConfigurationFQDNListBuilderApi.md#create_policy_list16) | **POST** /template/policy/list/fqdn | +[**delete_policy_list16**](ConfigurationFQDNListBuilderApi.md#delete_policy_list16) | **DELETE** /template/policy/list/fqdn/{id} | +[**delete_policy_lists_with_info_tag16**](ConfigurationFQDNListBuilderApi.md#delete_policy_lists_with_info_tag16) | **DELETE** /template/policy/list/fqdn | +[**edit_policy_list16**](ConfigurationFQDNListBuilderApi.md#edit_policy_list16) | **PUT** /template/policy/list/fqdn/{id} | +[**get_lists_by_id16**](ConfigurationFQDNListBuilderApi.md#get_lists_by_id16) | **GET** /template/policy/list/fqdn/{id} | +[**get_policy_lists14**](ConfigurationFQDNListBuilderApi.md#get_policy_lists14) | **GET** /template/policy/list/fqdn | +[**get_policy_lists_with_info_tag16**](ConfigurationFQDNListBuilderApi.md#get_policy_lists_with_info_tag16) | **GET** /template/policy/list/fqdn/filtered | +[**preview_policy_list16**](ConfigurationFQDNListBuilderApi.md#preview_policy_list16) | **POST** /template/policy/list/fqdn/preview | +[**preview_policy_list_by_id16**](ConfigurationFQDNListBuilderApi.md#preview_policy_list_by_id16) | **GET** /template/policy/list/fqdn/preview/{id} | + + +# **create_policy_list16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list16() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->create_policy_list16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list16** +> delete_policy_list16(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list16(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->delete_policy_list16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag16** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag16() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag16(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->delete_policy_lists_with_info_tag16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list16(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->edit_policy_list16: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list16(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->edit_policy_list16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id16(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->get_lists_by_id16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists14** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists14() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists14() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->get_policy_lists14: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag16** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag16() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag16(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->get_policy_lists_with_info_tag16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list16() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->preview_policy_list16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id16(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_fqdn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_fqdn_list_builder_api.ConfigurationFQDNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFQDNListBuilderApi->preview_policy_list_by_id16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationFeatureCertificateApi.md b/docs/ConfigurationFeatureCertificateApi.md new file mode 100644 index 0000000..0cfbb57 --- /dev/null +++ b/docs/ConfigurationFeatureCertificateApi.md @@ -0,0 +1,421 @@ +# openapi_client.ConfigurationFeatureCertificateApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**gen_device_csr**](ConfigurationFeatureCertificateApi.md#gen_device_csr) | **PUT** /featurecertificate/devicecsr | +[**get_device_certificate**](ConfigurationFeatureCertificateApi.md#get_device_certificate) | **GET** /featurecertificate/certificate | +[**get_device_csr**](ConfigurationFeatureCertificateApi.md#get_device_csr) | **GET** /featurecertificate/devicecsr | +[**get_feature_ca_state**](ConfigurationFeatureCertificateApi.md#get_feature_ca_state) | **GET** /featurecertificate/syslogconfig | +[**install_feature_certificate**](ConfigurationFeatureCertificateApi.md#install_feature_certificate) | **PUT** /featurecertificate/certificate | +[**revoke_feature_certificate**](ConfigurationFeatureCertificateApi.md#revoke_feature_certificate) | **PUT** /featurecertificate/revoke | + + +# **gen_device_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} gen_device_csr() + + + +Create CSR for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_certificate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_certificate_api.ConfigurationFeatureCertificateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | CSR request for cEdge (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.gen_device_csr(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureCertificateApi->gen_device_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| CSR request for cEdge | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_certificate(device_id) + + + +Get feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_certificate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_certificate_api.ConfigurationFeatureCertificateApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_certificate(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureCertificateApi->get_device_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_csr** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_csr(device_id) + + + +Get CSR from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_certificate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_certificate_api.ConfigurationFeatureCertificateApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_csr(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureCertificateApi->get_device_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_feature_ca_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_feature_ca_state() + + + +Get Feature CA state


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_certificate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_certificate_api.ConfigurationFeatureCertificateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_feature_ca_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureCertificateApi->get_feature_ca_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **install_feature_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} install_feature_certificate() + + + +Upload feature cert for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_certificate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_certificate_api.ConfigurationFeatureCertificateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Install feature cert request for cEdge (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.install_feature_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureCertificateApi->install_feature_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Install feature cert request for cEdge | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **revoke_feature_certificate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} revoke_feature_certificate() + + + +Revoke feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_certificate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_certificate_api.ConfigurationFeatureCertificateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Revoking feature cert request for cEdge (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.revoke_feature_certificate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureCertificateApi->revoke_feature_certificate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Revoking feature cert request for cEdge | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationFeatureProfileMobilityApi.md b/docs/ConfigurationFeatureProfileMobilityApi.md new file mode 100644 index 0000000..0fd6978 --- /dev/null +++ b/docs/ConfigurationFeatureProfileMobilityApi.md @@ -0,0 +1,2742 @@ +# openapi_client.ConfigurationFeatureProfileMobilityApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_basic_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_basic_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/basic | +[**create_cellular_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_cellular_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/cellular | +[**create_ethernet_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_ethernet_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/ethernet | +[**create_network_protocol_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_network_protocol_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/networkProtocol | +[**create_security_policy_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_security_policy_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/securityPolicy | +[**create_vpn_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_vpn_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/vpn | +[**create_wifi_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#create_wifi_profile_parcel_for_mobility) | **POST** /v1/feature-profile/mobility/global/{profileId}/wifi | +[**delete_a_cellular_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#delete_a_cellular_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId} | +[**delete_a_vpn_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#delete_a_vpn_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId} | +[**delete_basic_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#delete_basic_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/basic/{parcelId} | +[**delete_ethernet_profile_parcel_for_system**](ConfigurationFeatureProfileMobilityApi.md#delete_ethernet_profile_parcel_for_system) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId} | +[**delete_network_protocol_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#delete_network_protocol_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId} | +[**delete_security_policy_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#delete_security_policy_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId} | +[**delete_wifi_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#delete_wifi_profile_parcel_for_mobility) | **DELETE** /v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId} | +[**edit_basic_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#edit_basic_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/basic/{parcelId} | +[**edit_cellular_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#edit_cellular_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId} | +[**edit_ethernet_profile_parcel_for_system**](ConfigurationFeatureProfileMobilityApi.md#edit_ethernet_profile_parcel_for_system) | **PUT** /v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId} | +[**edit_network_protocol_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#edit_network_protocol_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId} | +[**edit_security_policy_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#edit_security_policy_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId} | +[**edit_vpn_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#edit_vpn_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId} | +[**edit_wifi_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#edit_wifi_profile_parcel_for_mobility) | **PUT** /v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId} | +[**get_basic_profile_parcel_by_parcel_id_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_basic_profile_parcel_by_parcel_id_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/basic/{parcelId} | +[**get_basic_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_basic_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/basic | +[**get_cellular_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_cellular_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId} | +[**get_cellular_profile_parcel_list_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_cellular_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/cellular | +[**get_ethernet_profile_parcel**](ConfigurationFeatureProfileMobilityApi.md#get_ethernet_profile_parcel) | **GET** /v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId} | +[**get_ethernet_profile_parcels**](ConfigurationFeatureProfileMobilityApi.md#get_ethernet_profile_parcels) | **GET** /v1/feature-profile/mobility/global/{profileId}/ethernet | +[**get_mobility_feature_profile_by_global_id**](ConfigurationFeatureProfileMobilityApi.md#get_mobility_feature_profile_by_global_id) | **GET** /v1/feature-profile/mobility/global/{profileId} | +[**get_mobility_global_basic_parcel_schema_by_schema_type**](ConfigurationFeatureProfileMobilityApi.md#get_mobility_global_basic_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/mobility/global/basic/schema | +[**get_network_protocol_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_network_protocol_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId} | +[**get_network_protocol_profile_parcel_list_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_network_protocol_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/networkProtocol | +[**get_security_policy_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_security_policy_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId} | +[**get_security_policy_profile_parcel_list_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_security_policy_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/securityPolicy | +[**get_vpn_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_vpn_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId} | +[**get_vpn_profile_parcel_list_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_vpn_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/vpn | +[**get_wifi_profile_parcel_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_wifi_profile_parcel_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId} | +[**get_wifi_profile_parcel_list_for_mobility**](ConfigurationFeatureProfileMobilityApi.md#get_wifi_profile_parcel_list_for_mobility) | **GET** /v1/feature-profile/mobility/global/{profileId}/wifi | + + +# **create_basic_profile_parcel_for_mobility** +> str create_basic_profile_parcel_for_mobility(profile_id) + + + +Create a Basic Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Basic Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_basic_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_basic_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_basic_profile_parcel_for_mobility(profile_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_basic_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Basic Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cellular_profile_parcel_for_mobility** +> str create_cellular_profile_parcel_for_mobility(profile_id) + + + +Create an cellular Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.cellular_profile import CellularProfile +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + cellular_profile = CellularProfile( + apn="apn_example", + auth_method="chap", + id=1, + password="password_example", + pdn_type="IPv4v6", + user_name="user_name_example", + ) # CellularProfile | Cellular Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cellular_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_cellular_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cellular_profile_parcel_for_mobility(profile_id, cellular_profile=cellular_profile) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_cellular_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **cellular_profile** | [**CellularProfile**](CellularProfile.md)| Cellular Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ethernet_profile_parcel_for_mobility** +> str create_ethernet_profile_parcel_for_mobility(profile_id) + + + +Create an ethernet Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.ethernet import Ethernet +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + ethernet = Ethernet() # Ethernet | Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ethernet_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_ethernet_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ethernet_profile_parcel_for_mobility(profile_id, ethernet=ethernet) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_ethernet_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **ethernet** | [**Ethernet**](Ethernet.md)| Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_network_protocol_profile_parcel_for_mobility** +> str create_network_protocol_profile_parcel_for_mobility(profile_id) + + + +Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.network_protocol import NetworkProtocol +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + network_protocol = NetworkProtocol() # NetworkProtocol | NetworkProtocol Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_network_protocol_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_network_protocol_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol=network_protocol) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_network_protocol_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **network_protocol** | [**NetworkProtocol**](NetworkProtocol.md)| NetworkProtocol Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_security_policy_profile_parcel_for_mobility** +> str create_security_policy_profile_parcel_for_mobility(profile_id) + + + +Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.security_policy import SecurityPolicy +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + security_policy = SecurityPolicy() # SecurityPolicy | SecurityPolicy Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_security_policy_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_security_policy_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_security_policy_profile_parcel_for_mobility(profile_id, security_policy=security_policy) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_security_policy_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **security_policy** | [**SecurityPolicy**](SecurityPolicy.md)| SecurityPolicy Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_vpn_profile_parcel_for_mobility** +> str create_vpn_profile_parcel_for_mobility(profile_id) + + + +Create an Vpn Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.vpn import Vpn +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + vpn = Vpn() # Vpn | Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_vpn_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_vpn_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_vpn_profile_parcel_for_mobility(profile_id, vpn=vpn) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_vpn_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **vpn** | [**Vpn**](Vpn.md)| Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wifi_profile_parcel_for_mobility** +> str create_wifi_profile_parcel_for_mobility(profile_id) + + + +Create an Wifi Profile Parcel for Mobility feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.wifi import Wifi +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + wifi = Wifi() # Wifi | Wifi Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wifi_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_wifi_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wifi_profile_parcel_for_mobility(profile_id, wifi=wifi) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->create_wifi_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **wifi** | [**Wifi**](Wifi.md)| Wifi Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_a_cellular_profile_parcel_for_mobility** +> delete_a_cellular_profile_parcel_for_mobility(profile_id, cellular_id) + + + +Delete a Cellular Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + cellular_id = "cellularId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_a_cellular_profile_parcel_for_mobility(profile_id, cellular_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_a_cellular_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **cellular_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_a_vpn_profile_parcel_for_mobility** +> delete_a_vpn_profile_parcel_for_mobility(profile_id, vpn_id) + + + +Delete a Vpn Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_a_vpn_profile_parcel_for_mobility(profile_id, vpn_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_a_vpn_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_basic_profile_parcel_for_mobility** +> delete_basic_profile_parcel_for_mobility(profile_id, parcel_id) + + + +Delete a Basic Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + parcel_id = "parcelId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_basic_profile_parcel_for_mobility(profile_id, parcel_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_basic_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **parcel_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_ethernet_profile_parcel_for_system** +> delete_ethernet_profile_parcel_for_system(profile_id, ethernet_id) + + + +Delete a Ethernet Profile Parcel for feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + ethernet_id = "ethernetId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_ethernet_profile_parcel_for_system(profile_id, ethernet_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_ethernet_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **ethernet_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_network_protocol_profile_parcel_for_mobility** +> delete_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id) + + + +Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + network_protocol_id = "networkProtocolId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_network_protocol_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **network_protocol_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_security_policy_profile_parcel_for_mobility** +> delete_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id) + + + +Delete a Security Policy Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + security_policy_id = "securityPolicyId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_security_policy_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **security_policy_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wifi_profile_parcel_for_mobility** +> delete_wifi_profile_parcel_for_mobility(profile_id, wifi_id) + + + +Delete an Wifi Profile Parcel for Mobility feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + wifi_id = "wifiId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wifi_profile_parcel_for_mobility(profile_id, wifi_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->delete_wifi_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **wifi_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_basic_profile_parcel_for_mobility** +> str edit_basic_profile_parcel_for_mobility(profile_id, parcel_id) + + + +Update a Basic Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + parcel_id = "parcelId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Basic Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_basic_profile_parcel_for_mobility(profile_id, parcel_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_basic_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_basic_profile_parcel_for_mobility(profile_id, parcel_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_basic_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **parcel_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Basic Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_cellular_profile_parcel_for_mobility** +> edit_cellular_profile_parcel_for_mobility(profile_id, cellular_id) + + + +Edit an Cellular Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.cellular import Cellular +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + cellular_id = "cellularId_example" # str | Profile Parcel ID + cellular = Cellular() # Cellular | Cellular Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_cellular_profile_parcel_for_mobility(profile_id, cellular_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_cellular_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_cellular_profile_parcel_for_mobility(profile_id, cellular_id, cellular=cellular) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_cellular_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **cellular_id** | **str**| Profile Parcel ID | + **cellular** | [**Cellular**](Cellular.md)| Cellular Profile Parcel | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_ethernet_profile_parcel_for_system** +> edit_ethernet_profile_parcel_for_system(profile_id, ethernet_id) + + + +Update a Ethernet Profile Parcel for feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + ethernet_id = "ethernetId_example" # str | Profile Parcel ID + body = "{"type":"ethernet","ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","wanConfiguration":"Active","portType":"WAN","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"3.3.3.3"},{"interfaceName":"GigabitEthernet0/1","adminState":"enabled"},{"interfaceName":"GigabitEthernet0/2","adminState":"disabled"}]}" # str | Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_ethernet_profile_parcel_for_system(profile_id, ethernet_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_ethernet_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_ethernet_profile_parcel_for_system(profile_id, ethernet_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_ethernet_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **ethernet_id** | **str**| Profile Parcel ID | + **body** | **str**| Ethernet Profile Parcel | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_network_protocol_profile_parcel_for_mobility** +> edit_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id) + + + +Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.network_protocol import NetworkProtocol +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + network_protocol_id = "networkProtocolId_example" # str | Profile Parcel ID + network_protocol = NetworkProtocol() # NetworkProtocol | Network Protocol Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_network_protocol_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id, network_protocol=network_protocol) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_network_protocol_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **network_protocol_id** | **str**| Profile Parcel ID | + **network_protocol** | [**NetworkProtocol**](NetworkProtocol.md)| Network Protocol Profile Parcel | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_security_policy_profile_parcel_for_mobility** +> edit_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id) + + + +Edit an Security Policy Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.security_policy import SecurityPolicy +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + security_policy_id = "securityPolicyId_example" # str | Profile Parcel ID + security_policy = SecurityPolicy() # SecurityPolicy | Security Policy Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_security_policy_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id, security_policy=security_policy) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_security_policy_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **security_policy_id** | **str**| Profile Parcel ID | + **security_policy** | [**SecurityPolicy**](SecurityPolicy.md)| Security Policy Profile Parcel | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_vpn_profile_parcel_for_mobility** +> edit_vpn_profile_parcel_for_mobility(profile_id, vpn_id) + + + +Edit an Vpn Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.vpn import Vpn +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + vpn = Vpn() # Vpn | Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_vpn_profile_parcel_for_mobility(profile_id, vpn_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_vpn_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_vpn_profile_parcel_for_mobility(profile_id, vpn_id, vpn=vpn) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_vpn_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **vpn** | [**Vpn**](Vpn.md)| Vpn Profile Parcel | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wifi_profile_parcel_for_mobility** +> edit_wifi_profile_parcel_for_mobility(profile_id, wifi_id) + + + +Edit an Wifi Profile Parcel for Mobility feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from openapi_client.model.wifi import Wifi +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + wifi_id = "wifiId_example" # str | Profile Parcel ID + wifi = Wifi() # Wifi | Wifi Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_wifi_profile_parcel_for_mobility(profile_id, wifi_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_wifi_profile_parcel_for_mobility: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_wifi_profile_parcel_for_mobility(profile_id, wifi_id, wifi=wifi) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->edit_wifi_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **wifi_id** | **str**| Profile Parcel ID | + **wifi** | [**Wifi**](Wifi.md)| Wifi Profile Parcel | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_basic_profile_parcel_by_parcel_id_for_mobility** +> str get_basic_profile_parcel_by_parcel_id_for_mobility(profile_id, parcel_id) + + + +Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + parcel_id = "parcelId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_basic_profile_parcel_by_parcel_id_for_mobility(profile_id, parcel_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_basic_profile_parcel_by_parcel_id_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **parcel_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_basic_profile_parcel_for_mobility** +> str get_basic_profile_parcel_for_mobility(profile_id) + + + +Get Basic Profile Parcels for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_basic_profile_parcel_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_basic_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_profile_parcel_for_mobility** +> str get_cellular_profile_parcel_for_mobility(profile_id, cellular_id) + + + +Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + cellular_id = "cellularId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_profile_parcel_for_mobility(profile_id, cellular_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_cellular_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **cellular_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_profile_parcel_list_for_mobility** +> str get_cellular_profile_parcel_list_for_mobility(profile_id) + + + +Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_profile_parcel_list_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_cellular_profile_parcel_list_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ethernet_profile_parcel** +> str get_ethernet_profile_parcel(profile_id, ethernet_id) + + + +Get Ethernet Profile Parcels for feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + ethernet_id = "ethernetId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ethernet_profile_parcel(profile_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_ethernet_profile_parcel: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **ethernet_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ethernet_profile_parcels** +> str get_ethernet_profile_parcels(profile_id) + + + +Get Ethernet Profile Parcels for feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ethernet_profile_parcels(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_ethernet_profile_parcels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mobility_feature_profile_by_global_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mobility_feature_profile_by_global_id(profile_id) + + + +Get a Mobility Global Feature Profile by profileId + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mobility_feature_profile_by_global_id(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_mobility_feature_profile_by_global_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mobility_global_basic_parcel_schema_by_schema_type** +> str get_mobility_global_basic_parcel_schema_by_schema_type(schema_type) + + + +Get a Mobility Global Basic Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mobility_global_basic_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_mobility_global_basic_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_network_protocol_profile_parcel_for_mobility** +> str get_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id) + + + +Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + network_protocol_id = "networkProtocolId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_network_protocol_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **network_protocol_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_network_protocol_profile_parcel_list_for_mobility** +> str get_network_protocol_profile_parcel_list_for_mobility(profile_id) + + + +Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_network_protocol_profile_parcel_list_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_network_protocol_profile_parcel_list_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_security_policy_profile_parcel_for_mobility** +> str get_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id) + + + +Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + security_policy_id = "securityPolicyId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_security_policy_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **security_policy_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_security_policy_profile_parcel_list_for_mobility** +> str get_security_policy_profile_parcel_list_for_mobility(profile_id) + + + +Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_security_policy_profile_parcel_list_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_security_policy_profile_parcel_list_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpn_profile_parcel_for_mobility** +> str get_vpn_profile_parcel_for_mobility(profile_id, vpn_id) + + + +Get an Mobility Vpn Profile Parcel for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vpn_profile_parcel_for_mobility(profile_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_vpn_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpn_profile_parcel_list_for_mobility** +> str get_vpn_profile_parcel_list_for_mobility(profile_id) + + + +Get an Mobility Vpn Profile Parcel list for Mobility Global Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vpn_profile_parcel_list_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_vpn_profile_parcel_list_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wifi_profile_parcel_for_mobility** +> str get_wifi_profile_parcel_for_mobility(profile_id, wifi_id) + + + +Get an Wifi Profile Parcel for Mobility feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + wifi_id = "wifiId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wifi_profile_parcel_for_mobility(profile_id, wifi_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_wifi_profile_parcel_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + **wifi_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wifi_profile_parcel_list_for_mobility** +> str get_wifi_profile_parcel_list_for_mobility(profile_id) + + + +Get Wifi Profile Parcel List for Mobility feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_mobility_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_mobility_api.ConfigurationFeatureProfileMobilityApi(api_client) + profile_id = "profileId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wifi_profile_parcel_list_for_mobility(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileMobilityApi->get_wifi_profile_parcel_list_for_mobility: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationFeatureProfileSDWANApi.md b/docs/ConfigurationFeatureProfileSDWANApi.md new file mode 100644 index 0000000..932acb4 --- /dev/null +++ b/docs/ConfigurationFeatureProfileSDWANApi.md @@ -0,0 +1,17223 @@ +# openapi_client.ConfigurationFeatureProfileSDWANApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cedge_service_profile_switchport_parcel_restful_resource**](ConfigurationFeatureProfileSDWANApi.md#cedge_service_profile_switchport_parcel_restful_resource) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/switchport | +[**create_aaa_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_aaa_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/aaa | +[**create_banner_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_banner_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/banner | +[**create_basic_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_basic_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/basic | +[**create_bfd_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_bfd_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/bfd | +[**create_cellular_controller_and_cellular_profile_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_cellular_controller_and_cellular_profile_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile | +[**create_cellular_controller_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_cellular_controller_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller | +[**create_cellular_profile_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_cellular_profile_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile | +[**create_dhcp_server_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_dhcp_server_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server | +[**create_global_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_global_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/global | +[**create_lan_vpn_and_routing_bgp_parcel_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_and_routing_bgp_parcel_association_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp | +[**create_lan_vpn_and_routing_ospf_parcel_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_and_routing_ospf_parcel_association_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf | +[**create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server | +[**create_lan_vpn_interface_ethernet_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_ethernet_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet | +[**create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server | +[**create_lan_vpn_interface_svi_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_interface_svi_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi | +[**create_lan_vpn_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_lan_vpn_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn | +[**create_logging_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_logging_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/logging | +[**create_management_vpn_interface_ethernet_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_management_vpn_interface_ethernet_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet | +[**create_management_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_management_vpn_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn | +[**create_ntp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_ntp_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/ntp | +[**create_omp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_omp_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/omp | +[**create_routing_bgp_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_routing_bgp_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp | +[**create_routing_bgp_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_routing_bgp_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp | +[**create_routing_ospf_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_routing_ospf_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf | +[**create_sdwan_config_profile_parcel_for_cli**](ConfigurationFeatureProfileSDWANApi.md#create_sdwan_config_profile_parcel_for_cli) | **POST** /v1/feature-profile/sdwan/cli/{cliId}/config | +[**create_sdwan_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#create_sdwan_feature_profile) | **POST** /v1/feature-profile/sdwan/cli | +[**create_sdwan_other_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#create_sdwan_other_feature_profile) | **POST** /v1/feature-profile/sdwan/other | +[**create_sdwan_service_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#create_sdwan_service_feature_profile) | **POST** /v1/feature-profile/sdwan/service | +[**create_sdwan_system_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#create_sdwan_system_feature_profile) | **POST** /v1/feature-profile/sdwan/system | +[**create_sdwan_transport_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#create_sdwan_transport_feature_profile) | **POST** /v1/feature-profile/sdwan/transport | +[**create_snmp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#create_snmp_profile_parcel_for_system) | **POST** /v1/feature-profile/sdwan/system/{systemId}/snmp | +[**create_thousandeyes_profile_parcel_for_other**](ConfigurationFeatureProfileSDWANApi.md#create_thousandeyes_profile_parcel_for_other) | **POST** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes | +[**create_tracker_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_tracker_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/tracker | +[**create_wan_vpn_and_routing_bgp_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_and_routing_bgp_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp | +[**create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker | +[**create_wan_vpn_interface_cellular_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_cellular_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular | +[**create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker | +[**create_wan_vpn_interface_ethernet_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_interface_ethernet_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet | +[**create_wan_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#create_wan_vpn_profile_parcel_for_transport) | **POST** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn | +[**create_wirelesslan_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#create_wirelesslan_profile_parcel_for_service) | **POST** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan | +[**delete_aaa_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_aaa_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId} | +[**delete_banner_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_banner_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId} | +[**delete_basic_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_basic_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/basic/{basicId} | +[**delete_bfd_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_bfd_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId} | +[**delete_cellular_controller_and_cellular_profile_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_cellular_controller_and_cellular_profile_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId} | +[**delete_cellular_controller_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_cellular_controller_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId} | +[**delete_cellular_profile_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_cellular_profile_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId} | +[**delete_config_profile_parcel_for_cli**](ConfigurationFeatureProfileSDWANApi.md#delete_config_profile_parcel_for_cli) | **DELETE** /v1/feature-profile/sdwan/cli/{cliId}/config/{configId} | +[**delete_dhcp_server_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_dhcp_server_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId} | +[**delete_global_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_global_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/global/{globalId} | +[**delete_lan_vpn_and_routing_bgp_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_and_routing_bgp_association_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId} | +[**delete_lan_vpn_and_routing_ospf_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_and_routing_ospf_association_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId} | +[**delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId} | +[**delete_lan_vpn_interface_ethernet_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_ethernet_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId} | +[**delete_lan_vpn_interface_svi_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_interface_svi_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId} | +[**delete_lan_vpn_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_lan_vpn_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId} | +[**delete_logging_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_logging_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId} | +[**delete_management_vpn_interface_ethernet_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_management_vpn_interface_ethernet_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**delete_management_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_management_vpn_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId} | +[**delete_ntp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_ntp_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId} | +[**delete_omp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_omp_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/omp/{ompId} | +[**delete_routing_bgp_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_routing_bgp_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId} | +[**delete_routing_bgp_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_routing_bgp_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId} | +[**delete_routing_ospf_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_routing_ospf_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId} | +[**delete_sdwan_feature_profile_for_cli**](ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_feature_profile_for_cli) | **DELETE** /v1/feature-profile/sdwan/cli/{cliId} | +[**delete_sdwan_other_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_other_feature_profile) | **DELETE** /v1/feature-profile/sdwan/other/{otherId} | +[**delete_sdwan_service_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_service_feature_profile) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId} | +[**delete_sdwan_system_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_system_feature_profile) | **DELETE** /v1/feature-profile/sdwan/system/{systemId} | +[**delete_sdwan_transport_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#delete_sdwan_transport_feature_profile) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId} | +[**delete_snmp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#delete_snmp_profile_parcel_for_system) | **DELETE** /v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId} | +[**delete_switchport_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_switchport_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId} | +[**delete_thousandeyes_profile_parcel_for_other**](ConfigurationFeatureProfileSDWANApi.md#delete_thousandeyes_profile_parcel_for_other) | **DELETE** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId} | +[**delete_tracker_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_tracker_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId} | +[**delete_wan_vpn_and_routing_bgp_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_and_routing_bgp_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId} | +[**delete_wan_vpn_interface_cellular_and_tracker_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_cellular_and_tracker_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId} | +[**delete_wan_vpn_interface_cellular_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_cellular_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId} | +[**delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId} | +[**delete_wan_vpn_interface_ethernet_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_interface_ethernet_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**delete_wan_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#delete_wan_vpn_profile_parcel_for_transport) | **DELETE** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId} | +[**delete_wirelesslan_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#delete_wirelesslan_profile_parcel_for_service) | **DELETE** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId} | +[**edit_aaa_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_aaa_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId} | +[**edit_banner_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_banner_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId} | +[**edit_basic_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_basic_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/basic/{basicId} | +[**edit_bfd_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_bfd_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId} | +[**edit_cellular_controller_and_cellular_profile_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_cellular_controller_and_cellular_profile_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId} | +[**edit_cellular_controller_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_cellular_controller_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId} | +[**edit_cellular_profile_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_cellular_profile_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId} | +[**edit_config_profile_parcel_for_cli**](ConfigurationFeatureProfileSDWANApi.md#edit_config_profile_parcel_for_cli) | **PUT** /v1/feature-profile/sdwan/cli/{cliId}/config/{configId} | +[**edit_dhcp_server_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_dhcp_server_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId} | +[**edit_global_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_global_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/global/{globalId} | +[**edit_lan_vpn_and_routing_bgp_parcel_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_and_routing_bgp_parcel_association_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId} | +[**edit_lan_vpn_and_routing_ospf_parcel_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_and_routing_ospf_parcel_association_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId} | +[**edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId} | +[**edit_lan_vpn_interface_ethernet_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_ethernet_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId} | +[**edit_lan_vpn_interface_svi_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_interface_svi_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId} | +[**edit_lan_vpn_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_lan_vpn_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId} | +[**edit_logging_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_logging_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId} | +[**edit_management_vpn_interface_ethernet_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_management_vpn_interface_ethernet_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**edit_management_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_management_vpn_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId} | +[**edit_ntp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_ntp_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId} | +[**edit_omp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_omp_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/omp/{ompId} | +[**edit_routing_bgp_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_routing_bgp_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId} | +[**edit_routing_bgp_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_routing_bgp_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId} | +[**edit_routing_ospf_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_routing_ospf_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId} | +[**edit_sdwan_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_feature_profile) | **PUT** /v1/feature-profile/sdwan/cli/{cliId} | +[**edit_sdwan_other_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_other_feature_profile) | **PUT** /v1/feature-profile/sdwan/other/{otherId} | +[**edit_sdwan_service_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_service_feature_profile) | **PUT** /v1/feature-profile/sdwan/service/{serviceId} | +[**edit_sdwan_system_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_system_feature_profile) | **PUT** /v1/feature-profile/sdwan/system/{systemId} | +[**edit_sdwan_transport_feature_profile**](ConfigurationFeatureProfileSDWANApi.md#edit_sdwan_transport_feature_profile) | **PUT** /v1/feature-profile/sdwan/transport/{transportId} | +[**edit_snmp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#edit_snmp_profile_parcel_for_system) | **PUT** /v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId} | +[**edit_switchport_parcel_association_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_switchport_parcel_association_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId} | +[**edit_thousandeyes_profile_parcel_for_other**](ConfigurationFeatureProfileSDWANApi.md#edit_thousandeyes_profile_parcel_for_other) | **PUT** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId} | +[**edit_tracker_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_tracker_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId} | +[**edit_wan_vpn_and_routing_bgp_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_and_routing_bgp_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId} | +[**edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId} | +[**edit_wan_vpn_interface_cellular_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_cellular_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId} | +[**edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId} | +[**edit_wan_vpn_interface_ethernet_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_interface_ethernet_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**edit_wan_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#edit_wan_vpn_profile_parcel_for_transport) | **PUT** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId} | +[**edit_wirelesslan_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#edit_wirelesslan_profile_parcel_for_service) | **PUT** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId} | +[**get_aaa_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_aaa_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId} | +[**get_aaa_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_aaa_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/aaa | +[**get_banner_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_banner_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId} | +[**get_banner_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_banner_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/banner | +[**get_basic_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_basic_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/basic/{basicId} | +[**get_basic_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_basic_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/basic | +[**get_bfd_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_bfd_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId} | +[**get_bfd_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_bfd_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/bfd | +[**get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema**](ConfigurationFeatureProfileSDWANApi.md#get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema | +[**get_cedge_service_switchport_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_cedge_service_switchport_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/switchport/schema | +[**get_cedge_system_global_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_cedge_system_global_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/global/schema | +[**get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId} | +[**get_cellular_controller_associated_cellular_profile_parcels_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_associated_cellular_profile_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile | +[**get_cellular_controller_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId} | +[**get_cellular_controller_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_cellular_controller_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-controller | +[**get_cellular_profile_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_cellular_profile_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId} | +[**get_cellular_profile_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_cellular_profile_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/cellular-profile | +[**get_config_profile_parcel_by_parcel_id_for_cli**](ConfigurationFeatureProfileSDWANApi.md#get_config_profile_parcel_by_parcel_id_for_cli) | **GET** /v1/feature-profile/sdwan/cli/{cliId}/config/{configId} | +[**get_config_profile_parcel_for_cli**](ConfigurationFeatureProfileSDWANApi.md#get_config_profile_parcel_for_cli) | **GET** /v1/feature-profile/sdwan/cli/{cliId}/config | +[**get_dhcp_server_profile_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_dhcp_server_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId} | +[**get_dhcp_server_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_dhcp_server_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/dhcp-server | +[**get_global_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_global_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/global/{globalId} | +[**get_global_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_global_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/global | +[**get_interface_cellular_parcels_for_transport_wan_vpn**](ConfigurationFeatureProfileSDWANApi.md#get_interface_cellular_parcels_for_transport_wan_vpn) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular | +[**get_interface_ethernet_parcels_for_service_lan_vpn**](ConfigurationFeatureProfileSDWANApi.md#get_interface_ethernet_parcels_for_service_lan_vpn) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet | +[**get_interface_ethernet_parcels_for_transport_management_vpn**](ConfigurationFeatureProfileSDWANApi.md#get_interface_ethernet_parcels_for_transport_management_vpn) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet | +[**get_interface_ethernet_parcels_for_transport_wan_vpn**](ConfigurationFeatureProfileSDWANApi.md#get_interface_ethernet_parcels_for_transport_wan_vpn) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet | +[**get_interface_svi_parcels_for_service_lan_vpn**](ConfigurationFeatureProfileSDWANApi.md#get_interface_svi_parcels_for_service_lan_vpn) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi | +[**get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId} | +[**get_lan_vpn_associated_routing_bgp_parcels_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_bgp_parcels_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp | +[**get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId} | +[**get_lan_vpn_associated_routing_ospf_parcels_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_associated_routing_ospf_parcels_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf | +[**get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId} | +[**get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server | +[**get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId} | +[**get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server | +[**get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId} | +[**get_lan_vpn_profile_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId} | +[**get_lan_vpn_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_lan_vpn_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/lan/vpn | +[**get_logging_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_logging_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId} | +[**get_logging_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_logging_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/logging | +[**get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**get_management_vpn_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_management_vpn_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId} | +[**get_management_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_management_vpn_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/management/vpn | +[**get_ntp_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_ntp_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId} | +[**get_ntp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_ntp_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/ntp | +[**get_omp_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_omp_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/omp/{ompId} | +[**get_omp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_omp_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/omp | +[**get_routing_bgp_profile_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId} | +[**get_routing_bgp_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId} | +[**get_routing_bgp_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/bgp | +[**get_routing_bgp_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_routing_bgp_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/routing/bgp | +[**get_routing_ospf_profile_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_routing_ospf_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId} | +[**get_routing_ospf_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_routing_ospf_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/routing/ospf | +[**get_sdwan_feature_profile_by_profile_id**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/cli/{cliId} | +[**get_sdwan_feature_profile_by_sdwan_family**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_feature_profile_by_sdwan_family) | **GET** /v1/feature-profile/sdwan | +[**get_sdwan_feature_profiles_by_family_and_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_feature_profiles_by_family_and_type) | **GET** /v1/feature-profile/sdwan/cli | +[**get_sdwan_other_feature_profile_by_profile_id**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_other_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/other/{otherId} | +[**get_sdwan_other_feature_profiles**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_other_feature_profiles) | **GET** /v1/feature-profile/sdwan/other | +[**get_sdwan_other_thousandeyes_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_other_thousandeyes_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/other/thousandeyes/schema | +[**get_sdwan_service_dhcp_server_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_dhcp_server_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/dhcp-server/schema | +[**get_sdwan_service_feature_profile_by_profile_id**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/service/{serviceId} | +[**get_sdwan_service_feature_profiles**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_feature_profiles) | **GET** /v1/feature-profile/sdwan/service | +[**get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema | +[**get_sdwan_service_lan_vpn_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_lan_vpn_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/lan/vpn/schema | +[**get_sdwan_service_routing_bgp_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_routing_bgp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/routing/bgp/schema | +[**get_sdwan_service_routing_ospf_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_routing_ospf_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/routing/ospf/schema | +[**get_sdwan_service_wirelesslan_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_service_wirelesslan_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/service/wirelesslan/schema | +[**get_sdwan_system_aaa_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_aaa_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/aaa/schema | +[**get_sdwan_system_banner_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_banner_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/banner/schema | +[**get_sdwan_system_basic_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_basic_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/basic/schema | +[**get_sdwan_system_bfd_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_bfd_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/bfd/schema | +[**get_sdwan_system_feature_profile_by_profile_id**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/system/{systemId} | +[**get_sdwan_system_feature_profiles**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_feature_profiles) | **GET** /v1/feature-profile/sdwan/system | +[**get_sdwan_system_logging_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_logging_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/logging/schema | +[**get_sdwan_system_ntp_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_ntp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/ntp/schema | +[**get_sdwan_system_omp_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_omp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/omp/schema | +[**get_sdwan_system_snmp_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_system_snmp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/system/snmp/schema | +[**get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/cellular-controller/schema | +[**get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/cellular-profile/schema | +[**get_sdwan_transport_feature_profile_by_profile_id**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_feature_profile_by_profile_id) | **GET** /v1/feature-profile/sdwan/transport/{transportId} | +[**get_sdwan_transport_feature_profiles**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_feature_profiles) | **GET** /v1/feature-profile/sdwan/transport | +[**get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema | +[**get_sdwan_transport_management_vpn_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_management_vpn_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/management/vpn/schema | +[**get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/routing/bgp/schema | +[**get_sdwan_transport_tracker_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_tracker_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/tracker/schema | +[**get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema | +[**get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema) | **GET** /v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema | +[**get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type**](ConfigurationFeatureProfileSDWANApi.md#get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type) | **GET** /v1/feature-profile/sdwan/transport/wan/vpn/schema | +[**get_snmp_profile_parcel_by_parcel_id_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_snmp_profile_parcel_by_parcel_id_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId} | +[**get_snmp_profile_parcel_for_system**](ConfigurationFeatureProfileSDWANApi.md#get_snmp_profile_parcel_for_system) | **GET** /v1/feature-profile/sdwan/system/{systemId}/snmp | +[**get_switchport_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_switchport_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId} | +[**get_switchport_parcels_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_switchport_parcels_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/switchport | +[**get_thousandeyes_profile_parcel_by_parcel_id_for_other**](ConfigurationFeatureProfileSDWANApi.md#get_thousandeyes_profile_parcel_by_parcel_id_for_other) | **GET** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId} | +[**get_thousandeyes_profile_parcel_for_other**](ConfigurationFeatureProfileSDWANApi.md#get_thousandeyes_profile_parcel_for_other) | **GET** /v1/feature-profile/sdwan/other/{otherId}/thousandeyes | +[**get_tracker_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_tracker_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId} | +[**get_tracker_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_tracker_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/tracker | +[**get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId} | +[**get_wan_vpn_associated_routing_bgp_parcels_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_associated_routing_bgp_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp | +[**get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId} | +[**get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker | +[**get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId} | +[**get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId} | +[**get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker | +[**get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId} | +[**get_wan_vpn_profile_parcel_by_parcel_id_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_profile_parcel_by_parcel_id_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId} | +[**get_wan_vpn_profile_parcel_for_transport**](ConfigurationFeatureProfileSDWANApi.md#get_wan_vpn_profile_parcel_for_transport) | **GET** /v1/feature-profile/sdwan/transport/{transportId}/wan/vpn | +[**get_wirelesslan_profile_parcel_by_parcel_id_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_wirelesslan_profile_parcel_by_parcel_id_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId} | +[**get_wirelesslan_profile_parcel_for_service**](ConfigurationFeatureProfileSDWANApi.md#get_wirelesslan_profile_parcel_for_service) | **GET** /v1/feature-profile/sdwan/service/{serviceId}/wirelesslan | + + +# **cedge_service_profile_switchport_parcel_restful_resource** +> str cedge_service_profile_switchport_parcel_restful_resource(service_id) + + + +Create a switchport Parcel to a service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Feature Profile Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.cedge_service_profile_switchport_parcel_restful_resource(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->cedge_service_profile_switchport_parcel_restful_resource: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.cedge_service_profile_switchport_parcel_restful_resource(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->cedge_service_profile_switchport_parcel_restful_resource: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Feature Profile Id | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_aaa_profile_parcel_for_system** +> str create_aaa_profile_parcel_for_system(system_id) + + + +Create a Aaa Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Aaa Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_aaa_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_aaa_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_aaa_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_aaa_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Aaa Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_banner_profile_parcel_for_system** +> str create_banner_profile_parcel_for_system(system_id) + + + +Create a Banner Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Banner Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_banner_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_banner_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_banner_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_banner_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Banner Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_basic_profile_parcel_for_system** +> str create_basic_profile_parcel_for_system(system_id) + + + +Create a Basic Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Basic Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_basic_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_basic_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_basic_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_basic_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Basic Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_bfd_profile_parcel_for_system** +> str create_bfd_profile_parcel_for_system(system_id) + + + +Create a Bfd Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Bfd Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bfd_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_bfd_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_bfd_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_bfd_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Bfd Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cellular_controller_and_cellular_profile_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type create_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id) + + + +Associate a cellularcontroller parcel with a cellularprofile Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Cellular Controller Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Cellular Profile Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_cellular_controller_and_cellular_profile_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_cellular_controller_and_cellular_profile_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Cellular Controller Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Cellular Profile Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cellular_controller_profile_parcel_for_transport** +> str create_cellular_controller_profile_parcel_for_transport(transport_id) + + + +Create a Cellular Controller Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Cellular Controller Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cellular_controller_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_cellular_controller_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cellular_controller_profile_parcel_for_transport(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_cellular_controller_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Cellular Controller Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cellular_profile_profile_parcel_for_transport** +> str create_cellular_profile_profile_parcel_for_transport(transport_id) + + + +Create a Cellular Profile Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Cellular Profile Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cellular_profile_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_cellular_profile_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cellular_profile_profile_parcel_for_transport(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_cellular_profile_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Cellular Profile Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dhcp_server_profile_parcel_for_service** +> str create_dhcp_server_profile_parcel_for_service(service_id) + + + +Create a Dhcp Server Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Dhcp Server Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dhcp_server_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_dhcp_server_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dhcp_server_profile_parcel_for_service(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_dhcp_server_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Dhcp Server Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_global_profile_parcel_for_system** +> str create_global_profile_parcel_for_system(system_id) + + + +Create a Global Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Global Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_global_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_global_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_global_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_global_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Global Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_and_routing_bgp_parcel_association_for_service** +> bool, date, datetime, dict, float, int, list, str, none_type create_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id) + + + +Associate a lanvpn parcel with a routingbgp Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Lan Vpn Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_and_routing_bgp_parcel_association_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_and_routing_bgp_parcel_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Lan Vpn Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_and_routing_ospf_parcel_association_for_service** +> bool, date, datetime, dict, float, int, list, str, none_type create_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id) + + + +Associate a lanvpn parcel with a routingospf Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Lan Vpn Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Ospf Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_and_routing_ospf_parcel_association_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_and_routing_ospf_parcel_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Lan Vpn Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Ospf Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, ethernet_id) + + + +Associate a LanVpnInterfaceEthernet parcel with a DhcpServer Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_parcel_id = "vpnParcelId_example" # str | VPN Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | DhcpServer Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, ethernet_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_parcel_id** | **str**| VPN Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| DhcpServer Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_interface_ethernet_parcel_for_service** +> str create_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id) + + + +Create a LanVpn InterfaceEthernet parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Lan Vpn Interface Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_ethernet_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_ethernet_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Lan Vpn Interface Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, svi_id) + + + +Associate a LanVpnInterfaceSvi parcel with a DhcpServer Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_parcel_id = "vpnParcelId_example" # str | VPN Profile Parcel ID + svi_id = "sviId_example" # str | Interface Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | DhcpServer Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, svi_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, svi_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_parcel_id** | **str**| VPN Profile Parcel ID | + **svi_id** | **str**| Interface Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| DhcpServer Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_interface_svi_parcel_for_service** +> str create_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id) + + + +Create a LanVpn InterfaceSvi parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Lan Vpn Interface Svi Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_svi_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_interface_svi_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Lan Vpn Interface Svi Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lan_vpn_profile_parcel_for_service** +> str create_lan_vpn_profile_parcel_for_service(service_id) + + + +Create a Lan Vpn Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Lan Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_lan_vpn_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lan_vpn_profile_parcel_for_service(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_lan_vpn_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Lan Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_logging_profile_parcel_for_system** +> str create_logging_profile_parcel_for_system(system_id) + + + +Create a Logging Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Logging Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_logging_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_logging_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_logging_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_logging_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Logging Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_management_vpn_interface_ethernet_parcel_for_transport** +> str create_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id) + + + +Create a ManagementVpn InterfaceEthernet parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Management Vpn Interface Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_management_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_management_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Management Vpn Interface Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_management_vpn_profile_parcel_for_transport** +> str create_management_vpn_profile_parcel_for_transport(transport_id) + + + +Create a Management Vpn Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Management Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_management_vpn_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_management_vpn_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_management_vpn_profile_parcel_for_transport(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_management_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Management Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ntp_profile_parcel_for_system** +> str create_ntp_profile_parcel_for_system(system_id) + + + +Create a Ntp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Ntp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ntp_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_ntp_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ntp_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_ntp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Ntp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_profile_parcel_for_system** +> str create_omp_profile_parcel_for_system(system_id) + + + +Create a Omp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Omp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_omp_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_omp_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_omp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Omp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_routing_bgp_profile_parcel_for_service** +> str create_routing_bgp_profile_parcel_for_service(service_id) + + + +Create a Routing Bgp Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_routing_bgp_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_routing_bgp_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_routing_bgp_profile_parcel_for_service(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_routing_bgp_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_routing_bgp_profile_parcel_for_transport** +> str create_routing_bgp_profile_parcel_for_transport(transport_id) + + + +Create a Routing Bgp Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_routing_bgp_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_routing_bgp_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_routing_bgp_profile_parcel_for_transport(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_routing_bgp_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_routing_ospf_profile_parcel_for_service** +> str create_routing_ospf_profile_parcel_for_service(service_id) + + + +Create a Routing Ospf Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Ospf Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_routing_ospf_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_routing_ospf_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_routing_ospf_profile_parcel_for_service(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_routing_ospf_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Ospf Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sdwan_config_profile_parcel_for_cli** +> str create_sdwan_config_profile_parcel_for_cli(cli_id) + + + +Create a config Profile Parcel for cli feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | cli config Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_sdwan_config_profile_parcel_for_cli(cli_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_config_profile_parcel_for_cli: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sdwan_config_profile_parcel_for_cli(cli_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_config_profile_parcel_for_cli: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| cli config Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sdwan_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type create_sdwan_feature_profile() + + + +Create a SDWAN Feature Profile with profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sdwan_feature_profile(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sdwan_other_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type create_sdwan_other_feature_profile() + + + +Create a SDWAN Other Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sdwan_other_feature_profile(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_other_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sdwan_service_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type create_sdwan_service_feature_profile() + + + +Create a SDWAN Service Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sdwan_service_feature_profile(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_service_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sdwan_system_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type create_sdwan_system_feature_profile() + + + +Create a SDWAN System Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sdwan_system_feature_profile(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_system_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sdwan_transport_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type create_sdwan_transport_feature_profile() + + + +Create a SDWAN Transport Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sdwan_transport_feature_profile(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_sdwan_transport_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_snmp_profile_parcel_for_system** +> str create_snmp_profile_parcel_for_system(system_id) + + + +Create a Snmp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Snmp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_snmp_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_snmp_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_snmp_profile_parcel_for_system(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_snmp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Snmp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_thousandeyes_profile_parcel_for_other** +> str create_thousandeyes_profile_parcel_for_other(other_id) + + + +Create a Thousandeyes Profile Parcel for Other feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Thousandeyes Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_thousandeyes_profile_parcel_for_other(other_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_thousandeyes_profile_parcel_for_other: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_thousandeyes_profile_parcel_for_other(other_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_thousandeyes_profile_parcel_for_other: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Thousandeyes Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tracker_profile_parcel_for_transport** +> str create_tracker_profile_parcel_for_transport(transport_id) + + + +Create a Tracker Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Tracker Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_tracker_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_tracker_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tracker_profile_parcel_for_transport(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_tracker_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Tracker Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_vpn_and_routing_bgp_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type create_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id) + + + +Associate a wanvpn parcel with a routingbgp Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Wan Vpn Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_and_routing_bgp_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_and_routing_bgp_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Wan Vpn Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, cellular_id) + + + +Associate a WanVpnInterfaceCellular parcel with a Tracker Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_parcel_id = "vpnParcelId_example" # str | VPN Profile Parcel ID + cellular_id = "cellularId_example" # str | Interface Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Tracker Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, cellular_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, cellular_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_parcel_id** | **str**| VPN Profile Parcel ID | + **cellular_id** | **str**| Interface Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Tracker Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_vpn_interface_cellular_parcel_for_transport** +> str create_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id) + + + +Create a wanvpn Cellular interface Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | VPN Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | WanVpn Interface Cellular Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_cellular_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_cellular_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| VPN Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| WanVpn Interface Cellular Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, ethernet_id) + + + +Associate a WanVpnInterfaceEthernet parcel with a Tracker Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_parcel_id = "vpnParcelId_example" # str | VPN Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Tracker Profile Parcel Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, ethernet_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_parcel_id** | **str**| VPN Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Tracker Profile Parcel Id | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_vpn_interface_ethernet_parcel_for_transport** +> str create_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id) + + + +Create a WanVpn InterfaceEthernet parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Wan Vpn Interface Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Wan Vpn Interface Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_vpn_profile_parcel_for_transport** +> str create_wan_vpn_profile_parcel_for_transport(transport_id) + + + +Create a Wan Vpn Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Wan Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_vpn_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wan_vpn_profile_parcel_for_transport(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wan_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Wan Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wirelesslan_profile_parcel_for_service** +> str create_wirelesslan_profile_parcel_for_service(service_id) + + + +Create a Wirelesslan Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Wirelesslan Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wirelesslan_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wirelesslan_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_wirelesslan_profile_parcel_for_service(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->create_wirelesslan_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Wirelesslan Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_aaa_profile_parcel_for_system** +> delete_aaa_profile_parcel_for_system(system_id, aaa_id) + + + +Delete a Aaa Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + aaa_id = "aaaId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_aaa_profile_parcel_for_system(system_id, aaa_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_aaa_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **aaa_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_banner_profile_parcel_for_system** +> delete_banner_profile_parcel_for_system(system_id, banner_id) + + + +Delete a Banner Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + banner_id = "bannerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_banner_profile_parcel_for_system(system_id, banner_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_banner_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **banner_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_basic_profile_parcel_for_system** +> delete_basic_profile_parcel_for_system(system_id, basic_id) + + + +Delete a Basic Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + basic_id = "basicId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_basic_profile_parcel_for_system(system_id, basic_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_basic_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **basic_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_bfd_profile_parcel_for_system** +> delete_bfd_profile_parcel_for_system(system_id, bfd_id) + + + +Delete a Bfd Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + bfd_id = "bfdId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_bfd_profile_parcel_for_system(system_id, bfd_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_bfd_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **bfd_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_cellular_controller_and_cellular_profile_association_for_transport** +> delete_cellular_controller_and_cellular_profile_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id) + + + +Delete a CellularController parcel and a CellularProfile Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Profile Parcel ID + cellular_profile_id = "cellularProfileId_example" # str | Cellular Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_cellular_controller_and_cellular_profile_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_cellular_controller_and_cellular_profile_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Profile Parcel ID | + **cellular_profile_id** | **str**| Cellular Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_cellular_controller_profile_parcel_for_transport** +> delete_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id) + + + +Delete a Cellular Controller Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_cellular_controller_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_cellular_profile_profile_parcel_for_transport** +> delete_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id) + + + +Delete a Cellular Profile Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_profile_id = "cellularProfileId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_cellular_profile_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_profile_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_config_profile_parcel_for_cli** +> delete_config_profile_parcel_for_cli(cli_id, config_id) + + + +Delete a config Profile Parcel for cli feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile ID + config_id = "configId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_config_profile_parcel_for_cli(cli_id, config_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_config_profile_parcel_for_cli: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile ID | + **config_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_dhcp_server_profile_parcel_for_service** +> delete_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id) + + + +Delete a Dhcp Server Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + dhcp_server_id = "dhcpServerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_dhcp_server_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **dhcp_server_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_global_profile_parcel_for_system** +> delete_global_profile_parcel_for_system(system_id, global_id) + + + +Delete a Global Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + global_id = "globalId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_global_profile_parcel_for_system(system_id, global_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_global_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **global_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_and_routing_bgp_association_for_service** +> delete_lan_vpn_and_routing_bgp_association_for_service(service_id, vpn_id, bgp_id) + + + +Delete a LanVpn parcel and a RoutingBgp Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + bgp_id = "bgpId_example" # str | Routing Bgp Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_and_routing_bgp_association_for_service(service_id, vpn_id, bgp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_and_routing_bgp_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **bgp_id** | **str**| Routing Bgp Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_and_routing_ospf_association_for_service** +> delete_lan_vpn_and_routing_ospf_association_for_service(service_id, vpn_id, ospf_id) + + + +Delete a LanVpn parcel and a RoutingOspf Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ospf_id = "ospfId_example" # str | Routing Ospf Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_and_routing_ospf_association_for_service(service_id, vpn_id, ospf_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_and_routing_ospf_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ospf_id** | **str**| Routing Ospf Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport** +> delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id) + + + +Delete a LanVpnInterfaceEthernet and a DhcpServer Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + dhcp_server_id = "dhcpServerId_example" # str | DhcpServer Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **dhcp_server_id** | **str**| DhcpServer Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_interface_ethernet_for_service** +> delete_lan_vpn_interface_ethernet_for_service(service_id, vpn_id, ethernet_id) + + + +Delete a LanVpn InterfaceEthernet Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_interface_ethernet_for_service(service_id, vpn_id, ethernet_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_interface_ethernet_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport** +> delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id) + + + +Delete a LanVpnInterfaceSvi and a DhcpServer Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + svi_id = "sviId_example" # str | Interface Profile Parcel ID + dhcp_server_id = "dhcpServerId_example" # str | DhcpServer Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **svi_id** | **str**| Interface Profile Parcel ID | + **dhcp_server_id** | **str**| DhcpServer Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_interface_svi_for_service** +> delete_lan_vpn_interface_svi_for_service(service_id, vpn_id, svi_id) + + + +Delete a LanVpn InterfaceSvi Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + svi_id = "sviId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_interface_svi_for_service(service_id, vpn_id, svi_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_interface_svi_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **svi_id** | **str**| Interface Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_lan_vpn_profile_parcel_for_service** +> delete_lan_vpn_profile_parcel_for_service(service_id, vpn_id) + + + +Delete a Lan Vpn Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_lan_vpn_profile_parcel_for_service(service_id, vpn_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_lan_vpn_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_logging_profile_parcel_for_system** +> delete_logging_profile_parcel_for_system(system_id, logging_id) + + + +Delete a Logging Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + logging_id = "loggingId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_logging_profile_parcel_for_system(system_id, logging_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_logging_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **logging_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_management_vpn_interface_ethernet_for_transport** +> delete_management_vpn_interface_ethernet_for_transport(transport_id, vpn_id, ethernet_id) + + + +Delete a ManagementVpn InterfaceEthernet Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_management_vpn_interface_ethernet_for_transport(transport_id, vpn_id, ethernet_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_management_vpn_interface_ethernet_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_management_vpn_profile_parcel_for_transport** +> delete_management_vpn_profile_parcel_for_transport(transport_id, vpn_id) + + + +Delete a Management Vpn Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_management_vpn_profile_parcel_for_transport(transport_id, vpn_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_management_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_ntp_profile_parcel_for_system** +> delete_ntp_profile_parcel_for_system(system_id, ntp_id) + + + +Delete a Ntp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + ntp_id = "ntpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_ntp_profile_parcel_for_system(system_id, ntp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_ntp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **ntp_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_omp_profile_parcel_for_system** +> delete_omp_profile_parcel_for_system(system_id, omp_id) + + + +Delete a Omp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + omp_id = "ompId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_omp_profile_parcel_for_system(system_id, omp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_omp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **omp_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_routing_bgp_profile_parcel_for_service** +> delete_routing_bgp_profile_parcel_for_service(service_id, bgp_id) + + + +Delete a Routing Bgp Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + bgp_id = "bgpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_routing_bgp_profile_parcel_for_service(service_id, bgp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_routing_bgp_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **bgp_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_routing_bgp_profile_parcel_for_transport** +> delete_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id) + + + +Delete a Routing Bgp Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + bgp_id = "bgpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_routing_bgp_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **bgp_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_routing_ospf_profile_parcel_for_service** +> delete_routing_ospf_profile_parcel_for_service(service_id, ospf_id) + + + +Delete a Routing Ospf Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + ospf_id = "ospfId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_routing_ospf_profile_parcel_for_service(service_id, ospf_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_routing_ospf_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **ospf_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_sdwan_feature_profile_for_cli** +> delete_sdwan_feature_profile_for_cli(cli_id) + + + +Delete Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.delete_sdwan_feature_profile_for_cli(cli_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_sdwan_feature_profile_for_cli: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_sdwan_other_feature_profile** +> delete_sdwan_other_feature_profile(other_id) + + + +Delete Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.delete_sdwan_other_feature_profile(other_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_sdwan_other_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_sdwan_service_feature_profile** +> delete_sdwan_service_feature_profile(service_id) + + + +Delete Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.delete_sdwan_service_feature_profile(service_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_sdwan_service_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_sdwan_system_feature_profile** +> delete_sdwan_system_feature_profile(system_id) + + + +Delete Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.delete_sdwan_system_feature_profile(system_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_sdwan_system_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_sdwan_transport_feature_profile** +> delete_sdwan_transport_feature_profile(transport_id) + + + +Delete Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.delete_sdwan_transport_feature_profile(transport_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_sdwan_transport_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_snmp_profile_parcel_for_system** +> delete_snmp_profile_parcel_for_system(system_id, snmp_id) + + + +Delete a Snmp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + snmp_id = "snmpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_snmp_profile_parcel_for_system(system_id, snmp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_snmp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **snmp_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_switchport_profile_parcel_for_service** +> delete_switchport_profile_parcel_for_service(service_id, switchport_id) + + + +Delete a Switchport Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + switchport_id = "switchportId_example" # str | Switchport Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_switchport_profile_parcel_for_service(service_id, switchport_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_switchport_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **switchport_id** | **str**| Switchport Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_thousandeyes_profile_parcel_for_other** +> delete_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id) + + + +Delete a Thousandeyes Profile Parcel for Other feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile ID + thousandeyes_id = "thousandeyesId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_thousandeyes_profile_parcel_for_other: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile ID | + **thousandeyes_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tracker_profile_parcel_for_transport** +> delete_tracker_profile_parcel_for_transport(transport_id, tracker_id) + + + +Delete a Tracker Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + tracker_id = "trackerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_tracker_profile_parcel_for_transport(transport_id, tracker_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_tracker_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **tracker_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_vpn_and_routing_bgp_association_for_transport** +> delete_wan_vpn_and_routing_bgp_association_for_transport(transport_id, vpn_id, bgp_id) + + + +Delete a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + bgp_id = "bgpId_example" # str | Routing Bgp Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wan_vpn_and_routing_bgp_association_for_transport(transport_id, vpn_id, bgp_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wan_vpn_and_routing_bgp_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **bgp_id** | **str**| Routing Bgp Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_vpn_interface_cellular_and_tracker_association_for_transport** +> delete_wan_vpn_interface_cellular_and_tracker_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id) + + + +Delete a WanVpnInterfaceCellular and a Tracker Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + cellular_id = "cellularId_example" # str | Interface Profile Parcel ID + tracker_id = "trackerId_example" # str | Tracker Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wan_vpn_interface_cellular_and_tracker_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wan_vpn_interface_cellular_and_tracker_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **cellular_id** | **str**| Interface Profile Parcel ID | + **tracker_id** | **str**| Tracker Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_vpn_interface_cellular_for_transport** +> delete_wan_vpn_interface_cellular_for_transport(transport_id, vpn_id, intf_id) + + + +Delete a wanvpn Cellular interface Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + intf_id = "intfId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wan_vpn_interface_cellular_for_transport(transport_id, vpn_id, intf_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wan_vpn_interface_cellular_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **intf_id** | **str**| Interface Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport** +> delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id) + + + +Delete a WanVpnInterfaceEthernet and a Tracker Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + tracker_id = "trackerId_example" # str | Tracker Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **tracker_id** | **str**| Tracker Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_vpn_interface_ethernet_for_transport** +> delete_wan_vpn_interface_ethernet_for_transport(transport_id, vpn_id, ethernet_id) + + + +Delete a WanVpn InterfaceEthernet Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wan_vpn_interface_ethernet_for_transport(transport_id, vpn_id, ethernet_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wan_vpn_interface_ethernet_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wan_vpn_profile_parcel_for_transport** +> delete_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id) + + + +Delete a Wan Vpn Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wan_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_wirelesslan_profile_parcel_for_service** +> delete_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id) + + + +Delete a Wirelesslan Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + wirelesslan_id = "wirelesslanId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_instance.delete_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->delete_wirelesslan_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **wirelesslan_id** | **str**| Profile Parcel ID | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_aaa_profile_parcel_for_system** +> str edit_aaa_profile_parcel_for_system(system_id, aaa_id) + + + +Update a Aaa Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + aaa_id = "aaaId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Aaa Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_aaa_profile_parcel_for_system(system_id, aaa_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_aaa_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_aaa_profile_parcel_for_system(system_id, aaa_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_aaa_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **aaa_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Aaa Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_banner_profile_parcel_for_system** +> str edit_banner_profile_parcel_for_system(system_id, banner_id) + + + +Update a Banner Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + banner_id = "bannerId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Banner Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_banner_profile_parcel_for_system(system_id, banner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_banner_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_banner_profile_parcel_for_system(system_id, banner_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_banner_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **banner_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Banner Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_basic_profile_parcel_for_system** +> str edit_basic_profile_parcel_for_system(system_id, basic_id) + + + +Update a Basic Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + basic_id = "basicId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Basic Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_basic_profile_parcel_for_system(system_id, basic_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_basic_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_basic_profile_parcel_for_system(system_id, basic_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_basic_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **basic_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Basic Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_bfd_profile_parcel_for_system** +> str edit_bfd_profile_parcel_for_system(system_id, bfd_id) + + + +Update a Bfd Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + bfd_id = "bfdId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Bfd Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_bfd_profile_parcel_for_system(system_id, bfd_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_bfd_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_bfd_profile_parcel_for_system(system_id, bfd_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_bfd_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **bfd_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Bfd Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_cellular_controller_and_cellular_profile_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type edit_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id) + + + +Update a CellularController parcel and a CellularProfile Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Profile Parcel ID + cellular_profile_id = "cellularProfileId_example" # str | Cellular Profile ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Cellular Profile Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_cellular_controller_and_cellular_profile_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_cellular_controller_and_cellular_profile_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Profile Parcel ID | + **cellular_profile_id** | **str**| Cellular Profile ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Cellular Profile Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_cellular_controller_profile_parcel_for_transport** +> str edit_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id) + + + +Update a Cellular Controller Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Cellular Controller Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_cellular_controller_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_cellular_controller_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Cellular Controller Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_cellular_profile_profile_parcel_for_transport** +> str edit_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id) + + + +Update a Cellular Profile Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_profile_id = "cellularProfileId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Cellular Profile Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_cellular_profile_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_cellular_profile_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_profile_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Cellular Profile Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_config_profile_parcel_for_cli** +> str edit_config_profile_parcel_for_cli(cli_id, config_id) + + + +Update a config Profile Parcel for cli feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile ID + config_id = "configId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | cli config Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_config_profile_parcel_for_cli(cli_id, config_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_config_profile_parcel_for_cli: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_config_profile_parcel_for_cli(cli_id, config_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_config_profile_parcel_for_cli: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile ID | + **config_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| cli config Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_dhcp_server_profile_parcel_for_service** +> str edit_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id) + + + +Update a Dhcp Server Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + dhcp_server_id = "dhcpServerId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Dhcp Server Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_dhcp_server_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_dhcp_server_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **dhcp_server_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Dhcp Server Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_global_profile_parcel_for_system** +> str edit_global_profile_parcel_for_system(system_id, global_id) + + + +Update a Global Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + global_id = "globalId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Global Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_global_profile_parcel_for_system(system_id, global_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_global_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_global_profile_parcel_for_system(system_id, global_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_global_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **global_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Global Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_and_routing_bgp_parcel_association_for_service** +> bool, date, datetime, dict, float, int, list, str, none_type edit_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id, bgp_id) + + + +Update a LanVpn parcel and a RoutingBgp Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + bgp_id = "bgpId_example" # str | Routing Bgp ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_and_routing_bgp_parcel_association_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id, bgp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_and_routing_bgp_parcel_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **bgp_id** | **str**| Routing Bgp ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_and_routing_ospf_parcel_association_for_service** +> bool, date, datetime, dict, float, int, list, str, none_type edit_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id, ospf_id) + + + +Update a LanVpn parcel and a RoutingOspf Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ospf_id = "ospfId_example" # str | Routing Ospf ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Ospf Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id, ospf_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_and_routing_ospf_parcel_association_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id, ospf_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_and_routing_ospf_parcel_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ospf_id** | **str**| Routing Ospf ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Ospf Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id) + + + +Update a LanVpnInterfaceEthernet parcel and a DhcpServer Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + dhcp_server_id = "dhcpServerId_example" # str | DhcpServer ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | DhcpServer Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **dhcp_server_id** | **str**| DhcpServer ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| DhcpServer Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_interface_ethernet_parcel_for_service** +> str edit_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id, ethernet_id) + + + +Update a LanVpn InterfaceEthernet Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Lan Vpn Interface Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_ethernet_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id, ethernet_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_ethernet_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Lan Vpn Interface Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id) + + + +Update a LanVpnInterfaceSvi parcel and a DhcpServer Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + svi_id = "sviId_example" # str | Interface Profile Parcel ID + dhcp_server_id = "dhcpServerId_example" # str | DhcpServer ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | DhcpServer Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **svi_id** | **str**| Interface Profile Parcel ID | + **dhcp_server_id** | **str**| DhcpServer ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| DhcpServer Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_interface_svi_parcel_for_service** +> str edit_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id, svi_id) + + + +Update a LanVpn InterfaceSvi Parcel for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + svi_id = "sviId_example" # str | Interface ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Lan Vpn Interface Svi Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id, svi_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_svi_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id, svi_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_interface_svi_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **svi_id** | **str**| Interface ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Lan Vpn Interface Svi Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_lan_vpn_profile_parcel_for_service** +> str edit_lan_vpn_profile_parcel_for_service(service_id, vpn_id) + + + +Update a Lan Vpn Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Lan Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_lan_vpn_profile_parcel_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_lan_vpn_profile_parcel_for_service(service_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_lan_vpn_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Lan Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_logging_profile_parcel_for_system** +> str edit_logging_profile_parcel_for_system(system_id, logging_id) + + + +Update a Logging Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + logging_id = "loggingId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Logging Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_logging_profile_parcel_for_system(system_id, logging_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_logging_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_logging_profile_parcel_for_system(system_id, logging_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_logging_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **logging_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Logging Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_management_vpn_interface_ethernet_parcel_for_transport** +> str edit_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id) + + + +Update a ManagementVpn InterfaceEthernet Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Management Vpn Interface Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_management_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_management_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Management Vpn Interface Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_management_vpn_profile_parcel_for_transport** +> str edit_management_vpn_profile_parcel_for_transport(transport_id, vpn_id) + + + +Update a Management Vpn Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Management Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_management_vpn_profile_parcel_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_management_vpn_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_management_vpn_profile_parcel_for_transport(transport_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_management_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Management Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_ntp_profile_parcel_for_system** +> str edit_ntp_profile_parcel_for_system(system_id, ntp_id) + + + +Update a Ntp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + ntp_id = "ntpId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Ntp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_ntp_profile_parcel_for_system(system_id, ntp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_ntp_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_ntp_profile_parcel_for_system(system_id, ntp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_ntp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **ntp_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Ntp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_omp_profile_parcel_for_system** +> str edit_omp_profile_parcel_for_system(system_id, omp_id) + + + +Update a Omp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + omp_id = "ompId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Omp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_omp_profile_parcel_for_system(system_id, omp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_omp_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_omp_profile_parcel_for_system(system_id, omp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_omp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **omp_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Omp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_routing_bgp_profile_parcel_for_service** +> str edit_routing_bgp_profile_parcel_for_service(service_id, bgp_id) + + + +Update a Routing Bgp Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + bgp_id = "bgpId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_routing_bgp_profile_parcel_for_service(service_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_routing_bgp_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_routing_bgp_profile_parcel_for_service(service_id, bgp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_routing_bgp_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **bgp_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_routing_bgp_profile_parcel_for_transport** +> str edit_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id) + + + +Update a Routing Bgp Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + bgp_id = "bgpId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_routing_bgp_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_routing_bgp_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **bgp_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_routing_ospf_profile_parcel_for_service** +> str edit_routing_ospf_profile_parcel_for_service(service_id, ospf_id) + + + +Update a Routing Ospf Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + ospf_id = "ospfId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Ospf Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_routing_ospf_profile_parcel_for_service(service_id, ospf_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_routing_ospf_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_routing_ospf_profile_parcel_for_service(service_id, ospf_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_routing_ospf_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **ospf_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Ospf Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_sdwan_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type edit_sdwan_feature_profile(cli_id) + + + +Edit a SDWAN Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_sdwan_feature_profile(cli_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_feature_profile: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_sdwan_feature_profile(cli_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_sdwan_other_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type edit_sdwan_other_feature_profile(other_id) + + + +Edit a SDWAN Other Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_sdwan_other_feature_profile(other_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_other_feature_profile: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_sdwan_other_feature_profile(other_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_other_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_sdwan_service_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type edit_sdwan_service_feature_profile(service_id) + + + +Edit a SDWAN Service Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_sdwan_service_feature_profile(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_service_feature_profile: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_sdwan_service_feature_profile(service_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_service_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_sdwan_system_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type edit_sdwan_system_feature_profile(system_id) + + + +Edit a SDWAN System Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_sdwan_system_feature_profile(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_system_feature_profile: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_sdwan_system_feature_profile(system_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_system_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_sdwan_transport_feature_profile** +> bool, date, datetime, dict, float, int, list, str, none_type edit_sdwan_transport_feature_profile(transport_id) + + + +Edit a SDWAN Transport Feature Profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile Id + body = None # bool, date, datetime, dict, float, int, list, str, none_type | SDWAN Feature profile (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_sdwan_transport_feature_profile(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_transport_feature_profile: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_sdwan_transport_feature_profile(transport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_sdwan_transport_feature_profile: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile Id | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| SDWAN Feature profile | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_snmp_profile_parcel_for_system** +> str edit_snmp_profile_parcel_for_system(system_id, snmp_id) + + + +Update a Snmp Profile Parcel for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + snmp_id = "snmpId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Snmp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_snmp_profile_parcel_for_system(system_id, snmp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_snmp_profile_parcel_for_system: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_snmp_profile_parcel_for_system(system_id, snmp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_snmp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **snmp_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Snmp Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_switchport_parcel_association_for_service** +> str edit_switchport_parcel_association_for_service(service_id, switchport_id) + + + +Update a Switchport Parcel association for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + switchport_id = "switchportId_example" # str | Switchport ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Switchport Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_switchport_parcel_association_for_service(service_id, switchport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_switchport_parcel_association_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_switchport_parcel_association_for_service(service_id, switchport_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_switchport_parcel_association_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **switchport_id** | **str**| Switchport ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Switchport Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_thousandeyes_profile_parcel_for_other** +> str edit_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id) + + + +Update a Thousandeyes Profile Parcel for Other feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile ID + thousandeyes_id = "thousandeyesId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Thousandeyes Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_thousandeyes_profile_parcel_for_other: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_thousandeyes_profile_parcel_for_other: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile ID | + **thousandeyes_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Thousandeyes Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_tracker_profile_parcel_for_transport** +> str edit_tracker_profile_parcel_for_transport(transport_id, tracker_id) + + + +Update a Tracker Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + tracker_id = "trackerId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Tracker Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_tracker_profile_parcel_for_transport(transport_id, tracker_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_tracker_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_tracker_profile_parcel_for_transport(transport_id, tracker_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_tracker_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **tracker_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Tracker Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_vpn_and_routing_bgp_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type edit_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id, bgp_id) + + + +Update a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + bgp_id = "bgpId_example" # str | Routing Bgp ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Routing Bgp Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_and_routing_bgp_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id, bgp_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_and_routing_bgp_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **bgp_id** | **str**| Routing Bgp ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Routing Bgp Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id) + + + +Update a WanVpnInterfaceCellular parcel and a Tracker Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + cellular_id = "cellularId_example" # str | Interface Profile Parcel ID + tracker_id = "trackerId_example" # str | Tracker ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Tracker Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **cellular_id** | **str**| Interface Profile Parcel ID | + **tracker_id** | **str**| Tracker ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Tracker Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_vpn_interface_cellular_parcel_for_transport** +> str edit_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id, intf_id) + + + +Update a wanvpn Cellular Interface Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + intf_id = "intfId_example" # str | Interface ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | WanVpn Cellular Interface Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id, intf_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_cellular_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id, intf_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_cellular_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **intf_id** | **str**| Interface ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| WanVpn Cellular Interface Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport** +> bool, date, datetime, dict, float, int, list, str, none_type edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id) + + + +Update a WanVpnInterfaceEthernet parcel and a Tracker Parcel association for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + tracker_id = "trackerId_example" # str | Tracker ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Tracker Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **tracker_id** | **str**| Tracker ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Tracker Profile Parcel | [optional] + +### Return type + +**bool, date, datetime, dict, float, int, list, str, none_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_vpn_interface_ethernet_parcel_for_transport** +> str edit_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id) + + + +Update a WanVpn InterfaceEthernet Parcel for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Wan Vpn Interface Ethernet Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_interface_ethernet_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Wan Vpn Interface Ethernet Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wan_vpn_profile_parcel_for_transport** +> str edit_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id) + + + +Update a Wan Vpn Profile Parcel for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Wan Vpn Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_profile_parcel_for_transport: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wan_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Wan Vpn Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_wirelesslan_profile_parcel_for_service** +> str edit_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id) + + + +Update a Wirelesslan Profile Parcel for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + wirelesslan_id = "wirelesslanId_example" # str | Profile Parcel ID + body = None # bool, date, datetime, dict, float, int, list, str, none_type | Wirelesslan Profile Parcel (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wirelesslan_profile_parcel_for_service: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->edit_wirelesslan_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **wirelesslan_id** | **str**| Profile Parcel ID | + **body** | **bool, date, datetime, dict, float, int, list, str, none_type**| Wirelesslan Profile Parcel | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aaa_profile_parcel_by_parcel_id_for_system** +> str get_aaa_profile_parcel_by_parcel_id_for_system(system_id, aaa_id) + + + +Get Aaa Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + aaa_id = "aaaId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aaa_profile_parcel_by_parcel_id_for_system(system_id, aaa_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_aaa_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **aaa_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aaa_profile_parcel_for_system** +> str get_aaa_profile_parcel_for_system(system_id) + + + +Get Aaa Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aaa_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_aaa_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_banner_profile_parcel_by_parcel_id_for_system** +> str get_banner_profile_parcel_by_parcel_id_for_system(system_id, banner_id) + + + +Get Banner Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + banner_id = "bannerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_banner_profile_parcel_by_parcel_id_for_system(system_id, banner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_banner_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **banner_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_banner_profile_parcel_for_system** +> str get_banner_profile_parcel_for_system(system_id) + + + +Get Banner Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_banner_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_banner_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_basic_profile_parcel_by_parcel_id_for_system** +> str get_basic_profile_parcel_by_parcel_id_for_system(system_id, basic_id) + + + +Get Basic Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + basic_id = "basicId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_basic_profile_parcel_by_parcel_id_for_system(system_id, basic_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_basic_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **basic_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_basic_profile_parcel_for_system** +> str get_basic_profile_parcel_for_system(system_id) + + + +Get Basic Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_basic_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_basic_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bfd_profile_parcel_by_parcel_id_for_system** +> str get_bfd_profile_parcel_by_parcel_id_for_system(system_id, bfd_id) + + + +Get Bfd Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + bfd_id = "bfdId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bfd_profile_parcel_by_parcel_id_for_system(system_id, bfd_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_bfd_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **bfd_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bfd_profile_parcel_for_system** +> str get_bfd_profile_parcel_for_system(system_id) + + + +Get Bfd Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bfd_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_bfd_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema** +> str get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema(schema_type) + + + +Get a Cedge Service LanVpn InterfaceSvi Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cedge_service_switchport_parcel_schema_by_schema_type** +> str get_cedge_service_switchport_parcel_schema_by_schema_type(schema_type) + + + +Get a Cedge Service Switchport Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cedge_service_switchport_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cedge_service_switchport_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cedge_system_global_parcel_schema_by_schema_type** +> str get_cedge_system_global_parcel_schema_by_schema_type(schema_type) + + + +Get a Cedge System Global Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cedge_system_global_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cedge_system_global_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport** +> str get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_controller_id, cellular_profile_id) + + + +Get CellularController parcel associated CellularProfile Parcel by cellularProfileId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Profile Parcel ID + cellular_profile_id = "cellularProfileId_example" # str | Cellular Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_controller_id, cellular_profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Profile Parcel ID | + **cellular_profile_id** | **str**| Cellular Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_controller_associated_cellular_profile_parcels_for_transport** +> str get_cellular_controller_associated_cellular_profile_parcels_for_transport(transport_id, cellular_controller_id) + + + +Get CellularController associated Cellular Profile Parcels for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_controller_associated_cellular_profile_parcels_for_transport(transport_id, cellular_controller_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cellular_controller_associated_cellular_profile_parcels_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_controller_profile_parcel_by_parcel_id_for_transport** +> str get_cellular_controller_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_controller_id) + + + +Get Cellular Controller Profile Parcel by parcelId for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_controller_id = "cellularControllerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_controller_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_controller_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cellular_controller_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_controller_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_controller_profile_parcel_for_transport** +> str get_cellular_controller_profile_parcel_for_transport(transport_id) + + + +Get Cellular Controller Profile Parcels for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_controller_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cellular_controller_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_profile_profile_parcel_by_parcel_id_for_transport** +> str get_cellular_profile_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_profile_id) + + + +Get Cellular Profile Profile Parcel by parcelId for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + cellular_profile_id = "cellularProfileId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_profile_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cellular_profile_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **cellular_profile_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_profile_profile_parcel_for_transport** +> str get_cellular_profile_profile_parcel_for_transport(transport_id) + + + +Get Cellular Profile Profile Parcels for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_profile_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_cellular_profile_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_profile_parcel_by_parcel_id_for_cli** +> str get_config_profile_parcel_by_parcel_id_for_cli(cli_id, config_id) + + + +Get config Profile Parcel by configId for cli feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile ID + config_id = "configId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_config_profile_parcel_by_parcel_id_for_cli(cli_id, config_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_config_profile_parcel_by_parcel_id_for_cli: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile ID | + **config_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_config_profile_parcel_for_cli** +> str get_config_profile_parcel_for_cli(cli_id) + + + +Get config Profile Parcels for cli feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_config_profile_parcel_for_cli(cli_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_config_profile_parcel_for_cli: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dhcp_server_profile_parcel_by_parcel_id_for_service** +> str get_dhcp_server_profile_parcel_by_parcel_id_for_service(service_id, dhcp_server_id) + + + +Get Dhcp Server Profile Parcel by parcelId for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + dhcp_server_id = "dhcpServerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dhcp_server_profile_parcel_by_parcel_id_for_service(service_id, dhcp_server_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_dhcp_server_profile_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **dhcp_server_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dhcp_server_profile_parcel_for_service** +> str get_dhcp_server_profile_parcel_for_service(service_id) + + + +Get Dhcp Server Profile Parcels for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dhcp_server_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_dhcp_server_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_global_profile_parcel_by_parcel_id_for_system** +> str get_global_profile_parcel_by_parcel_id_for_system(system_id, global_id) + + + +Get Global Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + global_id = "globalId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_global_profile_parcel_by_parcel_id_for_system(system_id, global_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_global_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **global_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_global_profile_parcel_for_system** +> str get_global_profile_parcel_for_system(system_id) + + + +Get Global Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_global_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_global_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_interface_cellular_parcels_for_transport_wan_vpn** +> str get_interface_cellular_parcels_for_transport_wan_vpn(transport_id, vpn_id) + + + +Get Interface Cellular Parcels for transport Wan Vpn Parcel + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_interface_cellular_parcels_for_transport_wan_vpn(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_interface_cellular_parcels_for_transport_wan_vpn: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_interface_ethernet_parcels_for_service_lan_vpn** +> str get_interface_ethernet_parcels_for_service_lan_vpn(service_id, vpn_id) + + + +Get InterfaceEthernet Parcels for service LanVpn Parcel + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_interface_ethernet_parcels_for_service_lan_vpn(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_interface_ethernet_parcels_for_service_lan_vpn: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_interface_ethernet_parcels_for_transport_management_vpn** +> str get_interface_ethernet_parcels_for_transport_management_vpn(transport_id, vpn_id) + + + +Get InterfaceEthernet Parcels for transport ManagementVpn Parcel + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_interface_ethernet_parcels_for_transport_management_vpn(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_interface_ethernet_parcels_for_transport_management_vpn: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_interface_ethernet_parcels_for_transport_wan_vpn** +> str get_interface_ethernet_parcels_for_transport_wan_vpn(transport_id, vpn_id) + + + +Get InterfaceEthernet Parcels for transport WanVpn Parcel + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_interface_ethernet_parcels_for_transport_wan_vpn(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_interface_ethernet_parcels_for_transport_wan_vpn: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_interface_svi_parcels_for_service_lan_vpn** +> str get_interface_svi_parcels_for_service_lan_vpn(service_id, vpn_id) + + + +Get InterfaceSvi Parcels for service LanVpn Parcel + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_interface_svi_parcels_for_service_lan_vpn(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_interface_svi_parcels_for_service_lan_vpn: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service** +> str get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service(service_id, vpn_id, bgp_id) + + + +Get LanVpn parcel associated RoutingBgp Parcel by bgpId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + bgp_id = "bgpId_example" # str | Routing Bgp Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service(service_id, vpn_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **bgp_id** | **str**| Routing Bgp Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_associated_routing_bgp_parcels_for_service** +> str get_lan_vpn_associated_routing_bgp_parcels_for_service(service_id, vpn_id) + + + +Get LanVpn associated Routing Bgp Parcels for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_associated_routing_bgp_parcels_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_associated_routing_bgp_parcels_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service** +> str get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service(service_id, vpn_id, ospf_id) + + + +Get LanVpn parcel associated RoutingOspf Parcel by ospfId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ospf_id = "ospfId_example" # str | Routing Ospf Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service(service_id, vpn_id, ospf_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ospf_id** | **str**| Routing Ospf Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_associated_routing_ospf_parcels_for_service** +> str get_lan_vpn_associated_routing_ospf_parcels_for_service(service_id, vpn_id) + + + +Get LanVpn associated Routing Ospf Parcels for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_associated_routing_ospf_parcels_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_associated_routing_ospf_parcels_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport** +> str get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id) + + + +Get LanVpnInterfaceEthernet associated DhcpServer Parcel by dhcpServerId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + dhcp_server_id = "dhcpServerId_example" # str | DhcpServer Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **dhcp_server_id** | **str**| DhcpServer Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport** +> str get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport(service_id, vpn_id, ethernet_id) + + + +Get LanVpnInterfaceEthernet associated DhcpServer Parcels for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport(service_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service** +> str get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service(service_id, vpn_id, ethernet_id) + + + +Get LanVpn InterfaceEthernet Parcel by ethernetId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service(service_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport** +> str get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport(service_id, vpn_id, svi_id, dhcp_server_id) + + + +Get LanVpnInterfaceSvi associated DhcpServer Parcel by dhcpServerId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + svi_id = "sviId_example" # str | Interface Profile Parcel ID + dhcp_server_id = "dhcpServerId_example" # str | DhcpServer Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport(service_id, vpn_id, svi_id, dhcp_server_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **svi_id** | **str**| Interface Profile Parcel ID | + **dhcp_server_id** | **str**| DhcpServer Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport** +> str get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport(service_id, vpn_id, svi_id) + + + +Get LanVpnInterfaceSvi associated DhcpServer Parcels for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + svi_id = "sviId_example" # str | Interface Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport(service_id, vpn_id, svi_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + **svi_id** | **str**| Interface Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service** +> str get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service(service_id, vpn_id, svi_id) + + + +Get LanVpn InterfaceSvi Parcel by sviId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + svi_id = "sviId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service(service_id, vpn_id, svi_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **svi_id** | **str**| Interface Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_profile_parcel_by_parcel_id_for_service** +> str get_lan_vpn_profile_parcel_by_parcel_id_for_service(service_id, vpn_id) + + + +Get Lan Vpn Profile Parcel by parcelId for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_profile_parcel_by_parcel_id_for_service(service_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_profile_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lan_vpn_profile_parcel_for_service** +> str get_lan_vpn_profile_parcel_for_service(service_id) + + + +Get Lan Vpn Profile Parcels for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lan_vpn_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_lan_vpn_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_logging_profile_parcel_by_parcel_id_for_system** +> str get_logging_profile_parcel_by_parcel_id_for_system(system_id, logging_id) + + + +Get Logging Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + logging_id = "loggingId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_logging_profile_parcel_by_parcel_id_for_system(system_id, logging_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_logging_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **logging_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_logging_profile_parcel_for_system** +> str get_logging_profile_parcel_for_system(system_id) + + + +Get Logging Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_logging_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_logging_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport** +> str get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id) + + + +Get ManagementVpn InterfaceEthernet Parcel by ethernetId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_management_vpn_profile_parcel_by_parcel_id_for_transport** +> str get_management_vpn_profile_parcel_by_parcel_id_for_transport(transport_id, vpn_id) + + + +Get Management Vpn Profile Parcel by parcelId for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_management_vpn_profile_parcel_by_parcel_id_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_management_vpn_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_management_vpn_profile_parcel_for_transport** +> str get_management_vpn_profile_parcel_for_transport(transport_id) + + + +Get Management Vpn Profile Parcels for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_management_vpn_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_management_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ntp_profile_parcel_by_parcel_id_for_system** +> str get_ntp_profile_parcel_by_parcel_id_for_system(system_id, ntp_id) + + + +Get Ntp Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + ntp_id = "ntpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ntp_profile_parcel_by_parcel_id_for_system(system_id, ntp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_ntp_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **ntp_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ntp_profile_parcel_for_system** +> str get_ntp_profile_parcel_for_system(system_id) + + + +Get Ntp Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ntp_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_ntp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_omp_profile_parcel_by_parcel_id_for_system** +> str get_omp_profile_parcel_by_parcel_id_for_system(system_id, omp_id) + + + +Get Omp Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + omp_id = "ompId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_omp_profile_parcel_by_parcel_id_for_system(system_id, omp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_omp_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **omp_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_omp_profile_parcel_for_system** +> str get_omp_profile_parcel_for_system(system_id) + + + +Get Omp Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_omp_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_omp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_bgp_profile_parcel_by_parcel_id_for_service** +> str get_routing_bgp_profile_parcel_by_parcel_id_for_service(service_id, bgp_id) + + + +Get Routing Bgp Profile Parcel by parcelId for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + bgp_id = "bgpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_bgp_profile_parcel_by_parcel_id_for_service(service_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_routing_bgp_profile_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **bgp_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_bgp_profile_parcel_by_parcel_id_for_transport** +> str get_routing_bgp_profile_parcel_by_parcel_id_for_transport(transport_id, bgp_id) + + + +Get Routing Bgp Profile Parcel by parcelId for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + bgp_id = "bgpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_bgp_profile_parcel_by_parcel_id_for_transport(transport_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_routing_bgp_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **bgp_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_bgp_profile_parcel_for_service** +> str get_routing_bgp_profile_parcel_for_service(service_id) + + + +Get Routing Bgp Profile Parcels for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_bgp_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_routing_bgp_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_bgp_profile_parcel_for_transport** +> str get_routing_bgp_profile_parcel_for_transport(transport_id) + + + +Get Routing Bgp Profile Parcels for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_bgp_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_routing_bgp_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_ospf_profile_parcel_by_parcel_id_for_service** +> str get_routing_ospf_profile_parcel_by_parcel_id_for_service(service_id, ospf_id) + + + +Get Routing Ospf Profile Parcel by parcelId for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + ospf_id = "ospfId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_ospf_profile_parcel_by_parcel_id_for_service(service_id, ospf_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_routing_ospf_profile_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **ospf_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_ospf_profile_parcel_for_service** +> str get_routing_ospf_profile_parcel_for_service(service_id) + + + +Get Routing Ospf Profile Parcels for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_ospf_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_routing_ospf_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_feature_profile_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_feature_profile_by_profile_id(cli_id) + + + +Get a SDWAN Feature Profile with Cli profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + cli_id = "cliId_example" # str | Feature Profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_feature_profile_by_profile_id(cli_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_feature_profile_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cli_id** | **str**| Feature Profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_feature_profile_by_sdwan_family** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_feature_profile_by_sdwan_family() + + + +Get all SDWAN Feature Profiles + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sdwan_feature_profile_by_sdwan_family(offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_feature_profile_by_sdwan_family: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit | [optional] if omitted the server will use the default value of 0 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_feature_profiles_by_family_and_type** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_feature_profiles_by_family_and_type() + + + +Get all SDWAN Feature Profiles with giving Family and profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sdwan_feature_profiles_by_family_and_type(offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_feature_profiles_by_family_and_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit | [optional] if omitted the server will use the default value of 0 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_other_feature_profile_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_other_feature_profile_by_profile_id(other_id) + + + +Get a SDWAN Other Feature Profile with otherId + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_other_feature_profile_by_profile_id(other_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_other_feature_profile_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_other_feature_profiles** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_other_feature_profiles() + + + +Get all SDWAN Feature Profiles with giving Family and profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sdwan_other_feature_profiles(offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_other_feature_profiles: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit | [optional] if omitted the server will use the default value of 0 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_other_thousandeyes_parcel_schema_by_schema_type** +> str get_sdwan_other_thousandeyes_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Other Thousandeyes Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_other_thousandeyes_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_other_thousandeyes_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_dhcp_server_parcel_schema_by_schema_type** +> str get_sdwan_service_dhcp_server_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Service DhcpServer Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_dhcp_server_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_dhcp_server_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_feature_profile_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_service_feature_profile_by_profile_id(service_id) + + + +Get a SDWAN Service Feature Profile with serviceId + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_feature_profile_by_profile_id(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_feature_profile_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_feature_profiles** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_service_feature_profiles() + + + +Get all SDWAN Feature Profiles with giving Family and profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sdwan_service_feature_profiles(offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_feature_profiles: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit | [optional] if omitted the server will use the default value of 0 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema** +> str get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema(schema_type) + + + +Get a SDWAN Service LanVpn InterfaceEthernet Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_lan_vpn_parcel_schema_by_schema_type** +> str get_sdwan_service_lan_vpn_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Service LanVpn Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_lan_vpn_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_lan_vpn_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_routing_bgp_parcel_schema_by_schema_type** +> str get_sdwan_service_routing_bgp_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Service RoutingBgp Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_routing_bgp_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_routing_bgp_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_routing_ospf_parcel_schema_by_schema_type** +> str get_sdwan_service_routing_ospf_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Service RoutingOspf Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_routing_ospf_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_routing_ospf_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_service_wirelesslan_parcel_schema_by_schema_type** +> str get_sdwan_service_wirelesslan_parcel_schema_by_schema_type(schema_type) + + + +Get a sdwan Service Wirelesslan Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_service_wirelesslan_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_service_wirelesslan_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_aaa_parcel_schema_by_schema_type** +> str get_sdwan_system_aaa_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Aaa Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_aaa_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_aaa_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_banner_parcel_schema_by_schema_type** +> str get_sdwan_system_banner_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Banner Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_banner_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_banner_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_basic_parcel_schema_by_schema_type** +> str get_sdwan_system_basic_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Basic Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_basic_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_basic_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_bfd_parcel_schema_by_schema_type** +> str get_sdwan_system_bfd_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Bfd Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_bfd_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_bfd_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_feature_profile_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_system_feature_profile_by_profile_id(system_id) + + + +Get a SDWAN System Feature Profile with systemId + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_feature_profile_by_profile_id(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_feature_profile_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_feature_profiles** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_system_feature_profiles() + + + +Get all SDWAN Feature Profiles with giving Family and profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sdwan_system_feature_profiles(offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_feature_profiles: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit | [optional] if omitted the server will use the default value of 0 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_logging_parcel_schema_by_schema_type** +> str get_sdwan_system_logging_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Logging Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_logging_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_logging_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_ntp_parcel_schema_by_schema_type** +> str get_sdwan_system_ntp_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Ntp Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_ntp_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_ntp_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_omp_parcel_schema_by_schema_type** +> str get_sdwan_system_omp_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Omp Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_omp_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_omp_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_system_snmp_parcel_schema_by_schema_type** +> str get_sdwan_system_snmp_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN System Snmp Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_system_snmp_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_system_snmp_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type** +> str get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Transport CellularController Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type** +> str get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Transport CellularProfile Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_feature_profile_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_transport_feature_profile_by_profile_id(transport_id) + + + +Get a SDWAN Transport Feature Profile with transportId + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_feature_profile_by_profile_id(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_feature_profile_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_feature_profiles** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sdwan_transport_feature_profiles() + + + +Get all SDWAN Feature Profiles with giving Family and profile type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sdwan_transport_feature_profiles(offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_feature_profiles: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit | [optional] if omitted the server will use the default value of 0 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema** +> str get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema(schema_type) + + + +Get a SDWAN Transport ManagementVpn InterfaceEthernet Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_management_vpn_parcel_schema_by_schema_type** +> str get_sdwan_transport_management_vpn_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Transport ManagementVpn Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_management_vpn_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_management_vpn_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type** +> str get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Transport RoutingBgp Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_tracker_parcel_schema_by_schema_type** +> str get_sdwan_transport_tracker_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Transport Tracker Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_tracker_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_tracker_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema** +> str get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema(schema_type) + + + +Get a SDWAN Transport WanVpn CellularInterface Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema** +> str get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema(schema_type) + + + +Get a SDWAN Transport WanVpn InterfaceEthernet Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type** +> str get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type(schema_type) + + + +Get a SDWAN Transport WanVpn Parcel Schema by Schema Type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + schema_type = "post" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type(schema_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema_type** | **str**| | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_snmp_profile_parcel_by_parcel_id_for_system** +> str get_snmp_profile_parcel_by_parcel_id_for_system(system_id, snmp_id) + + + +Get Snmp Profile Parcel by parcelId for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + snmp_id = "snmpId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_snmp_profile_parcel_by_parcel_id_for_system(system_id, snmp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_snmp_profile_parcel_by_parcel_id_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + **snmp_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_snmp_profile_parcel_for_system** +> str get_snmp_profile_parcel_for_system(system_id) + + + +Get Snmp Profile Parcels for System feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + system_id = "systemId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_snmp_profile_parcel_for_system(system_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_snmp_profile_parcel_for_system: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **system_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_switchport_parcel_by_parcel_id_for_service** +> str get_switchport_parcel_by_parcel_id_for_service(service_id, switchport_id) + + + +Get Switchport Parcel by switchportId for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + switchport_id = "switchportId_example" # str | Switchport Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_switchport_parcel_by_parcel_id_for_service(service_id, switchport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_switchport_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **switchport_id** | **str**| Switchport Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_switchport_parcels_for_service** +> str get_switchport_parcels_for_service(service_id) + + + +Get Switchport Parcels for service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_switchport_parcels_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_switchport_parcels_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_thousandeyes_profile_parcel_by_parcel_id_for_other** +> str get_thousandeyes_profile_parcel_by_parcel_id_for_other(other_id, thousandeyes_id) + + + +Get Thousandeyes Profile Parcel by parcelId for Other feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile ID + thousandeyes_id = "thousandeyesId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_thousandeyes_profile_parcel_by_parcel_id_for_other(other_id, thousandeyes_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_thousandeyes_profile_parcel_by_parcel_id_for_other: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile ID | + **thousandeyes_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_thousandeyes_profile_parcel_for_other** +> str get_thousandeyes_profile_parcel_for_other(other_id) + + + +Get Thousandeyes Profile Parcels for Other feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + other_id = "otherId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_thousandeyes_profile_parcel_for_other(other_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_thousandeyes_profile_parcel_for_other: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **other_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tracker_profile_parcel_by_parcel_id_for_transport** +> str get_tracker_profile_parcel_by_parcel_id_for_transport(transport_id, tracker_id) + + + +Get Tracker Profile Parcel by parcelId for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + tracker_id = "trackerId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tracker_profile_parcel_by_parcel_id_for_transport(transport_id, tracker_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_tracker_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **tracker_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tracker_profile_parcel_for_transport** +> str get_tracker_profile_parcel_for_transport(transport_id) + + + +Get Tracker Profile Parcels for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tracker_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_tracker_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport** +> str get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport(transport_id, vpn_id, bgp_id) + + + +Get WanVpn parcel associated RoutingBgp Parcel by bgpId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + bgp_id = "bgpId_example" # str | Routing Bgp Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport(transport_id, vpn_id, bgp_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **bgp_id** | **str**| Routing Bgp Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_associated_routing_bgp_parcels_for_transport** +> str get_wan_vpn_associated_routing_bgp_parcels_for_transport(transport_id, vpn_id) + + + +Get WanVpn associated Routing Bgp Parcels for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_associated_routing_bgp_parcels_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_associated_routing_bgp_parcels_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport** +> str get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport(transport_id, vpn_id, cellular_id, tracker_id) + + + +Get WanVpnInterfaceCellular associated Tracker Parcel by trackerId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + cellular_id = "cellularId_example" # str | Interface Profile Parcel ID + tracker_id = "trackerId_example" # str | Tracker Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport(transport_id, vpn_id, cellular_id, tracker_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **cellular_id** | **str**| Interface Profile Parcel ID | + **tracker_id** | **str**| Tracker Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport** +> str get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport(transport_id, vpn_id, cellular_id) + + + +Get WanVpnInterfaceCellular associated Tracker Parcels for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + cellular_id = "cellularId_example" # str | Interface Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport(transport_id, vpn_id, cellular_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + **cellular_id** | **str**| Interface Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport** +> str get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport(transport_id, vpn_id, intf_id) + + + +Get wanvpn Cellular interface Parcel by intfId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + intf_id = "intfId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport(transport_id, vpn_id, intf_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **intf_id** | **str**| Interface Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport** +> str get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id, tracker_id) + + + +Get WanVpnInterfaceEthernet associated Tracker Parcel by trackerId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + tracker_id = "trackerId_example" # str | Tracker Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id, tracker_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + **tracker_id** | **str**| Tracker Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport** +> str get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport(transport_id, vpn_id, ethernet_id) + + + +Get WanVpnInterfaceEthernet associated Tracker Parcels for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Feature Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport(transport_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Feature Parcel ID | + **ethernet_id** | **str**| Interface Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport** +> str get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id) + + + +Get WanVpn InterfaceEthernet Parcel by ethernetId for transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + ethernet_id = "ethernetId_example" # str | Interface Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + **ethernet_id** | **str**| Interface Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_profile_parcel_by_parcel_id_for_transport** +> str get_wan_vpn_profile_parcel_by_parcel_id_for_transport(transport_id, vpn_id) + + + +Get Wan Vpn Profile Parcel by parcelId for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + vpn_id = "vpnId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_profile_parcel_by_parcel_id_for_transport(transport_id, vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_profile_parcel_by_parcel_id_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + **vpn_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_vpn_profile_parcel_for_transport** +> str get_wan_vpn_profile_parcel_for_transport(transport_id) + + + +Get Wan Vpn Profile Parcels for Transport feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + transport_id = "transportId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wan_vpn_profile_parcel_for_transport(transport_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wan_vpn_profile_parcel_for_transport: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transport_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wirelesslan_profile_parcel_by_parcel_id_for_service** +> str get_wirelesslan_profile_parcel_by_parcel_id_for_service(service_id, wirelesslan_id) + + + +Get Wirelesslan Profile Parcel by parcelId for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + wirelesslan_id = "wirelesslanId_example" # str | Profile Parcel ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wirelesslan_profile_parcel_by_parcel_id_for_service(service_id, wirelesslan_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wirelesslan_profile_parcel_by_parcel_id_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + **wirelesslan_id** | **str**| Profile Parcel ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wirelesslan_profile_parcel_for_service** +> str get_wirelesslan_profile_parcel_for_service(service_id) + + + +Get Wirelesslan Profile Parcels for Service feature profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_feature_profile_sdwan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_feature_profile_sdwan_api.ConfigurationFeatureProfileSDWANApi(api_client) + service_id = "serviceId_example" # str | Feature Profile ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wirelesslan_profile_parcel_for_service(service_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationFeatureProfileSDWANApi->get_wirelesslan_profile_parcel_for_service: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Feature Profile ID | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationGeneralTemplateApi.md b/docs/ConfigurationGeneralTemplateApi.md new file mode 100644 index 0000000..9b7fe19 --- /dev/null +++ b/docs/ConfigurationGeneralTemplateApi.md @@ -0,0 +1,1414 @@ +# openapi_client.ConfigurationGeneralTemplateApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**change_template_resource_group**](ConfigurationGeneralTemplateApi.md#change_template_resource_group) | **POST** /template/feature/resource-group/{resourceGroupName}/{templateId} | +[**clone_template**](ConfigurationGeneralTemplateApi.md#clone_template) | **POST** /template/feature/clone | +[**create_feature_template**](ConfigurationGeneralTemplateApi.md#create_feature_template) | **POST** /template/feature | +[**create_li_template**](ConfigurationGeneralTemplateApi.md#create_li_template) | **POST** /template/feature/li | +[**delete_general_template**](ConfigurationGeneralTemplateApi.md#delete_general_template) | **DELETE** /template/feature/{templateId} | +[**edit_feature_template**](ConfigurationGeneralTemplateApi.md#edit_feature_template) | **PUT** /template/feature/{templateId} | +[**edit_li_template**](ConfigurationGeneralTemplateApi.md#edit_li_template) | **PUT** /template/feature/li/{templateId} | +[**generate_feature_template_list**](ConfigurationGeneralTemplateApi.md#generate_feature_template_list) | **GET** /template/feature | +[**generate_master_template_definition**](ConfigurationGeneralTemplateApi.md#generate_master_template_definition) | **GET** /template/feature/master/{type_name} | +[**generate_template_by_device_type**](ConfigurationGeneralTemplateApi.md#generate_template_by_device_type) | **GET** /template/feature/{deviceType} | +[**generate_template_type_definition**](ConfigurationGeneralTemplateApi.md#generate_template_type_definition) | **GET** /template/feature/types/definition/{type_name}/{version} | +[**generate_template_types**](ConfigurationGeneralTemplateApi.md#generate_template_types) | **GET** /template/feature/types | +[**get_default_networks**](ConfigurationGeneralTemplateApi.md#get_default_networks) | **GET** /template/feature/default/networks | +[**get_device_templates_attached_to_feature**](ConfigurationGeneralTemplateApi.md#get_device_templates_attached_to_feature) | **GET** /template/feature/devicetemplates/{templateId} | +[**get_encrypted_string**](ConfigurationGeneralTemplateApi.md#get_encrypted_string) | **POST** /template/security/encryptText/encrypt | +[**get_general_template**](ConfigurationGeneralTemplateApi.md#get_general_template) | **GET** /template/feature/object/{templateId} | +[**get_network_interface**](ConfigurationGeneralTemplateApi.md#get_network_interface) | **GET** /template/feature/default/networkinterface | +[**get_template_definition**](ConfigurationGeneralTemplateApi.md#get_template_definition) | **GET** /template/feature/definition/{templateId} | +[**get_template_for_migration**](ConfigurationGeneralTemplateApi.md#get_template_for_migration) | **GET** /template/feature/migration | +[**list_li_template**](ConfigurationGeneralTemplateApi.md#list_li_template) | **GET** /template/feature/li | + + +# **change_template_resource_group** +> change_template_resource_group(template_id, resource_group_name) + + + +Change template resource group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Template Id + resource_group_name = "resourceGroupName_example" # str | Resrouce group name + + # example passing only required values which don't have defaults set + try: + api_instance.change_template_resource_group(template_id, resource_group_name) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->change_template_resource_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **resource_group_name** | **str**| Resrouce group name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **clone_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} clone_template(id, name, desc) + + + +Clone a feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + id = "220a6bd0-28ef-4c88-92e6-ee7539396fd7" # str | Template Id to clone from + name = "BR2-VPN10-Feature" # str | Name for the cloned template + desc = "desc_example" # str | Description for the cloned template + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.clone_template(id, name, desc) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->clone_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Template Id to clone from | + **name** | **str**| Name for the cloned template | + **desc** | **str**| Description for the cloned template | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_feature_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_feature_template() + + + +Create feature template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Feature template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_feature_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->create_feature_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Feature template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_li_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_li_template() + + + +Create LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | LI template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_li_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->create_li_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| LI template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_general_template** +> delete_general_template(template_id) + + + +Delete feature template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_general_template(template_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->delete_general_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_feature_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_feature_template(template_id) + + + +Update feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Template Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_feature_template(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->edit_feature_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_feature_template(template_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->edit_feature_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_li_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_li_template(template_id) + + + +Update LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Template Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | LI template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_li_template(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->edit_li_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_li_template(template_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->edit_li_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| LI template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_feature_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_feature_template_list() + + + +Get feature template list


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + summary = False # bool | Flag to include template definition (optional) if omitted the server will use the default value of False + offset = 1 # int | Pagination offset (optional) + limit = 0 # int | Pagination limit on templateId (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_feature_template_list(summary=summary, offset=offset, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->generate_feature_template_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **summary** | **bool**| Flag to include template definition | [optional] if omitted the server will use the default value of False + **offset** | **int**| Pagination offset | [optional] + **limit** | **int**| Pagination limit on templateId | [optional] if omitted the server will use the default value of 0 + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_master_template_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_master_template_definition(type_name) + + + +Generate template type definition by device type


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + type_name = "type_name_example" # str | Device type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_master_template_definition(type_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->generate_master_template_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type_name** | **str**| Device type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_template_by_device_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_template_by_device_type(device_type) + + + +Generate template based on device


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + device_type = "deviceType_example" # str | Device type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_template_by_device_type(device_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->generate_template_by_device_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_type** | **str**| Device type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_template_type_definition** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_template_type_definition(type_name, version) + + + +Generate template type definition


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + type_name = "type_name_example" # str | Feature template type + version = "version_example" # str | Version + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_template_type_definition(type_name, version) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->generate_template_type_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type_name** | **str**| Feature template type | + **version** | **str**| Version | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_template_types** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_template_types(type) + + + +Generate template types


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + type = "vedge" # str | Device type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_template_types(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->generate_template_types: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Device type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_default_networks** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_default_networks(device_model) + + + +Get default networks


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + device_model = "vedge-nfvis-ENCS5400" # str | Device model + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_default_networks(device_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_default_networks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_model** | **str**| Device model | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_templates_attached_to_feature** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_templates_attached_to_feature(template_id) + + + +Get all device templates for this feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Feature template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_templates_attached_to_feature(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_device_templates_attached_to_feature: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Feature template Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_encrypted_string** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_encrypted_string() + + + +Get Type 6 Encryptedd String for a given value + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Type6 Encryption (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_encrypted_string(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_encrypted_string: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Type6 Encryption | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_general_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_general_template(template_id) + + + +Get template object definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_general_template(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_general_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_network_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_network_interface(device_model) + + + +Get default network interface


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + device_model = "ENCS" # str | Device model + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_network_interface(device_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_network_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_model** | **str**| Device model | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_template_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_template_definition(template_id) + + + +Get the configured template definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_template_definition(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_template_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_template_for_migration** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_template_for_migration() + + + +Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_template_for_migration() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->get_template_for_migration: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_li_template** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_li_template() + + + +Get LI feature template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_general_template_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_general_template_api.ConfigurationGeneralTemplateApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_li_template() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationGeneralTemplateApi->list_li_template: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationIdentityServiceEngineApi.md b/docs/ConfigurationIdentityServiceEngineApi.md new file mode 100644 index 0000000..a11ab6f --- /dev/null +++ b/docs/ConfigurationIdentityServiceEngineApi.md @@ -0,0 +1,147 @@ +# openapi_client.ConfigurationIdentityServiceEngineApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_all_identity_lists**](ConfigurationIdentityServiceEngineApi.md#delete_all_identity_lists) | **DELETE** /template/policy/ise/identity/deleteAllLists | +[**get_identity_list_reference**](ConfigurationIdentityServiceEngineApi.md#get_identity_list_reference) | **GET** /template/policy/ise/identity/referenced/{listType} | + + +# **delete_all_identity_lists** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_all_identity_lists() + + + +Delete all identity lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_identity_service_engine_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_identity_service_engine_api.ConfigurationIdentityServiceEngineApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Delete lists (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_all_identity_lists(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIdentityServiceEngineApi->delete_all_identity_lists: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Delete lists | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_identity_list_reference** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_identity_list_reference(list_type) + + + +Get all referenced Identity Lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_identity_service_engine_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_identity_service_engine_api.ConfigurationIdentityServiceEngineApi(api_client) + list_type = "listType_example" # str | list type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_identity_list_reference(list_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIdentityServiceEngineApi->get_identity_list_reference: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **list_type** | **str**| list type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationIseServerApi.md b/docs/ConfigurationIseServerApi.md new file mode 100644 index 0000000..ca479c0 --- /dev/null +++ b/docs/ConfigurationIseServerApi.md @@ -0,0 +1,948 @@ +# openapi_client.ConfigurationIseServerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**account_activate**](ConfigurationIseServerApi.md#account_activate) | **POST** /ise/pxgrid/activate | +[**account_create**](ConfigurationIseServerApi.md#account_create) | **POST** /ise/pxgrid/create | +[**add_ise_server_credentials**](ConfigurationIseServerApi.md#add_ise_server_credentials) | **POST** /ise/credentials | +[**approve**](ConfigurationIseServerApi.md#approve) | **PUT** /ise/pxgrid/approve | +[**connect1**](ConfigurationIseServerApi.md#connect1) | **GET** /ise/connect | +[**delete_ise_and_px_grid_account**](ConfigurationIseServerApi.md#delete_ise_and_px_grid_account) | **DELETE** /ise/credentials/iseandpxgrid | +[**delete_px_grid**](ConfigurationIseServerApi.md#delete_px_grid) | **DELETE** /ise/credentials/pxgrid | +[**get_identity_user_groups**](ConfigurationIseServerApi.md#get_identity_user_groups) | **POST** /template/policy/ise/identity/usergroups | +[**get_identity_users**](ConfigurationIseServerApi.md#get_identity_users) | **POST** /template/policy/ise/identity/users | +[**get_ise_server_credentials**](ConfigurationIseServerApi.md#get_ise_server_credentials) | **GET** /ise/credentials | +[**get_p_xgrid_cert**](ConfigurationIseServerApi.md#get_p_xgrid_cert) | **GET** /ise/credentials/pxgrid/cert | +[**get_px_grid_account**](ConfigurationIseServerApi.md#get_px_grid_account) | **GET** /ise/credentials/pxgrid | +[**sync_vsmart**](ConfigurationIseServerApi.md#sync_vsmart) | **POST** /ise/credentials/vsmart/sync | +[**update_ise_server_credentials**](ConfigurationIseServerApi.md#update_ise_server_credentials) | **PUT** /ise/credentials | + + +# **account_activate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} account_activate() + + + +pxGrid Account Activate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.account_activate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->account_activate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **account_create** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} account_create() + + + +pxGrid Account Create + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.account_create(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->account_create: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_ise_server_credentials** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} add_ise_server_credentials() + + + +Add Ise server credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Config Ise server request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_ise_server_credentials(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->add_ise_server_credentials: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Config Ise server request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **approve** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} approve() + + + +pxGrid Account Approve with ERS API + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.approve() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->approve: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **connect1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} connect1() + + + +ISE connect + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.connect1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->connect1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_ise_and_px_grid_account** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_ise_and_px_grid_account() + + + +Delete ISE and PxGrid on vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete_ise_and_px_grid_account() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->delete_ise_and_px_grid_account: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_px_grid** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_px_grid() + + + +Delete PxGrid on vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete_px_grid() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->delete_px_grid: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_identity_user_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_identity_user_groups() + + + +Get all identity user groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Get Users (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_identity_user_groups(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->get_identity_user_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Get Users | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_identity_users** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_identity_users() + + + +Get all identity users + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Get Users (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_identity_users(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->get_identity_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Get Users | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ise_server_credentials** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ise_server_credentials() + + + +Get Ise server credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_ise_server_credentials() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->get_ise_server_credentials: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_p_xgrid_cert** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_p_xgrid_cert() + + + +getPXgridCert + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_p_xgrid_cert() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->get_p_xgrid_cert: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_px_grid_account** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_px_grid_account() + + + +Get PXGrid account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_px_grid_account() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->get_px_grid_account: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_vsmart** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sync_vsmart() + + + +syncVsmart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.sync_vsmart() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->sync_vsmart: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_ise_server_credentials** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_ise_server_credentials() + + + +Configure Ise server credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ise_server_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ise_server_api.ConfigurationIseServerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Config Ise server request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_ise_server_credentials(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationIseServerApi->update_ise_server_credentials: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Config Ise server request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationMultiCloudApi.md b/docs/ConfigurationMultiCloudApi.md new file mode 100644 index 0000000..b4729dd --- /dev/null +++ b/docs/ConfigurationMultiCloudApi.md @@ -0,0 +1,8486 @@ +# openapi_client.ConfigurationMultiCloudApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_edge_global_settings**](ConfigurationMultiCloudApi.md#add_edge_global_settings) | **POST** /multicloud/settings/edge/global | +[**add_global_settings**](ConfigurationMultiCloudApi.md#add_global_settings) | **POST** /multicloud/settings/global | +[**attach_sites**](ConfigurationMultiCloudApi.md#attach_sites) | **POST** /multicloud/cloudgateway/{cloudGatewayName}/site | +[**audit**](ConfigurationMultiCloudApi.md#audit) | **POST** /multicloud/audit | +[**audit_dry_run**](ConfigurationMultiCloudApi.md#audit_dry_run) | **GET** /multicloud/audit | +[**clean_up_all_connectivity_gateways_in_local_db**](ConfigurationMultiCloudApi.md#clean_up_all_connectivity_gateways_in_local_db) | **DELETE** /multicloud/connectivitygateway | +[**create_cgw**](ConfigurationMultiCloudApi.md#create_cgw) | **POST** /multicloud/cloudgateway | +[**create_connectivity_gateway**](ConfigurationMultiCloudApi.md#create_connectivity_gateway) | **POST** /multicloud/connectivitygateway | +[**create_device_link**](ConfigurationMultiCloudApi.md#create_device_link) | **POST** /multicloud/devicelink/edge | +[**create_edge_connectivity**](ConfigurationMultiCloudApi.md#create_edge_connectivity) | **POST** /multicloud/connectivity/edge | +[**create_icgw**](ConfigurationMultiCloudApi.md#create_icgw) | **POST** /multicloud/gateway/edge | +[**create_virtual_wan**](ConfigurationMultiCloudApi.md#create_virtual_wan) | **POST** /multicloud/vwan | +[**delete_account**](ConfigurationMultiCloudApi.md#delete_account) | **DELETE** /multicloud/accounts/{accountId} | +[**delete_cgw**](ConfigurationMultiCloudApi.md#delete_cgw) | **DELETE** /multicloud/cloudgateway/{cloudGatewayName} | +[**delete_connectivity_gateway**](ConfigurationMultiCloudApi.md#delete_connectivity_gateway) | **DELETE** /multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName} | +[**delete_device_link**](ConfigurationMultiCloudApi.md#delete_device_link) | **DELETE** /multicloud/devicelink/edge/{deviceLinkName} | +[**delete_edge_account**](ConfigurationMultiCloudApi.md#delete_edge_account) | **DELETE** /multicloud/accounts/edge/{accountId} | +[**delete_edge_account1**](ConfigurationMultiCloudApi.md#delete_edge_account1) | **DELETE** /multicloud/locations/edge/{edgeType} | +[**delete_edge_connectivity**](ConfigurationMultiCloudApi.md#delete_edge_connectivity) | **DELETE** /multicloud/connectivity/edge/{connectionName} | +[**delete_icgw**](ConfigurationMultiCloudApi.md#delete_icgw) | **DELETE** /multicloud/gateway/edge/{edgeGatewayName} | +[**delete_virtual_wan**](ConfigurationMultiCloudApi.md#delete_virtual_wan) | **DELETE** /multicloud/vwan/{cloudProvider}/{vWanName} | +[**detach_sites1**](ConfigurationMultiCloudApi.md#detach_sites1) | **DELETE** /multicloud/cloudgateway/{cloudGatewayName}/site | +[**edge_audit**](ConfigurationMultiCloudApi.md#edge_audit) | **POST** /multicloud/audit/edge | +[**edge_audit_dry_run**](ConfigurationMultiCloudApi.md#edge_audit_dry_run) | **GET** /multicloud/audit/edge | +[**edit_tag**](ConfigurationMultiCloudApi.md#edit_tag) | **PUT** /multicloud/hostvpc/tags | +[**get_all_cloud_accounts**](ConfigurationMultiCloudApi.md#get_all_cloud_accounts) | **GET** /multicloud/accounts | +[**get_azure_network_virtual_appliances**](ConfigurationMultiCloudApi.md#get_azure_network_virtual_appliances) | **GET** /multicloud/cloudgateway/nvas | +[**get_azure_nva_sku_list**](ConfigurationMultiCloudApi.md#get_azure_nva_sku_list) | **GET** /multicloud/cloudgateway/nvasku | +[**get_azure_resource_groups**](ConfigurationMultiCloudApi.md#get_azure_resource_groups) | **GET** /multicloud/cloudgateway/resourceGroups | +[**get_azure_virtual_hubs**](ConfigurationMultiCloudApi.md#get_azure_virtual_hubs) | **GET** /multicloud/cloudgateway/vhubs | +[**get_azure_virtual_wans**](ConfigurationMultiCloudApi.md#get_azure_virtual_wans) | **GET** /multicloud/cloudgateway/vwans | +[**get_cgw_associated_mappings**](ConfigurationMultiCloudApi.md#get_cgw_associated_mappings) | **GET** /multicloud/mapping/{cloudType} | +[**get_cgw_custom_setting_details**](ConfigurationMultiCloudApi.md#get_cgw_custom_setting_details) | **GET** /multicloud/cloudgatewaysetting/{cloudGatewayName} | +[**get_cgw_details**](ConfigurationMultiCloudApi.md#get_cgw_details) | **GET** /multicloud/cloudgateway/{cloudGatewayName} | +[**get_cgw_org_resources**](ConfigurationMultiCloudApi.md#get_cgw_org_resources) | **GET** /multicloud/cloudgateway/resource | +[**get_cgw_types**](ConfigurationMultiCloudApi.md#get_cgw_types) | **GET** /multicloud/cloudgatewaytype | +[**get_cgws**](ConfigurationMultiCloudApi.md#get_cgws) | **GET** /multicloud/cloudgateway | +[**get_cloud_account_details**](ConfigurationMultiCloudApi.md#get_cloud_account_details) | **GET** /multicloud/accounts/{accountId} | +[**get_cloud_connected_sites**](ConfigurationMultiCloudApi.md#get_cloud_connected_sites) | **GET** /multicloud/connected-sites/{cloudType} | +[**get_cloud_connected_sites1**](ConfigurationMultiCloudApi.md#get_cloud_connected_sites1) | **GET** /multicloud/connected-sites/edge/{edgeType} | +[**get_cloud_devices**](ConfigurationMultiCloudApi.md#get_cloud_devices) | **GET** /multicloud/devices/{cloudType} | +[**get_cloud_devices1**](ConfigurationMultiCloudApi.md#get_cloud_devices1) | **GET** /multicloud/devices/edge/{edgeType} | +[**get_cloud_gateways**](ConfigurationMultiCloudApi.md#get_cloud_gateways) | **GET** /multicloud/cloudgateways/{cloudType} | +[**get_cloud_regions**](ConfigurationMultiCloudApi.md#get_cloud_regions) | **GET** /multicloud/regions | +[**get_cloud_routers_and_attachments**](ConfigurationMultiCloudApi.md#get_cloud_routers_and_attachments) | **GET** /multicloud/cloudRoutersAndAttachments | +[**get_cloud_types**](ConfigurationMultiCloudApi.md#get_cloud_types) | **GET** /multicloud/types | +[**get_cloud_widget**](ConfigurationMultiCloudApi.md#get_cloud_widget) | **GET** /multicloud/widget/{cloudType} | +[**get_connectivity_gateway_creation_options**](ConfigurationMultiCloudApi.md#get_connectivity_gateway_creation_options) | **GET** /multicloud/connectivitygatewaycreationoptions | +[**get_connectivity_gateways**](ConfigurationMultiCloudApi.md#get_connectivity_gateways) | **GET** /multicloud/connectivitygateway | +[**get_dashboard_edge_info**](ConfigurationMultiCloudApi.md#get_dashboard_edge_info) | **GET** /multicloud/dashboard/edge | +[**get_default_mapping_values**](ConfigurationMultiCloudApi.md#get_default_mapping_values) | **GET** /multicloud/map/defaults | +[**get_device_link_metro_speed**](ConfigurationMultiCloudApi.md#get_device_link_metro_speed) | **POST** /multicloud/devicelink/metroSpeed/edge | +[**get_device_links**](ConfigurationMultiCloudApi.md#get_device_links) | **GET** /multicloud/devicelink/edge | +[**get_dl_port_speed**](ConfigurationMultiCloudApi.md#get_dl_port_speed) | **GET** /multicloud/devicelink/edge/portspeed/{edgeType} | +[**get_edge_account_details**](ConfigurationMultiCloudApi.md#get_edge_account_details) | **GET** /multicloud/accounts/edge/{accountId} | +[**get_edge_accounts**](ConfigurationMultiCloudApi.md#get_edge_accounts) | **GET** /multicloud/accounts/edge | +[**get_edge_billing_accounts**](ConfigurationMultiCloudApi.md#get_edge_billing_accounts) | **GET** /multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId} | +[**get_edge_connectivity_detail_by_name**](ConfigurationMultiCloudApi.md#get_edge_connectivity_detail_by_name) | **GET** /multicloud/connectivity/edge/{connectivityName} | +[**get_edge_connectivity_details**](ConfigurationMultiCloudApi.md#get_edge_connectivity_details) | **GET** /multicloud/connectivity/edge | +[**get_edge_gateways**](ConfigurationMultiCloudApi.md#get_edge_gateways) | **GET** /multicloud/gateways/edge/{edgeType} | +[**get_edge_global_settings**](ConfigurationMultiCloudApi.md#get_edge_global_settings) | **GET** /multicloud/settings/edge/global | +[**get_edge_locations_info**](ConfigurationMultiCloudApi.md#get_edge_locations_info) | **GET** /multicloud/locations/edge/{edgeType} | +[**get_edge_mapping_tags**](ConfigurationMultiCloudApi.md#get_edge_mapping_tags) | **GET** /multicloud/map/tags/edge | +[**get_edge_types**](ConfigurationMultiCloudApi.md#get_edge_types) | **GET** /multicloud/types/edge | +[**get_edge_wan_devices**](ConfigurationMultiCloudApi.md#get_edge_wan_devices) | **GET** /multicloud/edge/{edgeType}/device | +[**get_edge_widget**](ConfigurationMultiCloudApi.md#get_edge_widget) | **GET** /multicloud/widget/edge/{edgeType} | +[**get_global_settings**](ConfigurationMultiCloudApi.md#get_global_settings) | **GET** /multicloud/settings/global | +[**get_host_vpcs**](ConfigurationMultiCloudApi.md#get_host_vpcs) | **GET** /multicloud/hostvpc | +[**get_icgw_custom_setting_details**](ConfigurationMultiCloudApi.md#get_icgw_custom_setting_details) | **GET** /multicloud/gateway/edge/setting/{edgeGatewayName} | +[**get_icgw_details**](ConfigurationMultiCloudApi.md#get_icgw_details) | **GET** /multicloud/gateway/edge/{edgeGatewayName} | +[**get_icgw_types**](ConfigurationMultiCloudApi.md#get_icgw_types) | **GET** /multicloud/gateway/edge/types | +[**get_icgws**](ConfigurationMultiCloudApi.md#get_icgws) | **GET** /multicloud/gateway/edge | +[**get_licenses**](ConfigurationMultiCloudApi.md#get_licenses) | **GET** /multicloud/license/edge | +[**get_mapping_matrix**](ConfigurationMultiCloudApi.md#get_mapping_matrix) | **GET** /multicloud/map | +[**get_mapping_status**](ConfigurationMultiCloudApi.md#get_mapping_status) | **GET** /multicloud/map/status | +[**get_mapping_summary**](ConfigurationMultiCloudApi.md#get_mapping_summary) | **GET** /multicloud/map/summary | +[**get_mapping_tags**](ConfigurationMultiCloudApi.md#get_mapping_tags) | **GET** /multicloud/map/tags | +[**get_mapping_vpns**](ConfigurationMultiCloudApi.md#get_mapping_vpns) | **GET** /multicloud/map/vpns | +[**get_nva_security_rules**](ConfigurationMultiCloudApi.md#get_nva_security_rules) | **GET** /multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName} | +[**get_partner_ports**](ConfigurationMultiCloudApi.md#get_partner_ports) | **GET** /multicloud/partnerports/edge | +[**get_port_speed**](ConfigurationMultiCloudApi.md#get_port_speed) | **GET** /multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType} | +[**get_post_aggregation_data_by_query25**](ConfigurationMultiCloudApi.md#get_post_aggregation_data_by_query25) | **POST** /multicloud/statistics/interface/aggregation | +[**get_sites**](ConfigurationMultiCloudApi.md#get_sites) | **GET** /multicloud/site | +[**get_sites1**](ConfigurationMultiCloudApi.md#get_sites1) | **GET** /multicloud/cloudgateway/{cloudGatewayName}/site | +[**get_ssh_key_list**](ConfigurationMultiCloudApi.md#get_ssh_key_list) | **GET** /multicloud/sshkeys | +[**get_supported_edge_image_names**](ConfigurationMultiCloudApi.md#get_supported_edge_image_names) | **GET** /multicloud/imagename/edge | +[**get_supported_edge_instance_size**](ConfigurationMultiCloudApi.md#get_supported_edge_instance_size) | **GET** /multicloud/instancesize/edge | +[**get_supported_instance_size**](ConfigurationMultiCloudApi.md#get_supported_instance_size) | **GET** /multicloud/instancesize | +[**get_supported_loopback_cgw_colors**](ConfigurationMultiCloudApi.md#get_supported_loopback_cgw_colors) | **GET** /multicloud/loopbackCGWColor/edge | +[**get_supported_loopback_transport_colors**](ConfigurationMultiCloudApi.md#get_supported_loopback_transport_colors) | **GET** /multicloud/loopbacktransportcolor/edge | +[**get_supported_software_image_list**](ConfigurationMultiCloudApi.md#get_supported_software_image_list) | **GET** /multicloud/swimages | +[**get_tunnel_names**](ConfigurationMultiCloudApi.md#get_tunnel_names) | **GET** /multicloud/tunnels/{cloudType} | +[**get_v_hubs**](ConfigurationMultiCloudApi.md#get_v_hubs) | **GET** /multicloud/vhubs | +[**get_v_wans**](ConfigurationMultiCloudApi.md#get_v_wans) | **GET** /multicloud/vwans | +[**get_vpc_tags**](ConfigurationMultiCloudApi.md#get_vpc_tags) | **GET** /multicloud/hostvpc/tags | +[**get_wan_devices**](ConfigurationMultiCloudApi.md#get_wan_devices) | **GET** /multicloud/device | +[**get_wan_interface_colors**](ConfigurationMultiCloudApi.md#get_wan_interface_colors) | **GET** /multicloud/interfacecolor | +[**hostvpc_tagging**](ConfigurationMultiCloudApi.md#hostvpc_tagging) | **POST** /multicloud/hostvpc/tags | +[**process_mapping**](ConfigurationMultiCloudApi.md#process_mapping) | **POST** /multicloud/map | +[**telemetry**](ConfigurationMultiCloudApi.md#telemetry) | **POST** /multicloud/telemetry | +[**tunnel_scaling**](ConfigurationMultiCloudApi.md#tunnel_scaling) | **PUT** /multicloud/cloudgateway/{cloudGatewayName}/site | +[**un_tag**](ConfigurationMultiCloudApi.md#un_tag) | **DELETE** /multicloud/hostvpc/tags/{tagName} | +[**update_account**](ConfigurationMultiCloudApi.md#update_account) | **PUT** /multicloud/accounts/{accountId} | +[**update_cgw**](ConfigurationMultiCloudApi.md#update_cgw) | **PUT** /multicloud/cloudgateway/{cloudGatewayName} | +[**update_device_link**](ConfigurationMultiCloudApi.md#update_device_link) | **PUT** /multicloud/devicelink/edge | +[**update_edge_account**](ConfigurationMultiCloudApi.md#update_edge_account) | **PUT** /multicloud/accounts/edge/{accountId} | +[**update_edge_connectivity**](ConfigurationMultiCloudApi.md#update_edge_connectivity) | **PUT** /multicloud/connectivity/edge | +[**update_edge_global_settings**](ConfigurationMultiCloudApi.md#update_edge_global_settings) | **PUT** /multicloud/settings/edge/global | +[**update_edge_locations_info**](ConfigurationMultiCloudApi.md#update_edge_locations_info) | **PUT** /multicloud/locations/edge/{edgeType}/accountId/{accountId} | +[**update_global_settings**](ConfigurationMultiCloudApi.md#update_global_settings) | **PUT** /multicloud/settings/global | +[**update_icgw**](ConfigurationMultiCloudApi.md#update_icgw) | **PUT** /multicloud/gateway/edge/{edgeGatewayName} | +[**update_nva_security_rules**](ConfigurationMultiCloudApi.md#update_nva_security_rules) | **PUT** /multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName} | +[**validate_account_add**](ConfigurationMultiCloudApi.md#validate_account_add) | **POST** /multicloud/accounts | +[**validate_account_update_credentials**](ConfigurationMultiCloudApi.md#validate_account_update_credentials) | **PUT** /multicloud/accounts/{accountId}/credentials | +[**validate_edge_account_add**](ConfigurationMultiCloudApi.md#validate_edge_account_add) | **POST** /multicloud/accounts/edge | +[**validate_edge_account_update_credentials**](ConfigurationMultiCloudApi.md#validate_edge_account_update_credentials) | **PUT** /multicloud/accounts/edge/{accountId}/credentials | + + +# **add_edge_global_settings** +> add_edge_global_settings() + + + +Add global settings for Edge provider + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_edge_global_settings(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->add_edge_global_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **add_global_settings** +> add_global_settings() + + + +Acquire ip from resource pool + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_global_settings(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->add_global_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **attach_sites** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} attach_sites(cloud_gateway_name) + + + +Attach sites to cloud gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Site information (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.attach_sites(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->attach_sites: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.attach_sites(cloud_gateway_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->attach_sites: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Site information | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **audit** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} audit() + + + +Call an audit + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Audit (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.audit(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->audit: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Audit | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **audit_dry_run** +> audit_dry_run() + + + +Call an audit with dry run + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type (optional) + cloud_region = "cloudRegion_example" # str | Region (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.audit_dry_run(cloud_type=cloud_type, cloud_region=cloud_region) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->audit_dry_run: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | [optional] + **cloud_region** | **str**| Region | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **clean_up_all_connectivity_gateways_in_local_db** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} clean_up_all_connectivity_gateways_in_local_db() + + + +Delete all Connectivity Gateways in local DB + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + deletion_type = "deletionType_example" # str | Deletion Type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.clean_up_all_connectivity_gateways_in_local_db(deletion_type=deletion_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->clean_up_all_connectivity_gateways_in_local_db: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deletion_type** | **str**| Deletion Type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cgw** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cgw() + + + +Create cloud gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloud gateway (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cgw(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->create_cgw: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloud gateway | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_connectivity_gateway** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_connectivity_gateway() + + + +Create Connectivity gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Connectivity gateway (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_connectivity_gateway(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->create_connectivity_gateway: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Connectivity gateway | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_link** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_link() + + + +Create Device Link + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device Link (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_device_link(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->create_device_link: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device Link | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_edge_connectivity** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_edge_connectivity() + + + +Create Interconnect connectivity + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Edge connectivity (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_edge_connectivity(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->create_edge_connectivity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Edge connectivity | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_icgw** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_icgw() + + + +Create Interconnect Gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Interconnect Gateway (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_icgw(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->create_icgw: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Interconnect Gateway | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_virtual_wan** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_virtual_wan() + + + +Create Virtual WAN + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Virtual WAN (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_virtual_wan(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->create_virtual_wan: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Virtual WAN | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_account** +> delete_account(account_id) + + + +Delete cloud account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_account(account_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_account: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_cgw** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_cgw(cloud_gateway_name) + + + +Delete cloud gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + delete_all_resources = True # bool | Optional Flag for deletion of Azure Resource Group, Default: True (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_cgw(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_cgw: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_cgw(cloud_gateway_name, delete_all_resources=delete_all_resources) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_cgw: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **delete_all_resources** | **bool**| Optional Flag for deletion of Azure Resource Group, Default: True | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_connectivity_gateway** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_connectivity_gateway(cloud_provider, connectivity_gateway_name) + + + +Delete Connectivity Gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_provider = "cloudProvider_example" # str | Cloud Provider + connectivity_gateway_name = "connectivityGatewayName_example" # str | Connectivity gateway name + connectivity_type = "connectivityType_example" # str | Cloud Connectivity Type (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_connectivity_gateway(cloud_provider, connectivity_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_connectivity_gateway: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_connectivity_gateway(cloud_provider, connectivity_gateway_name, connectivity_type=connectivity_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_connectivity_gateway: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_provider** | **str**| Cloud Provider | + **connectivity_gateway_name** | **str**| Connectivity gateway name | + **connectivity_type** | **str**| Cloud Connectivity Type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_device_link** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_device_link(device_link_name) + + + +Delete Device Link + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + device_link_name = "deviceLinkName_example" # str | Device Link Name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_device_link(device_link_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_device_link: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_link_name** | **str**| Device Link Name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_edge_account** +> delete_edge_account(account_id) + + + +Delete edge account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Edge Account Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_edge_account(account_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_edge_account: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Edge Account Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_edge_account1** +> delete_edge_account1() + + + +Delete edge account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_instance.delete_edge_account1() + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_edge_account1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge Type | defaults to "MEGAPORT" + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_edge_connectivity** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_edge_connectivity(connection_name) + + + +Delete Interconnect connectivity + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + connection_name = "connectionName_example" # str | Edge connectivity name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_edge_connectivity(connection_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_edge_connectivity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connection_name** | **str**| Edge connectivity name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_icgw** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_icgw(edge_gateway_name) + + + +Delete Interconnect Gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_gateway_name = "edgeGatewayName_example" # str | Edge gateway name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_icgw(edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_icgw: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_gateway_name** | **str**| Edge gateway name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_virtual_wan** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_virtual_wan(cloud_provider, v_wan_name) + + + +Delete Virtual Wan + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_provider = "cloudProvider_example" # str | Cloud Provider + v_wan_name = "vWanName_example" # str | Virtual Wan name + account_id = "accountId_example" # str | Account Id (optional) + resource_group = "resourceGroup_example" # str | Resource Group (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_virtual_wan(cloud_provider, v_wan_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_virtual_wan: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_virtual_wan(cloud_provider, v_wan_name, account_id=account_id, resource_group=resource_group) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->delete_virtual_wan: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_provider** | **str**| Cloud Provider | + **v_wan_name** | **str**| Virtual Wan name | + **account_id** | **str**| Account Id | [optional] + **resource_group** | **str**| Resource Group | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **detach_sites1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} detach_sites1(cloud_gateway_name) + + + +Detach sites from cloud gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Site information (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.detach_sites1(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->detach_sites1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.detach_sites1(cloud_gateway_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->detach_sites1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Site information | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edge_audit** +> edge_audit() + + + +Call an edge audit + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "edgeType_example" # str | Edge type (optional) + cloud_type = "cloudType_example" # str | Cloud type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edge_audit(edge_type=edge_type, cloud_type=cloud_type) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->edge_audit: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + **cloud_type** | **str**| Cloud type | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edge_audit_dry_run** +> edge_audit_dry_run() + + + +Call an edge audit with dry run + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "edgeType_example" # str | Edge type (optional) + cloud_type = "cloudType_example" # str | Cloud type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edge_audit_dry_run(edge_type=edge_type, cloud_type=cloud_type) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->edge_audit_dry_run: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + **cloud_type** | **str**| Cloud type | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_tag** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_tag() + + + +Edit VPCs for a tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPC tag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_tag(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->edit_tag: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPC tag | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_cloud_accounts** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_cloud_accounts() + + + +Get All cloud accounts + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type (optional) + cloud_gateway_enabled = True # bool | Cloud gateway enabled flag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_all_cloud_accounts(cloud_type=cloud_type, cloud_gateway_enabled=cloud_gateway_enabled) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_all_cloud_accounts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | [optional] + **cloud_gateway_enabled** | **bool**| Cloud gateway enabled flag | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_azure_network_virtual_appliances** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_azure_network_virtual_appliances(cloud_type, accound_id, region, resource_group_name, resource_group_source, vhub_name, vhub_source) + + + +Discover Azure Virtual NVAs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AZURE" # str | Cloud type + accound_id = "accoundId_example" # str | Account ID + region = "region_example" # str | Region + resource_group_name = "resourceGroupName_example" # str | Resource Group Name + resource_group_source = "resourceGroupSource_example" # str | Resource Group Source + vhub_name = "vhubName_example" # str | VHUB name + vhub_source = "vhubSource_example" # str | VHUB source + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_azure_network_virtual_appliances(cloud_type, accound_id, region, resource_group_name, resource_group_source, vhub_name, vhub_source) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_azure_network_virtual_appliances: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **accound_id** | **str**| Account ID | + **region** | **str**| Region | + **resource_group_name** | **str**| Resource Group Name | + **resource_group_source** | **str**| Resource Group Source | + **vhub_name** | **str**| VHUB name | + **vhub_source** | **str**| VHUB source | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_azure_nva_sku_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_azure_nva_sku_list(cloud_type) + + + +Get Azure NVA SKUs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_azure_nva_sku_list(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_azure_nva_sku_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_azure_resource_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_azure_resource_groups(cloud_type, account_id) + + + +Discover Azure Resource Groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AZURE" # str | Cloud type + account_id = "accountId_example" # str | Account ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_azure_resource_groups(cloud_type, account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_azure_resource_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **account_id** | **str**| Account ID | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_azure_virtual_hubs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_azure_virtual_hubs(cloud_type, accound_id, region, resource_group_name, resource_group_source, vwan_name, vwan_source) + + + +Discover Azure Virtual HUBs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AZURE" # str | Cloud type + accound_id = "accoundId_example" # str | Account ID + region = "region_example" # str | Region + resource_group_name = "resourceGroupName_example" # str | Resource Group Name + resource_group_source = "resourceGroupSource_example" # str | Resource Group Source + vwan_name = "vwanName_example" # str | VWAN name + vwan_source = "vwanSource_example" # str | VWAN source + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_azure_virtual_hubs(cloud_type, accound_id, region, resource_group_name, resource_group_source, vwan_name, vwan_source) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_azure_virtual_hubs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **accound_id** | **str**| Account ID | + **region** | **str**| Region | + **resource_group_name** | **str**| Resource Group Name | + **resource_group_source** | **str**| Resource Group Source | + **vwan_name** | **str**| VWAN name | + **vwan_source** | **str**| VWAN source | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_azure_virtual_wans** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_azure_virtual_wans(cloud_type, accound_id, resource_group_name, resource_group_source) + + + +Discover Azure Virtual WANs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AZURE" # str | Cloud type + accound_id = "accoundId_example" # str | Account ID + resource_group_name = "resourceGroupName_example" # str | Resource Group Name + resource_group_source = "resourceGroupSource_example" # str | Resource Group Source + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_azure_virtual_wans(cloud_type, accound_id, resource_group_name, resource_group_source) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_azure_virtual_wans: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **accound_id** | **str**| Account ID | + **resource_group_name** | **str**| Resource Group Name | + **resource_group_source** | **str**| Resource Group Source | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cgw_associated_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cgw_associated_mappings(cloud_type, cloud_gateway_name) + + + +Get associated mappings to the CGW + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud type + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud Gateway Name + site_uuid = "siteUuid_example" # str | Site Device UUID (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cgw_associated_mappings(cloud_type, cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgw_associated_mappings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cgw_associated_mappings(cloud_type, cloud_gateway_name, site_uuid=site_uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgw_associated_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **cloud_gateway_name** | **str**| Cloud Gateway Name | + **site_uuid** | **str**| Site Device UUID | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cgw_custom_setting_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cgw_custom_setting_details(cloud_gateway_name) + + + +Get cloud gateway custom setting by cloud gateway name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cgw_custom_setting_details(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgw_custom_setting_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cgw_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cgw_details(cloud_gateway_name) + + + +Get cloud gateway by name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cgw_details(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgw_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cgw_org_resources** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cgw_org_resources(cloud_gateway_name) + + + +Get cloud gateways + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cgw_org_resources(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgw_org_resources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cgw_types** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cgw_types() + + + +Get cloud gateway types for specified cloudType + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cgw_types(cloud_type=cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgw_types: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cgws** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cgws() + + + +Get cloud gateways + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type (optional) + account_id = "accountId_example" # str | Account Id (optional) + region = "region_example" # str | Region (optional) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name (optional) + connectivity_state = "connectivityState_example" # str | Connectivity State (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cgws(cloud_type=cloud_type, account_id=account_id, region=region, cloud_gateway_name=cloud_gateway_name, connectivity_state=connectivity_state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cgws: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | [optional] + **account_id** | **str**| Account Id | [optional] + **region** | **str**| Region | [optional] + **cloud_gateway_name** | **str**| Cloud gateway name | [optional] + **connectivity_state** | **str**| Connectivity State | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_account_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_account_details(account_id) + + + +Get cloud account by account Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_account_details(account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_account_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_connected_sites** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_connected_sites(cloud_type) + + + +Get sites with connectivity to the cloud by cloud type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud type + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud Gateway Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_connected_sites(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_connected_sites: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_connected_sites(cloud_type, cloud_gateway_name=cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_connected_sites: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **cloud_gateway_name** | **str**| Cloud Gateway Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_connected_sites1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_connected_sites1(edge_type) + + + +Get sites with connectivity to the interconnect gateways by edge type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "edgeType_example" # str | Edge type + edge_gateway_name = "edgeGatewayName_example" # str | Interconnect Gateway Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_connected_sites1(edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_connected_sites1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_connected_sites1(edge_type, edge_gateway_name=edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_connected_sites1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | + **edge_gateway_name** | **str**| Interconnect Gateway Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_devices(cloud_type) + + + +Get cloud devices by cloud type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud type + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud Gateway Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_devices(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_devices: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_devices(cloud_type, cloud_gateway_name=cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **cloud_gateway_name** | **str**| Cloud Gateway Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_devices1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_devices1(edge_type) + + + +Get cloud devices by cloud type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "edgeType_example" # str | Edge type + edge_gateway_name = "edgeGatewayName_example" # str | Edge Gateway Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_devices1(edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_devices1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_devices1(edge_type, edge_gateway_name=edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_devices1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | + **edge_gateway_name** | **str**| Edge Gateway Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_gateways** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_gateways(cloud_type) + + + +Get sites with connectivity to the cloud by cloud type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_gateways(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_gateways: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_regions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_regions() + + + +Get cloud regions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_regions(cloud_type=cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_regions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_routers_and_attachments** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_routers_and_attachments() + + + +Get all Cloud Routers and their Attachments + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id (optional) + region = "region_example" # str | Region (optional) + network = "network_example" # str | Network (optional) + connectivity_gateway_name = "connectivityGatewayName_example" # str | Connectivity Gateway Name (optional) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud Gateway Name (optional) + state = "state_example" # str | State (optional) + refresh = "refresh_example" # str | Refresh (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cloud_routers_and_attachments(account_id=account_id, region=region, network=network, connectivity_gateway_name=connectivity_gateway_name, cloud_gateway_name=cloud_gateway_name, state=state, refresh=refresh) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_routers_and_attachments: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | [optional] + **region** | **str**| Region | [optional] + **network** | **str**| Network | [optional] + **connectivity_gateway_name** | **str**| Connectivity Gateway Name | [optional] + **cloud_gateway_name** | **str**| Cloud Gateway Name | [optional] + **state** | **str**| State | [optional] + **refresh** | **str**| Refresh | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_types** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_types() + + + +Get cloud types + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_types() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_types: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_widget** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_widget(cloud_type) + + + +Get cloud widget by cloud type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_widget(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_cloud_widget: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_connectivity_gateway_creation_options** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_connectivity_gateway_creation_options() + + + +Get connectivity gateway creation options + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id (optional) + cloud_type = "cloudType_example" # str | Cloud Type (optional) + connectivity_type = "connectivityType_example" # str | Cloud Connectivity Type (optional) + refresh = "refresh_example" # str | Refresh (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_connectivity_gateway_creation_options(account_id=account_id, cloud_type=cloud_type, connectivity_type=connectivity_type, refresh=refresh) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_connectivity_gateway_creation_options: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | [optional] + **cloud_type** | **str**| Cloud Type | [optional] + **connectivity_type** | **str**| Cloud Connectivity Type | [optional] + **refresh** | **str**| Refresh | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_connectivity_gateways** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_connectivity_gateways() + + + +Get all Connectivity Gateways + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id (optional) + cloud_type = "cloudType_example" # str | Cloud Type (optional) + connectivity_type = "connectivityType_example" # str | Cloud Connectivity Type (optional) + connectivity_gateway_name = "connectivityGatewayName_example" # str | Connectivity Gateway Name (optional) + region = "region_example" # str | Region (optional) + network = "network_example" # str | Network (optional) + state = "state_example" # str | State (optional) + refresh = "refresh_example" # str | Refresh (optional) + edge_type = "MEGAPORT" # str | Edge type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_connectivity_gateways(account_id=account_id, cloud_type=cloud_type, connectivity_type=connectivity_type, connectivity_gateway_name=connectivity_gateway_name, region=region, network=network, state=state, refresh=refresh, edge_type=edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_connectivity_gateways: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | [optional] + **cloud_type** | **str**| Cloud Type | [optional] + **connectivity_type** | **str**| Cloud Connectivity Type | [optional] + **connectivity_gateway_name** | **str**| Connectivity Gateway Name | [optional] + **region** | **str**| Region | [optional] + **network** | **str**| Network | [optional] + **state** | **str**| State | [optional] + **refresh** | **str**| Refresh | [optional] + **edge_type** | **str**| Edge type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dashboard_edge_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dashboard_edge_info() + + + +Get interconnect edge gateway dashboard info + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_dashboard_edge_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_dashboard_edge_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_default_mapping_values** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_default_mapping_values(cloud_type) + + + +Get default mapping values + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_default_mapping_values(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_default_mapping_values: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_link_metro_speed** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_link_metro_speed() + + + +Get Device Link Metro Speed based on device link config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device Link (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_link_metro_speed(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_device_link_metro_speed: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device Link | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_links** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_links() + + + +Get Device Links + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) + device_link_name = "deviceLinkName_example" # str | Device Link Name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_links(edge_type=edge_type, device_link_name=device_link_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_device_links: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + **device_link_name** | **str**| Device Link Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dl_port_speed** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dl_port_speed(edge_type) + + + +Get supported port speed for Device Link + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Interconnect Provider + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dl_port_speed(edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_dl_port_speed: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Interconnect Provider | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_account_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_account_details(account_id) + + + +Get edge account by account Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Edge Account Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_account_details(account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_account_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Edge Account Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_accounts** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_accounts() + + + +Get all Multicloud edge accounts + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) if omitted the server will use the default value of "MEGAPORT" + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_edge_accounts(edge_type=edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_accounts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] if omitted the server will use the default value of "MEGAPORT" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_billing_accounts** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_billing_accounts(edge_account_id) + + + +Get Edge Billing Accounts + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_account_id = "edgeAccountId_example" # str | Interconnect Provider Account ID + region = "region_example" # str | Region (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_billing_accounts(edge_account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_billing_accounts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_edge_billing_accounts(edge_account_id, region=region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_billing_accounts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_account_id** | **str**| Interconnect Provider Account ID | + **edge_type** | **str**| Interconnect Provider | defaults to "EQUINIX" + **region** | **str**| Region | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_connectivity_detail_by_name** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_connectivity_detail_by_name(connectivity_name) + + + +Get Interconnect Connectivity by name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + connectivity_name = "connectivityName_example" # str | IC-GW connectivity name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_connectivity_detail_by_name(connectivity_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_connectivity_detail_by_name: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connectivity_name** | **str**| IC-GW connectivity name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_connectivity_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_connectivity_details() + + + +Get Interconnect Connectivity details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) + connectivity_name = "connectivityName_example" # str | Connectivity Name (optional) + connectivity_type = "connectivityType_example" # str | Connectivity Type (optional) + edge_gateway_name = "edgeGatewayName_example" # str | Interconnect Gateway name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_edge_connectivity_details(edge_type=edge_type, connectivity_name=connectivity_name, connectivity_type=connectivity_type, edge_gateway_name=edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_connectivity_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + **connectivity_name** | **str**| Connectivity Name | [optional] + **connectivity_type** | **str**| Connectivity Type | [optional] + **edge_gateway_name** | **str**| Interconnect Gateway name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_gateways** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_gateways(edge_type) + + + +Get sites with connectivity to the interconnect gateways by edge type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "edgeType_example" # str | Edge type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_gateways(edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_gateways: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_global_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_global_settings(edge_type) + + + +Get edge global settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MP" # str | Edge type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_global_settings(edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_global_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_locations_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_locations_info() + + + +Get Edge Locations + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Edge Account Id (optional) + region = "region_example" # str | Region (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_locations_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_locations_info: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_edge_locations_info(account_id=account_id, region=region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_locations_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge Type | defaults to "MEGAPORT" + **account_id** | **str**| Edge Account Id | [optional] + **region** | **str**| Region | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_mapping_tags** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_mapping_tags(cloud_type) + + + +Get default Interconnect mapping tag values + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + account_id = "accountId_example" # str | Cloud Account Id (optional) + resource_group = "resourceGroup_example" # str | Resource Group (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_mapping_tags(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_mapping_tags: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_edge_mapping_tags(cloud_type, account_id=account_id, resource_group=resource_group) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_mapping_tags: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **account_id** | **str**| Cloud Account Id | [optional] + **resource_group** | **str**| Resource Group | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_types** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_types() + + + +Get edge types + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_edge_types() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_types: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_wan_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_wan_devices() + + + +Get available WAN edge devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_wan_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_wan_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge Type | defaults to "MEGAPORT" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_edge_widget** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_edge_widget(edge_type) + + + +Get Interconnect Edge widget by edge type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "edgeType_example" # str | Edge type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_edge_widget(edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_edge_widget: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_global_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_global_settings(cloud_type) + + + +Get global settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_global_settings(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_global_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_host_vpcs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_host_vpcs(cloud_type) + + + +Get tagged, untagged, or all Host VPCs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + account_ids = "accountIds_example" # str | Account Id (optional) + region = "region_example" # str | Region (optional) + untagged = "untagged_example" # str | Untagged flag (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_host_vpcs(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_host_vpcs: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_host_vpcs(cloud_type, account_ids=account_ids, region=region, untagged=untagged) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_host_vpcs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **account_ids** | **str**| Account Id | [optional] + **region** | **str**| Region | [optional] + **untagged** | **str**| Untagged flag | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_icgw_custom_setting_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_icgw_custom_setting_details(edge_gateway_name) + + + +Get Interconnect Gateway custom setting by Interconnect Gateway name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_gateway_name = "edgeGatewayName_example" # str | Edge gateway name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_icgw_custom_setting_details(edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_icgw_custom_setting_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_gateway_name** | **str**| Edge gateway name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_icgw_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_icgw_details(edge_gateway_name) + + + +Get Interconnect Gateway by name + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_gateway_name = "edgeGatewayName_example" # str | Edge gateway name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_icgw_details(edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_icgw_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_gateway_name** | **str**| Edge gateway name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_icgw_types** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_icgw_types() + + + +Get Interconnect Gateway type for specified Edge Provider + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_icgw_types(edge_type=edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_icgw_types: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_icgws** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_icgws() + + + +Get Interconnect Gateways + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) + account_id = "accountId_example" # str | Account Id (optional) + region = "region_example" # str | Region (optional) + region_id = "regionId_example" # str | Region Id (optional) + resource_state = "resourceState_example" # str | Resource State (optional) + edge_gateway_name = "edgeGatewayName_example" # str | Edge gateway name (optional) + billing_account_id = "billingAccountId_example" # str | billing Account Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_icgws(edge_type=edge_type, account_id=account_id, region=region, region_id=region_id, resource_state=resource_state, edge_gateway_name=edge_gateway_name, billing_account_id=billing_account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_icgws: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + **account_id** | **str**| Account Id | [optional] + **region** | **str**| Region | [optional] + **region_id** | **str**| Region Id | [optional] + **resource_state** | **str**| Resource State | [optional] + **edge_gateway_name** | **str**| Edge gateway name | [optional] + **billing_account_id** | **str**| billing Account Id | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_licenses** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_licenses() + + + +Get License Info for Edge Gateways/Connections + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) if omitted the server will use the default value of "MEGAPORT" + account_id = "accountId_example" # str | Edge Account Id (optional) + product_type = "GATEWAY" # str | product Type (optional) + refresh = "refresh_example" # str | Refresh License Cache from Megaport (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_licenses(edge_type=edge_type, account_id=account_id, product_type=product_type, refresh=refresh) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_licenses: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] if omitted the server will use the default value of "MEGAPORT" + **account_id** | **str**| Edge Account Id | [optional] + **product_type** | **str**| product Type | [optional] + **refresh** | **str**| Refresh License Cache from Megaport | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapping_matrix** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapping_matrix(cloud_type) + + + +Get default mapping values + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mapping_matrix(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_mapping_matrix: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapping_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapping_status() + + + +Get mapping status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type (optional) + region = "region_example" # str | Region (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_mapping_status(cloud_type=cloud_type, region=region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_mapping_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | [optional] + **region** | **str**| Region | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapping_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapping_summary() + + + +Get mapping summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + vpn_tunnel_status = True # bool | VPN tunnel status (optional) + cloud_type = "AWS" # str | Cloud type (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_mapping_summary(vpn_tunnel_status=vpn_tunnel_status, cloud_type=cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_mapping_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_tunnel_status** | **bool**| VPN tunnel status | [optional] + **cloud_type** | **str**| Cloud type | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapping_tags** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapping_tags(cloud_type) + + + +Get default mapping values + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mapping_tags(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_mapping_tags: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mapping_vpns** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mapping_vpns() + + + +Get default mapping values + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_mapping_vpns() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_mapping_vpns: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_nva_security_rules** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_nva_security_rules(cloud_gateway_name) + + + +Get NVA Security Rules + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Get NVA security Rules (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_nva_security_rules(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_nva_security_rules: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_nva_security_rules(cloud_gateway_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_nva_security_rules: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Get NVA security Rules | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_partner_ports** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_partner_ports() + + + +Get partner ports + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) + account_id = "accountId_example" # str | Edge Account Id (optional) + cloud_type = "cloudType_example" # str | Cloud Type (optional) + connect_type = "connectType_example" # str | Connect Type filter (optional) + vxc_permitted = "vxcPermitted_example" # str | VXC Permitted on the port (optional) + authorization_key = "authorizationKey_example" # str | authorization Key (optional) + refresh = "refresh_example" # str | Refresh (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_partner_ports(edge_type=edge_type, account_id=account_id, cloud_type=cloud_type, connect_type=connect_type, vxc_permitted=vxc_permitted, authorization_key=authorization_key, refresh=refresh) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_partner_ports: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] + **account_id** | **str**| Edge Account Id | [optional] + **cloud_type** | **str**| Cloud Type | [optional] + **connect_type** | **str**| Connect Type filter | [optional] + **vxc_permitted** | **str**| VXC Permitted on the port | [optional] + **authorization_key** | **str**| authorization Key | [optional] + **refresh** | **str**| Refresh | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_port_speed** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_port_speed(edge_type, edge_account_id, connectivity_type) + + + +Get supported port speed + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Interconnect Provider + edge_account_id = "edgeAccountId_example" # str | Interconnect Provider Account ID + connectivity_type = "connectivityType_example" # str | Interconnect Connectivity Type + cloud_type = "AWS" # str | Cloud Service Provider (optional) + cloud_account_id = "cloudAccountId_example" # str | Cloud Service Provider Account ID (optional) + connect_type = "connectType_example" # str | Connection Type filter (optional) + connect_sub_type = "connectSubType_example" # str | Connection Sub-Type filter (optional) + connectivity_gateway = "connectivityGateway_example" # str | Connectivity Gateway (optional) + partner_port = "partnerPort_example" # str | partnerPort (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_port_speed(edge_type, edge_account_id, connectivity_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_port_speed: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_port_speed(edge_type, edge_account_id, connectivity_type, cloud_type=cloud_type, cloud_account_id=cloud_account_id, connect_type=connect_type, connect_sub_type=connect_sub_type, connectivity_gateway=connectivity_gateway, partner_port=partner_port) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_port_speed: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Interconnect Provider | + **edge_account_id** | **str**| Interconnect Provider Account ID | + **connectivity_type** | **str**| Interconnect Connectivity Type | + **cloud_type** | **str**| Cloud Service Provider | [optional] + **cloud_account_id** | **str**| Cloud Service Provider Account ID | [optional] + **connect_type** | **str**| Connection Type filter | [optional] + **connect_sub_type** | **str**| Connection Sub-Type filter | [optional] + **connectivity_gateway** | **str**| Connectivity Gateway | [optional] + **partner_port** | **str**| partnerPort | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query25() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_post_aggregation_data_by_query25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sites** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sites() + + + +Get available sites + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + color = "color_example" # str | Color (optional) + attached = True # bool | Is endpoint attached (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sites(color=color, attached=attached) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_sites: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **color** | **str**| Color | [optional] + **attached** | **bool**| Is endpoint attached | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sites1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sites1(cloud_gateway_name) + + + +Get sites attached to CGW + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + system_ip = "systemIp_example" # str | System IP (optional) + site_id = "siteId_example" # str | Site Id (optional) + color = "color_example" # str | Color (optional) + vpn_tunnel_status = True # bool | Fetch vpnTunnelStatus (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sites1(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_sites1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sites1(cloud_gateway_name, system_ip=system_ip, site_id=site_id, color=color, vpn_tunnel_status=vpn_tunnel_status) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_sites1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **system_ip** | **str**| System IP | [optional] + **site_id** | **str**| Site Id | [optional] + **color** | **str**| Color | [optional] + **vpn_tunnel_status** | **bool**| Fetch vpnTunnelStatus | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ssh_key_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ssh_key_list(cloud_type, account_id, cloud_region) + + + +Get SSH keys + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + account_id = "accountId_example" # str | Account Id + cloud_region = "cloudRegion_example" # str | Region + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ssh_key_list(cloud_type, account_id, cloud_region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_ssh_key_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **account_id** | **str**| Account Id | + **cloud_region** | **str**| Region | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_edge_image_names** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_supported_edge_image_names() + + + +Get Edge provider supported images + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) if omitted the server will use the default value of "MEGAPORT" + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_supported_edge_image_names(edge_type=edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_edge_image_names: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] if omitted the server will use the default value of "MEGAPORT" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_edge_instance_size** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_supported_edge_instance_size() + + + +Get Edge provider supported size + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_type = "MEGAPORT" # str | Edge type (optional) if omitted the server will use the default value of "MEGAPORT" + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_supported_edge_instance_size(edge_type=edge_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_edge_instance_size: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_type** | **str**| Edge type | [optional] if omitted the server will use the default value of "MEGAPORT" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_instance_size** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_supported_instance_size(cloud_type) + + + +Get Transit VPC supported size + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | + account_id = "accountId_example" # str | (optional) + cloud_region = "cloudRegion_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_supported_instance_size(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_instance_size: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_supported_instance_size(cloud_type, account_id=account_id, cloud_region=cloud_region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_instance_size: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| | + **account_id** | **str**| | [optional] + **cloud_region** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_loopback_cgw_colors** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_supported_loopback_cgw_colors() + + + +Get Edge Loopback CGW supported colors + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_supported_loopback_cgw_colors() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_loopback_cgw_colors: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_loopback_transport_colors** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_supported_loopback_transport_colors() + + + +Get Edge Loopback Tunnel supported colors + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_supported_loopback_transport_colors() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_loopback_transport_colors: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_software_image_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_supported_software_image_list(cloud_type) + + + +Get software image list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + account_id = "accountId_example" # str | Account Id (optional) + cloud_region = "cloudRegion_example" # str | Region (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_supported_software_image_list(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_software_image_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_supported_software_image_list(cloud_type, account_id=account_id, cloud_region=cloud_region) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_supported_software_image_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **account_id** | **str**| Account Id | [optional] + **cloud_region** | **str**| Region | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tunnel_names** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tunnel_names(cloud_type) + + + +Get tunnel names + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud type + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tunnel_names(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_tunnel_names: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_tunnel_names(cloud_type, cloud_gateway_name=cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_tunnel_names: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **cloud_gateway_name** | **str**| Cloud gateway name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_hubs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_v_hubs() + + + +Get Virtual Hubs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "cloudType_example" # str | Cloud Type (optional) + account_id = "accountId_example" # str | Account Id (optional) + resource_group = "resourceGroup_example" # str | Resource Group (optional) + v_wan_name = "vWanName_example" # str | VWan Name (optional) + v_net_tags = "vNetTags_example" # str | VNet Tags (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_v_hubs(cloud_type=cloud_type, account_id=account_id, resource_group=resource_group, v_wan_name=v_wan_name, v_net_tags=v_net_tags) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_v_hubs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud Type | [optional] + **account_id** | **str**| Account Id | [optional] + **resource_group** | **str**| Resource Group | [optional] + **v_wan_name** | **str**| VWan Name | [optional] + **v_net_tags** | **str**| VNet Tags | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_wans** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_v_wans() + + + +Get Virtual Wans + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id (optional) + cloud_type = "cloudType_example" # str | Cloud Type (optional) + resource_group = "resourceGroup_example" # str | Resource Group (optional) + refresh = "refresh_example" # str | Refresh (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_v_wans(account_id=account_id, cloud_type=cloud_type, resource_group=resource_group, refresh=refresh) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_v_wans: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | [optional] + **cloud_type** | **str**| Cloud Type | [optional] + **resource_group** | **str**| Resource Group | [optional] + **refresh** | **str**| Refresh | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpc_tags** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vpc_tags(cloud_type) + + + +Get vpc tags + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_type = "AWS" # str | Cloud type + region = "region_example" # str | Region (optional) + tag_name = "tagName_example" # str | Tag name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vpc_tags(cloud_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_vpc_tags: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vpc_tags(cloud_type, region=region, tag_name=tag_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_vpc_tags: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_type** | **str**| Cloud type | + **region** | **str**| Region | [optional] + **tag_name** | **str**| Tag name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wan_devices() + + + +Get available WAN edge devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_wan_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_wan_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wan_interface_colors** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wan_interface_colors() + + + +Get WAN interface colors + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_wan_interface_colors() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->get_wan_interface_colors: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **hostvpc_tagging** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} hostvpc_tagging() + + + +Tag a VPC + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPC tag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.hostvpc_tagging(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->hostvpc_tagging: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPC tag | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_mapping** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_mapping() + + + +Process intent of connecting VPNs with VPCs through cloud gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | VPC mapping (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.process_mapping(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->process_mapping: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| VPC mapping | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **telemetry** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} telemetry() + + + +reports telemetry data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | telemetry (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.telemetry(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->telemetry: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| telemetry | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tunnel_scaling** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} tunnel_scaling(cloud_gateway_name) + + + +Update tunnel scaling and accelerated vpn parameter for a branch endpoint + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Site information (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.tunnel_scaling(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->tunnel_scaling: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.tunnel_scaling(cloud_gateway_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->tunnel_scaling: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Site information | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **un_tag** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} un_tag(tag_name) + + + +Delete a tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + tag_name = "tagName_example" # str | Tag name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.un_tag(tag_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->un_tag: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tag_name** | **str**| Tag name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_account** +> update_account(account_id) + + + +Update multicloud account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Multicloud account info (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_account(account_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_account: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_account(account_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_account: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Multicloud account info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_cgw** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_cgw(cloud_gateway_name) + + + +Update cloud gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloud gateway (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_cgw(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_cgw: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_cgw(cloud_gateway_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_cgw: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloud gateway | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_device_link** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_device_link() + + + +Update Device Link + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device Link (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_device_link(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_device_link: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device Link | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_edge_account** +> update_edge_account(account_id) + + + +Update Multicloud edge account + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Multicloud Edge Account Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Multicloud edge account info (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_edge_account(account_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_edge_account: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_edge_account(account_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_edge_account: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Multicloud Edge Account Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Multicloud edge account info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_edge_connectivity** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_edge_connectivity() + + + +Update Interconnect connectivity + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Edge connectivity (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_edge_connectivity(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_edge_connectivity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Edge connectivity | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_edge_global_settings** +> update_edge_global_settings() + + + +Update edge global settings for Edge provider + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_edge_global_settings(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_edge_global_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_edge_locations_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_edge_locations_info(account_id) + + + +Update Edge Locations + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Edge Account Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_edge_locations_info(account_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_edge_locations_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Edge Account Id | + **edge_type** | **str**| Edge Type | defaults to "MEGAPORT" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_global_settings** +> update_global_settings() + + + +Update ip in resource pool + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_global_settings(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_global_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_icgw** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_icgw(edge_gateway_name) + + + +Update Interconnect Gateway + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + edge_gateway_name = "edgeGatewayName_example" # str | Edge gateway name + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_icgw(edge_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_icgw: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_icgw(edge_gateway_name, get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_icgw: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_gateway_name** | **str**| Edge gateway name | + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_nva_security_rules** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_nva_security_rules(cloud_gateway_name) + + + +Update NVA Security Rules + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + cloud_gateway_name = "cloudGatewayName_example" # str | Cloud gateway name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update NVA security Rules (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_nva_security_rules(cloud_gateway_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_nva_security_rules: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_nva_security_rules(cloud_gateway_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->update_nva_security_rules: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cloud_gateway_name** | **str**| Cloud gateway name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update NVA security Rules | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_account_add** +> validate_account_add() + + + +Authenticate cloud account credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Multicloud account info (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.validate_account_add(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->validate_account_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Multicloud account info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_account_update_credentials** +> validate_account_update_credentials(account_id) + + + +Update multicloud account credential + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Account Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Multicloud account info (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.validate_account_update_credentials(account_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->validate_account_update_credentials: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.validate_account_update_credentials(account_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->validate_account_update_credentials: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Multicloud account info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_edge_account_add** +> validate_edge_account_add() + + + +Authenticate edge account credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Multicloud edge account info (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.validate_edge_account_add(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->validate_edge_account_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Multicloud edge account info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate_edge_account_update_credentials** +> validate_edge_account_update_credentials(account_id) + + + +Update Multicloud edge account credential + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multi_cloud_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multi_cloud_api.ConfigurationMultiCloudApi(api_client) + account_id = "accountId_example" # str | Multicloud Edge Account Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Multicloud edge account info (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.validate_edge_account_update_credentials(account_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->validate_edge_account_update_credentials: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.validate_edge_account_update_credentials(account_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultiCloudApi->validate_edge_account_update_credentials: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Multicloud Edge Account Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Multicloud edge account info | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationMultidomainPolicyApi.md b/docs/ConfigurationMultidomainPolicyApi.md new file mode 100644 index 0000000..7992013 --- /dev/null +++ b/docs/ConfigurationMultidomainPolicyApi.md @@ -0,0 +1,1021 @@ +# openapi_client.ConfigurationMultidomainPolicyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_internal_policy**](ConfigurationMultidomainPolicyApi.md#add_internal_policy) | **PUT** /mdp/policies/mdpconfig | +[**attach_devices**](ConfigurationMultidomainPolicyApi.md#attach_devices) | **POST** /mdp/attachDevices/{nmsId} | +[**detach_devices**](ConfigurationMultidomainPolicyApi.md#detach_devices) | **POST** /mdp/detachDevices/{nmsId} | +[**disconnect_from_mdp**](ConfigurationMultidomainPolicyApi.md#disconnect_from_mdp) | **GET** /mdp/disconnect/{nmsId} | +[**edit_attached_devices**](ConfigurationMultidomainPolicyApi.md#edit_attached_devices) | **PUT** /mdp/attachDevices/{nmsId} | +[**get_mdp_onboarding_status**](ConfigurationMultidomainPolicyApi.md#get_mdp_onboarding_status) | **GET** /mdp/onboard/status | +[**offboard**](ConfigurationMultidomainPolicyApi.md#offboard) | **DELETE** /mdp/onboard/{nmsId} | +[**onboard_mdp**](ConfigurationMultidomainPolicyApi.md#onboard_mdp) | **POST** /mdp/onboard | +[**retrieve_mdp_attached_devices**](ConfigurationMultidomainPolicyApi.md#retrieve_mdp_attached_devices) | **GET** /mdp/attachDevices/{nmsId} | +[**retrieve_mdp_config_object**](ConfigurationMultidomainPolicyApi.md#retrieve_mdp_config_object) | **GET** /mdp/policies/mdpconfig/{deviceId} | +[**retrieve_mdp_policies**](ConfigurationMultidomainPolicyApi.md#retrieve_mdp_policies) | **GET** /mdp/policies/{nmsId} | +[**retrieve_mdp_supported_devices_**](ConfigurationMultidomainPolicyApi.md#retrieve_mdp_supported_devices_) | **GET** /mdp/devices/{nmsId} | +[**update_onboarding_payload**](ConfigurationMultidomainPolicyApi.md#update_onboarding_payload) | **PUT** /mdp/onboard/{nmsId} | +[**update_policy_status**](ConfigurationMultidomainPolicyApi.md#update_policy_status) | **PUT** /mdp/policies/{nmsId} | + + +# **add_internal_policy** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} add_internal_policy() + + + +Add internal policy from vmanage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | addInternalPolicy (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_internal_policy(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->add_internal_policy: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| addInternalPolicy | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **attach_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} attach_devices(nms_id) + + + +Share devices with MDP + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | deviceList (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.attach_devices(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->attach_devices: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.attach_devices(nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->attach_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| deviceList | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **detach_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} detach_devices(nms_id) + + + +Disconnect devices from mpd controller + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | deviceList (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.detach_devices(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->detach_devices: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.detach_devices(nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->detach_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| deviceList | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disconnect_from_mdp** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] disconnect_from_mdp(nms_id) + + + +disconnect from mpd controller + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.disconnect_from_mdp(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->disconnect_from_mdp: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_attached_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_attached_devices(nms_id) + + + +Edit attached devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | deviceList (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_attached_devices(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->edit_attached_devices: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_attached_devices(nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->edit_attached_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| deviceList | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mdp_onboarding_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_mdp_onboarding_status() + + + +Get MDP onboarding status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_mdp_onboarding_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->get_mdp_onboarding_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **offboard** +> offboard(nms_id) + + + +offboard the mdp application + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.offboard(nms_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->offboard: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **onboard_mdp** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} onboard_mdp() + + + +Start MDP onboarding operation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Onboard (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.onboard_mdp(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->onboard_mdp: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Onboard | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retrieve_mdp_attached_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] retrieve_mdp_attached_devices(nms_id) + + + +Retrieve MDP attached devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.retrieve_mdp_attached_devices(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->retrieve_mdp_attached_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retrieve_mdp_config_object** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] retrieve_mdp_config_object(device_id) + + + +Retrieve MDP ConfigObject + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + device_id = "deviceId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.retrieve_mdp_config_object(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->retrieve_mdp_config_object: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retrieve_mdp_policies** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] retrieve_mdp_policies(nms_id) + + + +Retrieve MDP policies + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.retrieve_mdp_policies(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->retrieve_mdp_policies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retrieve_mdp_supported_devices_** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] retrieve_mdp_supported_devices_(nms_id) + + + +Retrieve MDP supported devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.retrieve_mdp_supported_devices_(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->retrieve_mdp_supported_devices_: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_onboarding_payload** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_onboarding_payload(nms_id) + + + +update MDP onboarding document + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Onboard (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_onboarding_payload(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->update_onboarding_payload: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_onboarding_payload(nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->update_onboarding_payload: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Onboard | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_policy_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_policy_status(nms_id) + + + +update policy status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_multidomain_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_multidomain_policy_api.ConfigurationMultidomainPolicyApi(api_client) + nms_id = "nmsId_example" # str | + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | policyList (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_policy_status(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->update_policy_status: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_policy_status(nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationMultidomainPolicyApi->update_policy_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| policyList | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationNetworkDesignApi.md b/docs/ConfigurationNetworkDesignApi.md new file mode 100644 index 0000000..a701c69 --- /dev/null +++ b/docs/ConfigurationNetworkDesignApi.md @@ -0,0 +1,1043 @@ +# openapi_client.ConfigurationNetworkDesignApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**acquire_attach_lock**](ConfigurationNetworkDesignApi.md#acquire_attach_lock) | **POST** /networkdesign/profile/lock/{profileId} | +[**acquire_edit_lock**](ConfigurationNetworkDesignApi.md#acquire_edit_lock) | **POST** /networkdesign/lock/edit | +[**create_network_design**](ConfigurationNetworkDesignApi.md#create_network_design) | **POST** /networkdesign | +[**edit_network_design**](ConfigurationNetworkDesignApi.md#edit_network_design) | **PUT** /networkdesign | +[**get_device_profile_config_status**](ConfigurationNetworkDesignApi.md#get_device_profile_config_status) | **GET** /networkdesign/profile/status | +[**get_device_profile_config_status_by_profile_id**](ConfigurationNetworkDesignApi.md#get_device_profile_config_status_by_profile_id) | **GET** /networkdesign/profile/status/{profileId} | +[**get_device_profile_task_count**](ConfigurationNetworkDesignApi.md#get_device_profile_task_count) | **GET** /networkdesign/profile/task/count | +[**get_device_profile_task_status**](ConfigurationNetworkDesignApi.md#get_device_profile_task_status) | **GET** /networkdesign/profile/task/status | +[**get_device_profile_task_status_by_profile_id**](ConfigurationNetworkDesignApi.md#get_device_profile_task_status_by_profile_id) | **GET** /networkdesign/profile/task/status/{profileId} | +[**get_global_parameters**](ConfigurationNetworkDesignApi.md#get_global_parameters) | **GET** /networkdesign/global/parameters | +[**get_network_design**](ConfigurationNetworkDesignApi.md#get_network_design) | **GET** /networkdesign | +[**get_service_profile_config**](ConfigurationNetworkDesignApi.md#get_service_profile_config) | **GET** /networkdesign/serviceProfileConfig/{profileId} | +[**push_device_profile_template**](ConfigurationNetworkDesignApi.md#push_device_profile_template) | **POST** /networkdesign/profile/attachment/{profileId} | +[**push_network_design**](ConfigurationNetworkDesignApi.md#push_network_design) | **POST** /networkdesign/attachment | +[**run_my_test**](ConfigurationNetworkDesignApi.md#run_my_test) | **GET** /networkdesign/mytest/{name} | + + +# **acquire_attach_lock** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} acquire_attach_lock(profile_id) + + + +Get the service profile config for a given device profile id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + profile_id = "profileId_example" # str | Device profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.acquire_attach_lock(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->acquire_attach_lock: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Device profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **acquire_edit_lock** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} acquire_edit_lock() + + + +Acquire edit lock + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.acquire_edit_lock() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->acquire_edit_lock: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_network_design** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_network_design() + + + +Create network design + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network design payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_network_design(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->create_network_design: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network design payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_network_design** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_network_design(id) + + + +Edit network segment + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + id = "id_example" # str | Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network design payload (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_network_design(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->edit_network_design: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_network_design(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->edit_network_design: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network design payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_config_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_profile_config_status() + + + +Get device profile configuration status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_profile_config_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_device_profile_config_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_config_status_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_profile_config_status_by_profile_id(profile_id) + + + +Get device profile configuration status by profile Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + profile_id = "profileId_example" # str | Device profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_profile_config_status_by_profile_id(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_device_profile_config_status_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Device profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_task_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_profile_task_count() + + + +Get device profile configuration task count + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_profile_task_count() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_device_profile_task_count: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_task_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_profile_task_status() + + + +Get device profile configuration task status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_profile_task_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_device_profile_task_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_task_status_by_profile_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_profile_task_status_by_profile_id(profile_id) + + + +Get device profile configuration status by profile Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + profile_id = "profileId_example" # str | Device profile Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_profile_task_status_by_profile_id(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_device_profile_task_status_by_profile_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Device profile Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_global_parameters** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_global_parameters() + + + +Get global parameter templates + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_global_parameters() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_global_parameters: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_network_design** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_network_design() + + + +Get existing network design + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_network_design() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_network_design: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_service_profile_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_service_profile_config(profile_id, device_model) + + + +Get the service profile config for a given device profile id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + profile_id = "profileId_example" # str | Device profile Id + device_model = "deviceModel_example" # str | Device model + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_service_profile_config(profile_id, device_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->get_service_profile_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Device profile Id | + **device_model** | **str**| Device model | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **push_device_profile_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} push_device_profile_template(profile_id) + + + +Attach to device profile + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + profile_id = "profileId_example" # str | Device profile Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.push_device_profile_template(profile_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->push_device_profile_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_device_profile_template(profile_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->push_device_profile_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profile_id** | **str**| Device profile Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **push_network_design** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} push_network_design() + + + +Attach network design + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_network_design(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->push_network_design: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **run_my_test** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} run_my_test(name) + + + +Get all device templates for this feature template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_api.ConfigurationNetworkDesignApi(api_client) + name = "name_example" # str | Test bane + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.run_my_test(name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignApi->run_my_test: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| Test bane | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationNetworkDesignTemplatesApi.md b/docs/ConfigurationNetworkDesignTemplatesApi.md new file mode 100644 index 0000000..1b43f26 --- /dev/null +++ b/docs/ConfigurationNetworkDesignTemplatesApi.md @@ -0,0 +1,430 @@ +# openapi_client.ConfigurationNetworkDesignTemplatesApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**edit_device_profile_template**](ConfigurationNetworkDesignTemplatesApi.md#edit_device_profile_template) | **PUT** /networkdesign/profile/template/{templateId} | +[**edit_global_template**](ConfigurationNetworkDesignTemplatesApi.md#edit_global_template) | **PUT** /networkdesign/global/template/{templateId} | +[**generate_profile_template_list**](ConfigurationNetworkDesignTemplatesApi.md#generate_profile_template_list) | **GET** /networkdesign/profile/template | +[**get_device_profile_feature_template_list**](ConfigurationNetworkDesignTemplatesApi.md#get_device_profile_feature_template_list) | **GET** /networkdesign/profile/feature | +[**get_device_profile_template**](ConfigurationNetworkDesignTemplatesApi.md#get_device_profile_template) | **GET** /networkdesign/profile/template/{templateId} | +[**get_global_template**](ConfigurationNetworkDesignTemplatesApi.md#get_global_template) | **GET** /networkdesign/global/template/{templateId} | + + +# **edit_device_profile_template** +> edit_device_profile_template(template_id) + + + +Edit device profile template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_templates_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_templates_api.ConfigurationNetworkDesignTemplatesApi(api_client) + template_id = "templateId_example" # str | Template Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global template (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_device_profile_template(template_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->edit_device_profile_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_device_profile_template(template_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->edit_device_profile_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global template | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_global_template** +> edit_global_template(template_id) + + + +Edit global template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_templates_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_templates_api.ConfigurationNetworkDesignTemplatesApi(api_client) + template_id = "templateId_example" # str | Template Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Global template (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_global_template(template_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->edit_global_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_global_template(template_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->edit_global_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Global template | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_profile_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_profile_template_list() + + + +Generate profile template list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_templates_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_templates_api.ConfigurationNetworkDesignTemplatesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_profile_template_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->generate_profile_template_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_feature_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_profile_feature_template_list() + + + +Generate device profile template list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_templates_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_templates_api.ConfigurationNetworkDesignTemplatesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_profile_feature_template_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->get_device_profile_feature_template_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_profile_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_profile_template(template_id) + + + +Get device profile template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_templates_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_templates_api.ConfigurationNetworkDesignTemplatesApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_profile_template(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->get_device_profile_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_global_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_global_template(template_id) + + + +Get global template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_network_design_templates_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_network_design_templates_api.ConfigurationNetworkDesignTemplatesApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_global_template(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationNetworkDesignTemplatesApi->get_global_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyAMPDefinitionBuilderApi.md b/docs/ConfigurationPolicyAMPDefinitionBuilderApi.md new file mode 100644 index 0000000..5d7fa4b --- /dev/null +++ b/docs/ConfigurationPolicyAMPDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyAMPDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#create_policy_definition11) | **POST** /template/policy/definition/advancedMalwareProtection | +[**delete_policy_definition11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#delete_policy_definition11) | **DELETE** /template/policy/definition/advancedMalwareProtection/{id} | +[**edit_multiple_policy_definition11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#edit_multiple_policy_definition11) | **PUT** /template/policy/definition/advancedMalwareProtection/multiple/{id} | +[**edit_policy_definition11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#edit_policy_definition11) | **PUT** /template/policy/definition/advancedMalwareProtection/{id} | +[**get_definitions11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#get_definitions11) | **GET** /template/policy/definition/advancedMalwareProtection | +[**get_policy_definition11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#get_policy_definition11) | **GET** /template/policy/definition/advancedMalwareProtection/{id} | +[**preview_policy_definition11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#preview_policy_definition11) | **POST** /template/policy/definition/advancedMalwareProtection/preview | +[**preview_policy_definition_by_id11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#preview_policy_definition_by_id11) | **GET** /template/policy/definition/advancedMalwareProtection/preview/{id} | +[**save_policy_definition_in_bulk11**](ConfigurationPolicyAMPDefinitionBuilderApi.md#save_policy_definition_in_bulk11) | **PUT** /template/policy/definition/advancedMalwareProtection/bulk | + + +# **create_policy_definition11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition11() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->create_policy_definition11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition11** +> delete_policy_definition11(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition11(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->delete_policy_definition11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition11(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->edit_multiple_policy_definition11: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition11(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->edit_multiple_policy_definition11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition11(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->edit_policy_definition11: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition11(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->edit_policy_definition11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions11() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions11() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->get_definitions11: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition11(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->get_policy_definition11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition11() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->preview_policy_definition11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id11(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->preview_policy_definition_by_id11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk11() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_amp_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_amp_definition_builder_api.ConfigurationPolicyAMPDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAMPDefinitionBuilderApi->save_policy_definition_in_bulk11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyASPathListBuilderApi.md b/docs/ConfigurationPolicyASPathListBuilderApi.md new file mode 100644 index 0000000..2b15e05 --- /dev/null +++ b/docs/ConfigurationPolicyASPathListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyASPathListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list5**](ConfigurationPolicyASPathListBuilderApi.md#create_policy_list5) | **POST** /template/policy/list/aspath | +[**delete_policy_list5**](ConfigurationPolicyASPathListBuilderApi.md#delete_policy_list5) | **DELETE** /template/policy/list/aspath/{id} | +[**delete_policy_lists_with_info_tag5**](ConfigurationPolicyASPathListBuilderApi.md#delete_policy_lists_with_info_tag5) | **DELETE** /template/policy/list/aspath | +[**edit_policy_list5**](ConfigurationPolicyASPathListBuilderApi.md#edit_policy_list5) | **PUT** /template/policy/list/aspath/{id} | +[**get_lists_by_id5**](ConfigurationPolicyASPathListBuilderApi.md#get_lists_by_id5) | **GET** /template/policy/list/aspath/{id} | +[**get_policy_lists5**](ConfigurationPolicyASPathListBuilderApi.md#get_policy_lists5) | **GET** /template/policy/list/aspath | +[**get_policy_lists_with_info_tag5**](ConfigurationPolicyASPathListBuilderApi.md#get_policy_lists_with_info_tag5) | **GET** /template/policy/list/aspath/filtered | +[**preview_policy_list5**](ConfigurationPolicyASPathListBuilderApi.md#preview_policy_list5) | **POST** /template/policy/list/aspath/preview | +[**preview_policy_list_by_id5**](ConfigurationPolicyASPathListBuilderApi.md#preview_policy_list_by_id5) | **GET** /template/policy/list/aspath/preview/{id} | + + +# **create_policy_list5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list5() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->create_policy_list5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list5** +> delete_policy_list5(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list5(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->delete_policy_list5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag5** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag5() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag5(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->delete_policy_lists_with_info_tag5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list5(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->edit_policy_list5: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list5(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->edit_policy_list5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id5(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->get_lists_by_id5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists5** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists5() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists5() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->get_policy_lists5: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag5** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag5() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag5(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->get_policy_lists_with_info_tag5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list5() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->preview_policy_list5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id5(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_as_path_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_as_path_list_builder_api.ConfigurationPolicyASPathListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyASPathListBuilderApi->preview_policy_list_by_id5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md b/docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md new file mode 100644 index 0000000..2b02d84 --- /dev/null +++ b/docs/ConfigurationPolicyAccessListDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyAccessListDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#create_policy_definition8) | **POST** /template/policy/definition/acl | +[**delete_policy_definition8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#delete_policy_definition8) | **DELETE** /template/policy/definition/acl/{id} | +[**edit_multiple_policy_definition8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#edit_multiple_policy_definition8) | **PUT** /template/policy/definition/acl/multiple/{id} | +[**edit_policy_definition8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#edit_policy_definition8) | **PUT** /template/policy/definition/acl/{id} | +[**get_definitions8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#get_definitions8) | **GET** /template/policy/definition/acl | +[**get_policy_definition8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#get_policy_definition8) | **GET** /template/policy/definition/acl/{id} | +[**preview_policy_definition8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#preview_policy_definition8) | **POST** /template/policy/definition/acl/preview | +[**preview_policy_definition_by_id8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#preview_policy_definition_by_id8) | **GET** /template/policy/definition/acl/preview/{id} | +[**save_policy_definition_in_bulk8**](ConfigurationPolicyAccessListDefinitionBuilderApi.md#save_policy_definition_in_bulk8) | **PUT** /template/policy/definition/acl/bulk | + + +# **create_policy_definition8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition8() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->create_policy_definition8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition8** +> delete_policy_definition8(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition8(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->delete_policy_definition8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition8(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->edit_multiple_policy_definition8: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition8(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->edit_multiple_policy_definition8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition8(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->edit_policy_definition8: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition8(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->edit_policy_definition8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions8() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions8() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->get_definitions8: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition8(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->get_policy_definition8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition8() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->preview_policy_definition8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id8(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->preview_policy_definition_by_id8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk8() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_access_list_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_access_list_definition_builder_api.ConfigurationPolicyAccessListDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAccessListDefinitionBuilderApi->save_policy_definition_in_bulk8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyAppProbeClassListBuilderApi.md b/docs/ConfigurationPolicyAppProbeClassListBuilderApi.md new file mode 100644 index 0000000..d3db52b --- /dev/null +++ b/docs/ConfigurationPolicyAppProbeClassListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyAppProbeClassListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#create_policy_list4) | **POST** /template/policy/list/appprobe | +[**delete_policy_list4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#delete_policy_list4) | **DELETE** /template/policy/list/appprobe/{id} | +[**delete_policy_lists_with_info_tag4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#delete_policy_lists_with_info_tag4) | **DELETE** /template/policy/list/appprobe | +[**edit_policy_list4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#edit_policy_list4) | **PUT** /template/policy/list/appprobe/{id} | +[**get_lists_by_id4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#get_lists_by_id4) | **GET** /template/policy/list/appprobe/{id} | +[**get_policy_lists4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#get_policy_lists4) | **GET** /template/policy/list/appprobe | +[**get_policy_lists_with_info_tag4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#get_policy_lists_with_info_tag4) | **GET** /template/policy/list/appprobe/filtered | +[**preview_policy_list4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#preview_policy_list4) | **POST** /template/policy/list/appprobe/preview | +[**preview_policy_list_by_id4**](ConfigurationPolicyAppProbeClassListBuilderApi.md#preview_policy_list_by_id4) | **GET** /template/policy/list/appprobe/preview/{id} | + + +# **create_policy_list4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list4() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->create_policy_list4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list4** +> delete_policy_list4(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list4(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->delete_policy_list4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag4** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag4() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag4(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->delete_policy_lists_with_info_tag4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list4(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->edit_policy_list4: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list4(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->edit_policy_list4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id4(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->get_lists_by_id4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists4** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists4() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists4() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->get_policy_lists4: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag4** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag4() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag4(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->get_policy_lists_with_info_tag4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list4() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->preview_policy_list4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id4(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_probe_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_probe_class_list_builder_api.ConfigurationPolicyAppProbeClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppProbeClassListBuilderApi->preview_policy_list_by_id4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md b/docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md new file mode 100644 index 0000000..6b38f51 --- /dev/null +++ b/docs/ConfigurationPolicyAppRouteDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyAppRouteDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#create_policy_definition12) | **POST** /template/policy/definition/approute | +[**delete_policy_definition12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#delete_policy_definition12) | **DELETE** /template/policy/definition/approute/{id} | +[**edit_multiple_policy_definition12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#edit_multiple_policy_definition12) | **PUT** /template/policy/definition/approute/multiple/{id} | +[**edit_policy_definition12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#edit_policy_definition12) | **PUT** /template/policy/definition/approute/{id} | +[**get_definitions12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#get_definitions12) | **GET** /template/policy/definition/approute | +[**get_policy_definition12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#get_policy_definition12) | **GET** /template/policy/definition/approute/{id} | +[**preview_policy_definition12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#preview_policy_definition12) | **POST** /template/policy/definition/approute/preview | +[**preview_policy_definition_by_id12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#preview_policy_definition_by_id12) | **GET** /template/policy/definition/approute/preview/{id} | +[**save_policy_definition_in_bulk12**](ConfigurationPolicyAppRouteDefinitionBuilderApi.md#save_policy_definition_in_bulk12) | **PUT** /template/policy/definition/approute/bulk | + + +# **create_policy_definition12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition12() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->create_policy_definition12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition12** +> delete_policy_definition12(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition12(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->delete_policy_definition12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition12(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->edit_multiple_policy_definition12: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition12(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->edit_multiple_policy_definition12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition12(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->edit_policy_definition12: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition12(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->edit_policy_definition12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions12() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions12() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->get_definitions12: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition12(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->get_policy_definition12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition12() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->preview_policy_definition12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id12(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->preview_policy_definition_by_id12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk12() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_app_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_app_route_definition_builder_api.ConfigurationPolicyAppRouteDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyAppRouteDefinitionBuilderApi->save_policy_definition_in_bulk12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyApplicationListBuilderApi.md b/docs/ConfigurationPolicyApplicationListBuilderApi.md new file mode 100644 index 0000000..8e2c3b3 --- /dev/null +++ b/docs/ConfigurationPolicyApplicationListBuilderApi.md @@ -0,0 +1,1268 @@ +# openapi_client.ConfigurationPolicyApplicationListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list22**](ConfigurationPolicyApplicationListBuilderApi.md#create_policy_list22) | **POST** /template/policy/list/localapp | +[**create_policy_list3**](ConfigurationPolicyApplicationListBuilderApi.md#create_policy_list3) | **POST** /template/policy/list/app | +[**delete_policy_list22**](ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_list22) | **DELETE** /template/policy/list/localapp/{id} | +[**delete_policy_list3**](ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_list3) | **DELETE** /template/policy/list/app/{id} | +[**delete_policy_lists_with_info_tag22**](ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_lists_with_info_tag22) | **DELETE** /template/policy/list/localapp | +[**delete_policy_lists_with_info_tag3**](ConfigurationPolicyApplicationListBuilderApi.md#delete_policy_lists_with_info_tag3) | **DELETE** /template/policy/list/app | +[**edit_policy_list22**](ConfigurationPolicyApplicationListBuilderApi.md#edit_policy_list22) | **PUT** /template/policy/list/localapp/{id} | +[**edit_policy_list3**](ConfigurationPolicyApplicationListBuilderApi.md#edit_policy_list3) | **PUT** /template/policy/list/app/{id} | +[**get_lists_by_id22**](ConfigurationPolicyApplicationListBuilderApi.md#get_lists_by_id22) | **GET** /template/policy/list/localapp/{id} | +[**get_lists_by_id3**](ConfigurationPolicyApplicationListBuilderApi.md#get_lists_by_id3) | **GET** /template/policy/list/app/{id} | +[**get_policy_lists19**](ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists19) | **GET** /template/policy/list/localapp | +[**get_policy_lists3**](ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists3) | **GET** /template/policy/list/app | +[**get_policy_lists_with_info_tag22**](ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists_with_info_tag22) | **GET** /template/policy/list/localapp/filtered | +[**get_policy_lists_with_info_tag3**](ConfigurationPolicyApplicationListBuilderApi.md#get_policy_lists_with_info_tag3) | **GET** /template/policy/list/app/filtered | +[**preview_policy_list22**](ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list22) | **POST** /template/policy/list/localapp/preview | +[**preview_policy_list3**](ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list3) | **POST** /template/policy/list/app/preview | +[**preview_policy_list_by_id22**](ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list_by_id22) | **GET** /template/policy/list/localapp/preview/{id} | +[**preview_policy_list_by_id3**](ConfigurationPolicyApplicationListBuilderApi.md#preview_policy_list_by_id3) | **GET** /template/policy/list/app/preview/{id} | + + +# **create_policy_list22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list22() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->create_policy_list22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_list3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list3() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->create_policy_list3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list22** +> delete_policy_list22(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list22(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->delete_policy_list22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list3** +> delete_policy_list3(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list3(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->delete_policy_list3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag22** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag22() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag22(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->delete_policy_lists_with_info_tag22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag3** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag3() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag3(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->delete_policy_lists_with_info_tag3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list22(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->edit_policy_list22: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list22(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->edit_policy_list22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list3(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->edit_policy_list3: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list3(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->edit_policy_list3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id22(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->get_lists_by_id22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id3(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->get_lists_by_id3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists19** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists19() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists19() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->get_policy_lists19: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists3** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists3() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists3() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->get_policy_lists3: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag22** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag22() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag22(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->get_policy_lists_with_info_tag22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag3** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag3() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag3(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->get_policy_lists_with_info_tag3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list22() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->preview_policy_list22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list3() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->preview_policy_list3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id22(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->preview_policy_list_by_id22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id3(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_application_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_application_list_builder_api.ConfigurationPolicyApplicationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyApplicationListBuilderApi->preview_policy_list_by_id3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md b/docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md new file mode 100644 index 0000000..b12b1b7 --- /dev/null +++ b/docs/ConfigurationPolicyCflowdDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyCflowdDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#create_policy_definition13) | **POST** /template/policy/definition/cflowd | +[**delete_policy_definition13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#delete_policy_definition13) | **DELETE** /template/policy/definition/cflowd/{id} | +[**edit_multiple_policy_definition13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#edit_multiple_policy_definition13) | **PUT** /template/policy/definition/cflowd/multiple/{id} | +[**edit_policy_definition13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#edit_policy_definition13) | **PUT** /template/policy/definition/cflowd/{id} | +[**get_definitions13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#get_definitions13) | **GET** /template/policy/definition/cflowd | +[**get_policy_definition13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#get_policy_definition13) | **GET** /template/policy/definition/cflowd/{id} | +[**preview_policy_definition13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#preview_policy_definition13) | **POST** /template/policy/definition/cflowd/preview | +[**preview_policy_definition_by_id13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#preview_policy_definition_by_id13) | **GET** /template/policy/definition/cflowd/preview/{id} | +[**save_policy_definition_in_bulk13**](ConfigurationPolicyCflowdDefinitionBuilderApi.md#save_policy_definition_in_bulk13) | **PUT** /template/policy/definition/cflowd/bulk | + + +# **create_policy_definition13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition13() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->create_policy_definition13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition13** +> delete_policy_definition13(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition13(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->delete_policy_definition13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition13(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->edit_multiple_policy_definition13: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition13(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->edit_multiple_policy_definition13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition13(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->edit_policy_definition13: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition13(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->edit_policy_definition13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions13() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions13() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->get_definitions13: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition13(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->get_policy_definition13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition13() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->preview_policy_definition13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id13(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->preview_policy_definition_by_id13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk13() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cflowd_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cflowd_definition_builder_api.ConfigurationPolicyCflowdDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCflowdDefinitionBuilderApi->save_policy_definition_in_bulk13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyCloudApplicationBuilderApi.md b/docs/ConfigurationPolicyCloudApplicationBuilderApi.md new file mode 100644 index 0000000..b71260e --- /dev/null +++ b/docs/ConfigurationPolicyCloudApplicationBuilderApi.md @@ -0,0 +1,73 @@ +# openapi_client.ConfigurationPolicyCloudApplicationBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_cloud_discovered_apps**](ConfigurationPolicyCloudApplicationBuilderApi.md#get_cloud_discovered_apps) | **GET** /template/policy/clouddiscoveredapp | + + +# **get_cloud_discovered_apps** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cloud_discovered_apps() + + + +Get all cloud discovered applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_cloud_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_cloud_application_builder_api.ConfigurationPolicyCloudApplicationBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_discovered_apps() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCloudApplicationBuilderApi->get_cloud_discovered_apps: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyColorListBuilderApi.md b/docs/ConfigurationPolicyColorListBuilderApi.md new file mode 100644 index 0000000..bc5c04f --- /dev/null +++ b/docs/ConfigurationPolicyColorListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyColorListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list6**](ConfigurationPolicyColorListBuilderApi.md#create_policy_list6) | **POST** /template/policy/list/color | +[**delete_policy_list6**](ConfigurationPolicyColorListBuilderApi.md#delete_policy_list6) | **DELETE** /template/policy/list/color/{id} | +[**delete_policy_lists_with_info_tag6**](ConfigurationPolicyColorListBuilderApi.md#delete_policy_lists_with_info_tag6) | **DELETE** /template/policy/list/color | +[**edit_policy_list6**](ConfigurationPolicyColorListBuilderApi.md#edit_policy_list6) | **PUT** /template/policy/list/color/{id} | +[**get_lists_by_id6**](ConfigurationPolicyColorListBuilderApi.md#get_lists_by_id6) | **GET** /template/policy/list/color/{id} | +[**get_policy_lists6**](ConfigurationPolicyColorListBuilderApi.md#get_policy_lists6) | **GET** /template/policy/list/color | +[**get_policy_lists_with_info_tag6**](ConfigurationPolicyColorListBuilderApi.md#get_policy_lists_with_info_tag6) | **GET** /template/policy/list/color/filtered | +[**preview_policy_list6**](ConfigurationPolicyColorListBuilderApi.md#preview_policy_list6) | **POST** /template/policy/list/color/preview | +[**preview_policy_list_by_id6**](ConfigurationPolicyColorListBuilderApi.md#preview_policy_list_by_id6) | **GET** /template/policy/list/color/preview/{id} | + + +# **create_policy_list6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list6() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->create_policy_list6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list6** +> delete_policy_list6(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list6(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->delete_policy_list6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag6** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag6() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag6(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->delete_policy_lists_with_info_tag6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list6(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->edit_policy_list6: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list6(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->edit_policy_list6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id6(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->get_lists_by_id6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists6** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists6() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists6() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->get_policy_lists6: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag6** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag6() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag6(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->get_policy_lists_with_info_tag6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list6() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->preview_policy_list6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id6(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_color_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_color_list_builder_api.ConfigurationPolicyColorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyColorListBuilderApi->preview_policy_list_by_id6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyCommunityListBuilderApi.md b/docs/ConfigurationPolicyCommunityListBuilderApi.md new file mode 100644 index 0000000..078362b --- /dev/null +++ b/docs/ConfigurationPolicyCommunityListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyCommunityListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list7**](ConfigurationPolicyCommunityListBuilderApi.md#create_policy_list7) | **POST** /template/policy/list/community | +[**delete_policy_list7**](ConfigurationPolicyCommunityListBuilderApi.md#delete_policy_list7) | **DELETE** /template/policy/list/community/{id} | +[**delete_policy_lists_with_info_tag7**](ConfigurationPolicyCommunityListBuilderApi.md#delete_policy_lists_with_info_tag7) | **DELETE** /template/policy/list/community | +[**edit_policy_list7**](ConfigurationPolicyCommunityListBuilderApi.md#edit_policy_list7) | **PUT** /template/policy/list/community/{id} | +[**get_lists_by_id7**](ConfigurationPolicyCommunityListBuilderApi.md#get_lists_by_id7) | **GET** /template/policy/list/community/{id} | +[**get_policy_lists7**](ConfigurationPolicyCommunityListBuilderApi.md#get_policy_lists7) | **GET** /template/policy/list/community | +[**get_policy_lists_with_info_tag7**](ConfigurationPolicyCommunityListBuilderApi.md#get_policy_lists_with_info_tag7) | **GET** /template/policy/list/community/filtered | +[**preview_policy_list7**](ConfigurationPolicyCommunityListBuilderApi.md#preview_policy_list7) | **POST** /template/policy/list/community/preview | +[**preview_policy_list_by_id7**](ConfigurationPolicyCommunityListBuilderApi.md#preview_policy_list_by_id7) | **GET** /template/policy/list/community/preview/{id} | + + +# **create_policy_list7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list7() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->create_policy_list7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list7** +> delete_policy_list7(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list7(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->delete_policy_list7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag7** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag7() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag7(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->delete_policy_lists_with_info_tag7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list7(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->edit_policy_list7: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list7(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->edit_policy_list7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id7(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->get_lists_by_id7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists7** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists7() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists7() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->get_policy_lists7: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag7** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag7() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag7(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->get_policy_lists_with_info_tag7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list7() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->preview_policy_list7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id7(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_community_list_builder_api.ConfigurationPolicyCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCommunityListBuilderApi->preview_policy_list_by_id7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyControlDefinitionBuilderApi.md b/docs/ConfigurationPolicyControlDefinitionBuilderApi.md new file mode 100644 index 0000000..5e60941 --- /dev/null +++ b/docs/ConfigurationPolicyControlDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyControlDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition14**](ConfigurationPolicyControlDefinitionBuilderApi.md#create_policy_definition14) | **POST** /template/policy/definition/control | +[**delete_policy_definition14**](ConfigurationPolicyControlDefinitionBuilderApi.md#delete_policy_definition14) | **DELETE** /template/policy/definition/control/{id} | +[**edit_multiple_policy_definition14**](ConfigurationPolicyControlDefinitionBuilderApi.md#edit_multiple_policy_definition14) | **PUT** /template/policy/definition/control/multiple/{id} | +[**edit_policy_definition14**](ConfigurationPolicyControlDefinitionBuilderApi.md#edit_policy_definition14) | **PUT** /template/policy/definition/control/{id} | +[**get_definitions14**](ConfigurationPolicyControlDefinitionBuilderApi.md#get_definitions14) | **GET** /template/policy/definition/control | +[**get_policy_definition14**](ConfigurationPolicyControlDefinitionBuilderApi.md#get_policy_definition14) | **GET** /template/policy/definition/control/{id} | +[**preview_policy_definition14**](ConfigurationPolicyControlDefinitionBuilderApi.md#preview_policy_definition14) | **POST** /template/policy/definition/control/preview | +[**preview_policy_definition_by_id14**](ConfigurationPolicyControlDefinitionBuilderApi.md#preview_policy_definition_by_id14) | **GET** /template/policy/definition/control/preview/{id} | +[**save_policy_definition_in_bulk14**](ConfigurationPolicyControlDefinitionBuilderApi.md#save_policy_definition_in_bulk14) | **PUT** /template/policy/definition/control/bulk | + + +# **create_policy_definition14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition14() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->create_policy_definition14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition14** +> delete_policy_definition14(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition14(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->delete_policy_definition14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition14(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->edit_multiple_policy_definition14: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition14(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->edit_multiple_policy_definition14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition14(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->edit_policy_definition14: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition14(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->edit_policy_definition14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions14() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions14() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->get_definitions14: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition14(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->get_policy_definition14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition14() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->preview_policy_definition14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id14(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->preview_policy_definition_by_id14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk14() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_control_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_control_definition_builder_api.ConfigurationPolicyControlDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyControlDefinitionBuilderApi->save_policy_definition_in_bulk14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyCustomApplicationBuilderApi.md b/docs/ConfigurationPolicyCustomApplicationBuilderApi.md new file mode 100644 index 0000000..aaebeba --- /dev/null +++ b/docs/ConfigurationPolicyCustomApplicationBuilderApi.md @@ -0,0 +1,427 @@ +# openapi_client.ConfigurationPolicyCustomApplicationBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_custom_app**](ConfigurationPolicyCustomApplicationBuilderApi.md#create_custom_app) | **POST** /template/policy/customapp | +[**delete_custom_app**](ConfigurationPolicyCustomApplicationBuilderApi.md#delete_custom_app) | **DELETE** /template/policy/customapp/{id} | +[**edit_custom_app**](ConfigurationPolicyCustomApplicationBuilderApi.md#edit_custom_app) | **PUT** /template/policy/customapp/{id} | +[**get_custom_app_by_id**](ConfigurationPolicyCustomApplicationBuilderApi.md#get_custom_app_by_id) | **GET** /template/policy/customapp/{id} | +[**get_custom_apps**](ConfigurationPolicyCustomApplicationBuilderApi.md#get_custom_apps) | **GET** /template/policy/customapp | +[**map_traffic_profiles**](ConfigurationPolicyCustomApplicationBuilderApi.md#map_traffic_profiles) | **POST** /template/policy/clouddiscoveredapp | + + +# **create_custom_app** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_custom_app() + + + +Create a policy custom applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_custom_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_custom_application_builder_api.ConfigurationPolicyCustomApplicationBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | App payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_custom_app(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->create_custom_app: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| App payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_custom_app** +> delete_custom_app(id) + + + +Delete a policy custom applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_custom_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_custom_application_builder_api.ConfigurationPolicyCustomApplicationBuilderApi(api_client) + id = "id_example" # str | Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_custom_app(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->delete_custom_app: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_custom_app** +> edit_custom_app(id) + + + +Edit a policy custom applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_custom_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_custom_application_builder_api.ConfigurationPolicyCustomApplicationBuilderApi(api_client) + id = "id_example" # str | Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | App payload (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_custom_app(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->edit_custom_app: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_custom_app(id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->edit_custom_app: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| App payload | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_custom_app_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_custom_app_by_id(id) + + + +Get a policy custom applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_custom_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_custom_application_builder_api.ConfigurationPolicyCustomApplicationBuilderApi(api_client) + id = "id_example" # str | Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_custom_app_by_id(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->get_custom_app_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_custom_apps** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_custom_apps() + + + +Get all policy custom applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_custom_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_custom_application_builder_api.ConfigurationPolicyCustomApplicationBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_custom_apps() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->get_custom_apps: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **map_traffic_profiles** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} map_traffic_profiles() + + + +Set SLA class for policy cloud discovered applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_custom_application_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_custom_application_builder_api.ConfigurationPolicyCustomApplicationBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | App payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.map_traffic_profiles(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyCustomApplicationBuilderApi->map_traffic_profiles: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| App payload | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDataDefinitionBuilderApi.md b/docs/ConfigurationPolicyDataDefinitionBuilderApi.md new file mode 100644 index 0000000..87bb836 --- /dev/null +++ b/docs/ConfigurationPolicyDataDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyDataDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition15**](ConfigurationPolicyDataDefinitionBuilderApi.md#create_policy_definition15) | **POST** /template/policy/definition/data | +[**delete_policy_definition15**](ConfigurationPolicyDataDefinitionBuilderApi.md#delete_policy_definition15) | **DELETE** /template/policy/definition/data/{id} | +[**edit_multiple_policy_definition15**](ConfigurationPolicyDataDefinitionBuilderApi.md#edit_multiple_policy_definition15) | **PUT** /template/policy/definition/data/multiple/{id} | +[**edit_policy_definition15**](ConfigurationPolicyDataDefinitionBuilderApi.md#edit_policy_definition15) | **PUT** /template/policy/definition/data/{id} | +[**get_definitions15**](ConfigurationPolicyDataDefinitionBuilderApi.md#get_definitions15) | **GET** /template/policy/definition/data | +[**get_policy_definition15**](ConfigurationPolicyDataDefinitionBuilderApi.md#get_policy_definition15) | **GET** /template/policy/definition/data/{id} | +[**preview_policy_definition15**](ConfigurationPolicyDataDefinitionBuilderApi.md#preview_policy_definition15) | **POST** /template/policy/definition/data/preview | +[**preview_policy_definition_by_id15**](ConfigurationPolicyDataDefinitionBuilderApi.md#preview_policy_definition_by_id15) | **GET** /template/policy/definition/data/preview/{id} | +[**save_policy_definition_in_bulk15**](ConfigurationPolicyDataDefinitionBuilderApi.md#save_policy_definition_in_bulk15) | **PUT** /template/policy/definition/data/bulk | + + +# **create_policy_definition15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition15() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->create_policy_definition15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition15** +> delete_policy_definition15(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition15(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->delete_policy_definition15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition15(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->edit_multiple_policy_definition15: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition15(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->edit_multiple_policy_definition15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition15(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->edit_policy_definition15: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition15(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->edit_policy_definition15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions15() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions15() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->get_definitions15: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition15(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->get_policy_definition15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition15() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->preview_policy_definition15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id15(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->preview_policy_definition_by_id15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk15() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_definition_builder_api.ConfigurationPolicyDataDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataDefinitionBuilderApi->save_policy_definition_in_bulk15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md b/docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md new file mode 100644 index 0000000..9e86b37 --- /dev/null +++ b/docs/ConfigurationPolicyDataIPV6PrefixListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyDataIPV6PrefixListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#create_policy_list8) | **POST** /template/policy/list/dataipv6prefix | +[**delete_policy_list8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#delete_policy_list8) | **DELETE** /template/policy/list/dataipv6prefix/{id} | +[**delete_policy_lists_with_info_tag8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#delete_policy_lists_with_info_tag8) | **DELETE** /template/policy/list/dataipv6prefix | +[**edit_policy_list8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#edit_policy_list8) | **PUT** /template/policy/list/dataipv6prefix/{id} | +[**get_lists_by_id8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#get_lists_by_id8) | **GET** /template/policy/list/dataipv6prefix/{id} | +[**get_policy_lists8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#get_policy_lists8) | **GET** /template/policy/list/dataipv6prefix | +[**get_policy_lists_with_info_tag8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#get_policy_lists_with_info_tag8) | **GET** /template/policy/list/dataipv6prefix/filtered | +[**preview_policy_list8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#preview_policy_list8) | **POST** /template/policy/list/dataipv6prefix/preview | +[**preview_policy_list_by_id8**](ConfigurationPolicyDataIPV6PrefixListBuilderApi.md#preview_policy_list_by_id8) | **GET** /template/policy/list/dataipv6prefix/preview/{id} | + + +# **create_policy_list8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list8() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->create_policy_list8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list8** +> delete_policy_list8(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list8(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->delete_policy_list8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag8** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag8() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag8(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->delete_policy_lists_with_info_tag8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list8(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->edit_policy_list8: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list8(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->edit_policy_list8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id8(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->get_lists_by_id8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists8** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists8() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists8() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->get_policy_lists8: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag8** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag8() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag8(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->get_policy_lists_with_info_tag8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list8() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->preview_policy_list8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id8(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_ipv6_prefix_list_builder_api.ConfigurationPolicyDataIPV6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id8(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataIPV6PrefixListBuilderApi->preview_policy_list_by_id8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md b/docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md new file mode 100644 index 0000000..2de46c4 --- /dev/null +++ b/docs/ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#create_policy_list9) | **POST** /template/policy/list/dataprefixall | +[**delete_policy_list9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#delete_policy_list9) | **DELETE** /template/policy/list/dataprefixall/{id} | +[**delete_policy_lists_with_info_tag9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#delete_policy_lists_with_info_tag9) | **DELETE** /template/policy/list/dataprefixall | +[**edit_policy_list9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#edit_policy_list9) | **PUT** /template/policy/list/dataprefixall/{id} | +[**get_lists_by_id9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#get_lists_by_id9) | **GET** /template/policy/list/dataprefixall/{id} | +[**get_lists_for_all_data_prefixes**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#get_lists_for_all_data_prefixes) | **GET** /template/policy/list/dataprefixall | +[**get_policy_lists_with_info_tag9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#get_policy_lists_with_info_tag9) | **GET** /template/policy/list/dataprefixall/filtered | +[**preview_policy_list9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#preview_policy_list9) | **POST** /template/policy/list/dataprefixall/preview | +[**preview_policy_list_by_id9**](ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi.md#preview_policy_list_by_id9) | **GET** /template/policy/list/dataprefixall/preview/{id} | + + +# **create_policy_list9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list9() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->create_policy_list9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list9** +> delete_policy_list9(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list9(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->delete_policy_list9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag9** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag9() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag9(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->delete_policy_lists_with_info_tag9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list9(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->edit_policy_list9: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list9(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->edit_policy_list9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id9(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->get_lists_by_id9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_for_all_data_prefixes** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_lists_for_all_data_prefixes() + + + +Get policy lists for all data prefixes + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_lists_for_all_data_prefixes() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->get_lists_for_all_data_prefixes: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag9** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag9() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag9(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->get_policy_lists_with_info_tag9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list9() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->preview_policy_list9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id9(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi->preview_policy_list_by_id9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md b/docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md new file mode 100644 index 0000000..51798f5 --- /dev/null +++ b/docs/ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#create_policy_list15) | **POST** /template/policy/list/dataprefixfqdn | +[**delete_policy_list15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#delete_policy_list15) | **DELETE** /template/policy/list/dataprefixfqdn/{id} | +[**delete_policy_lists_with_info_tag15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#delete_policy_lists_with_info_tag15) | **DELETE** /template/policy/list/dataprefixfqdn | +[**edit_policy_list15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#edit_policy_list15) | **PUT** /template/policy/list/dataprefixfqdn/{id} | +[**get_all_data_prefix_and_fqdn_lists**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#get_all_data_prefix_and_fqdn_lists) | **GET** /template/policy/list/dataprefixfqdn | +[**get_lists_by_id15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#get_lists_by_id15) | **GET** /template/policy/list/dataprefixfqdn/{id} | +[**get_policy_lists_with_info_tag15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#get_policy_lists_with_info_tag15) | **GET** /template/policy/list/dataprefixfqdn/filtered | +[**preview_policy_list15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#preview_policy_list15) | **POST** /template/policy/list/dataprefixfqdn/preview | +[**preview_policy_list_by_id15**](ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi.md#preview_policy_list_by_id15) | **GET** /template/policy/list/dataprefixfqdn/preview/{id} | + + +# **create_policy_list15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list15() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->create_policy_list15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list15** +> delete_policy_list15(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list15(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->delete_policy_list15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag15** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag15() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag15(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->delete_policy_lists_with_info_tag15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list15(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->edit_policy_list15: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list15(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->edit_policy_list15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_data_prefix_and_fqdn_lists** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_data_prefix_and_fqdn_lists() + + + +Get lists for all all data-prefix(IPv4) and Fqdn lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_data_prefix_and_fqdn_lists() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->get_all_data_prefix_and_fqdn_lists: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id15(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->get_lists_by_id15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag15** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag15() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag15(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->get_policy_lists_with_info_tag15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list15() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->preview_policy_list15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id15(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id15(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi->preview_policy_list_by_id15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDataPrefixListBuilderApi.md b/docs/ConfigurationPolicyDataPrefixListBuilderApi.md new file mode 100644 index 0000000..3ff07f9 --- /dev/null +++ b/docs/ConfigurationPolicyDataPrefixListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyDataPrefixListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list10**](ConfigurationPolicyDataPrefixListBuilderApi.md#create_policy_list10) | **POST** /template/policy/list/dataprefix | +[**delete_policy_list10**](ConfigurationPolicyDataPrefixListBuilderApi.md#delete_policy_list10) | **DELETE** /template/policy/list/dataprefix/{id} | +[**delete_policy_lists_with_info_tag10**](ConfigurationPolicyDataPrefixListBuilderApi.md#delete_policy_lists_with_info_tag10) | **DELETE** /template/policy/list/dataprefix | +[**edit_policy_list10**](ConfigurationPolicyDataPrefixListBuilderApi.md#edit_policy_list10) | **PUT** /template/policy/list/dataprefix/{id} | +[**get_lists_by_id10**](ConfigurationPolicyDataPrefixListBuilderApi.md#get_lists_by_id10) | **GET** /template/policy/list/dataprefix/{id} | +[**get_policy_lists9**](ConfigurationPolicyDataPrefixListBuilderApi.md#get_policy_lists9) | **GET** /template/policy/list/dataprefix | +[**get_policy_lists_with_info_tag10**](ConfigurationPolicyDataPrefixListBuilderApi.md#get_policy_lists_with_info_tag10) | **GET** /template/policy/list/dataprefix/filtered | +[**preview_policy_list10**](ConfigurationPolicyDataPrefixListBuilderApi.md#preview_policy_list10) | **POST** /template/policy/list/dataprefix/preview | +[**preview_policy_list_by_id10**](ConfigurationPolicyDataPrefixListBuilderApi.md#preview_policy_list_by_id10) | **GET** /template/policy/list/dataprefix/preview/{id} | + + +# **create_policy_list10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list10() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->create_policy_list10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list10** +> delete_policy_list10(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list10(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->delete_policy_list10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag10** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag10() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag10(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->delete_policy_lists_with_info_tag10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list10(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->edit_policy_list10: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list10(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->edit_policy_list10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id10(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->get_lists_by_id10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists9** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists9() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists9() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->get_policy_lists9: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag10** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag10() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag10(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->get_policy_lists_with_info_tag10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list10() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->preview_policy_list10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id10(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_data_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_data_prefix_list_builder_api.ConfigurationPolicyDataPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id10(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDataPrefixListBuilderApi->preview_policy_list_by_id10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md b/docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md new file mode 100644 index 0000000..39b83e6 --- /dev/null +++ b/docs/ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyDeviceAccessDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#create_policy_definition16) | **POST** /template/policy/definition/deviceaccesspolicy | +[**delete_policy_definition16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#delete_policy_definition16) | **DELETE** /template/policy/definition/deviceaccesspolicy/{id} | +[**edit_multiple_policy_definition16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#edit_multiple_policy_definition16) | **PUT** /template/policy/definition/deviceaccesspolicy/multiple/{id} | +[**edit_policy_definition16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#edit_policy_definition16) | **PUT** /template/policy/definition/deviceaccesspolicy/{id} | +[**get_definitions16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#get_definitions16) | **GET** /template/policy/definition/deviceaccesspolicy | +[**get_policy_definition16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#get_policy_definition16) | **GET** /template/policy/definition/deviceaccesspolicy/{id} | +[**preview_policy_definition16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#preview_policy_definition16) | **POST** /template/policy/definition/deviceaccesspolicy/preview | +[**preview_policy_definition_by_id16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#preview_policy_definition_by_id16) | **GET** /template/policy/definition/deviceaccesspolicy/preview/{id} | +[**save_policy_definition_in_bulk16**](ConfigurationPolicyDeviceAccessDefinitionBuilderApi.md#save_policy_definition_in_bulk16) | **PUT** /template/policy/definition/deviceaccesspolicy/bulk | + + +# **create_policy_definition16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition16() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->create_policy_definition16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition16** +> delete_policy_definition16(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition16(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->delete_policy_definition16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition16(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->edit_multiple_policy_definition16: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition16(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->edit_multiple_policy_definition16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition16(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->edit_policy_definition16: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition16(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->edit_policy_definition16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions16() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions16() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->get_definitions16: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition16(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->get_policy_definition16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition16() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->preview_policy_definition16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id16(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id16(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->preview_policy_definition_by_id16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk16() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_device_access_definition_builder_api.ConfigurationPolicyDeviceAccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDeviceAccessDefinitionBuilderApi->save_policy_definition_in_bulk16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md b/docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md new file mode 100644 index 0000000..b09dde8 --- /dev/null +++ b/docs/ConfigurationPolicyDialPeerDefinitionBuilderApi.md @@ -0,0 +1,1286 @@ +# openapi_client.ConfigurationPolicyDialPeerDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#create_policy_definition25) | **POST** /template/policy/definition/dialpeer | +[**create_policy_definition30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#create_policy_definition30) | **POST** /template/policy/definition/srstphoneprofile | +[**delete_policy_definition25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#delete_policy_definition25) | **DELETE** /template/policy/definition/dialpeer/{id} | +[**delete_policy_definition30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#delete_policy_definition30) | **DELETE** /template/policy/definition/srstphoneprofile/{id} | +[**edit_multiple_policy_definition25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_multiple_policy_definition25) | **PUT** /template/policy/definition/dialpeer/multiple/{id} | +[**edit_multiple_policy_definition30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_multiple_policy_definition30) | **PUT** /template/policy/definition/srstphoneprofile/multiple/{id} | +[**edit_policy_definition25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_policy_definition25) | **PUT** /template/policy/definition/dialpeer/{id} | +[**edit_policy_definition30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#edit_policy_definition30) | **PUT** /template/policy/definition/srstphoneprofile/{id} | +[**get_definitions25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_definitions25) | **GET** /template/policy/definition/dialpeer | +[**get_definitions30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_definitions30) | **GET** /template/policy/definition/srstphoneprofile | +[**get_policy_definition25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_policy_definition25) | **GET** /template/policy/definition/dialpeer/{id} | +[**get_policy_definition30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#get_policy_definition30) | **GET** /template/policy/definition/srstphoneprofile/{id} | +[**preview_policy_definition25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition25) | **POST** /template/policy/definition/dialpeer/preview | +[**preview_policy_definition30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition30) | **POST** /template/policy/definition/srstphoneprofile/preview | +[**preview_policy_definition_by_id25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition_by_id25) | **GET** /template/policy/definition/dialpeer/preview/{id} | +[**preview_policy_definition_by_id30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#preview_policy_definition_by_id30) | **GET** /template/policy/definition/srstphoneprofile/preview/{id} | +[**save_policy_definition_in_bulk25**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#save_policy_definition_in_bulk25) | **PUT** /template/policy/definition/dialpeer/bulk | +[**save_policy_definition_in_bulk30**](ConfigurationPolicyDialPeerDefinitionBuilderApi.md#save_policy_definition_in_bulk30) | **PUT** /template/policy/definition/srstphoneprofile/bulk | + + +# **create_policy_definition25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition25() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->create_policy_definition25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_definition30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition30() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition30(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->create_policy_definition30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition25** +> delete_policy_definition25(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition25(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->delete_policy_definition25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition30** +> delete_policy_definition30(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition30(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->delete_policy_definition30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition25(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_multiple_policy_definition25: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition25(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_multiple_policy_definition25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition30(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_multiple_policy_definition30: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition30(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_multiple_policy_definition30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition25(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_policy_definition25: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition25(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_policy_definition25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition30(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_policy_definition30: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition30(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->edit_policy_definition30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions25() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions25() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->get_definitions25: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions30() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions30() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->get_definitions30: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition25(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->get_policy_definition25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition30(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->get_policy_definition30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition25() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->preview_policy_definition25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition30() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition30(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->preview_policy_definition30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id25(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->preview_policy_definition_by_id25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id30(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->preview_policy_definition_by_id30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk25() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->save_policy_definition_in_bulk25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk30() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_dial_peer_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_dial_peer_definition_builder_api.ConfigurationPolicyDialPeerDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk30(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyDialPeerDefinitionBuilderApi->save_policy_definition_in_bulk30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md b/docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md new file mode 100644 index 0000000..792aaf1 --- /dev/null +++ b/docs/ConfigurationPolicyExpandedCommunityListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyExpandedCommunityListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#create_policy_list11) | **POST** /template/policy/list/expandedcommunity | +[**delete_policy_list11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#delete_policy_list11) | **DELETE** /template/policy/list/expandedcommunity/{id} | +[**delete_policy_lists_with_info_tag11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#delete_policy_lists_with_info_tag11) | **DELETE** /template/policy/list/expandedcommunity | +[**edit_policy_list11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#edit_policy_list11) | **PUT** /template/policy/list/expandedcommunity/{id} | +[**get_lists_by_id11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#get_lists_by_id11) | **GET** /template/policy/list/expandedcommunity/{id} | +[**get_policy_lists10**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#get_policy_lists10) | **GET** /template/policy/list/expandedcommunity | +[**get_policy_lists_with_info_tag11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#get_policy_lists_with_info_tag11) | **GET** /template/policy/list/expandedcommunity/filtered | +[**preview_policy_list11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#preview_policy_list11) | **POST** /template/policy/list/expandedcommunity/preview | +[**preview_policy_list_by_id11**](ConfigurationPolicyExpandedCommunityListBuilderApi.md#preview_policy_list_by_id11) | **GET** /template/policy/list/expandedcommunity/preview/{id} | + + +# **create_policy_list11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list11() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->create_policy_list11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list11** +> delete_policy_list11(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list11(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->delete_policy_list11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag11** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag11() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag11(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->delete_policy_lists_with_info_tag11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list11(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->edit_policy_list11: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list11(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->edit_policy_list11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id11(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->get_lists_by_id11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists10** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists10() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists10() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->get_policy_lists10: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag11** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag11() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag11(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->get_policy_lists_with_info_tag11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list11() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->preview_policy_list11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id11(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_expanded_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_expanded_community_list_builder_api.ConfigurationPolicyExpandedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id11(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExpandedCommunityListBuilderApi->preview_policy_list_by_id11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md b/docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md new file mode 100644 index 0000000..2c580bf --- /dev/null +++ b/docs/ConfigurationPolicyExtendedCommunityListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyExtendedCommunityListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#create_policy_list12) | **POST** /template/policy/list/extcommunity | +[**delete_policy_list12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#delete_policy_list12) | **DELETE** /template/policy/list/extcommunity/{id} | +[**delete_policy_lists_with_info_tag12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#delete_policy_lists_with_info_tag12) | **DELETE** /template/policy/list/extcommunity | +[**edit_policy_list12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#edit_policy_list12) | **PUT** /template/policy/list/extcommunity/{id} | +[**get_lists_by_id12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#get_lists_by_id12) | **GET** /template/policy/list/extcommunity/{id} | +[**get_policy_lists11**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#get_policy_lists11) | **GET** /template/policy/list/extcommunity | +[**get_policy_lists_with_info_tag12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#get_policy_lists_with_info_tag12) | **GET** /template/policy/list/extcommunity/filtered | +[**preview_policy_list12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#preview_policy_list12) | **POST** /template/policy/list/extcommunity/preview | +[**preview_policy_list_by_id12**](ConfigurationPolicyExtendedCommunityListBuilderApi.md#preview_policy_list_by_id12) | **GET** /template/policy/list/extcommunity/preview/{id} | + + +# **create_policy_list12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list12() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->create_policy_list12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list12** +> delete_policy_list12(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list12(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->delete_policy_list12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag12** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag12() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag12(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->delete_policy_lists_with_info_tag12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list12(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->edit_policy_list12: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list12(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->edit_policy_list12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id12(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->get_lists_by_id12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists11** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists11() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists11() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->get_policy_lists11: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag12** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag12() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag12(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->get_policy_lists_with_info_tag12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list12() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->preview_policy_list12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id12(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_extended_community_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_extended_community_list_builder_api.ConfigurationPolicyExtendedCommunityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id12(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyExtendedCommunityListBuilderApi->preview_policy_list_by_id12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md b/docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md new file mode 100644 index 0000000..314bf37 --- /dev/null +++ b/docs/ConfigurationPolicyFXOPortDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyFXOPortDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#create_policy_definition26) | **POST** /template/policy/definition/fxoport | +[**delete_policy_definition26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#delete_policy_definition26) | **DELETE** /template/policy/definition/fxoport/{id} | +[**edit_multiple_policy_definition26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#edit_multiple_policy_definition26) | **PUT** /template/policy/definition/fxoport/multiple/{id} | +[**edit_policy_definition26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#edit_policy_definition26) | **PUT** /template/policy/definition/fxoport/{id} | +[**get_definitions26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#get_definitions26) | **GET** /template/policy/definition/fxoport | +[**get_policy_definition26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#get_policy_definition26) | **GET** /template/policy/definition/fxoport/{id} | +[**preview_policy_definition26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#preview_policy_definition26) | **POST** /template/policy/definition/fxoport/preview | +[**preview_policy_definition_by_id26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#preview_policy_definition_by_id26) | **GET** /template/policy/definition/fxoport/preview/{id} | +[**save_policy_definition_in_bulk26**](ConfigurationPolicyFXOPortDefinitionBuilderApi.md#save_policy_definition_in_bulk26) | **PUT** /template/policy/definition/fxoport/bulk | + + +# **create_policy_definition26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition26() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->create_policy_definition26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition26** +> delete_policy_definition26(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition26(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->delete_policy_definition26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition26(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->edit_multiple_policy_definition26: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition26(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->edit_multiple_policy_definition26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition26(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->edit_policy_definition26: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition26(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->edit_policy_definition26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions26() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions26() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->get_definitions26: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition26(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->get_policy_definition26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition26() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->preview_policy_definition26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id26(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->preview_policy_definition_by_id26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk26() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxo_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxo_port_definition_builder_api.ConfigurationPolicyFXOPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXOPortDefinitionBuilderApi->save_policy_definition_in_bulk26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md b/docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md new file mode 100644 index 0000000..3c8f42d --- /dev/null +++ b/docs/ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#create_policy_definition28) | **POST** /template/policy/definition/fxsdidport | +[**delete_policy_definition28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#delete_policy_definition28) | **DELETE** /template/policy/definition/fxsdidport/{id} | +[**edit_multiple_policy_definition28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#edit_multiple_policy_definition28) | **PUT** /template/policy/definition/fxsdidport/multiple/{id} | +[**edit_policy_definition28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#edit_policy_definition28) | **PUT** /template/policy/definition/fxsdidport/{id} | +[**get_definitions28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#get_definitions28) | **GET** /template/policy/definition/fxsdidport | +[**get_policy_definition28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#get_policy_definition28) | **GET** /template/policy/definition/fxsdidport/{id} | +[**preview_policy_definition28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#preview_policy_definition28) | **POST** /template/policy/definition/fxsdidport/preview | +[**preview_policy_definition_by_id28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#preview_policy_definition_by_id28) | **GET** /template/policy/definition/fxsdidport/preview/{id} | +[**save_policy_definition_in_bulk28**](ConfigurationPolicyFXSDIDPortDefinitionBuilderApi.md#save_policy_definition_in_bulk28) | **PUT** /template/policy/definition/fxsdidport/bulk | + + +# **create_policy_definition28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition28() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->create_policy_definition28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition28** +> delete_policy_definition28(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition28(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->delete_policy_definition28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition28(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->edit_multiple_policy_definition28: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition28(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->edit_multiple_policy_definition28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition28(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->edit_policy_definition28: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition28(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->edit_policy_definition28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions28() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions28() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->get_definitions28: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition28(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->get_policy_definition28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition28() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->preview_policy_definition28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id28(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->preview_policy_definition_by_id28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk28() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxsdid_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxsdid_port_definition_builder_api.ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSDIDPortDefinitionBuilderApi->save_policy_definition_in_bulk28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md b/docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md new file mode 100644 index 0000000..85ea61b --- /dev/null +++ b/docs/ConfigurationPolicyFXSPortDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyFXSPortDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#create_policy_definition27) | **POST** /template/policy/definition/fxsport | +[**delete_policy_definition27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#delete_policy_definition27) | **DELETE** /template/policy/definition/fxsport/{id} | +[**edit_multiple_policy_definition27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#edit_multiple_policy_definition27) | **PUT** /template/policy/definition/fxsport/multiple/{id} | +[**edit_policy_definition27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#edit_policy_definition27) | **PUT** /template/policy/definition/fxsport/{id} | +[**get_definitions27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#get_definitions27) | **GET** /template/policy/definition/fxsport | +[**get_policy_definition27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#get_policy_definition27) | **GET** /template/policy/definition/fxsport/{id} | +[**preview_policy_definition27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#preview_policy_definition27) | **POST** /template/policy/definition/fxsport/preview | +[**preview_policy_definition_by_id27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#preview_policy_definition_by_id27) | **GET** /template/policy/definition/fxsport/preview/{id} | +[**save_policy_definition_in_bulk27**](ConfigurationPolicyFXSPortDefinitionBuilderApi.md#save_policy_definition_in_bulk27) | **PUT** /template/policy/definition/fxsport/bulk | + + +# **create_policy_definition27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition27() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->create_policy_definition27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition27** +> delete_policy_definition27(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition27(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->delete_policy_definition27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition27(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->edit_multiple_policy_definition27: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition27(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->edit_multiple_policy_definition27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition27(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->edit_policy_definition27: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition27(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->edit_policy_definition27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions27() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions27() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->get_definitions27: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition27(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->get_policy_definition27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition27() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->preview_policy_definition27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id27(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->preview_policy_definition_by_id27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk27() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fxs_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fxs_port_definition_builder_api.ConfigurationPolicyFXSPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFXSPortDefinitionBuilderApi->save_policy_definition_in_bulk27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyFaxProtocolListBuilderApi.md b/docs/ConfigurationPolicyFaxProtocolListBuilderApi.md new file mode 100644 index 0000000..e22f64b --- /dev/null +++ b/docs/ConfigurationPolicyFaxProtocolListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyFaxProtocolListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#create_policy_list13) | **POST** /template/policy/list/faxprotocol | +[**delete_policy_list13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#delete_policy_list13) | **DELETE** /template/policy/list/faxprotocol/{id} | +[**delete_policy_lists_with_info_tag13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#delete_policy_lists_with_info_tag13) | **DELETE** /template/policy/list/faxprotocol | +[**edit_policy_list13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#edit_policy_list13) | **PUT** /template/policy/list/faxprotocol/{id} | +[**get_lists_by_id13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#get_lists_by_id13) | **GET** /template/policy/list/faxprotocol/{id} | +[**get_policy_lists12**](ConfigurationPolicyFaxProtocolListBuilderApi.md#get_policy_lists12) | **GET** /template/policy/list/faxprotocol | +[**get_policy_lists_with_info_tag13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#get_policy_lists_with_info_tag13) | **GET** /template/policy/list/faxprotocol/filtered | +[**preview_policy_list13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#preview_policy_list13) | **POST** /template/policy/list/faxprotocol/preview | +[**preview_policy_list_by_id13**](ConfigurationPolicyFaxProtocolListBuilderApi.md#preview_policy_list_by_id13) | **GET** /template/policy/list/faxprotocol/preview/{id} | + + +# **create_policy_list13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list13() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->create_policy_list13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list13** +> delete_policy_list13(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list13(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->delete_policy_list13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag13** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag13() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag13(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->delete_policy_lists_with_info_tag13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list13(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->edit_policy_list13: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list13(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->edit_policy_list13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id13(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->get_lists_by_id13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists12** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists12() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists12() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->get_policy_lists12: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag13** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag13() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag13(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->get_policy_lists_with_info_tag13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list13() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->preview_policy_list13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id13(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_fax_protocol_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_fax_protocol_list_builder_api.ConfigurationPolicyFaxProtocolListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id13(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyFaxProtocolListBuilderApi->preview_policy_list_by_id13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyForwardingClassListBuilderApi.md b/docs/ConfigurationPolicyForwardingClassListBuilderApi.md new file mode 100644 index 0000000..8e4b7dd --- /dev/null +++ b/docs/ConfigurationPolicyForwardingClassListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyForwardingClassListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list14**](ConfigurationPolicyForwardingClassListBuilderApi.md#create_policy_list14) | **POST** /template/policy/list/class | +[**delete_policy_list14**](ConfigurationPolicyForwardingClassListBuilderApi.md#delete_policy_list14) | **DELETE** /template/policy/list/class/{id} | +[**delete_policy_lists_with_info_tag14**](ConfigurationPolicyForwardingClassListBuilderApi.md#delete_policy_lists_with_info_tag14) | **DELETE** /template/policy/list/class | +[**edit_policy_list14**](ConfigurationPolicyForwardingClassListBuilderApi.md#edit_policy_list14) | **PUT** /template/policy/list/class/{id} | +[**get_lists_by_id14**](ConfigurationPolicyForwardingClassListBuilderApi.md#get_lists_by_id14) | **GET** /template/policy/list/class/{id} | +[**get_policy_lists13**](ConfigurationPolicyForwardingClassListBuilderApi.md#get_policy_lists13) | **GET** /template/policy/list/class | +[**get_policy_lists_with_info_tag14**](ConfigurationPolicyForwardingClassListBuilderApi.md#get_policy_lists_with_info_tag14) | **GET** /template/policy/list/class/filtered | +[**preview_policy_list14**](ConfigurationPolicyForwardingClassListBuilderApi.md#preview_policy_list14) | **POST** /template/policy/list/class/preview | +[**preview_policy_list_by_id14**](ConfigurationPolicyForwardingClassListBuilderApi.md#preview_policy_list_by_id14) | **GET** /template/policy/list/class/preview/{id} | + + +# **create_policy_list14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list14() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->create_policy_list14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list14** +> delete_policy_list14(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list14(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->delete_policy_list14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag14** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag14() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag14(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->delete_policy_lists_with_info_tag14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list14(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->edit_policy_list14: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list14(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->edit_policy_list14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id14(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->get_lists_by_id14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists13** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists13() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists13() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->get_policy_lists13: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag14** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag14() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag14(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->get_policy_lists_with_info_tag14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list14() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->preview_policy_list14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id14(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_forwarding_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_forwarding_class_list_builder_api.ConfigurationPolicyForwardingClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id14(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyForwardingClassListBuilderApi->preview_policy_list_by_id14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyGeoLocationListBuilderApi.md b/docs/ConfigurationPolicyGeoLocationListBuilderApi.md new file mode 100644 index 0000000..82da00c --- /dev/null +++ b/docs/ConfigurationPolicyGeoLocationListBuilderApi.md @@ -0,0 +1,703 @@ +# openapi_client.ConfigurationPolicyGeoLocationListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list17**](ConfigurationPolicyGeoLocationListBuilderApi.md#create_policy_list17) | **POST** /template/policy/list/geolocation | +[**delete_policy_list17**](ConfigurationPolicyGeoLocationListBuilderApi.md#delete_policy_list17) | **DELETE** /template/policy/list/geolocation/{id} | +[**delete_policy_lists_with_info_tag17**](ConfigurationPolicyGeoLocationListBuilderApi.md#delete_policy_lists_with_info_tag17) | **DELETE** /template/policy/list/geolocation | +[**edit_policy_list17**](ConfigurationPolicyGeoLocationListBuilderApi.md#edit_policy_list17) | **PUT** /template/policy/list/geolocation/{id} | +[**get_geo_location_lists**](ConfigurationPolicyGeoLocationListBuilderApi.md#get_geo_location_lists) | **GET** /template/policy/list/geolocation/entries | +[**get_lists_by_id17**](ConfigurationPolicyGeoLocationListBuilderApi.md#get_lists_by_id17) | **GET** /template/policy/list/geolocation/{id} | +[**get_policy_lists15**](ConfigurationPolicyGeoLocationListBuilderApi.md#get_policy_lists15) | **GET** /template/policy/list/geolocation | +[**get_policy_lists_with_info_tag17**](ConfigurationPolicyGeoLocationListBuilderApi.md#get_policy_lists_with_info_tag17) | **GET** /template/policy/list/geolocation/filtered | +[**preview_policy_list17**](ConfigurationPolicyGeoLocationListBuilderApi.md#preview_policy_list17) | **POST** /template/policy/list/geolocation/preview | +[**preview_policy_list_by_id17**](ConfigurationPolicyGeoLocationListBuilderApi.md#preview_policy_list_by_id17) | **GET** /template/policy/list/geolocation/preview/{id} | + + +# **create_policy_list17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list17() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->create_policy_list17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list17** +> delete_policy_list17(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list17(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->delete_policy_list17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag17** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag17() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag17(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->delete_policy_lists_with_info_tag17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list17(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->edit_policy_list17: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list17(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->edit_policy_list17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_geo_location_lists** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_geo_location_lists() + + + +Get list of countries and continents for geo location + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_geo_location_lists() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->get_geo_location_lists: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id17(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->get_lists_by_id17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists15** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists15() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists15() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->get_policy_lists15: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag17** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag17() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag17(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->get_policy_lists_with_info_tag17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list17() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->preview_policy_list17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id17(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_geo_location_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_geo_location_list_builder_api.ConfigurationPolicyGeoLocationListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyGeoLocationListBuilderApi->preview_policy_list_by_id17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md b/docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md new file mode 100644 index 0000000..9bc2a89 --- /dev/null +++ b/docs/ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#create_policy_definition4) | **POST** /template/policy/definition/hubandspoke | +[**delete_policy_definition4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#delete_policy_definition4) | **DELETE** /template/policy/definition/hubandspoke/{id} | +[**edit_multiple_policy_definition4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#edit_multiple_policy_definition4) | **PUT** /template/policy/definition/hubandspoke/multiple/{id} | +[**edit_policy_definition4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#edit_policy_definition4) | **PUT** /template/policy/definition/hubandspoke/{id} | +[**get_definitions4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#get_definitions4) | **GET** /template/policy/definition/hubandspoke | +[**get_policy_definition4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#get_policy_definition4) | **GET** /template/policy/definition/hubandspoke/{id} | +[**preview_policy_definition4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#preview_policy_definition4) | **POST** /template/policy/definition/hubandspoke/preview | +[**preview_policy_definition_by_id4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#preview_policy_definition_by_id4) | **GET** /template/policy/definition/hubandspoke/preview/{id} | +[**save_policy_definition_in_bulk4**](ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md#save_policy_definition_in_bulk4) | **PUT** /template/policy/definition/hubandspoke/bulk | + + +# **create_policy_definition4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition4() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->create_policy_definition4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition4** +> delete_policy_definition4(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition4(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->delete_policy_definition4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition4(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_multiple_policy_definition4: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition4(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_multiple_policy_definition4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition4(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_policy_definition4: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition4(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_policy_definition4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions4() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions4() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->get_definitions4: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition4(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->get_policy_definition4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition4() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->preview_policy_definition4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id4(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id4(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->preview_policy_definition_by_id4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk4() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->save_policy_definition_in_bulk4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyIPSSignatureListBuilderApi.md b/docs/ConfigurationPolicyIPSSignatureListBuilderApi.md new file mode 100644 index 0000000..3b5c9fc --- /dev/null +++ b/docs/ConfigurationPolicyIPSSignatureListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyIPSSignatureListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#create_policy_list19) | **POST** /template/policy/list/ipssignature | +[**delete_policy_list19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#delete_policy_list19) | **DELETE** /template/policy/list/ipssignature/{id} | +[**delete_policy_lists_with_info_tag19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#delete_policy_lists_with_info_tag19) | **DELETE** /template/policy/list/ipssignature | +[**edit_policy_list19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#edit_policy_list19) | **PUT** /template/policy/list/ipssignature/{id} | +[**get_lists_by_id19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#get_lists_by_id19) | **GET** /template/policy/list/ipssignature/{id} | +[**get_policy_lists17**](ConfigurationPolicyIPSSignatureListBuilderApi.md#get_policy_lists17) | **GET** /template/policy/list/ipssignature | +[**get_policy_lists_with_info_tag19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#get_policy_lists_with_info_tag19) | **GET** /template/policy/list/ipssignature/filtered | +[**preview_policy_list19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#preview_policy_list19) | **POST** /template/policy/list/ipssignature/preview | +[**preview_policy_list_by_id19**](ConfigurationPolicyIPSSignatureListBuilderApi.md#preview_policy_list_by_id19) | **GET** /template/policy/list/ipssignature/preview/{id} | + + +# **create_policy_list19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list19() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->create_policy_list19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list19** +> delete_policy_list19(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list19(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->delete_policy_list19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag19** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag19() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag19(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->delete_policy_lists_with_info_tag19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list19(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->edit_policy_list19: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list19(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->edit_policy_list19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id19(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->get_lists_by_id19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists17** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists17() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists17() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->get_policy_lists17: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag19** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag19() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag19(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->get_policy_lists_with_info_tag19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list19() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->preview_policy_list19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id19(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ips_signature_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ips_signature_list_builder_api.ConfigurationPolicyIPSSignatureListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPSSignatureListBuilderApi->preview_policy_list_by_id19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md b/docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md new file mode 100644 index 0000000..025e13e --- /dev/null +++ b/docs/ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyIPv6AccessDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#create_policy_definition9) | **POST** /template/policy/definition/aclv6 | +[**delete_policy_definition9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#delete_policy_definition9) | **DELETE** /template/policy/definition/aclv6/{id} | +[**edit_multiple_policy_definition9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#edit_multiple_policy_definition9) | **PUT** /template/policy/definition/aclv6/multiple/{id} | +[**edit_policy_definition9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#edit_policy_definition9) | **PUT** /template/policy/definition/aclv6/{id} | +[**get_definitions9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#get_definitions9) | **GET** /template/policy/definition/aclv6 | +[**get_policy_definition9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#get_policy_definition9) | **GET** /template/policy/definition/aclv6/{id} | +[**preview_policy_definition9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#preview_policy_definition9) | **POST** /template/policy/definition/aclv6/preview | +[**preview_policy_definition_by_id9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#preview_policy_definition_by_id9) | **GET** /template/policy/definition/aclv6/preview/{id} | +[**save_policy_definition_in_bulk9**](ConfigurationPolicyIPv6AccessDefinitionBuilderApi.md#save_policy_definition_in_bulk9) | **PUT** /template/policy/definition/aclv6/bulk | + + +# **create_policy_definition9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition9() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->create_policy_definition9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition9** +> delete_policy_definition9(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition9(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->delete_policy_definition9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition9(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->edit_multiple_policy_definition9: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition9(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->edit_multiple_policy_definition9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition9(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->edit_policy_definition9: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition9(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->edit_policy_definition9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions9() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions9() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->get_definitions9: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition9(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->get_policy_definition9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition9() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->preview_policy_definition9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id9(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id9(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->preview_policy_definition_by_id9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk9() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_access_definition_builder_api.ConfigurationPolicyIPv6AccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6AccessDefinitionBuilderApi->save_policy_definition_in_bulk9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md b/docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md new file mode 100644 index 0000000..9e3392a --- /dev/null +++ b/docs/ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#create_policy_definition17) | **POST** /template/policy/definition/deviceaccesspolicyv6 | +[**delete_policy_definition17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#delete_policy_definition17) | **DELETE** /template/policy/definition/deviceaccesspolicyv6/{id} | +[**edit_multiple_policy_definition17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#edit_multiple_policy_definition17) | **PUT** /template/policy/definition/deviceaccesspolicyv6/multiple/{id} | +[**edit_policy_definition17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#edit_policy_definition17) | **PUT** /template/policy/definition/deviceaccesspolicyv6/{id} | +[**get_definitions17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#get_definitions17) | **GET** /template/policy/definition/deviceaccesspolicyv6 | +[**get_policy_definition17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#get_policy_definition17) | **GET** /template/policy/definition/deviceaccesspolicyv6/{id} | +[**preview_policy_definition17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#preview_policy_definition17) | **POST** /template/policy/definition/deviceaccesspolicyv6/preview | +[**preview_policy_definition_by_id17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#preview_policy_definition_by_id17) | **GET** /template/policy/definition/deviceaccesspolicyv6/preview/{id} | +[**save_policy_definition_in_bulk17**](ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi.md#save_policy_definition_in_bulk17) | **PUT** /template/policy/definition/deviceaccesspolicyv6/bulk | + + +# **create_policy_definition17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition17() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->create_policy_definition17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition17** +> delete_policy_definition17(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition17(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->delete_policy_definition17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition17(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->edit_multiple_policy_definition17: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition17(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->edit_multiple_policy_definition17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition17(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->edit_policy_definition17: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition17(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->edit_policy_definition17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions17() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions17() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->get_definitions17: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition17(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->get_policy_definition17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition17() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->preview_policy_definition17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id17(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id17(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->preview_policy_definition_by_id17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk17() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_device_access_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_device_access_definition_builder_api.ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi->save_policy_definition_in_bulk17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md b/docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md new file mode 100644 index 0000000..7144ec7 --- /dev/null +++ b/docs/ConfigurationPolicyIPv6PrefixListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyIPv6PrefixListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#create_policy_list20) | **POST** /template/policy/list/ipv6prefix | +[**delete_policy_list20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#delete_policy_list20) | **DELETE** /template/policy/list/ipv6prefix/{id} | +[**delete_policy_lists_with_info_tag20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#delete_policy_lists_with_info_tag20) | **DELETE** /template/policy/list/ipv6prefix | +[**edit_policy_list20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#edit_policy_list20) | **PUT** /template/policy/list/ipv6prefix/{id} | +[**get_lists_by_id20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#get_lists_by_id20) | **GET** /template/policy/list/ipv6prefix/{id} | +[**get_policy_lists18**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#get_policy_lists18) | **GET** /template/policy/list/ipv6prefix | +[**get_policy_lists_with_info_tag20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#get_policy_lists_with_info_tag20) | **GET** /template/policy/list/ipv6prefix/filtered | +[**preview_policy_list20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#preview_policy_list20) | **POST** /template/policy/list/ipv6prefix/preview | +[**preview_policy_list_by_id20**](ConfigurationPolicyIPv6PrefixListBuilderApi.md#preview_policy_list_by_id20) | **GET** /template/policy/list/ipv6prefix/preview/{id} | + + +# **create_policy_list20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list20() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->create_policy_list20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list20** +> delete_policy_list20(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list20(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->delete_policy_list20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag20** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag20() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag20(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->delete_policy_lists_with_info_tag20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list20(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->edit_policy_list20: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list20(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->edit_policy_list20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id20(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->get_lists_by_id20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists18** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists18() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists18() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->get_policy_lists18: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag20** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag20() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag20(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->get_policy_lists_with_info_tag20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list20() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->preview_policy_list20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id20(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_ipv6_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_ipv6_prefix_list_builder_api.ConfigurationPolicyIPv6PrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIPv6PrefixListBuilderApi->preview_policy_list_by_id20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyIdentityListBuilderApi.md b/docs/ConfigurationPolicyIdentityListBuilderApi.md new file mode 100644 index 0000000..54641c4 --- /dev/null +++ b/docs/ConfigurationPolicyIdentityListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyIdentityListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list18**](ConfigurationPolicyIdentityListBuilderApi.md#create_policy_list18) | **POST** /template/policy/list/identity | +[**delete_policy_list18**](ConfigurationPolicyIdentityListBuilderApi.md#delete_policy_list18) | **DELETE** /template/policy/list/identity/{id} | +[**delete_policy_lists_with_info_tag18**](ConfigurationPolicyIdentityListBuilderApi.md#delete_policy_lists_with_info_tag18) | **DELETE** /template/policy/list/identity | +[**edit_policy_list18**](ConfigurationPolicyIdentityListBuilderApi.md#edit_policy_list18) | **PUT** /template/policy/list/identity/{id} | +[**get_lists_by_id18**](ConfigurationPolicyIdentityListBuilderApi.md#get_lists_by_id18) | **GET** /template/policy/list/identity/{id} | +[**get_policy_lists16**](ConfigurationPolicyIdentityListBuilderApi.md#get_policy_lists16) | **GET** /template/policy/list/identity | +[**get_policy_lists_with_info_tag18**](ConfigurationPolicyIdentityListBuilderApi.md#get_policy_lists_with_info_tag18) | **GET** /template/policy/list/identity/filtered | +[**preview_policy_list18**](ConfigurationPolicyIdentityListBuilderApi.md#preview_policy_list18) | **POST** /template/policy/list/identity/preview | +[**preview_policy_list_by_id18**](ConfigurationPolicyIdentityListBuilderApi.md#preview_policy_list_by_id18) | **GET** /template/policy/list/identity/preview/{id} | + + +# **create_policy_list18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list18() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->create_policy_list18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list18** +> delete_policy_list18(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list18(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->delete_policy_list18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag18** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag18() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag18(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->delete_policy_lists_with_info_tag18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list18(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->edit_policy_list18: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list18(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->edit_policy_list18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id18(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->get_lists_by_id18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists16** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists16() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists16() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->get_policy_lists16: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag18** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag18() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag18(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->get_policy_lists_with_info_tag18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list18() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->preview_policy_list18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id18(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_identity_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_identity_list_builder_api.ConfigurationPolicyIdentityListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIdentityListBuilderApi->preview_policy_list_by_id18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md b/docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md new file mode 100644 index 0000000..6ee6ce7 --- /dev/null +++ b/docs/ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#create_policy_definition18) | **POST** /template/policy/definition/intrusionprevention | +[**delete_policy_definition18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#delete_policy_definition18) | **DELETE** /template/policy/definition/intrusionprevention/{id} | +[**edit_multiple_policy_definition18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#edit_multiple_policy_definition18) | **PUT** /template/policy/definition/intrusionprevention/multiple/{id} | +[**edit_policy_definition18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#edit_policy_definition18) | **PUT** /template/policy/definition/intrusionprevention/{id} | +[**get_definitions18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#get_definitions18) | **GET** /template/policy/definition/intrusionprevention | +[**get_policy_definition18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#get_policy_definition18) | **GET** /template/policy/definition/intrusionprevention/{id} | +[**preview_policy_definition18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#preview_policy_definition18) | **POST** /template/policy/definition/intrusionprevention/preview | +[**preview_policy_definition_by_id18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#preview_policy_definition_by_id18) | **GET** /template/policy/definition/intrusionprevention/preview/{id} | +[**save_policy_definition_in_bulk18**](ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi.md#save_policy_definition_in_bulk18) | **PUT** /template/policy/definition/intrusionprevention/bulk | + + +# **create_policy_definition18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition18() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->create_policy_definition18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition18** +> delete_policy_definition18(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition18(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->delete_policy_definition18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition18(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->edit_multiple_policy_definition18: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition18(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->edit_multiple_policy_definition18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition18(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->edit_policy_definition18: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition18(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->edit_policy_definition18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions18() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions18() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->get_definitions18: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition18(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->get_policy_definition18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition18() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->preview_policy_definition18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id18(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id18(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->preview_policy_definition_by_id18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk18() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_intrusion_prevention_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_intrusion_prevention_definition_builder_api.ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi->save_policy_definition_in_bulk18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyListBuilderApi.md b/docs/ConfigurationPolicyListBuilderApi.md new file mode 100644 index 0000000..4b2a23a --- /dev/null +++ b/docs/ConfigurationPolicyListBuilderApi.md @@ -0,0 +1,203 @@ +# openapi_client.ConfigurationPolicyListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_webex_prefix_lists**](ConfigurationPolicyListBuilderApi.md#create_webex_prefix_lists) | **POST** /template/policy/list/webex | +[**create_webex_prefix_lists1**](ConfigurationPolicyListBuilderApi.md#create_webex_prefix_lists1) | **POST** /template/policy/list/webex/update | +[**get_all_policy_lists**](ConfigurationPolicyListBuilderApi.md#get_all_policy_lists) | **GET** /template/policy/list | + + +# **create_webex_prefix_lists** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_webex_prefix_lists() + + + +TEMP-Create Webex policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_list_builder_api.ConfigurationPolicyListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_webex_prefix_lists() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyListBuilderApi->create_webex_prefix_lists: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_webex_prefix_lists1** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_webex_prefix_lists1() + + + +TEMP-Update Webex policy lists from Webex config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_list_builder_api.ConfigurationPolicyListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_webex_prefix_lists1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyListBuilderApi->create_webex_prefix_lists1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_policy_lists** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_policy_lists() + + + +Get all policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_list_builder_api.ConfigurationPolicyListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_policy_lists() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyListBuilderApi->get_all_policy_lists: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md b/docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md new file mode 100644 index 0000000..6e1c9ef --- /dev/null +++ b/docs/ConfigurationPolicyLocalDomainDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyLocalDomainDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#create_policy_definition) | **POST** /template/policy/definition/dnssecurity | +[**delete_policy_definition**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#delete_policy_definition) | **DELETE** /template/policy/definition/dnssecurity/{id} | +[**edit_multiple_policy_definition**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#edit_multiple_policy_definition) | **PUT** /template/policy/definition/dnssecurity/multiple/{id} | +[**edit_policy_definition**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#edit_policy_definition) | **PUT** /template/policy/definition/dnssecurity/{id} | +[**get_definitions**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#get_definitions) | **GET** /template/policy/definition/dnssecurity | +[**get_policy_definition**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#get_policy_definition) | **GET** /template/policy/definition/dnssecurity/{id} | +[**preview_policy_definition**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#preview_policy_definition) | **POST** /template/policy/definition/dnssecurity/preview | +[**preview_policy_definition_by_id**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#preview_policy_definition_by_id) | **GET** /template/policy/definition/dnssecurity/preview/{id} | +[**save_policy_definition_in_bulk**](ConfigurationPolicyLocalDomainDefinitionBuilderApi.md#save_policy_definition_in_bulk) | **PUT** /template/policy/definition/dnssecurity/bulk | + + +# **create_policy_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->create_policy_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition** +> delete_policy_definition(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->delete_policy_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->edit_multiple_policy_definition: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->edit_multiple_policy_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->edit_policy_definition: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->edit_policy_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->get_definitions: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->get_policy_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->preview_policy_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->preview_policy_definition_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_definition_builder_api.ConfigurationPolicyLocalDomainDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainDefinitionBuilderApi->save_policy_definition_in_bulk: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md b/docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md new file mode 100644 index 0000000..76997d6 --- /dev/null +++ b/docs/ConfigurationPolicyLocalDomainNameListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyLocalDomainNameListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#create_policy_list23) | **POST** /template/policy/list/localdomain | +[**delete_policy_list23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#delete_policy_list23) | **DELETE** /template/policy/list/localdomain/{id} | +[**delete_policy_lists_with_info_tag23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#delete_policy_lists_with_info_tag23) | **DELETE** /template/policy/list/localdomain | +[**edit_policy_list23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#edit_policy_list23) | **PUT** /template/policy/list/localdomain/{id} | +[**get_lists_by_id23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#get_lists_by_id23) | **GET** /template/policy/list/localdomain/{id} | +[**get_policy_lists20**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#get_policy_lists20) | **GET** /template/policy/list/localdomain | +[**get_policy_lists_with_info_tag23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#get_policy_lists_with_info_tag23) | **GET** /template/policy/list/localdomain/filtered | +[**preview_policy_list23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#preview_policy_list23) | **POST** /template/policy/list/localdomain/preview | +[**preview_policy_list_by_id23**](ConfigurationPolicyLocalDomainNameListBuilderApi.md#preview_policy_list_by_id23) | **GET** /template/policy/list/localdomain/preview/{id} | + + +# **create_policy_list23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list23() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->create_policy_list23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list23** +> delete_policy_list23(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list23(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->delete_policy_list23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag23** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag23() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag23(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->delete_policy_lists_with_info_tag23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list23(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->edit_policy_list23: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list23(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->edit_policy_list23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id23(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->get_lists_by_id23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists20** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists20() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists20() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->get_policy_lists20: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag23** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag23() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag23(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->get_policy_lists_with_info_tag23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list23() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->preview_policy_list23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id23(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_local_domain_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_local_domain_name_list_builder_api.ConfigurationPolicyLocalDomainNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyLocalDomainNameListBuilderApi->preview_policy_list_by_id23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyMediaProfileListBuilderApi.md b/docs/ConfigurationPolicyMediaProfileListBuilderApi.md new file mode 100644 index 0000000..cb948ac --- /dev/null +++ b/docs/ConfigurationPolicyMediaProfileListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyMediaProfileListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list**](ConfigurationPolicyMediaProfileListBuilderApi.md#create_policy_list) | **POST** /template/policy/list/mediaprofile | +[**delete_policy_list**](ConfigurationPolicyMediaProfileListBuilderApi.md#delete_policy_list) | **DELETE** /template/policy/list/mediaprofile/{id} | +[**delete_policy_lists_with_info_tag**](ConfigurationPolicyMediaProfileListBuilderApi.md#delete_policy_lists_with_info_tag) | **DELETE** /template/policy/list/mediaprofile | +[**edit_policy_list**](ConfigurationPolicyMediaProfileListBuilderApi.md#edit_policy_list) | **PUT** /template/policy/list/mediaprofile/{id} | +[**get_lists_by_id**](ConfigurationPolicyMediaProfileListBuilderApi.md#get_lists_by_id) | **GET** /template/policy/list/mediaprofile/{id} | +[**get_policy_lists**](ConfigurationPolicyMediaProfileListBuilderApi.md#get_policy_lists) | **GET** /template/policy/list/mediaprofile | +[**get_policy_lists_with_info_tag**](ConfigurationPolicyMediaProfileListBuilderApi.md#get_policy_lists_with_info_tag) | **GET** /template/policy/list/mediaprofile/filtered | +[**preview_policy_list**](ConfigurationPolicyMediaProfileListBuilderApi.md#preview_policy_list) | **POST** /template/policy/list/mediaprofile/preview | +[**preview_policy_list_by_id**](ConfigurationPolicyMediaProfileListBuilderApi.md#preview_policy_list_by_id) | **GET** /template/policy/list/mediaprofile/preview/{id} | + + +# **create_policy_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->create_policy_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list** +> delete_policy_list(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->delete_policy_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->delete_policy_lists_with_info_tag: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->edit_policy_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->edit_policy_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->get_lists_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->get_policy_lists: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->get_policy_lists_with_info_tag: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->preview_policy_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_media_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_media_profile_list_builder_api.ConfigurationPolicyMediaProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMediaProfileListBuilderApi->preview_policy_list_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyMeshDefinitionBuilderApi.md b/docs/ConfigurationPolicyMeshDefinitionBuilderApi.md new file mode 100644 index 0000000..4faac67 --- /dev/null +++ b/docs/ConfigurationPolicyMeshDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyMeshDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#create_policy_definition5) | **POST** /template/policy/definition/mesh | +[**delete_policy_definition5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#delete_policy_definition5) | **DELETE** /template/policy/definition/mesh/{id} | +[**edit_multiple_policy_definition5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#edit_multiple_policy_definition5) | **PUT** /template/policy/definition/mesh/multiple/{id} | +[**edit_policy_definition5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#edit_policy_definition5) | **PUT** /template/policy/definition/mesh/{id} | +[**get_definitions5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#get_definitions5) | **GET** /template/policy/definition/mesh | +[**get_policy_definition5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#get_policy_definition5) | **GET** /template/policy/definition/mesh/{id} | +[**preview_policy_definition5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#preview_policy_definition5) | **POST** /template/policy/definition/mesh/preview | +[**preview_policy_definition_by_id5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#preview_policy_definition_by_id5) | **GET** /template/policy/definition/mesh/preview/{id} | +[**save_policy_definition_in_bulk5**](ConfigurationPolicyMeshDefinitionBuilderApi.md#save_policy_definition_in_bulk5) | **PUT** /template/policy/definition/mesh/bulk | + + +# **create_policy_definition5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition5() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->create_policy_definition5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition5** +> delete_policy_definition5(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition5(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->delete_policy_definition5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition5(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->edit_multiple_policy_definition5: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition5(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->edit_multiple_policy_definition5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition5(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->edit_policy_definition5: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition5(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->edit_policy_definition5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions5() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions5() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->get_definitions5: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition5(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->get_policy_definition5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition5() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->preview_policy_definition5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id5(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id5(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->preview_policy_definition_by_id5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk5() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mesh_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mesh_definition_builder_api.ConfigurationPolicyMeshDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMeshDefinitionBuilderApi->save_policy_definition_in_bulk5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyMirrorListBuilderApi.md b/docs/ConfigurationPolicyMirrorListBuilderApi.md new file mode 100644 index 0000000..4c2393d --- /dev/null +++ b/docs/ConfigurationPolicyMirrorListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyMirrorListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list24**](ConfigurationPolicyMirrorListBuilderApi.md#create_policy_list24) | **POST** /template/policy/list/mirror | +[**delete_policy_list24**](ConfigurationPolicyMirrorListBuilderApi.md#delete_policy_list24) | **DELETE** /template/policy/list/mirror/{id} | +[**delete_policy_lists_with_info_tag24**](ConfigurationPolicyMirrorListBuilderApi.md#delete_policy_lists_with_info_tag24) | **DELETE** /template/policy/list/mirror | +[**edit_policy_list24**](ConfigurationPolicyMirrorListBuilderApi.md#edit_policy_list24) | **PUT** /template/policy/list/mirror/{id} | +[**get_lists_by_id24**](ConfigurationPolicyMirrorListBuilderApi.md#get_lists_by_id24) | **GET** /template/policy/list/mirror/{id} | +[**get_policy_lists21**](ConfigurationPolicyMirrorListBuilderApi.md#get_policy_lists21) | **GET** /template/policy/list/mirror | +[**get_policy_lists_with_info_tag24**](ConfigurationPolicyMirrorListBuilderApi.md#get_policy_lists_with_info_tag24) | **GET** /template/policy/list/mirror/filtered | +[**preview_policy_list24**](ConfigurationPolicyMirrorListBuilderApi.md#preview_policy_list24) | **POST** /template/policy/list/mirror/preview | +[**preview_policy_list_by_id24**](ConfigurationPolicyMirrorListBuilderApi.md#preview_policy_list_by_id24) | **GET** /template/policy/list/mirror/preview/{id} | + + +# **create_policy_list24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list24() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->create_policy_list24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list24** +> delete_policy_list24(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list24(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->delete_policy_list24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag24** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag24() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag24(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->delete_policy_lists_with_info_tag24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list24(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->edit_policy_list24: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list24(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->edit_policy_list24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id24(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->get_lists_by_id24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists21** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists21() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists21() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->get_policy_lists21: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag24** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag24() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag24(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->get_policy_lists_with_info_tag24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list24() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->preview_policy_list24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id24(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_mirror_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_mirror_list_builder_api.ConfigurationPolicyMirrorListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyMirrorListBuilderApi->preview_policy_list_by_id24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyModemPassthroughListBuilderApi.md b/docs/ConfigurationPolicyModemPassthroughListBuilderApi.md new file mode 100644 index 0000000..9cb9138 --- /dev/null +++ b/docs/ConfigurationPolicyModemPassthroughListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyModemPassthroughListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#create_policy_list25) | **POST** /template/policy/list/modempassthrough | +[**delete_policy_list25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#delete_policy_list25) | **DELETE** /template/policy/list/modempassthrough/{id} | +[**delete_policy_lists_with_info_tag25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#delete_policy_lists_with_info_tag25) | **DELETE** /template/policy/list/modempassthrough | +[**edit_policy_list25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#edit_policy_list25) | **PUT** /template/policy/list/modempassthrough/{id} | +[**get_lists_by_id25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#get_lists_by_id25) | **GET** /template/policy/list/modempassthrough/{id} | +[**get_policy_lists22**](ConfigurationPolicyModemPassthroughListBuilderApi.md#get_policy_lists22) | **GET** /template/policy/list/modempassthrough | +[**get_policy_lists_with_info_tag25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#get_policy_lists_with_info_tag25) | **GET** /template/policy/list/modempassthrough/filtered | +[**preview_policy_list25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#preview_policy_list25) | **POST** /template/policy/list/modempassthrough/preview | +[**preview_policy_list_by_id25**](ConfigurationPolicyModemPassthroughListBuilderApi.md#preview_policy_list_by_id25) | **GET** /template/policy/list/modempassthrough/preview/{id} | + + +# **create_policy_list25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list25() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->create_policy_list25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list25** +> delete_policy_list25(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list25(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->delete_policy_list25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag25** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag25() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag25(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->delete_policy_lists_with_info_tag25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list25(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->edit_policy_list25: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list25(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->edit_policy_list25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id25(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->get_lists_by_id25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists22** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists22() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists22() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->get_policy_lists22: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag25** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag25() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag25(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->get_policy_lists_with_info_tag25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list25() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->preview_policy_list25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id25(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_modem_passthrough_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_modem_passthrough_list_builder_api.ConfigurationPolicyModemPassthroughListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id25(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyModemPassthroughListBuilderApi->preview_policy_list_by_id25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md b/docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md new file mode 100644 index 0000000..9998ed9 --- /dev/null +++ b/docs/ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#create_policy_definition29) | **POST** /template/policy/definition/priisdnport | +[**delete_policy_definition29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#delete_policy_definition29) | **DELETE** /template/policy/definition/priisdnport/{id} | +[**edit_multiple_policy_definition29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#edit_multiple_policy_definition29) | **PUT** /template/policy/definition/priisdnport/multiple/{id} | +[**edit_policy_definition29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#edit_policy_definition29) | **PUT** /template/policy/definition/priisdnport/{id} | +[**get_definitions29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#get_definitions29) | **GET** /template/policy/definition/priisdnport | +[**get_policy_definition29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#get_policy_definition29) | **GET** /template/policy/definition/priisdnport/{id} | +[**preview_policy_definition29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#preview_policy_definition29) | **POST** /template/policy/definition/priisdnport/preview | +[**preview_policy_definition_by_id29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#preview_policy_definition_by_id29) | **GET** /template/policy/definition/priisdnport/preview/{id} | +[**save_policy_definition_in_bulk29**](ConfigurationPolicyPRIISDNPortDefinitionBuilderApi.md#save_policy_definition_in_bulk29) | **PUT** /template/policy/definition/priisdnport/bulk | + + +# **create_policy_definition29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition29() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition29(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->create_policy_definition29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition29** +> delete_policy_definition29(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition29(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->delete_policy_definition29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition29(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->edit_multiple_policy_definition29: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition29(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->edit_multiple_policy_definition29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition29(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->edit_policy_definition29: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition29(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->edit_policy_definition29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions29() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions29() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->get_definitions29: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition29(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->get_policy_definition29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition29() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition29(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->preview_policy_definition29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id29(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->preview_policy_definition_by_id29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk29() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_priisdn_port_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_priisdn_port_definition_builder_api.ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk29(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPRIISDNPortDefinitionBuilderApi->save_policy_definition_in_bulk29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyPolicerClassListBuilderApi.md b/docs/ConfigurationPolicyPolicerClassListBuilderApi.md new file mode 100644 index 0000000..39dfa0d --- /dev/null +++ b/docs/ConfigurationPolicyPolicerClassListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyPolicerClassListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list26**](ConfigurationPolicyPolicerClassListBuilderApi.md#create_policy_list26) | **POST** /template/policy/list/policer | +[**delete_policy_list26**](ConfigurationPolicyPolicerClassListBuilderApi.md#delete_policy_list26) | **DELETE** /template/policy/list/policer/{id} | +[**delete_policy_lists_with_info_tag26**](ConfigurationPolicyPolicerClassListBuilderApi.md#delete_policy_lists_with_info_tag26) | **DELETE** /template/policy/list/policer | +[**edit_policy_list26**](ConfigurationPolicyPolicerClassListBuilderApi.md#edit_policy_list26) | **PUT** /template/policy/list/policer/{id} | +[**get_lists_by_id26**](ConfigurationPolicyPolicerClassListBuilderApi.md#get_lists_by_id26) | **GET** /template/policy/list/policer/{id} | +[**get_policy_lists23**](ConfigurationPolicyPolicerClassListBuilderApi.md#get_policy_lists23) | **GET** /template/policy/list/policer | +[**get_policy_lists_with_info_tag26**](ConfigurationPolicyPolicerClassListBuilderApi.md#get_policy_lists_with_info_tag26) | **GET** /template/policy/list/policer/filtered | +[**preview_policy_list26**](ConfigurationPolicyPolicerClassListBuilderApi.md#preview_policy_list26) | **POST** /template/policy/list/policer/preview | +[**preview_policy_list_by_id26**](ConfigurationPolicyPolicerClassListBuilderApi.md#preview_policy_list_by_id26) | **GET** /template/policy/list/policer/preview/{id} | + + +# **create_policy_list26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list26() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->create_policy_list26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list26** +> delete_policy_list26(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list26(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->delete_policy_list26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag26** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag26() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag26(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->delete_policy_lists_with_info_tag26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list26(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->edit_policy_list26: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list26(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->edit_policy_list26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id26(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->get_lists_by_id26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists23** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists23() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists23() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->get_policy_lists23: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag26** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag26() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag26(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->get_policy_lists_with_info_tag26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list26() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->preview_policy_list26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id26(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_policer_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_policer_class_list_builder_api.ConfigurationPolicyPolicerClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id26(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPolicerClassListBuilderApi->preview_policy_list_by_id26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyPortListBuilderApi.md b/docs/ConfigurationPolicyPortListBuilderApi.md new file mode 100644 index 0000000..1849bb4 --- /dev/null +++ b/docs/ConfigurationPolicyPortListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyPortListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list27**](ConfigurationPolicyPortListBuilderApi.md#create_policy_list27) | **POST** /template/policy/list/port | +[**delete_policy_list27**](ConfigurationPolicyPortListBuilderApi.md#delete_policy_list27) | **DELETE** /template/policy/list/port/{id} | +[**delete_policy_lists_with_info_tag27**](ConfigurationPolicyPortListBuilderApi.md#delete_policy_lists_with_info_tag27) | **DELETE** /template/policy/list/port | +[**edit_policy_list27**](ConfigurationPolicyPortListBuilderApi.md#edit_policy_list27) | **PUT** /template/policy/list/port/{id} | +[**get_lists_by_id27**](ConfigurationPolicyPortListBuilderApi.md#get_lists_by_id27) | **GET** /template/policy/list/port/{id} | +[**get_policy_lists24**](ConfigurationPolicyPortListBuilderApi.md#get_policy_lists24) | **GET** /template/policy/list/port | +[**get_policy_lists_with_info_tag27**](ConfigurationPolicyPortListBuilderApi.md#get_policy_lists_with_info_tag27) | **GET** /template/policy/list/port/filtered | +[**preview_policy_list27**](ConfigurationPolicyPortListBuilderApi.md#preview_policy_list27) | **POST** /template/policy/list/port/preview | +[**preview_policy_list_by_id27**](ConfigurationPolicyPortListBuilderApi.md#preview_policy_list_by_id27) | **GET** /template/policy/list/port/preview/{id} | + + +# **create_policy_list27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list27() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->create_policy_list27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list27** +> delete_policy_list27(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list27(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->delete_policy_list27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag27** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag27() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag27(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->delete_policy_lists_with_info_tag27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list27(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->edit_policy_list27: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list27(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->edit_policy_list27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id27(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->get_lists_by_id27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists24** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists24() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists24() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->get_policy_lists24: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag27** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag27() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag27(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->get_policy_lists_with_info_tag27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list27() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->preview_policy_list27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id27(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_port_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_port_list_builder_api.ConfigurationPolicyPortListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id27(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPortListBuilderApi->preview_policy_list_by_id27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md b/docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md new file mode 100644 index 0000000..701ca59 --- /dev/null +++ b/docs/ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#create_policy_list21) | **POST** /template/policy/list/ipprefixall | +[**delete_policy_list21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#delete_policy_list21) | **DELETE** /template/policy/list/ipprefixall/{id} | +[**delete_policy_lists_with_info_tag21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#delete_policy_lists_with_info_tag21) | **DELETE** /template/policy/list/ipprefixall | +[**edit_policy_list21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#edit_policy_list21) | **PUT** /template/policy/list/ipprefixall/{id} | +[**get_lists_by_id21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#get_lists_by_id21) | **GET** /template/policy/list/ipprefixall/{id} | +[**get_lists_for_all_prefixes**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#get_lists_for_all_prefixes) | **GET** /template/policy/list/ipprefixall | +[**get_policy_lists_with_info_tag21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#get_policy_lists_with_info_tag21) | **GET** /template/policy/list/ipprefixall/filtered | +[**preview_policy_list21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#preview_policy_list21) | **POST** /template/policy/list/ipprefixall/preview | +[**preview_policy_list_by_id21**](ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi.md#preview_policy_list_by_id21) | **GET** /template/policy/list/ipprefixall/preview/{id} | + + +# **create_policy_list21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list21() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->create_policy_list21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list21** +> delete_policy_list21(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list21(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->delete_policy_list21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag21** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag21() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag21(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->delete_policy_lists_with_info_tag21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list21(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->edit_policy_list21: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list21(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->edit_policy_list21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id21(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->get_lists_by_id21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_for_all_prefixes** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_lists_for_all_prefixes() + + + +Get lists for all prefixes + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_lists_for_all_prefixes() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->get_lists_for_all_prefixes: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag21** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag21() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag21(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->get_policy_lists_with_info_tag21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list21() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->preview_policy_list21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id21(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_for_all_types_of_lists_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_for_all_types_of_lists_builder_api.ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi->preview_policy_list_by_id21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyPrefixListBuilderApi.md b/docs/ConfigurationPolicyPrefixListBuilderApi.md new file mode 100644 index 0000000..49b6277 --- /dev/null +++ b/docs/ConfigurationPolicyPrefixListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyPrefixListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list29**](ConfigurationPolicyPrefixListBuilderApi.md#create_policy_list29) | **POST** /template/policy/list/prefix | +[**delete_policy_list29**](ConfigurationPolicyPrefixListBuilderApi.md#delete_policy_list29) | **DELETE** /template/policy/list/prefix/{id} | +[**delete_policy_lists_with_info_tag29**](ConfigurationPolicyPrefixListBuilderApi.md#delete_policy_lists_with_info_tag29) | **DELETE** /template/policy/list/prefix | +[**edit_policy_list29**](ConfigurationPolicyPrefixListBuilderApi.md#edit_policy_list29) | **PUT** /template/policy/list/prefix/{id} | +[**get_lists_by_id29**](ConfigurationPolicyPrefixListBuilderApi.md#get_lists_by_id29) | **GET** /template/policy/list/prefix/{id} | +[**get_policy_lists26**](ConfigurationPolicyPrefixListBuilderApi.md#get_policy_lists26) | **GET** /template/policy/list/prefix | +[**get_policy_lists_with_info_tag29**](ConfigurationPolicyPrefixListBuilderApi.md#get_policy_lists_with_info_tag29) | **GET** /template/policy/list/prefix/filtered | +[**preview_policy_list29**](ConfigurationPolicyPrefixListBuilderApi.md#preview_policy_list29) | **POST** /template/policy/list/prefix/preview | +[**preview_policy_list_by_id29**](ConfigurationPolicyPrefixListBuilderApi.md#preview_policy_list_by_id29) | **GET** /template/policy/list/prefix/preview/{id} | + + +# **create_policy_list29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list29() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list29(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->create_policy_list29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list29** +> delete_policy_list29(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list29(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->delete_policy_list29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag29** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag29() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag29(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->delete_policy_lists_with_info_tag29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list29(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->edit_policy_list29: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list29(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->edit_policy_list29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id29(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->get_lists_by_id29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists26** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists26() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists26() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->get_policy_lists26: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag29** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag29() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag29(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->get_policy_lists_with_info_tag29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list29() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list29(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->preview_policy_list29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id29(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_prefix_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_prefix_list_builder_api.ConfigurationPolicyPrefixListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id29(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyPrefixListBuilderApi->preview_policy_list_by_id29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyProtocolNameListBuilderApi.md b/docs/ConfigurationPolicyProtocolNameListBuilderApi.md new file mode 100644 index 0000000..92ac111 --- /dev/null +++ b/docs/ConfigurationPolicyProtocolNameListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyProtocolNameListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list30**](ConfigurationPolicyProtocolNameListBuilderApi.md#create_policy_list30) | **POST** /template/policy/list/protocolname | +[**delete_policy_list30**](ConfigurationPolicyProtocolNameListBuilderApi.md#delete_policy_list30) | **DELETE** /template/policy/list/protocolname/{id} | +[**delete_policy_lists_with_info_tag30**](ConfigurationPolicyProtocolNameListBuilderApi.md#delete_policy_lists_with_info_tag30) | **DELETE** /template/policy/list/protocolname | +[**edit_policy_list30**](ConfigurationPolicyProtocolNameListBuilderApi.md#edit_policy_list30) | **PUT** /template/policy/list/protocolname/{id} | +[**get_lists_by_id30**](ConfigurationPolicyProtocolNameListBuilderApi.md#get_lists_by_id30) | **GET** /template/policy/list/protocolname/{id} | +[**get_policy_lists27**](ConfigurationPolicyProtocolNameListBuilderApi.md#get_policy_lists27) | **GET** /template/policy/list/protocolname | +[**get_policy_lists_with_info_tag30**](ConfigurationPolicyProtocolNameListBuilderApi.md#get_policy_lists_with_info_tag30) | **GET** /template/policy/list/protocolname/filtered | +[**preview_policy_list30**](ConfigurationPolicyProtocolNameListBuilderApi.md#preview_policy_list30) | **POST** /template/policy/list/protocolname/preview | +[**preview_policy_list_by_id30**](ConfigurationPolicyProtocolNameListBuilderApi.md#preview_policy_list_by_id30) | **GET** /template/policy/list/protocolname/preview/{id} | + + +# **create_policy_list30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list30() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list30(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->create_policy_list30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list30** +> delete_policy_list30(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list30(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->delete_policy_list30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag30** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag30() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag30(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->delete_policy_lists_with_info_tag30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list30(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->edit_policy_list30: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list30(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->edit_policy_list30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id30(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->get_lists_by_id30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists27** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists27() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists27() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->get_policy_lists27: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag30** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag30() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag30(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->get_policy_lists_with_info_tag30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list30() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list30(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->preview_policy_list30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id30(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_protocol_name_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_protocol_name_list_builder_api.ConfigurationPolicyProtocolNameListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id30(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyProtocolNameListBuilderApi->preview_policy_list_by_id30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md b/docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md new file mode 100644 index 0000000..6fe663c --- /dev/null +++ b/docs/ConfigurationPolicyQosMapDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyQosMapDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#create_policy_definition1) | **POST** /template/policy/definition/qosmap | +[**delete_policy_definition1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#delete_policy_definition1) | **DELETE** /template/policy/definition/qosmap/{id} | +[**edit_multiple_policy_definition1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#edit_multiple_policy_definition1) | **PUT** /template/policy/definition/qosmap/multiple/{id} | +[**edit_policy_definition1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#edit_policy_definition1) | **PUT** /template/policy/definition/qosmap/{id} | +[**get_definitions1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#get_definitions1) | **GET** /template/policy/definition/qosmap | +[**get_policy_definition1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#get_policy_definition1) | **GET** /template/policy/definition/qosmap/{id} | +[**preview_policy_definition1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#preview_policy_definition1) | **POST** /template/policy/definition/qosmap/preview | +[**preview_policy_definition_by_id1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#preview_policy_definition_by_id1) | **GET** /template/policy/definition/qosmap/preview/{id} | +[**save_policy_definition_in_bulk1**](ConfigurationPolicyQosMapDefinitionBuilderApi.md#save_policy_definition_in_bulk1) | **PUT** /template/policy/definition/qosmap/bulk | + + +# **create_policy_definition1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition1() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->create_policy_definition1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition1** +> delete_policy_definition1(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition1(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->delete_policy_definition1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition1(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->edit_multiple_policy_definition1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition1(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->edit_multiple_policy_definition1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition1(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->edit_policy_definition1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition1(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->edit_policy_definition1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions1() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->get_definitions1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition1(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->get_policy_definition1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition1() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->preview_policy_definition1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id1(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->preview_policy_definition_by_id1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk1() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_qos_map_definition_builder_api.ConfigurationPolicyQosMapDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyQosMapDefinitionBuilderApi->save_policy_definition_in_bulk1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyRegionListBuilderApi.md b/docs/ConfigurationPolicyRegionListBuilderApi.md new file mode 100644 index 0000000..c282f93 --- /dev/null +++ b/docs/ConfigurationPolicyRegionListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyRegionListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list31**](ConfigurationPolicyRegionListBuilderApi.md#create_policy_list31) | **POST** /template/policy/list/region | +[**delete_policy_list31**](ConfigurationPolicyRegionListBuilderApi.md#delete_policy_list31) | **DELETE** /template/policy/list/region/{id} | +[**delete_policy_lists_with_info_tag31**](ConfigurationPolicyRegionListBuilderApi.md#delete_policy_lists_with_info_tag31) | **DELETE** /template/policy/list/region | +[**edit_policy_list31**](ConfigurationPolicyRegionListBuilderApi.md#edit_policy_list31) | **PUT** /template/policy/list/region/{id} | +[**get_lists_by_id31**](ConfigurationPolicyRegionListBuilderApi.md#get_lists_by_id31) | **GET** /template/policy/list/region/{id} | +[**get_policy_lists28**](ConfigurationPolicyRegionListBuilderApi.md#get_policy_lists28) | **GET** /template/policy/list/region | +[**get_policy_lists_with_info_tag31**](ConfigurationPolicyRegionListBuilderApi.md#get_policy_lists_with_info_tag31) | **GET** /template/policy/list/region/filtered | +[**preview_policy_list31**](ConfigurationPolicyRegionListBuilderApi.md#preview_policy_list31) | **POST** /template/policy/list/region/preview | +[**preview_policy_list_by_id31**](ConfigurationPolicyRegionListBuilderApi.md#preview_policy_list_by_id31) | **GET** /template/policy/list/region/preview/{id} | + + +# **create_policy_list31** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list31() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list31(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->create_policy_list31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list31** +> delete_policy_list31(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list31(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->delete_policy_list31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag31** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag31() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag31(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->delete_policy_lists_with_info_tag31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list31** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list31(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list31(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->edit_policy_list31: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list31(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->edit_policy_list31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id31** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id31(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id31(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->get_lists_by_id31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists28** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists28() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists28() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->get_policy_lists28: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag31** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag31() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag31(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->get_policy_lists_with_info_tag31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list31** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list31() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list31(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->preview_policy_list31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id31** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id31(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_region_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_region_list_builder_api.ConfigurationPolicyRegionListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id31(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRegionListBuilderApi->preview_policy_list_by_id31: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md b/docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md new file mode 100644 index 0000000..6858a16 --- /dev/null +++ b/docs/ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyRewriteRuleDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#create_policy_definition19) | **POST** /template/policy/definition/rewriterule | +[**delete_policy_definition19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#delete_policy_definition19) | **DELETE** /template/policy/definition/rewriterule/{id} | +[**edit_multiple_policy_definition19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#edit_multiple_policy_definition19) | **PUT** /template/policy/definition/rewriterule/multiple/{id} | +[**edit_policy_definition19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#edit_policy_definition19) | **PUT** /template/policy/definition/rewriterule/{id} | +[**get_definitions19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#get_definitions19) | **GET** /template/policy/definition/rewriterule | +[**get_policy_definition19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#get_policy_definition19) | **GET** /template/policy/definition/rewriterule/{id} | +[**preview_policy_definition19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#preview_policy_definition19) | **POST** /template/policy/definition/rewriterule/preview | +[**preview_policy_definition_by_id19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#preview_policy_definition_by_id19) | **GET** /template/policy/definition/rewriterule/preview/{id} | +[**save_policy_definition_in_bulk19**](ConfigurationPolicyRewriteRuleDefinitionBuilderApi.md#save_policy_definition_in_bulk19) | **PUT** /template/policy/definition/rewriterule/bulk | + + +# **create_policy_definition19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition19() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->create_policy_definition19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition19** +> delete_policy_definition19(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition19(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->delete_policy_definition19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition19(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->edit_multiple_policy_definition19: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition19(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->edit_multiple_policy_definition19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition19(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->edit_policy_definition19: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition19(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->edit_policy_definition19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions19() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions19() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->get_definitions19: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition19(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->get_policy_definition19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition19() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->preview_policy_definition19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id19(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id19(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->preview_policy_definition_by_id19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk19() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_rewrite_rule_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_rewrite_rule_definition_builder_api.ConfigurationPolicyRewriteRuleDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyRewriteRuleDefinitionBuilderApi->save_policy_definition_in_bulk19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicySLAClassListBuilderApi.md b/docs/ConfigurationPolicySLAClassListBuilderApi.md new file mode 100644 index 0000000..0fc5d6f --- /dev/null +++ b/docs/ConfigurationPolicySLAClassListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicySLAClassListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list33**](ConfigurationPolicySLAClassListBuilderApi.md#create_policy_list33) | **POST** /template/policy/list/sla | +[**delete_policy_list33**](ConfigurationPolicySLAClassListBuilderApi.md#delete_policy_list33) | **DELETE** /template/policy/list/sla/{id} | +[**delete_policy_lists_with_info_tag33**](ConfigurationPolicySLAClassListBuilderApi.md#delete_policy_lists_with_info_tag33) | **DELETE** /template/policy/list/sla | +[**edit_policy_list33**](ConfigurationPolicySLAClassListBuilderApi.md#edit_policy_list33) | **PUT** /template/policy/list/sla/{id} | +[**get_lists_by_id33**](ConfigurationPolicySLAClassListBuilderApi.md#get_lists_by_id33) | **GET** /template/policy/list/sla/{id} | +[**get_policy_lists30**](ConfigurationPolicySLAClassListBuilderApi.md#get_policy_lists30) | **GET** /template/policy/list/sla | +[**get_policy_lists_with_info_tag33**](ConfigurationPolicySLAClassListBuilderApi.md#get_policy_lists_with_info_tag33) | **GET** /template/policy/list/sla/filtered | +[**preview_policy_list33**](ConfigurationPolicySLAClassListBuilderApi.md#preview_policy_list33) | **POST** /template/policy/list/sla/preview | +[**preview_policy_list_by_id33**](ConfigurationPolicySLAClassListBuilderApi.md#preview_policy_list_by_id33) | **GET** /template/policy/list/sla/preview/{id} | + + +# **create_policy_list33** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list33() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list33(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->create_policy_list33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list33** +> delete_policy_list33(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list33(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->delete_policy_list33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag33** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag33() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag33(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->delete_policy_lists_with_info_tag33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list33** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list33(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list33(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->edit_policy_list33: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list33(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->edit_policy_list33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id33** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id33(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id33(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->get_lists_by_id33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists30** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists30() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists30() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->get_policy_lists30: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag33** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag33() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag33(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->get_policy_lists_with_info_tag33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list33** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list33() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list33(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->preview_policy_list33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id33** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id33(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_sla_class_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_sla_class_list_builder_api.ConfigurationPolicySLAClassListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id33(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySLAClassListBuilderApi->preview_policy_list_by_id33: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi.md b/docs/ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi.md new file mode 100644 index 0000000..3f025c2 --- /dev/null +++ b/docs/ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi.md @@ -0,0 +1,81 @@ +# openapi_client.ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_sig_data_center_list**](ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi.md#get_sig_data_center_list) | **GET** /sig/datacenters/{type}/{tunneltype}/{devicetype} | + + +# **get_sig_data_center_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sig_data_center_list(type, tunneltype, devicetype) + + + +Get list of data centers for zscaler or umbrella + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_secure_internet_gateway_data_centers_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_secure_internet_gateway_data_centers_builder_api.ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi(api_client) + type = "type_example" # str | Provider type + tunneltype = "tunneltype_example" # str | Type of the tunnel ipsec/gre + devicetype = "devicetype_example" # str | Type of the device vedge/cedge + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sig_data_center_list(type, tunneltype, devicetype) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi->get_sig_data_center_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Provider type | + **tunneltype** | **str**| Type of the tunnel ipsec/gre | + **devicetype** | **str**| Type of the device vedge/cedge | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicySecurityAssemblerApi.md b/docs/ConfigurationPolicySecurityAssemblerApi.md new file mode 100644 index 0000000..b9f5eac --- /dev/null +++ b/docs/ConfigurationPolicySecurityAssemblerApi.md @@ -0,0 +1,147 @@ +# openapi_client.ConfigurationPolicySecurityAssemblerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**preview**](ConfigurationPolicySecurityAssemblerApi.md#preview) | **POST** /template/policy/assembly/security | +[**preview_by_id**](ConfigurationPolicySecurityAssemblerApi.md#preview_by_id) | **GET** /template/policy/assembly/security/{id} | + + +# **preview** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview() + + + +Get policy assembly preview + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_security_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_security_assembler_api.ConfigurationPolicySecurityAssemblerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy assembly (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySecurityAssemblerApi->preview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy assembly | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_by_id(id) + + + +Get policy assembly preview for feature policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_security_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_security_assembler_api.ConfigurationPolicySecurityAssemblerApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_by_id(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySecurityAssemblerApi->preview_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicySiteListBuilderApi.md b/docs/ConfigurationPolicySiteListBuilderApi.md new file mode 100644 index 0000000..fb27e8b --- /dev/null +++ b/docs/ConfigurationPolicySiteListBuilderApi.md @@ -0,0 +1,703 @@ +# openapi_client.ConfigurationPolicySiteListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_default_site_list**](ConfigurationPolicySiteListBuilderApi.md#create_default_site_list) | **POST** /template/policy/list/site/defaultsite | +[**create_policy_list32**](ConfigurationPolicySiteListBuilderApi.md#create_policy_list32) | **POST** /template/policy/list/site | +[**delete_policy_list32**](ConfigurationPolicySiteListBuilderApi.md#delete_policy_list32) | **DELETE** /template/policy/list/site/{id} | +[**delete_policy_lists_with_info_tag32**](ConfigurationPolicySiteListBuilderApi.md#delete_policy_lists_with_info_tag32) | **DELETE** /template/policy/list/site | +[**edit_policy_list32**](ConfigurationPolicySiteListBuilderApi.md#edit_policy_list32) | **PUT** /template/policy/list/site/{id} | +[**get_lists_by_id32**](ConfigurationPolicySiteListBuilderApi.md#get_lists_by_id32) | **GET** /template/policy/list/site/{id} | +[**get_policy_lists29**](ConfigurationPolicySiteListBuilderApi.md#get_policy_lists29) | **GET** /template/policy/list/site | +[**get_policy_lists_with_info_tag32**](ConfigurationPolicySiteListBuilderApi.md#get_policy_lists_with_info_tag32) | **GET** /template/policy/list/site/filtered | +[**preview_policy_list32**](ConfigurationPolicySiteListBuilderApi.md#preview_policy_list32) | **POST** /template/policy/list/site/preview | +[**preview_policy_list_by_id32**](ConfigurationPolicySiteListBuilderApi.md#preview_policy_list_by_id32) | **GET** /template/policy/list/site/preview/{id} | + + +# **create_default_site_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_default_site_list() + + + +Create default site list for sites missing from centralized policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_default_site_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->create_default_site_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_list32** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list32() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list32(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->create_policy_list32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list32** +> delete_policy_list32(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list32(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->delete_policy_list32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag32** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag32() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag32(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->delete_policy_lists_with_info_tag32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list32** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list32(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list32(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->edit_policy_list32: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list32(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->edit_policy_list32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id32** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id32(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id32(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->get_lists_by_id32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists29** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists29() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists29() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->get_policy_lists29: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag32** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag32() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag32(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->get_policy_lists_with_info_tag32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list32** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list32() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list32(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->preview_policy_list32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id32** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id32(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_site_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id32(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySiteListBuilderApi->preview_policy_list_by_id32: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md b/docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md new file mode 100644 index 0000000..767b520 --- /dev/null +++ b/docs/ConfigurationPolicySupervisoryDiscListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicySupervisoryDiscListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#create_policy_list34) | **POST** /template/policy/list/supervisorydisc | +[**delete_policy_list34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#delete_policy_list34) | **DELETE** /template/policy/list/supervisorydisc/{id} | +[**delete_policy_lists_with_info_tag34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#delete_policy_lists_with_info_tag34) | **DELETE** /template/policy/list/supervisorydisc | +[**edit_policy_list34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#edit_policy_list34) | **PUT** /template/policy/list/supervisorydisc/{id} | +[**get_lists_by_id34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#get_lists_by_id34) | **GET** /template/policy/list/supervisorydisc/{id} | +[**get_policy_lists31**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#get_policy_lists31) | **GET** /template/policy/list/supervisorydisc | +[**get_policy_lists_with_info_tag34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#get_policy_lists_with_info_tag34) | **GET** /template/policy/list/supervisorydisc/filtered | +[**preview_policy_list34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#preview_policy_list34) | **POST** /template/policy/list/supervisorydisc/preview | +[**preview_policy_list_by_id34**](ConfigurationPolicySupervisoryDiscListBuilderApi.md#preview_policy_list_by_id34) | **GET** /template/policy/list/supervisorydisc/preview/{id} | + + +# **create_policy_list34** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list34() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list34(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->create_policy_list34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list34** +> delete_policy_list34(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list34(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->delete_policy_list34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag34** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag34() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag34(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->delete_policy_lists_with_info_tag34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list34** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list34(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list34(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->edit_policy_list34: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list34(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->edit_policy_list34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id34** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id34(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id34(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->get_lists_by_id34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists31** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists31() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists31() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->get_policy_lists31: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag34** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag34() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag34(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->get_policy_lists_with_info_tag34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list34** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list34() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list34(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->preview_policy_list34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id34** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id34(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_supervisory_disc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_supervisory_disc_list_builder_api.ConfigurationPolicySupervisoryDiscListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id34(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicySupervisoryDiscListBuilderApi->preview_policy_list_by_id34: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyTLOCListBuilderApi.md b/docs/ConfigurationPolicyTLOCListBuilderApi.md new file mode 100644 index 0000000..4e6ef7e --- /dev/null +++ b/docs/ConfigurationPolicyTLOCListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyTLOCListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list36**](ConfigurationPolicyTLOCListBuilderApi.md#create_policy_list36) | **POST** /template/policy/list/tloc | +[**delete_policy_list36**](ConfigurationPolicyTLOCListBuilderApi.md#delete_policy_list36) | **DELETE** /template/policy/list/tloc/{id} | +[**delete_policy_lists_with_info_tag36**](ConfigurationPolicyTLOCListBuilderApi.md#delete_policy_lists_with_info_tag36) | **DELETE** /template/policy/list/tloc | +[**edit_policy_list36**](ConfigurationPolicyTLOCListBuilderApi.md#edit_policy_list36) | **PUT** /template/policy/list/tloc/{id} | +[**get_lists_by_id36**](ConfigurationPolicyTLOCListBuilderApi.md#get_lists_by_id36) | **GET** /template/policy/list/tloc/{id} | +[**get_policy_lists33**](ConfigurationPolicyTLOCListBuilderApi.md#get_policy_lists33) | **GET** /template/policy/list/tloc | +[**get_policy_lists_with_info_tag36**](ConfigurationPolicyTLOCListBuilderApi.md#get_policy_lists_with_info_tag36) | **GET** /template/policy/list/tloc/filtered | +[**preview_policy_list36**](ConfigurationPolicyTLOCListBuilderApi.md#preview_policy_list36) | **POST** /template/policy/list/tloc/preview | +[**preview_policy_list_by_id36**](ConfigurationPolicyTLOCListBuilderApi.md#preview_policy_list_by_id36) | **GET** /template/policy/list/tloc/preview/{id} | + + +# **create_policy_list36** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list36() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list36(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->create_policy_list36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list36** +> delete_policy_list36(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list36(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->delete_policy_list36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag36** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag36() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag36(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->delete_policy_lists_with_info_tag36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list36** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list36(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list36(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->edit_policy_list36: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list36(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->edit_policy_list36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id36** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id36(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id36(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->get_lists_by_id36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists33** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists33() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists33() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->get_policy_lists33: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag36** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag36() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag36(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->get_policy_lists_with_info_tag36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list36** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list36() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list36(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->preview_policy_list36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id36** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id36(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_tloc_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_tloc_list_builder_api.ConfigurationPolicyTLOCListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id36(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTLOCListBuilderApi->preview_policy_list_by_id36: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyThreatGridApiKeyListApi.md b/docs/ConfigurationPolicyThreatGridApiKeyListApi.md new file mode 100644 index 0000000..b1f70e1 --- /dev/null +++ b/docs/ConfigurationPolicyThreatGridApiKeyListApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyThreatGridApiKeyListApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list35**](ConfigurationPolicyThreatGridApiKeyListApi.md#create_policy_list35) | **POST** /template/policy/list/tgapikey | +[**delete_policy_list35**](ConfigurationPolicyThreatGridApiKeyListApi.md#delete_policy_list35) | **DELETE** /template/policy/list/tgapikey/{id} | +[**delete_policy_lists_with_info_tag35**](ConfigurationPolicyThreatGridApiKeyListApi.md#delete_policy_lists_with_info_tag35) | **DELETE** /template/policy/list/tgapikey | +[**edit_policy_list35**](ConfigurationPolicyThreatGridApiKeyListApi.md#edit_policy_list35) | **PUT** /template/policy/list/tgapikey/{id} | +[**get_lists_by_id35**](ConfigurationPolicyThreatGridApiKeyListApi.md#get_lists_by_id35) | **GET** /template/policy/list/tgapikey/{id} | +[**get_policy_lists32**](ConfigurationPolicyThreatGridApiKeyListApi.md#get_policy_lists32) | **GET** /template/policy/list/tgapikey | +[**get_policy_lists_with_info_tag35**](ConfigurationPolicyThreatGridApiKeyListApi.md#get_policy_lists_with_info_tag35) | **GET** /template/policy/list/tgapikey/filtered | +[**preview_policy_list35**](ConfigurationPolicyThreatGridApiKeyListApi.md#preview_policy_list35) | **POST** /template/policy/list/tgapikey/preview | +[**preview_policy_list_by_id35**](ConfigurationPolicyThreatGridApiKeyListApi.md#preview_policy_list_by_id35) | **GET** /template/policy/list/tgapikey/preview/{id} | + + +# **create_policy_list35** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list35() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list35(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->create_policy_list35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list35** +> delete_policy_list35(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list35(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->delete_policy_list35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag35** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag35() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag35(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->delete_policy_lists_with_info_tag35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list35** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list35(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list35(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->edit_policy_list35: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list35(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->edit_policy_list35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id35** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id35(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id35(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->get_lists_by_id35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists32** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists32() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists32() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->get_policy_lists32: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag35** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag35() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag35(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->get_policy_lists_with_info_tag35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list35** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list35() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list35(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->preview_policy_list35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id35** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id35(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_threat_grid_api_key_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_threat_grid_api_key_list_api.ConfigurationPolicyThreatGridApiKeyListApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id35(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyThreatGridApiKeyListApi->preview_policy_list_by_id35: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyTranslationProfileListBuilderApi.md b/docs/ConfigurationPolicyTranslationProfileListBuilderApi.md new file mode 100644 index 0000000..ca72fb7 --- /dev/null +++ b/docs/ConfigurationPolicyTranslationProfileListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyTranslationProfileListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#create_policy_list1) | **POST** /template/policy/list/translationprofile | +[**delete_policy_list1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#delete_policy_list1) | **DELETE** /template/policy/list/translationprofile/{id} | +[**delete_policy_lists_with_info_tag1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#delete_policy_lists_with_info_tag1) | **DELETE** /template/policy/list/translationprofile | +[**edit_policy_list1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#edit_policy_list1) | **PUT** /template/policy/list/translationprofile/{id} | +[**get_lists_by_id1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#get_lists_by_id1) | **GET** /template/policy/list/translationprofile/{id} | +[**get_policy_lists1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#get_policy_lists1) | **GET** /template/policy/list/translationprofile | +[**get_policy_lists_with_info_tag1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#get_policy_lists_with_info_tag1) | **GET** /template/policy/list/translationprofile/filtered | +[**preview_policy_list1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#preview_policy_list1) | **POST** /template/policy/list/translationprofile/preview | +[**preview_policy_list_by_id1**](ConfigurationPolicyTranslationProfileListBuilderApi.md#preview_policy_list_by_id1) | **GET** /template/policy/list/translationprofile/preview/{id} | + + +# **create_policy_list1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list1() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->create_policy_list1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list1** +> delete_policy_list1(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list1(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->delete_policy_list1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag1** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag1() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag1(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->delete_policy_lists_with_info_tag1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list1(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->edit_policy_list1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list1(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->edit_policy_list1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id1(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->get_lists_by_id1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists1** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists1() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->get_policy_lists1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag1** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag1() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag1(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->get_policy_lists_with_info_tag1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list1() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->preview_policy_list1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id1(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_profile_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_profile_list_builder_api.ConfigurationPolicyTranslationProfileListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationProfileListBuilderApi->preview_policy_list_by_id1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyTranslationRulesListBuilderApi.md b/docs/ConfigurationPolicyTranslationRulesListBuilderApi.md new file mode 100644 index 0000000..1295f67 --- /dev/null +++ b/docs/ConfigurationPolicyTranslationRulesListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyTranslationRulesListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#create_policy_list2) | **POST** /template/policy/list/translationrules | +[**delete_policy_list2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#delete_policy_list2) | **DELETE** /template/policy/list/translationrules/{id} | +[**delete_policy_lists_with_info_tag2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#delete_policy_lists_with_info_tag2) | **DELETE** /template/policy/list/translationrules | +[**edit_policy_list2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#edit_policy_list2) | **PUT** /template/policy/list/translationrules/{id} | +[**get_lists_by_id2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#get_lists_by_id2) | **GET** /template/policy/list/translationrules/{id} | +[**get_policy_lists2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#get_policy_lists2) | **GET** /template/policy/list/translationrules | +[**get_policy_lists_with_info_tag2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#get_policy_lists_with_info_tag2) | **GET** /template/policy/list/translationrules/filtered | +[**preview_policy_list2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#preview_policy_list2) | **POST** /template/policy/list/translationrules/preview | +[**preview_policy_list_by_id2**](ConfigurationPolicyTranslationRulesListBuilderApi.md#preview_policy_list_by_id2) | **GET** /template/policy/list/translationrules/preview/{id} | + + +# **create_policy_list2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list2() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->create_policy_list2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list2** +> delete_policy_list2(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list2(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->delete_policy_list2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag2** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag2() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag2(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->delete_policy_lists_with_info_tag2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list2(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->edit_policy_list2: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list2(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->edit_policy_list2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id2(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->get_lists_by_id2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists2** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists2() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists2() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->get_policy_lists2: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag2** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag2() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag2(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->get_policy_lists_with_info_tag2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list2() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->preview_policy_list2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id2(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_translation_rules_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_translation_rules_list_builder_api.ConfigurationPolicyTranslationRulesListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTranslationRulesListBuilderApi->preview_policy_list_by_id2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyTrunkGroupListBuilderApi.md b/docs/ConfigurationPolicyTrunkGroupListBuilderApi.md new file mode 100644 index 0000000..d98dab8 --- /dev/null +++ b/docs/ConfigurationPolicyTrunkGroupListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyTrunkGroupListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#create_policy_list37) | **POST** /template/policy/list/trunkgroup | +[**delete_policy_list37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#delete_policy_list37) | **DELETE** /template/policy/list/trunkgroup/{id} | +[**delete_policy_lists_with_info_tag37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#delete_policy_lists_with_info_tag37) | **DELETE** /template/policy/list/trunkgroup | +[**edit_policy_list37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#edit_policy_list37) | **PUT** /template/policy/list/trunkgroup/{id} | +[**get_lists_by_id37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#get_lists_by_id37) | **GET** /template/policy/list/trunkgroup/{id} | +[**get_policy_lists34**](ConfigurationPolicyTrunkGroupListBuilderApi.md#get_policy_lists34) | **GET** /template/policy/list/trunkgroup | +[**get_policy_lists_with_info_tag37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#get_policy_lists_with_info_tag37) | **GET** /template/policy/list/trunkgroup/filtered | +[**preview_policy_list37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#preview_policy_list37) | **POST** /template/policy/list/trunkgroup/preview | +[**preview_policy_list_by_id37**](ConfigurationPolicyTrunkGroupListBuilderApi.md#preview_policy_list_by_id37) | **GET** /template/policy/list/trunkgroup/preview/{id} | + + +# **create_policy_list37** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list37() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list37(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->create_policy_list37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list37** +> delete_policy_list37(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list37(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->delete_policy_list37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag37** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag37() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag37(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->delete_policy_lists_with_info_tag37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list37** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list37(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list37(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->edit_policy_list37: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list37(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->edit_policy_list37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id37** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id37(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id37(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->get_lists_by_id37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists34** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists34() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists34() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->get_policy_lists34: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag37** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag37() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag37(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->get_policy_lists_with_info_tag37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list37** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list37() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list37(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->preview_policy_list37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id37** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id37(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_trunk_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_trunk_group_list_builder_api.ConfigurationPolicyTrunkGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id37(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyTrunkGroupListBuilderApi->preview_policy_list_by_id37: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyURLBlackListBuilderApi.md b/docs/ConfigurationPolicyURLBlackListBuilderApi.md new file mode 100644 index 0000000..2a03817 --- /dev/null +++ b/docs/ConfigurationPolicyURLBlackListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyURLBlackListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list39**](ConfigurationPolicyURLBlackListBuilderApi.md#create_policy_list39) | **POST** /template/policy/list/urlblacklist | +[**delete_policy_list39**](ConfigurationPolicyURLBlackListBuilderApi.md#delete_policy_list39) | **DELETE** /template/policy/list/urlblacklist/{id} | +[**delete_policy_lists_with_info_tag39**](ConfigurationPolicyURLBlackListBuilderApi.md#delete_policy_lists_with_info_tag39) | **DELETE** /template/policy/list/urlblacklist | +[**edit_policy_list39**](ConfigurationPolicyURLBlackListBuilderApi.md#edit_policy_list39) | **PUT** /template/policy/list/urlblacklist/{id} | +[**get_lists_by_id39**](ConfigurationPolicyURLBlackListBuilderApi.md#get_lists_by_id39) | **GET** /template/policy/list/urlblacklist/{id} | +[**get_policy_lists36**](ConfigurationPolicyURLBlackListBuilderApi.md#get_policy_lists36) | **GET** /template/policy/list/urlblacklist | +[**get_policy_lists_with_info_tag39**](ConfigurationPolicyURLBlackListBuilderApi.md#get_policy_lists_with_info_tag39) | **GET** /template/policy/list/urlblacklist/filtered | +[**preview_policy_list39**](ConfigurationPolicyURLBlackListBuilderApi.md#preview_policy_list39) | **POST** /template/policy/list/urlblacklist/preview | +[**preview_policy_list_by_id39**](ConfigurationPolicyURLBlackListBuilderApi.md#preview_policy_list_by_id39) | **GET** /template/policy/list/urlblacklist/preview/{id} | + + +# **create_policy_list39** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list39() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list39(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->create_policy_list39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list39** +> delete_policy_list39(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list39(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->delete_policy_list39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag39** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag39() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag39(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->delete_policy_lists_with_info_tag39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list39** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list39(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list39(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->edit_policy_list39: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list39(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->edit_policy_list39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id39** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id39(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id39(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->get_lists_by_id39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists36** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists36() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists36() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->get_policy_lists36: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag39** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag39() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag39(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->get_policy_lists_with_info_tag39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list39** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list39() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list39(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->preview_policy_list39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id39** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id39(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_black_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_black_list_builder_api.ConfigurationPolicyURLBlackListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id39(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLBlackListBuilderApi->preview_policy_list_by_id39: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md b/docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md new file mode 100644 index 0000000..c154cab --- /dev/null +++ b/docs/ConfigurationPolicyURLFilteringDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyURLFilteringDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#create_policy_definition23) | **POST** /template/policy/definition/urlfiltering | +[**delete_policy_definition23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#delete_policy_definition23) | **DELETE** /template/policy/definition/urlfiltering/{id} | +[**edit_multiple_policy_definition23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#edit_multiple_policy_definition23) | **PUT** /template/policy/definition/urlfiltering/multiple/{id} | +[**edit_policy_definition23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#edit_policy_definition23) | **PUT** /template/policy/definition/urlfiltering/{id} | +[**get_definitions23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#get_definitions23) | **GET** /template/policy/definition/urlfiltering | +[**get_policy_definition23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#get_policy_definition23) | **GET** /template/policy/definition/urlfiltering/{id} | +[**preview_policy_definition23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#preview_policy_definition23) | **POST** /template/policy/definition/urlfiltering/preview | +[**preview_policy_definition_by_id23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#preview_policy_definition_by_id23) | **GET** /template/policy/definition/urlfiltering/preview/{id} | +[**save_policy_definition_in_bulk23**](ConfigurationPolicyURLFilteringDefinitionBuilderApi.md#save_policy_definition_in_bulk23) | **PUT** /template/policy/definition/urlfiltering/bulk | + + +# **create_policy_definition23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition23() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->create_policy_definition23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition23** +> delete_policy_definition23(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition23(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->delete_policy_definition23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition23(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->edit_multiple_policy_definition23: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition23(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->edit_multiple_policy_definition23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition23(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->edit_policy_definition23: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition23(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->edit_policy_definition23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions23() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions23() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->get_definitions23: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition23(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->get_policy_definition23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition23() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->preview_policy_definition23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id23(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id23(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->preview_policy_definition_by_id23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk23() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_filtering_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_filtering_definition_builder_api.ConfigurationPolicyURLFilteringDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLFilteringDefinitionBuilderApi->save_policy_definition_in_bulk23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyURLWhiteListBuilderApi.md b/docs/ConfigurationPolicyURLWhiteListBuilderApi.md new file mode 100644 index 0000000..cee69a0 --- /dev/null +++ b/docs/ConfigurationPolicyURLWhiteListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyURLWhiteListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list40**](ConfigurationPolicyURLWhiteListBuilderApi.md#create_policy_list40) | **POST** /template/policy/list/urlwhitelist | +[**delete_policy_list40**](ConfigurationPolicyURLWhiteListBuilderApi.md#delete_policy_list40) | **DELETE** /template/policy/list/urlwhitelist/{id} | +[**delete_policy_lists_with_info_tag40**](ConfigurationPolicyURLWhiteListBuilderApi.md#delete_policy_lists_with_info_tag40) | **DELETE** /template/policy/list/urlwhitelist | +[**edit_policy_list40**](ConfigurationPolicyURLWhiteListBuilderApi.md#edit_policy_list40) | **PUT** /template/policy/list/urlwhitelist/{id} | +[**get_lists_by_id40**](ConfigurationPolicyURLWhiteListBuilderApi.md#get_lists_by_id40) | **GET** /template/policy/list/urlwhitelist/{id} | +[**get_policy_lists37**](ConfigurationPolicyURLWhiteListBuilderApi.md#get_policy_lists37) | **GET** /template/policy/list/urlwhitelist | +[**get_policy_lists_with_info_tag40**](ConfigurationPolicyURLWhiteListBuilderApi.md#get_policy_lists_with_info_tag40) | **GET** /template/policy/list/urlwhitelist/filtered | +[**preview_policy_list40**](ConfigurationPolicyURLWhiteListBuilderApi.md#preview_policy_list40) | **POST** /template/policy/list/urlwhitelist/preview | +[**preview_policy_list_by_id40**](ConfigurationPolicyURLWhiteListBuilderApi.md#preview_policy_list_by_id40) | **GET** /template/policy/list/urlwhitelist/preview/{id} | + + +# **create_policy_list40** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list40() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list40(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->create_policy_list40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list40** +> delete_policy_list40(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list40(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->delete_policy_list40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag40** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag40() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag40(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->delete_policy_lists_with_info_tag40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list40** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list40(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list40(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->edit_policy_list40: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list40(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->edit_policy_list40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id40** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id40(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id40(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->get_lists_by_id40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists37** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists37() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists37() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->get_policy_lists37: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag40** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag40() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag40(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->get_policy_lists_with_info_tag40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list40** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list40() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list40(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->preview_policy_list40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id40** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id40(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_url_white_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_url_white_list_builder_api.ConfigurationPolicyURLWhiteListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id40(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyURLWhiteListBuilderApi->preview_policy_list_by_id40: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md b/docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md new file mode 100644 index 0000000..c44ee4a --- /dev/null +++ b/docs/ConfigurationPolicyUmbrellaDataListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyUmbrellaDataListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#create_policy_list38) | **POST** /template/policy/list/umbrelladata | +[**delete_policy_list38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#delete_policy_list38) | **DELETE** /template/policy/list/umbrelladata/{id} | +[**delete_policy_lists_with_info_tag38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#delete_policy_lists_with_info_tag38) | **DELETE** /template/policy/list/umbrelladata | +[**edit_policy_list38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#edit_policy_list38) | **PUT** /template/policy/list/umbrelladata/{id} | +[**get_lists_by_id38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#get_lists_by_id38) | **GET** /template/policy/list/umbrelladata/{id} | +[**get_policy_lists35**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#get_policy_lists35) | **GET** /template/policy/list/umbrelladata | +[**get_policy_lists_with_info_tag38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#get_policy_lists_with_info_tag38) | **GET** /template/policy/list/umbrelladata/filtered | +[**preview_policy_list38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#preview_policy_list38) | **POST** /template/policy/list/umbrelladata/preview | +[**preview_policy_list_by_id38**](ConfigurationPolicyUmbrellaDataListBuilderApi.md#preview_policy_list_by_id38) | **GET** /template/policy/list/umbrelladata/preview/{id} | + + +# **create_policy_list38** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list38() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list38(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->create_policy_list38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list38** +> delete_policy_list38(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list38(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->delete_policy_list38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag38** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag38() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag38(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->delete_policy_lists_with_info_tag38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list38** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list38(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list38(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->edit_policy_list38: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list38(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->edit_policy_list38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id38** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id38(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id38(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->get_lists_by_id38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists35** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists35() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists35() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->get_policy_lists35: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag38** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag38() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag38(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->get_policy_lists_with_info_tag38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list38** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list38() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list38(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->preview_policy_list38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id38** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id38(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_umbrella_data_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_umbrella_data_list_builder_api.ConfigurationPolicyUmbrellaDataListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id38(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyUmbrellaDataListBuilderApi->preview_policy_list_by_id38: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVEdgeAssemblerApi.md b/docs/ConfigurationPolicyVEdgeAssemblerApi.md new file mode 100644 index 0000000..c69215e --- /dev/null +++ b/docs/ConfigurationPolicyVEdgeAssemblerApi.md @@ -0,0 +1,147 @@ +# openapi_client.ConfigurationPolicyVEdgeAssemblerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**preview1**](ConfigurationPolicyVEdgeAssemblerApi.md#preview1) | **POST** /template/policy/assembly/vedge | +[**preview_by_id1**](ConfigurationPolicyVEdgeAssemblerApi.md#preview_by_id1) | **GET** /template/policy/assembly/vedge/{id} | + + +# **preview1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview1() + + + +Get policy assembly preview + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_assembler_api.ConfigurationPolicyVEdgeAssemblerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy assembly (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeAssemblerApi->preview1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy assembly | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_by_id1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_by_id1(id) + + + +Get policy assembly preview for feature policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_assembler_api.ConfigurationPolicyVEdgeAssemblerApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_by_id1(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeAssemblerApi->preview_by_id1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md b/docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md new file mode 100644 index 0000000..2aaaf2e --- /dev/null +++ b/docs/ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#create_policy_definition24) | **POST** /template/policy/definition/vedgeroute | +[**delete_policy_definition24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#delete_policy_definition24) | **DELETE** /template/policy/definition/vedgeroute/{id} | +[**edit_multiple_policy_definition24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#edit_multiple_policy_definition24) | **PUT** /template/policy/definition/vedgeroute/multiple/{id} | +[**edit_policy_definition24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#edit_policy_definition24) | **PUT** /template/policy/definition/vedgeroute/{id} | +[**get_definitions24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#get_definitions24) | **GET** /template/policy/definition/vedgeroute | +[**get_policy_definition24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#get_policy_definition24) | **GET** /template/policy/definition/vedgeroute/{id} | +[**preview_policy_definition24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#preview_policy_definition24) | **POST** /template/policy/definition/vedgeroute/preview | +[**preview_policy_definition_by_id24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#preview_policy_definition_by_id24) | **GET** /template/policy/definition/vedgeroute/preview/{id} | +[**save_policy_definition_in_bulk24**](ConfigurationPolicyVEdgeRouteDefinitionBuilderApi.md#save_policy_definition_in_bulk24) | **PUT** /template/policy/definition/vedgeroute/bulk | + + +# **create_policy_definition24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition24() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->create_policy_definition24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition24** +> delete_policy_definition24(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition24(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->delete_policy_definition24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition24(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->edit_multiple_policy_definition24: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition24(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->edit_multiple_policy_definition24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition24(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->edit_policy_definition24: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition24(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->edit_policy_definition24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions24() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions24() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->get_definitions24: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition24(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->get_policy_definition24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition24() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->preview_policy_definition24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id24(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id24(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->preview_policy_definition_by_id24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk24() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_edge_route_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_edge_route_definition_builder_api.ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVEdgeRouteDefinitionBuilderApi->save_policy_definition_in_bulk24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVPNListBuilderApi.md b/docs/ConfigurationPolicyVPNListBuilderApi.md new file mode 100644 index 0000000..d71116c --- /dev/null +++ b/docs/ConfigurationPolicyVPNListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyVPNListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list41**](ConfigurationPolicyVPNListBuilderApi.md#create_policy_list41) | **POST** /template/policy/list/vpn | +[**delete_policy_list41**](ConfigurationPolicyVPNListBuilderApi.md#delete_policy_list41) | **DELETE** /template/policy/list/vpn/{id} | +[**delete_policy_lists_with_info_tag41**](ConfigurationPolicyVPNListBuilderApi.md#delete_policy_lists_with_info_tag41) | **DELETE** /template/policy/list/vpn | +[**edit_policy_list41**](ConfigurationPolicyVPNListBuilderApi.md#edit_policy_list41) | **PUT** /template/policy/list/vpn/{id} | +[**get_lists_by_id41**](ConfigurationPolicyVPNListBuilderApi.md#get_lists_by_id41) | **GET** /template/policy/list/vpn/{id} | +[**get_policy_lists38**](ConfigurationPolicyVPNListBuilderApi.md#get_policy_lists38) | **GET** /template/policy/list/vpn | +[**get_policy_lists_with_info_tag41**](ConfigurationPolicyVPNListBuilderApi.md#get_policy_lists_with_info_tag41) | **GET** /template/policy/list/vpn/filtered | +[**preview_policy_list41**](ConfigurationPolicyVPNListBuilderApi.md#preview_policy_list41) | **POST** /template/policy/list/vpn/preview | +[**preview_policy_list_by_id41**](ConfigurationPolicyVPNListBuilderApi.md#preview_policy_list_by_id41) | **GET** /template/policy/list/vpn/preview/{id} | + + +# **create_policy_list41** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list41() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list41(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->create_policy_list41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list41** +> delete_policy_list41(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list41(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->delete_policy_list41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag41** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag41() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag41(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->delete_policy_lists_with_info_tag41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list41** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list41(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list41(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->edit_policy_list41: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list41(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->edit_policy_list41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id41** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id41(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id41(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->get_lists_by_id41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists38** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists38() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists38() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->get_policy_lists38: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag41** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag41() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag41(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->get_policy_lists_with_info_tag41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list41** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list41() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list41(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->preview_policy_list41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id41** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id41(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_list_builder_api.ConfigurationPolicyVPNListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id41(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNListBuilderApi->preview_policy_list_by_id41: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md b/docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md new file mode 100644 index 0000000..d941e73 --- /dev/null +++ b/docs/ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#create_policy_definition6) | **POST** /template/policy/definition/vpnmembershipgroup | +[**delete_policy_definition6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#delete_policy_definition6) | **DELETE** /template/policy/definition/vpnmembershipgroup/{id} | +[**edit_multiple_policy_definition6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#edit_multiple_policy_definition6) | **PUT** /template/policy/definition/vpnmembershipgroup/multiple/{id} | +[**edit_policy_definition6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#edit_policy_definition6) | **PUT** /template/policy/definition/vpnmembershipgroup/{id} | +[**get_definitions6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#get_definitions6) | **GET** /template/policy/definition/vpnmembershipgroup | +[**get_policy_definition6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#get_policy_definition6) | **GET** /template/policy/definition/vpnmembershipgroup/{id} | +[**preview_policy_definition6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#preview_policy_definition6) | **POST** /template/policy/definition/vpnmembershipgroup/preview | +[**preview_policy_definition_by_id6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#preview_policy_definition_by_id6) | **GET** /template/policy/definition/vpnmembershipgroup/preview/{id} | +[**save_policy_definition_in_bulk6**](ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md#save_policy_definition_in_bulk6) | **PUT** /template/policy/definition/vpnmembershipgroup/bulk | + + +# **create_policy_definition6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition6() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->create_policy_definition6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition6** +> delete_policy_definition6(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition6(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->delete_policy_definition6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition6(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_multiple_policy_definition6: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition6(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_multiple_policy_definition6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition6(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_policy_definition6: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition6(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_policy_definition6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions6() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions6() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->get_definitions6: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition6(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->get_policy_definition6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition6() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->preview_policy_definition6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id6(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id6(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->preview_policy_definition_by_id6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk6() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->save_policy_definition_in_bulk6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md b/docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md new file mode 100644 index 0000000..72b086c --- /dev/null +++ b/docs/ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyVPNQosMapDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#create_policy_definition2) | **POST** /template/policy/definition/vpnqosmap | +[**delete_policy_definition2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#delete_policy_definition2) | **DELETE** /template/policy/definition/vpnqosmap/{id} | +[**edit_multiple_policy_definition2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#edit_multiple_policy_definition2) | **PUT** /template/policy/definition/vpnqosmap/multiple/{id} | +[**edit_policy_definition2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#edit_policy_definition2) | **PUT** /template/policy/definition/vpnqosmap/{id} | +[**get_definitions2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#get_definitions2) | **GET** /template/policy/definition/vpnqosmap | +[**get_policy_definition2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#get_policy_definition2) | **GET** /template/policy/definition/vpnqosmap/{id} | +[**preview_policy_definition2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#preview_policy_definition2) | **POST** /template/policy/definition/vpnqosmap/preview | +[**preview_policy_definition_by_id2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#preview_policy_definition_by_id2) | **GET** /template/policy/definition/vpnqosmap/preview/{id} | +[**save_policy_definition_in_bulk2**](ConfigurationPolicyVPNQosMapDefinitionBuilderApi.md#save_policy_definition_in_bulk2) | **PUT** /template/policy/definition/vpnqosmap/bulk | + + +# **create_policy_definition2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition2() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->create_policy_definition2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition2** +> delete_policy_definition2(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition2(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->delete_policy_definition2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition2(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->edit_multiple_policy_definition2: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition2(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->edit_multiple_policy_definition2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition2(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->edit_policy_definition2: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition2(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->edit_policy_definition2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions2() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions2() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->get_definitions2: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition2(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->get_policy_definition2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition2() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->preview_policy_definition2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id2(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->preview_policy_definition_by_id2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk2() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_vpn_qos_map_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_vpn_qos_map_definition_builder_api.ConfigurationPolicyVPNQosMapDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVPNQosMapDefinitionBuilderApi->save_policy_definition_in_bulk2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVSmartAssemblerApi.md b/docs/ConfigurationPolicyVSmartAssemblerApi.md new file mode 100644 index 0000000..4dd66c6 --- /dev/null +++ b/docs/ConfigurationPolicyVSmartAssemblerApi.md @@ -0,0 +1,147 @@ +# openapi_client.ConfigurationPolicyVSmartAssemblerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**preview3**](ConfigurationPolicyVSmartAssemblerApi.md#preview3) | **POST** /template/policy/assembly/vsmart | +[**preview_by_id3**](ConfigurationPolicyVSmartAssemblerApi.md#preview_by_id3) | **GET** /template/policy/assembly/vsmart/{id} | + + +# **preview3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview3() + + + +Get policy assembly preview + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_smart_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_smart_assembler_api.ConfigurationPolicyVSmartAssemblerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy assembly (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVSmartAssemblerApi->preview3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy assembly | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_by_id3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_by_id3(id) + + + +Get policy assembly preview for feature policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_v_smart_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_v_smart_assembler_api.ConfigurationPolicyVSmartAssemblerApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_by_id3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVSmartAssemblerApi->preview_by_id3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyVoiceAssemblerApi.md b/docs/ConfigurationPolicyVoiceAssemblerApi.md new file mode 100644 index 0000000..0ea7551 --- /dev/null +++ b/docs/ConfigurationPolicyVoiceAssemblerApi.md @@ -0,0 +1,147 @@ +# openapi_client.ConfigurationPolicyVoiceAssemblerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**preview2**](ConfigurationPolicyVoiceAssemblerApi.md#preview2) | **POST** /template/policy/assembly/voice | +[**preview_by_id2**](ConfigurationPolicyVoiceAssemblerApi.md#preview_by_id2) | **GET** /template/policy/assembly/voice/{id} | + + +# **preview2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview2() + + + +Get policy assembly preview + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_voice_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_voice_assembler_api.ConfigurationPolicyVoiceAssemblerApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy assembly (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVoiceAssemblerApi->preview2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy assembly | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_by_id2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_by_id2(id) + + + +Get policy assembly preview for feature policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_voice_assembler_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_voice_assembler_api.ConfigurationPolicyVoiceAssemblerApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_by_id2(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyVoiceAssemblerApi->preview_by_id2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md b/docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md new file mode 100644 index 0000000..a8018b3 --- /dev/null +++ b/docs/ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#create_policy_definition7) | **POST** /template/policy/definition/zonebasedfw | +[**delete_policy_definition7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#delete_policy_definition7) | **DELETE** /template/policy/definition/zonebasedfw/{id} | +[**edit_multiple_policy_definition7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#edit_multiple_policy_definition7) | **PUT** /template/policy/definition/zonebasedfw/multiple/{id} | +[**edit_policy_definition7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#edit_policy_definition7) | **PUT** /template/policy/definition/zonebasedfw/{id} | +[**get_definitions7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#get_definitions7) | **GET** /template/policy/definition/zonebasedfw | +[**get_policy_definition7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#get_policy_definition7) | **GET** /template/policy/definition/zonebasedfw/{id} | +[**preview_policy_definition7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#preview_policy_definition7) | **POST** /template/policy/definition/zonebasedfw/preview | +[**preview_policy_definition_by_id7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#preview_policy_definition_by_id7) | **GET** /template/policy/definition/zonebasedfw/preview/{id} | +[**save_policy_definition_in_bulk7**](ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi.md#save_policy_definition_in_bulk7) | **PUT** /template/policy/definition/zonebasedfw/bulk | + + +# **create_policy_definition7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition7() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->create_policy_definition7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition7** +> delete_policy_definition7(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition7(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->delete_policy_definition7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition7(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->edit_multiple_policy_definition7: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition7(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->edit_multiple_policy_definition7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition7(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->edit_policy_definition7: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition7(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->edit_policy_definition7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions7() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions7() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->get_definitions7: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition7(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->get_policy_definition7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition7() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->preview_policy_definition7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id7(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id7(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->preview_policy_definition_by_id7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk7() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_based_firewall_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_based_firewall_definition_builder_api.ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi->save_policy_definition_in_bulk7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPolicyZoneListBuilderApi.md b/docs/ConfigurationPolicyZoneListBuilderApi.md new file mode 100644 index 0000000..022b683 --- /dev/null +++ b/docs/ConfigurationPolicyZoneListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPolicyZoneListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list42**](ConfigurationPolicyZoneListBuilderApi.md#create_policy_list42) | **POST** /template/policy/list/zone | +[**delete_policy_list42**](ConfigurationPolicyZoneListBuilderApi.md#delete_policy_list42) | **DELETE** /template/policy/list/zone/{id} | +[**delete_policy_lists_with_info_tag42**](ConfigurationPolicyZoneListBuilderApi.md#delete_policy_lists_with_info_tag42) | **DELETE** /template/policy/list/zone | +[**edit_policy_list42**](ConfigurationPolicyZoneListBuilderApi.md#edit_policy_list42) | **PUT** /template/policy/list/zone/{id} | +[**get_lists_by_id42**](ConfigurationPolicyZoneListBuilderApi.md#get_lists_by_id42) | **GET** /template/policy/list/zone/{id} | +[**get_policy_lists39**](ConfigurationPolicyZoneListBuilderApi.md#get_policy_lists39) | **GET** /template/policy/list/zone | +[**get_policy_lists_with_info_tag42**](ConfigurationPolicyZoneListBuilderApi.md#get_policy_lists_with_info_tag42) | **GET** /template/policy/list/zone/filtered | +[**preview_policy_list42**](ConfigurationPolicyZoneListBuilderApi.md#preview_policy_list42) | **POST** /template/policy/list/zone/preview | +[**preview_policy_list_by_id42**](ConfigurationPolicyZoneListBuilderApi.md#preview_policy_list_by_id42) | **GET** /template/policy/list/zone/preview/{id} | + + +# **create_policy_list42** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list42() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list42(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->create_policy_list42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list42** +> delete_policy_list42(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list42(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->delete_policy_list42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag42** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag42() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag42(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->delete_policy_lists_with_info_tag42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list42** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list42(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list42(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->edit_policy_list42: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list42(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->edit_policy_list42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id42** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id42(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id42(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->get_lists_by_id42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists39** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists39() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists39() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->get_policy_lists39: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag42** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag42() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag42(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->get_policy_lists_with_info_tag42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list42** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list42() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list42(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->preview_policy_list42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id42** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id42(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_policy_zone_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_policy_zone_list_builder_api.ConfigurationPolicyZoneListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id42(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPolicyZoneListBuilderApi->preview_policy_list_by_id42: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPreUpgradeCheckStatusApi.md b/docs/ConfigurationPreUpgradeCheckStatusApi.md new file mode 100644 index 0000000..fd8c4d2 --- /dev/null +++ b/docs/ConfigurationPreUpgradeCheckStatusApi.md @@ -0,0 +1,82 @@ +# openapi_client.ConfigurationPreUpgradeCheckStatusApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**update_pre_upgrade_check_status**](ConfigurationPreUpgradeCheckStatusApi.md#update_pre_upgrade_check_status) | **PUT** /device/action/status/preupgrade/check | + + +# **update_pre_upgrade_check_status** +> update_pre_upgrade_check_status() + + + +Update pre upgrade check status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_pre_upgrade_check_status_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_pre_upgrade_check_status_api.ConfigurationPreUpgradeCheckStatusApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_pre_upgrade_check_status(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreUpgradeCheckStatusApi->update_pre_upgrade_check_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationPreferredColorGroupListBuilderApi.md b/docs/ConfigurationPreferredColorGroupListBuilderApi.md new file mode 100644 index 0000000..beb5a1d --- /dev/null +++ b/docs/ConfigurationPreferredColorGroupListBuilderApi.md @@ -0,0 +1,638 @@ +# openapi_client.ConfigurationPreferredColorGroupListBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_list28**](ConfigurationPreferredColorGroupListBuilderApi.md#create_policy_list28) | **POST** /template/policy/list/preferredcolorgroup | +[**delete_policy_list28**](ConfigurationPreferredColorGroupListBuilderApi.md#delete_policy_list28) | **DELETE** /template/policy/list/preferredcolorgroup/{id} | +[**delete_policy_lists_with_info_tag28**](ConfigurationPreferredColorGroupListBuilderApi.md#delete_policy_lists_with_info_tag28) | **DELETE** /template/policy/list/preferredcolorgroup | +[**edit_policy_list28**](ConfigurationPreferredColorGroupListBuilderApi.md#edit_policy_list28) | **PUT** /template/policy/list/preferredcolorgroup/{id} | +[**get_lists_by_id28**](ConfigurationPreferredColorGroupListBuilderApi.md#get_lists_by_id28) | **GET** /template/policy/list/preferredcolorgroup/{id} | +[**get_policy_lists25**](ConfigurationPreferredColorGroupListBuilderApi.md#get_policy_lists25) | **GET** /template/policy/list/preferredcolorgroup | +[**get_policy_lists_with_info_tag28**](ConfigurationPreferredColorGroupListBuilderApi.md#get_policy_lists_with_info_tag28) | **GET** /template/policy/list/preferredcolorgroup/filtered | +[**preview_policy_list28**](ConfigurationPreferredColorGroupListBuilderApi.md#preview_policy_list28) | **POST** /template/policy/list/preferredcolorgroup/preview | +[**preview_policy_list_by_id28**](ConfigurationPreferredColorGroupListBuilderApi.md#preview_policy_list_by_id28) | **GET** /template/policy/list/preferredcolorgroup/preview/{id} | + + +# **create_policy_list28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list28() + + + +Create policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_list28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->create_policy_list28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_list28** +> delete_policy_list28(id) + + + +Delete policy list entry for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_list28(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->delete_policy_list28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_lists_with_info_tag28** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag28() + + + +Delete policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_policy_lists_with_info_tag28(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->delete_policy_lists_with_info_tag28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_list28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list28(id) + + + +Edit policy list entries for a specific type of policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_list28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->edit_policy_list28: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_list28(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->edit_policy_list28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_lists_by_id28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id28(id) + + + +Get a specific policy list based on the id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_lists_by_id28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->get_lists_by_id28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists25** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists25() + + + +Get policy lists + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_policy_lists25() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->get_policy_lists25: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_lists_with_info_tag28** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag28() + + + +Get policy lists with specific info tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + info_tag = "infoTag_example" # str | InfoTag (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_policy_lists_with_info_tag28(info_tag=info_tag) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->get_policy_lists_with_info_tag28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **info_tag** | **str**| InfoTag | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list28() + + + +Preview a policy list based on the policy list type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_list28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->preview_policy_list28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_list_by_id28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id28(id) + + + +Preview a specific policy list entry based on id provided + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_preferred_color_group_list_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_preferred_color_group_list_builder_api.ConfigurationPreferredColorGroupListBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_list_by_id28(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationPreferredColorGroupListBuilderApi->preview_policy_list_by_id28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationQuickConnectApi.md b/docs/ConfigurationQuickConnectApi.md new file mode 100644 index 0000000..3ff1a7c --- /dev/null +++ b/docs/ConfigurationQuickConnectApi.md @@ -0,0 +1,83 @@ +# openapi_client.ConfigurationQuickConnectApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**submit_day0_config**](ConfigurationQuickConnectApi.md#submit_day0_config) | **POST** /template/config/quickConnect/submitDevices | + + +# **submit_day0_config** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] submit_day0_config() + + + +Creates and pushes bootstrap configurations onto day0 devices. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_quick_connect_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_quick_connect_api.ConfigurationQuickConnectApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.submit_day0_config(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationQuickConnectApi->submit_day0_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationRuleSetDefinitionApi.md b/docs/ConfigurationRuleSetDefinitionApi.md new file mode 100644 index 0000000..90a9099 --- /dev/null +++ b/docs/ConfigurationRuleSetDefinitionApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationRuleSetDefinitionApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition20**](ConfigurationRuleSetDefinitionApi.md#create_policy_definition20) | **POST** /template/policy/definition/ruleset | +[**delete_policy_definition20**](ConfigurationRuleSetDefinitionApi.md#delete_policy_definition20) | **DELETE** /template/policy/definition/ruleset/{id} | +[**edit_multiple_policy_definition20**](ConfigurationRuleSetDefinitionApi.md#edit_multiple_policy_definition20) | **PUT** /template/policy/definition/ruleset/multiple/{id} | +[**edit_policy_definition20**](ConfigurationRuleSetDefinitionApi.md#edit_policy_definition20) | **PUT** /template/policy/definition/ruleset/{id} | +[**get_definitions20**](ConfigurationRuleSetDefinitionApi.md#get_definitions20) | **GET** /template/policy/definition/ruleset | +[**get_policy_definition20**](ConfigurationRuleSetDefinitionApi.md#get_policy_definition20) | **GET** /template/policy/definition/ruleset/{id} | +[**preview_policy_definition20**](ConfigurationRuleSetDefinitionApi.md#preview_policy_definition20) | **POST** /template/policy/definition/ruleset/preview | +[**preview_policy_definition_by_id20**](ConfigurationRuleSetDefinitionApi.md#preview_policy_definition_by_id20) | **GET** /template/policy/definition/ruleset/preview/{id} | +[**save_policy_definition_in_bulk20**](ConfigurationRuleSetDefinitionApi.md#save_policy_definition_in_bulk20) | **PUT** /template/policy/definition/ruleset/bulk | + + +# **create_policy_definition20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition20() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->create_policy_definition20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition20** +> delete_policy_definition20(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition20(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->delete_policy_definition20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition20(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->edit_multiple_policy_definition20: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition20(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->edit_multiple_policy_definition20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition20(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->edit_policy_definition20: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition20(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->edit_policy_definition20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions20() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions20() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->get_definitions20: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition20(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->get_policy_definition20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition20() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->preview_policy_definition20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id20(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id20(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->preview_policy_definition_by_id20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk20() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_rule_set_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_rule_set_definition_api.ConfigurationRuleSetDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationRuleSetDefinitionApi->save_policy_definition_in_bulk20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md b/docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md new file mode 100644 index 0000000..7aa2665 --- /dev/null +++ b/docs/ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#create_policy_definition3) | **POST** /template/policy/definition/ssldecryption | +[**delete_policy_definition3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#delete_policy_definition3) | **DELETE** /template/policy/definition/ssldecryption/{id} | +[**edit_multiple_policy_definition3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#edit_multiple_policy_definition3) | **PUT** /template/policy/definition/ssldecryption/multiple/{id} | +[**edit_policy_definition3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#edit_policy_definition3) | **PUT** /template/policy/definition/ssldecryption/{id} | +[**get_definitions3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#get_definitions3) | **GET** /template/policy/definition/ssldecryption | +[**get_policy_definition3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#get_policy_definition3) | **GET** /template/policy/definition/ssldecryption/{id} | +[**preview_policy_definition3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#preview_policy_definition3) | **POST** /template/policy/definition/ssldecryption/preview | +[**preview_policy_definition_by_id3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#preview_policy_definition_by_id3) | **GET** /template/policy/definition/ssldecryption/preview/{id} | +[**save_policy_definition_in_bulk3**](ConfigurationSSLDecryptionPolicyDefinitionBuilderApi.md#save_policy_definition_in_bulk3) | **PUT** /template/policy/definition/ssldecryption/bulk | + + +# **create_policy_definition3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition3() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->create_policy_definition3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition3** +> delete_policy_definition3(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition3(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->delete_policy_definition3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition3(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->edit_multiple_policy_definition3: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition3(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->edit_multiple_policy_definition3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition3(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->edit_policy_definition3: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition3(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->edit_policy_definition3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions3() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions3() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->get_definitions3: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition3(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->get_policy_definition3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition3() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->preview_policy_definition3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id3(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id3(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->preview_policy_definition_by_id3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk3() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_policy_definition_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_policy_definition_builder_api.ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionPolicyDefinitionBuilderApi->save_policy_definition_in_bulk3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md b/docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md new file mode 100644 index 0000000..18a9454 --- /dev/null +++ b/docs/ConfigurationSSLDecryptionUTDProfileDefinitionApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationSSLDecryptionUTDProfileDefinitionApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#create_policy_definition22) | **POST** /template/policy/definition/sslutdprofile | +[**delete_policy_definition22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#delete_policy_definition22) | **DELETE** /template/policy/definition/sslutdprofile/{id} | +[**edit_multiple_policy_definition22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#edit_multiple_policy_definition22) | **PUT** /template/policy/definition/sslutdprofile/multiple/{id} | +[**edit_policy_definition22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#edit_policy_definition22) | **PUT** /template/policy/definition/sslutdprofile/{id} | +[**get_definitions22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#get_definitions22) | **GET** /template/policy/definition/sslutdprofile | +[**get_policy_definition22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#get_policy_definition22) | **GET** /template/policy/definition/sslutdprofile/{id} | +[**preview_policy_definition22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#preview_policy_definition22) | **POST** /template/policy/definition/sslutdprofile/preview | +[**preview_policy_definition_by_id22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#preview_policy_definition_by_id22) | **GET** /template/policy/definition/sslutdprofile/preview/{id} | +[**save_policy_definition_in_bulk22**](ConfigurationSSLDecryptionUTDProfileDefinitionApi.md#save_policy_definition_in_bulk22) | **PUT** /template/policy/definition/sslutdprofile/bulk | + + +# **create_policy_definition22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition22() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->create_policy_definition22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition22** +> delete_policy_definition22(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition22(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->delete_policy_definition22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition22(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->edit_multiple_policy_definition22: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition22(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->edit_multiple_policy_definition22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition22(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->edit_policy_definition22: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition22(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->edit_policy_definition22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions22() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions22() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->get_definitions22: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition22(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->get_policy_definition22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition22() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->preview_policy_definition22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id22(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id22(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->preview_policy_definition_by_id22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk22() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_ssl_decryption_utd_profile_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_ssl_decryption_utd_profile_definition_api.ConfigurationSSLDecryptionUTDProfileDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSSLDecryptionUTDProfileDefinitionApi->save_policy_definition_in_bulk22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSecureInternetGatewayTunnelsApi.md b/docs/ConfigurationSecureInternetGatewayTunnelsApi.md new file mode 100644 index 0000000..9545605 --- /dev/null +++ b/docs/ConfigurationSecureInternetGatewayTunnelsApi.md @@ -0,0 +1,76 @@ +# openapi_client.ConfigurationSecureInternetGatewayTunnelsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_sig_tunnel_list1**](ConfigurationSecureInternetGatewayTunnelsApi.md#get_sig_tunnel_list1) | **GET** /template/cloudx/sig_tunnels | + + +# **get_sig_tunnel_list1** +> get_sig_tunnel_list1(device_id) + + + +Get Secure Internet Gateway Tunnel List + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_secure_internet_gateway_tunnels_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_secure_internet_gateway_tunnels_api.ConfigurationSecureInternetGatewayTunnelsApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_instance.get_sig_tunnel_list1(device_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecureInternetGatewayTunnelsApi->get_sig_tunnel_list1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSecurityGroupDefinitionApi.md b/docs/ConfigurationSecurityGroupDefinitionApi.md new file mode 100644 index 0000000..6d8d8aa --- /dev/null +++ b/docs/ConfigurationSecurityGroupDefinitionApi.md @@ -0,0 +1,647 @@ +# openapi_client.ConfigurationSecurityGroupDefinitionApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_policy_definition21**](ConfigurationSecurityGroupDefinitionApi.md#create_policy_definition21) | **POST** /template/policy/definition/securitygroup | +[**delete_policy_definition21**](ConfigurationSecurityGroupDefinitionApi.md#delete_policy_definition21) | **DELETE** /template/policy/definition/securitygroup/{id} | +[**edit_multiple_policy_definition21**](ConfigurationSecurityGroupDefinitionApi.md#edit_multiple_policy_definition21) | **PUT** /template/policy/definition/securitygroup/multiple/{id} | +[**edit_policy_definition21**](ConfigurationSecurityGroupDefinitionApi.md#edit_policy_definition21) | **PUT** /template/policy/definition/securitygroup/{id} | +[**get_definitions21**](ConfigurationSecurityGroupDefinitionApi.md#get_definitions21) | **GET** /template/policy/definition/securitygroup | +[**get_policy_definition21**](ConfigurationSecurityGroupDefinitionApi.md#get_policy_definition21) | **GET** /template/policy/definition/securitygroup/{id} | +[**preview_policy_definition21**](ConfigurationSecurityGroupDefinitionApi.md#preview_policy_definition21) | **POST** /template/policy/definition/securitygroup/preview | +[**preview_policy_definition_by_id21**](ConfigurationSecurityGroupDefinitionApi.md#preview_policy_definition_by_id21) | **GET** /template/policy/definition/securitygroup/preview/{id} | +[**save_policy_definition_in_bulk21**](ConfigurationSecurityGroupDefinitionApi.md#save_policy_definition_in_bulk21) | **PUT** /template/policy/definition/securitygroup/bulk | + + +# **create_policy_definition21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition21() + + + +Create policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_policy_definition21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->create_policy_definition21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_policy_definition21** +> delete_policy_definition21(id) + + + +Delete policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_policy_definition21(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->delete_policy_definition21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_multiple_policy_definition21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition21(id) + + + +Edit multiple policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_multiple_policy_definition21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->edit_multiple_policy_definition21: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_multiple_policy_definition21(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->edit_multiple_policy_definition21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_policy_definition21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition21(id) + + + +Edit a policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + id = "id_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_policy_definition21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->edit_policy_definition21: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_policy_definition21(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->edit_policy_definition21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_definitions21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions21() + + + +Get policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_definitions21() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->get_definitions21: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_policy_definition21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition21(id) + + + +Get a specific policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policy_definition21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->get_policy_definition21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition21() + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.preview_policy_definition21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->preview_policy_definition21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_policy_definition_by_id21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id21(id) + + + +Preview policy definition + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + id = "id_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_policy_definition_by_id21(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->preview_policy_definition_by_id21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_policy_definition_in_bulk21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk21() + + + +Create/Edit policy definitions in bulk + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_group_definition_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_group_definition_api.ConfigurationSecurityGroupDefinitionApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.save_policy_definition_in_bulk21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityGroupDefinitionApi->save_policy_definition_in_bulk21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSecurityTemplatePolicyApi.md b/docs/ConfigurationSecurityTemplatePolicyApi.md new file mode 100644 index 0000000..b365620 --- /dev/null +++ b/docs/ConfigurationSecurityTemplatePolicyApi.md @@ -0,0 +1,713 @@ +# openapi_client.ConfigurationSecurityTemplatePolicyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_security_template**](ConfigurationSecurityTemplatePolicyApi.md#create_security_template) | **POST** /template/policy/security | +[**delete_security_template**](ConfigurationSecurityTemplatePolicyApi.md#delete_security_template) | **DELETE** /template/policy/security/{policyId} | +[**edit_security_template**](ConfigurationSecurityTemplatePolicyApi.md#edit_security_template) | **PUT** /template/policy/security/{policyId} | +[**edit_template_with_lenient_lock**](ConfigurationSecurityTemplatePolicyApi.md#edit_template_with_lenient_lock) | **PUT** /template/policy/security/staging/{policyId} | +[**generate_security_policy_summary**](ConfigurationSecurityTemplatePolicyApi.md#generate_security_policy_summary) | **GET** /template/policy/security/summary | +[**generate_security_template_list**](ConfigurationSecurityTemplatePolicyApi.md#generate_security_template_list) | **GET** /template/policy/security | +[**get_device_list_by_id**](ConfigurationSecurityTemplatePolicyApi.md#get_device_list_by_id) | **GET** /template/policy/security/devices/{policyId} | +[**get_security_policy_device_list**](ConfigurationSecurityTemplatePolicyApi.md#get_security_policy_device_list) | **GET** /template/policy/security/devices | +[**get_security_template**](ConfigurationSecurityTemplatePolicyApi.md#get_security_template) | **GET** /template/policy/security/definition/{policyId} | +[**get_security_templates_for_device**](ConfigurationSecurityTemplatePolicyApi.md#get_security_templates_for_device) | **GET** /template/policy/security/{deviceModel} | + + +# **create_security_template** +> create_security_template() + + + +Create Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_security_template(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->create_security_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy template | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_security_template** +> delete_security_template(policy_id) + + + +Delete Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_security_template(policy_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->delete_security_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_security_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_security_template(policy_id) + + + +Edit Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_security_template(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->edit_security_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_security_template(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->edit_security_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_template_with_lenient_lock** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_template_with_lenient_lock(policy_id) + + + +Edit Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_template_with_lenient_lock(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->edit_template_with_lenient_lock: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_template_with_lenient_lock(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->edit_template_with_lenient_lock: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_security_policy_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_security_policy_summary() + + + +Generate security policy summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_security_policy_summary() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->generate_security_policy_summary: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_security_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_security_template_list() + + + +Generate template list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + mode = "mode_example" # str | Mode (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_security_template_list(mode=mode) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->generate_security_template_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mode** | **str**| Mode | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_list_by_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_list_by_id(policy_id) + + + +Get device list by Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_list_by_id(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->get_device_list_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_security_policy_device_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_security_policy_device_list() + + + +Get device list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_security_policy_device_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->get_security_policy_device_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_security_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_security_template(policy_id) + + + +Get Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_security_template(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->get_security_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_security_templates_for_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_security_templates_for_device(device_model) + + + +Get templates that map a device model + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_security_template_policy_api +from openapi_client.model.device_model import DeviceModel +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_security_template_policy_api.ConfigurationSecurityTemplatePolicyApi(api_client) + device_model = DeviceModel( + device_model="device_model_example", + ) # DeviceModel | Device model + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_security_templates_for_device(device_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSecurityTemplatePolicyApi->get_security_templates_for_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_model** | **DeviceModel**| Device model | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSegmentsApi.md b/docs/ConfigurationSegmentsApi.md new file mode 100644 index 0000000..5beda90 --- /dev/null +++ b/docs/ConfigurationSegmentsApi.md @@ -0,0 +1,357 @@ +# openapi_client.ConfigurationSegmentsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_segment**](ConfigurationSegmentsApi.md#create_segment) | **POST** /segment | +[**delete_segment**](ConfigurationSegmentsApi.md#delete_segment) | **DELETE** /segment/{id} | +[**edit_segment**](ConfigurationSegmentsApi.md#edit_segment) | **PUT** /segment/{id} | +[**get_segment**](ConfigurationSegmentsApi.md#get_segment) | **GET** /segment/{id} | +[**get_segments**](ConfigurationSegmentsApi.md#get_segments) | **GET** /segment | + + +# **create_segment** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_segment() + + + +Create network segment + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_segments_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_segments_api.ConfigurationSegmentsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network segment (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_segment(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSegmentsApi->create_segment: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network segment | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_segment** +> delete_segment(id) + + + +Delete network segment + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_segments_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_segments_api.ConfigurationSegmentsApi(api_client) + id = "id_example" # str | Segment Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_segment(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSegmentsApi->delete_segment: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Segment Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_segment** +> edit_segment(id) + + + +Edit network segment + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_segments_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_segments_api.ConfigurationSegmentsApi(api_client) + id = "id_example" # str | Segment Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network segment (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_segment(id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSegmentsApi->edit_segment: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_segment(id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSegmentsApi->edit_segment: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Segment Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network segment | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_segment** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_segment(id) + + + +Get network segment + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_segments_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_segments_api.ConfigurationSegmentsApi(api_client) + id = "id_example" # str | Segment Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_segment(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSegmentsApi->get_segment: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Segment Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_segments** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_segments() + + + +Get network segments + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_segments_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_segments_api.ConfigurationSegmentsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_segments() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSegmentsApi->get_segments: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSettingsApi.md b/docs/ConfigurationSettingsApi.md new file mode 100644 index 0000000..2f2b381 --- /dev/null +++ b/docs/ConfigurationSettingsApi.md @@ -0,0 +1,852 @@ +# openapi_client.ConfigurationSettingsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_analytics_data_file**](ConfigurationSettingsApi.md#create_analytics_data_file) | **POST** /settings/configuration/analytics/dca | +[**edit_cert_configuration**](ConfigurationSettingsApi.md#edit_cert_configuration) | **PUT** /settings/configuration/certificate/{settingType} | +[**edit_configuration**](ConfigurationSettingsApi.md#edit_configuration) | **PUT** /settings/configuration/{settingType} | +[**get_banner**](ConfigurationSettingsApi.md#get_banner) | **GET** /settings/banner | +[**get_cert_configuration**](ConfigurationSettingsApi.md#get_cert_configuration) | **GET** /settings/configuration/certificate/{settingType} | +[**get_configuration_by_setting_type**](ConfigurationSettingsApi.md#get_configuration_by_setting_type) | **GET** /settings/configuration/{settingType} | +[**get_google_map_key**](ConfigurationSettingsApi.md#get_google_map_key) | **GET** /settings/configuration/googleMapKey | +[**get_maintenance_window**](ConfigurationSettingsApi.md#get_maintenance_window) | **GET** /settings/configuration/maintenanceWindow | +[**get_password_policy**](ConfigurationSettingsApi.md#get_password_policy) | **GET** /settings/passwordPolicy | +[**get_session_timout**](ConfigurationSettingsApi.md#get_session_timout) | **GET** /settings/clientSessionTimeout | +[**new_cert_configuration**](ConfigurationSettingsApi.md#new_cert_configuration) | **POST** /settings/configuration/certificate/{settingType} | +[**new_configuration**](ConfigurationSettingsApi.md#new_configuration) | **POST** /settings/configuration/{settingType} | + + +# **create_analytics_data_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_analytics_data_file() + + + +Create analytics data file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_analytics_data_file() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->create_analytics_data_file: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_cert_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_cert_configuration(setting_type) + + + +Update certificate configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + setting_type = "settingType_example" # str | Setting type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Certificate config (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_cert_configuration(setting_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->edit_cert_configuration: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_cert_configuration(setting_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->edit_cert_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setting_type** | **str**| Setting type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Certificate config | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_configuration(setting_type) + + + +Update configuration setting + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + setting_type = "settingType_example" # str | Setting type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Configuration setting (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_configuration(setting_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->edit_configuration: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_configuration(setting_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->edit_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setting_type** | **str**| Setting type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Configuration setting | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_banner** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_banner() + + + +Retrieve banner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_banner() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_banner: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cert_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cert_configuration(setting_type) + + + +Retrieve certificate configuration value by settingType + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + setting_type = "settingType_example" # str | Setting type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cert_configuration(setting_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_cert_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setting_type** | **str**| Setting type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_configuration_by_setting_type** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_configuration_by_setting_type(setting_type) + + + +Retrieve configuration value by settingType + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + setting_type = "settingType_example" # str | Setting type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_configuration_by_setting_type(setting_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_configuration_by_setting_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setting_type** | **str**| Setting type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_google_map_key** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_google_map_key() + + + +Retrieve Google map key + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_google_map_key() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_google_map_key: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_maintenance_window** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_maintenance_window() + + + +Retrieve maintenance window + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_maintenance_window() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_maintenance_window: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_password_policy** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_password_policy() + + + +Retrieve password policy from global settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_password_policy() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_password_policy: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_session_timout** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_session_timout() + + + +Get client session timeout + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_session_timout() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->get_session_timout: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **new_cert_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} new_cert_configuration(setting_type) + + + +Add new certificate configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + setting_type = "settingType_example" # str | Setting type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Certificate config (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.new_cert_configuration(setting_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->new_cert_configuration: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.new_cert_configuration(setting_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->new_cert_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setting_type** | **str**| Setting type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Certificate config | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **new_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} new_configuration(setting_type) + + + +Add new configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_settings_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_settings_api.ConfigurationSettingsApi(api_client) + setting_type = "settingType_example" # str | Setting type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Configuration setting (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.new_configuration(setting_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->new_configuration: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.new_configuration(setting_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSettingsApi->new_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setting_type** | **str**| Setting type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Configuration setting | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationSoftwareActionsApi.md b/docs/ConfigurationSoftwareActionsApi.md new file mode 100644 index 0000000..9f39167 --- /dev/null +++ b/docs/ConfigurationSoftwareActionsApi.md @@ -0,0 +1,1265 @@ +# openapi_client.ConfigurationSoftwareActionsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_remote_server**](ConfigurationSoftwareActionsApi.md#add_remote_server) | **POST** /device/action/remote-server | +[**create_image_url**](ConfigurationSoftwareActionsApi.md#create_image_url) | **POST** /device/action/software | +[**delete_image_url**](ConfigurationSoftwareActionsApi.md#delete_image_url) | **DELETE** /device/action/software/{versionId} | +[**delete_remote_server**](ConfigurationSoftwareActionsApi.md#delete_remote_server) | **DELETE** /device/action/remote-server/{id} | +[**edit_image_remote_server**](ConfigurationSoftwareActionsApi.md#edit_image_remote_server) | **PUT** /device/action/software/remoteserver/{versionId} | +[**find_software_images**](ConfigurationSoftwareActionsApi.md#find_software_images) | **GET** /device/action/software | +[**find_software_images_with_filters**](ConfigurationSoftwareActionsApi.md#find_software_images_with_filters) | **GET** /device/action/software/images | +[**find_software_version**](ConfigurationSoftwareActionsApi.md#find_software_version) | **GET** /device/action/software/version | +[**find_v_edge_software_version**](ConfigurationSoftwareActionsApi.md#find_v_edge_software_version) | **GET** /device/action/software/vedge/version | +[**find_ztp_software_version**](ConfigurationSoftwareActionsApi.md#find_ztp_software_version) | **GET** /device/action/software/ztp/version | +[**get_image_properties**](ConfigurationSoftwareActionsApi.md#get_image_properties) | **GET** /device/action/software/imageProperties/{versionId} | +[**get_image_remote_server**](ConfigurationSoftwareActionsApi.md#get_image_remote_server) | **GET** /device/action/software/remoteserver/{versionId} | +[**get_pnf_properties**](ConfigurationSoftwareActionsApi.md#get_pnf_properties) | **GET** /device/action/software/pnfproperties/{pnfType} | +[**get_remote_server_by_id**](ConfigurationSoftwareActionsApi.md#get_remote_server_by_id) | **GET** /device/action/remote-server/{id} | +[**get_remote_server_list**](ConfigurationSoftwareActionsApi.md#get_remote_server_list) | **GET** /device/action/remote-server | +[**get_vnf_properties**](ConfigurationSoftwareActionsApi.md#get_vnf_properties) | **GET** /device/action/software/vnfproperties/{versionId} | +[**update_image_url**](ConfigurationSoftwareActionsApi.md#update_image_url) | **PUT** /device/action/software/{versionId} | +[**update_remote_server**](ConfigurationSoftwareActionsApi.md#update_remote_server) | **PUT** /device/action/remote-server/{id} | + + +# **add_remote_server** +> add_remote_server() + + + +Add a new remote server entry. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Request payload for a new remote server entry. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.add_remote_server(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->add_remote_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Request payload for a new remote server entry. | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_image_url** +> create_image_url() + + + +Create software image URL + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Create software image request payload (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_image_url(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->create_image_url: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Create software image request payload | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_image_url** +> delete_image_url(version_id) + + + +Delete software image URL + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + version_id = "versionId_example" # str | Version + + # example passing only required values which don't have defaults set + try: + api_instance.delete_image_url(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->delete_image_url: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Version | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_remote_server** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_remote_server(id) + + + +Delete remote server for the specified ID + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + id = "id_example" # str | Remote Server ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_remote_server(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->delete_remote_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Remote Server ID | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_image_remote_server** +> edit_image_remote_server(version_id) + + + +Update Image Remote Server Details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + version_id = "versionId_example" # str | Image ID + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update image remote server details (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.edit_image_remote_server(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->edit_image_remote_server: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_image_remote_server(version_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->edit_image_remote_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Image ID | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update image remote server details | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_software_images** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] find_software_images() + + + +Get software images + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_software_images() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->find_software_images: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_software_images_with_filters** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] find_software_images_with_filters(image_type) + + + +Get software images + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + image_type = "imageType_example" # str | Image type + vnf_type = "vnfType_example" # str | VNF type (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.find_software_images_with_filters(image_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->find_software_images_with_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.find_software_images_with_filters(image_type, vnf_type=vnf_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->find_software_images_with_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **image_type** | **str**| Image type | + **vnf_type** | **str**| VNF type | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_software_version** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_software_version() + + + +Get software version + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_software_version() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->find_software_version: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_v_edge_software_version** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_v_edge_software_version() + + + +Get vEdge software version + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_v_edge_software_version() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->find_v_edge_software_version: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_ztp_software_version** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_ztp_software_version() + + + +Get ZTP software version + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.find_ztp_software_version() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->find_ztp_software_version: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_image_properties** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_image_properties(version_id) + + + +Get Image Properties + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + version_id = "versionId_example" # str | Version + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_image_properties(version_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->get_image_properties: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Version | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_image_remote_server** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_image_remote_server(version_id) + + + +Get Image Remote Server Details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + version_id = "versionId_example" # str | Version + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_image_remote_server(version_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->get_image_remote_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Version | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pnf_properties** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_pnf_properties(pnf_type) + + + +Get PNF Properties + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + pnf_type = "pnfType_example" # str | PNF type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_pnf_properties(pnf_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->get_pnf_properties: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pnf_type** | **str**| PNF type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_remote_server_by_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_remote_server_by_id(id) + + + +Get remote server for the specified ID + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + id = "id_example" # str | Remote Server ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_remote_server_by_id(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->get_remote_server_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Remote Server ID | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_remote_server_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_remote_server_list() + + + +Get list of remote servers + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_remote_server_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->get_remote_server_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnf_properties** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vnf_properties(version_id) + + + +Get VNF Properties + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + version_id = "versionId_example" # str | Version + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vnf_properties(version_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->get_vnf_properties: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Version | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_image_url** +> update_image_url(version_id) + + + +Update software image URL + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + version_id = "versionId_example" # str | Version + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Update software image request payload (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_image_url(version_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->update_image_url: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_image_url(version_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->update_image_url: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| Version | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Update software image request payload | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_remote_server** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] update_remote_server(id) + + + +Update remote server for the specified ID + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_software_actions_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_software_actions_api.ConfigurationSoftwareActionsApi(api_client) + id = "id_example" # str | Remote Server ID + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_remote_server(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->update_remote_server: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_remote_server(id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationSoftwareActionsApi->update_remote_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Remote Server ID | + **body** | **str**| | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationTemplateConfigurationApi.md b/docs/ConfigurationTemplateConfigurationApi.md new file mode 100644 index 0000000..606895c --- /dev/null +++ b/docs/ConfigurationTemplateConfigurationApi.md @@ -0,0 +1,717 @@ +# openapi_client.ConfigurationTemplateConfigurationApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**generate_cli_mode_devices**](ConfigurationTemplateConfigurationApi.md#generate_cli_mode_devices) | **GET** /template/config/device/mode/cli | +[**generatev_manage_mode_devices**](ConfigurationTemplateConfigurationApi.md#generatev_manage_mode_devices) | **GET** /template/config/device/mode/vmanage | +[**get_attached_config**](ConfigurationTemplateConfigurationApi.md#get_attached_config) | **GET** /template/config/attached/{deviceId} | +[**get_compatible_devices**](ConfigurationTemplateConfigurationApi.md#get_compatible_devices) | **GET** /template/config/rmalist/{oldDeviceId} | +[**get_device_diff**](ConfigurationTemplateConfigurationApi.md#get_device_diff) | **GET** /template/config/diff/{deviceId} | +[**get_running_config**](ConfigurationTemplateConfigurationApi.md#get_running_config) | **GET** /template/config/running/{deviceId} | +[**get_vpn_for_device**](ConfigurationTemplateConfigurationApi.md#get_vpn_for_device) | **GET** /template/config/vpn/{deviceId} | +[**rma_update**](ConfigurationTemplateConfigurationApi.md#rma_update) | **PUT** /template/config/rmaupdate | +[**update_device_to_cli_mode**](ConfigurationTemplateConfigurationApi.md#update_device_to_cli_mode) | **POST** /template/config/device/mode/cli | +[**upload_config**](ConfigurationTemplateConfigurationApi.md#upload_config) | **PUT** /template/config/attach/{deviceId} | + + +# **generate_cli_mode_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_cli_mode_devices(type) + + + +Generates a JSON object that contains a list of valid devices in CLI mode + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + type = "vedge" # str | Device type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_cli_mode_devices(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->generate_cli_mode_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Device type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generatev_manage_mode_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generatev_manage_mode_devices(type) + + + +Get list of devices that are allowable for vmanage modes + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + type = "vedge" # str | Device type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generatev_manage_mode_devices(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->generatev_manage_mode_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Device type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_attached_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_attached_config(device_id) + + + +Get local template attached config for given device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + device_id = "deviceId_example" # str | Device Model ID + type = "CFS" # str | Config type (optional) if omitted the server will use the default value of "CFS" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_attached_config(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->get_attached_config: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_attached_config(device_id, type=type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->get_attached_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Model ID | + **type** | **str**| Config type | [optional] if omitted the server will use the default value of "CFS" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_compatible_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_compatible_devices(old_device_id) + + + +Get compatible devices of model, chassis number, certificate serial number with the old device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + old_device_id = "oldDeviceId_example" # str | Device Model ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_compatible_devices(old_device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->get_compatible_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **old_device_id** | **str**| Device Model ID | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_diff** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_diff(device_id) + + + +Generates a JSON object that contains the diff for a given device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + device_id = "deviceId_example" # str | Device Model ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_diff(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->get_device_diff: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Model ID | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_running_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_running_config(device_id) + + + +Get device running config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + device_id = "deviceId_example" # str | Device Model ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_running_config(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->get_running_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Model ID | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpn_for_device** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vpn_for_device(device_id) + + + +Get list of configured VPN (excluding reserved VPN) for a device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + device_id = "deviceId_example" # str | Device Model ID + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vpn_for_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->get_vpn_for_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Model ID | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rma_update** +> rma_update() + + + +Update new device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template config (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.rma_update(body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->rma_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_device_to_cli_mode** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_device_to_cli_mode() + + + +Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device list (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_device_to_cli_mode(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->update_device_to_cli_mode: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device list | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_config** +> upload_config(device_id) + + + +Upload device config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_configuration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_configuration_api.ConfigurationTemplateConfigurationApi(api_client) + device_id = "deviceId_example" # str | Device Model ID + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template config (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.upload_config(device_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->upload_config: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.upload_config(device_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateConfigurationApi->upload_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Model ID | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationTemplateLockApi.md b/docs/ConfigurationTemplateLockApi.md new file mode 100644 index 0000000..1f4ecb7 --- /dev/null +++ b/docs/ConfigurationTemplateLockApi.md @@ -0,0 +1,144 @@ +# openapi_client.ConfigurationTemplateLockApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**remove_lock**](ConfigurationTemplateLockApi.md#remove_lock) | **DELETE** /template/lock/{processId} | +[**update_lease_time**](ConfigurationTemplateLockApi.md#update_lease_time) | **PUT** /template/lock/{processId} | + + +# **remove_lock** +> remove_lock(process_id) + + + +Remove lock + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_lock_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_lock_api.ConfigurationTemplateLockApi(api_client) + process_id = "processId_example" # str | Process Id + + # example passing only required values which don't have defaults set + try: + api_instance.remove_lock(process_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateLockApi->remove_lock: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_id** | **str**| Process Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_lease_time** +> update_lease_time(process_id) + + + +Update lease + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_lock_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_lock_api.ConfigurationTemplateLockApi(api_client) + process_id = "processId_example" # str | Process Id + + # example passing only required values which don't have defaults set + try: + api_instance.update_lease_time(process_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateLockApi->update_lease_time: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_id** | **str**| Process Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationTemplateMasterApi.md b/docs/ConfigurationTemplateMasterApi.md new file mode 100644 index 0000000..afc0dbc --- /dev/null +++ b/docs/ConfigurationTemplateMasterApi.md @@ -0,0 +1,920 @@ +# openapi_client.ConfigurationTemplateMasterApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**change_template_resource_group1**](ConfigurationTemplateMasterApi.md#change_template_resource_group1) | **POST** /template/device/resource-group/{resourceGroupName}/{templateId} | +[**create_cli_template**](ConfigurationTemplateMasterApi.md#create_cli_template) | **POST** /template/device/cli | +[**create_master_template**](ConfigurationTemplateMasterApi.md#create_master_template) | **POST** /template/device/feature | +[**delete_master_template**](ConfigurationTemplateMasterApi.md#delete_master_template) | **DELETE** /template/device/{templateId} | +[**edit_master_template**](ConfigurationTemplateMasterApi.md#edit_master_template) | **PUT** /template/device/{templateId} | +[**generate_master_template_list**](ConfigurationTemplateMasterApi.md#generate_master_template_list) | **GET** /template/device | +[**generate_template_for_migration**](ConfigurationTemplateMasterApi.md#generate_template_for_migration) | **GET** /template/device/migration | +[**get_master_template_definition**](ConfigurationTemplateMasterApi.md#get_master_template_definition) | **GET** /template/device/object/{templateId} | +[**get_out_of_sync_devices**](ConfigurationTemplateMasterApi.md#get_out_of_sync_devices) | **GET** /template/device/syncstatus/{templateId} | +[**get_out_of_sync_templates**](ConfigurationTemplateMasterApi.md#get_out_of_sync_templates) | **GET** /template/device/syncstatus | +[**is_migration_required**](ConfigurationTemplateMasterApi.md#is_migration_required) | **GET** /template/device/is_migration_required | +[**migrate_templates**](ConfigurationTemplateMasterApi.md#migrate_templates) | **POST** /template/device/migration | +[**migration_info**](ConfigurationTemplateMasterApi.md#migration_info) | **GET** /template/device/migration_info | + + +# **change_template_resource_group1** +> change_template_resource_group1(template_id, resource_group_name) + + + +Change template resource group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + template_id = "templateId_example" # str | Template Id + resource_group_name = "resourceGroupName_example" # str | Resource group name + + # example passing only required values which don't have defaults set + try: + api_instance.change_template_resource_group1(template_id, resource_group_name) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->change_template_resource_group1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **resource_group_name** | **str**| Resource group name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cli_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cli_template() + + + +Create CLI template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Create template request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cli_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->create_cli_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Create template request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_master_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_master_template() + + + +Create a device template from feature templates and sub templates


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Create template request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_master_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->create_master_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Create template request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_master_template** +> delete_master_template(template_id) + + + +Delete template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_master_template(template_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->delete_master_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_master_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_master_template(template_id) + + + +Edit template


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + template_id = "templateId_example" # str | Template Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_master_template(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->edit_master_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_master_template(template_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->edit_master_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_master_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_master_template_list(feature) + + + +Generate template list


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + feature = "lawful-interception" # str | Feature + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_master_template_list(feature) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->generate_master_template_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feature** | **str**| Feature | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_template_for_migration** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_template_for_migration() + + + +Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + has_aaa = True # bool | Return only those uses AAA (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_template_for_migration(has_aaa=has_aaa) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->generate_template_for_migration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **has_aaa** | **bool**| Return only those uses AAA | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_master_template_definition** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_master_template_definition(template_id) + + + +Generate template by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_master_template_definition(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->get_master_template_definition: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_out_of_sync_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_out_of_sync_devices(template_id) + + + +Get out of sync devices


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + template_id = "templateId_example" # str | Template Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_out_of_sync_devices(template_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->get_out_of_sync_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **template_id** | **str**| Template Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_out_of_sync_templates** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_out_of_sync_templates() + + + +Get template sync status


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_out_of_sync_templates() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->get_out_of_sync_templates: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **is_migration_required** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} is_migration_required() + + + +Check if any device templates need migration


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.is_migration_required() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->is_migration_required: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **migrate_templates** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} migrate_templates(id) + + + +Migrate the device templates given the template Ids + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + id = [ + "id_example", + ] # [str] | Template Id + prefix = "cisco" # str | Prefix (optional) if omitted the server will use the default value of "cisco" + include_all = True # bool | Include all flag (optional) if omitted the server will use the default value of True + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.migrate_templates(id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->migrate_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.migrate_templates(id, prefix=prefix, include_all=include_all) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->migrate_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **[str]**| Template Id | + **prefix** | **str**| Prefix | [optional] if omitted the server will use the default value of "cisco" + **include_all** | **bool**| Include all flag | [optional] if omitted the server will use the default value of True + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **migration_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} migration_info() + + + +Returns the mapping between old and migrated templates


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_template_master_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_template_master_api.ConfigurationTemplateMasterApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.migration_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTemplateMasterApi->migration_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationTopologyApi.md b/docs/ConfigurationTopologyApi.md new file mode 100644 index 0000000..e2a7fd8 --- /dev/null +++ b/docs/ConfigurationTopologyApi.md @@ -0,0 +1,359 @@ +# openapi_client.ConfigurationTopologyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_device_topology**](ConfigurationTopologyApi.md#create_device_topology) | **GET** /topology/device | +[**create_full_topology**](ConfigurationTopologyApi.md#create_full_topology) | **GET** /topology | +[**create_physical_topology**](ConfigurationTopologyApi.md#create_physical_topology) | **GET** /topology/physical | +[**get_site_topology**](ConfigurationTopologyApi.md#get_site_topology) | **GET** /topology/device/site/{siteId} | +[**get_site_topology_monitor_data**](ConfigurationTopologyApi.md#get_site_topology_monitor_data) | **GET** /topology/monitor/site/{siteId} | + + +# **create_device_topology** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_topology(device_id) + + + +Create device topology + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_topology_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_topology_api.ConfigurationTopologyApi(api_client) + device_id = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | Device Id list + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_topology(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTopologyApi->create_device_topology: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | [**[DeviceIP]**](DeviceIP.md)| Device Id list | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_full_topology** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_full_topology() + + + +Create full topology + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_topology_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_topology_api.ConfigurationTopologyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_full_topology() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTopologyApi->create_full_topology: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_physical_topology** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_physical_topology(device_id) + + + +Create pysical topology + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_topology_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_topology_api.ConfigurationTopologyApi(api_client) + device_id = [ + DeviceIP( + device_ip="device_ip_example", + ), + ] # [DeviceIP] | Device Id list + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_physical_topology(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTopologyApi->create_physical_topology: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | [**[DeviceIP]**](DeviceIP.md)| Device Id list | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_site_topology** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_site_topology(site_id) + + + +Get topology for a given site id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_topology_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_topology_api.ConfigurationTopologyApi(api_client) + site_id = "siteId_example" # str | Site Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_site_topology(site_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTopologyApi->get_site_topology: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **site_id** | **str**| Site Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_site_topology_monitor_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_site_topology_monitor_data(site_id) + + + +Get topology monitor data for a given site id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_topology_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_topology_api.ConfigurationTopologyApi(api_client) + site_id = "siteId_example" # str | Site Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_site_topology_monitor_data(site_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationTopologyApi->get_site_topology_monitor_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **site_id** | **str**| Site Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationVEdgeTemplatePolicyApi.md b/docs/ConfigurationVEdgeTemplatePolicyApi.md new file mode 100644 index 0000000..1e5f678 --- /dev/null +++ b/docs/ConfigurationVEdgeTemplatePolicyApi.md @@ -0,0 +1,563 @@ +# openapi_client.ConfigurationVEdgeTemplatePolicyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**change_policy_resource_group**](ConfigurationVEdgeTemplatePolicyApi.md#change_policy_resource_group) | **POST** /template/policy/vedge/{resourceGroupName}/{policyId} | +[**create_v_edge_template**](ConfigurationVEdgeTemplatePolicyApi.md#create_v_edge_template) | **POST** /template/policy/vedge | +[**delete_v_edge_template**](ConfigurationVEdgeTemplatePolicyApi.md#delete_v_edge_template) | **DELETE** /template/policy/vedge/{policyId} | +[**edit_v_edge_template**](ConfigurationVEdgeTemplatePolicyApi.md#edit_v_edge_template) | **PUT** /template/policy/vedge/{policyId} | +[**generate_policy_template_list**](ConfigurationVEdgeTemplatePolicyApi.md#generate_policy_template_list) | **GET** /template/policy/vedge | +[**get_device_list_by_policy**](ConfigurationVEdgeTemplatePolicyApi.md#get_device_list_by_policy) | **GET** /template/policy/vedge/devices/{policyId} | +[**get_v_edge_policy_device_list**](ConfigurationVEdgeTemplatePolicyApi.md#get_v_edge_policy_device_list) | **GET** /template/policy/vedge/devices | +[**get_v_edge_template**](ConfigurationVEdgeTemplatePolicyApi.md#get_v_edge_template) | **GET** /template/policy/vedge/definition/{policyId} | + + +# **change_policy_resource_group** +> change_policy_resource_group(policy_id, resource_group_name) + + + +Change policy resource group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + resource_group_name = "resourceGroupName_example" # str | Resrouce group name + + # example passing only required values which don't have defaults set + try: + api_instance.change_policy_resource_group(policy_id, resource_group_name) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->change_policy_resource_group: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **resource_group_name** | **str**| Resrouce group name | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_v_edge_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_v_edge_template() + + + +Create template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_v_edge_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->create_v_edge_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_v_edge_template** +> delete_v_edge_template(policy_id) + + + +Delete template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_v_edge_template(policy_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->delete_v_edge_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_v_edge_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_v_edge_template(policy_id) + + + +Edit template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_v_edge_template(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->edit_v_edge_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_v_edge_template(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->edit_v_edge_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_policy_template_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_policy_template_list() + + + +Get policy details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_policy_template_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->generate_policy_template_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_list_by_policy** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_list_by_policy(policy_id) + + + +Get device list by policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_list_by_policy(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->get_device_list_by_policy: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_edge_policy_device_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_v_edge_policy_device_list() + + + +Get device list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_v_edge_policy_device_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->get_v_edge_policy_device_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_edge_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_v_edge_template(policy_id) + + + +Get template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_edge_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_edge_template_policy_api.ConfigurationVEdgeTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_v_edge_template(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVEdgeTemplatePolicyApi->get_v_edge_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationVSmartTemplatePolicyApi.md b/docs/ConfigurationVSmartTemplatePolicyApi.md new file mode 100644 index 0000000..ac5ab0f --- /dev/null +++ b/docs/ConfigurationVSmartTemplatePolicyApi.md @@ -0,0 +1,795 @@ +# openapi_client.ConfigurationVSmartTemplatePolicyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activate_policy**](ConfigurationVSmartTemplatePolicyApi.md#activate_policy) | **POST** /template/policy/vsmart/activate/{policyId} | +[**activate_policy_for_cloud_services**](ConfigurationVSmartTemplatePolicyApi.md#activate_policy_for_cloud_services) | **POST** /template/policy/vsmart/activate/central/{policyId} | +[**check_v_smart_connectivity_status**](ConfigurationVSmartTemplatePolicyApi.md#check_v_smart_connectivity_status) | **GET** /template/policy/vsmart/connectivity/status | +[**create_v_smart_template**](ConfigurationVSmartTemplatePolicyApi.md#create_v_smart_template) | **POST** /template/policy/vsmart | +[**de_activate_policy**](ConfigurationVSmartTemplatePolicyApi.md#de_activate_policy) | **POST** /template/policy/vsmart/deactivate/{policyId} | +[**delete_v_smart_template**](ConfigurationVSmartTemplatePolicyApi.md#delete_v_smart_template) | **DELETE** /template/policy/vsmart/{policyId} | +[**edit_template_without_lock_checks**](ConfigurationVSmartTemplatePolicyApi.md#edit_template_without_lock_checks) | **PUT** /template/policy/vsmart/central/{policyId} | +[**edit_v_smart_template**](ConfigurationVSmartTemplatePolicyApi.md#edit_v_smart_template) | **PUT** /template/policy/vsmart/{policyId} | +[**generate_v_smart_policy_template_list**](ConfigurationVSmartTemplatePolicyApi.md#generate_v_smart_policy_template_list) | **GET** /template/policy/vsmart | +[**get_template_by_policy_id**](ConfigurationVSmartTemplatePolicyApi.md#get_template_by_policy_id) | **GET** /template/policy/vsmart/definition/{policyId} | +[**qosmos_nbar_migration_warning**](ConfigurationVSmartTemplatePolicyApi.md#qosmos_nbar_migration_warning) | **GET** /template/policy/vsmart/qosmos_nbar_migration_warning | + + +# **activate_policy** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} activate_policy(policy_id) + + + +Activate vsmart policy for a given policy id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.activate_policy(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->activate_policy: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.activate_policy(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->activate_policy: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **activate_policy_for_cloud_services** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} activate_policy_for_cloud_services(policy_id) + + + +Activate vsmart policy for a given policy id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.activate_policy_for_cloud_services(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->activate_policy_for_cloud_services: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.activate_policy_for_cloud_services(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->activate_policy_for_cloud_services: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **check_v_smart_connectivity_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} check_v_smart_connectivity_status() + + + +Check VSmart Connectivity Status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.check_v_smart_connectivity_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->check_v_smart_connectivity_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_v_smart_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_v_smart_template() + + + +Create template for given policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_v_smart_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->create_v_smart_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **de_activate_policy** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} de_activate_policy(policy_id) + + + +Deactivate vsmart policy for a given policy id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.de_activate_policy(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->de_activate_policy: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_v_smart_template** +> delete_v_smart_template(policy_id) + + + +Delete template for a given policy id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_v_smart_template(policy_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->delete_v_smart_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_template_without_lock_checks** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] edit_template_without_lock_checks(policy_id) + + + +Edit template for given policy id to allow for multiple component edits + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_template_without_lock_checks(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->edit_template_without_lock_checks: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_template_without_lock_checks(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->edit_template_without_lock_checks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_v_smart_template** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] edit_v_smart_template(policy_id) + + + +Edit template for given policy id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Template policy (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_v_smart_template(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->edit_v_smart_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_v_smart_template(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->edit_v_smart_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Template policy | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_v_smart_policy_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_v_smart_policy_template_list() + + + +Get all template vsmart policy list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_v_smart_policy_template_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->generate_v_smart_policy_template_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_template_by_policy_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_template_by_policy_id(policy_id) + + + +Get template policy definition by policy id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_template_by_policy_id(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->get_template_by_policy_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **qosmos_nbar_migration_warning** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} qosmos_nbar_migration_warning() + + + +Qosmos Nbar migration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_v_smart_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_v_smart_template_policy_api.ConfigurationVSmartTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.qosmos_nbar_migration_warning() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVSmartTemplatePolicyApi->qosmos_nbar_migration_warning: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConfigurationVoiceTemplatePolicyApi.md b/docs/ConfigurationVoiceTemplatePolicyApi.md new file mode 100644 index 0000000..8611c88 --- /dev/null +++ b/docs/ConfigurationVoiceTemplatePolicyApi.md @@ -0,0 +1,630 @@ +# openapi_client.ConfigurationVoiceTemplatePolicyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_voice_template**](ConfigurationVoiceTemplatePolicyApi.md#create_voice_template) | **POST** /template/policy/voice | +[**delete_voice_template**](ConfigurationVoiceTemplatePolicyApi.md#delete_voice_template) | **DELETE** /template/policy/voice/{policyId} | +[**edit_voice_template**](ConfigurationVoiceTemplatePolicyApi.md#edit_voice_template) | **PUT** /template/policy/voice/{policyId} | +[**generate_voice_policy_summary**](ConfigurationVoiceTemplatePolicyApi.md#generate_voice_policy_summary) | **GET** /template/policy/voice/summary | +[**generate_voice_template_list**](ConfigurationVoiceTemplatePolicyApi.md#generate_voice_template_list) | **GET** /template/policy/voice | +[**get_device_list_by_policy_id**](ConfigurationVoiceTemplatePolicyApi.md#get_device_list_by_policy_id) | **GET** /template/policy/voice/devices/{policyId} | +[**get_template_by_id**](ConfigurationVoiceTemplatePolicyApi.md#get_template_by_id) | **GET** /template/policy/voice/definition/{policyId} | +[**get_voice_policy_device_list**](ConfigurationVoiceTemplatePolicyApi.md#get_voice_policy_device_list) | **GET** /template/policy/voice/devices | +[**get_voice_templates_for_device**](ConfigurationVoiceTemplatePolicyApi.md#get_voice_templates_for_device) | **GET** /template/policy/voice/{deviceModel} | + + +# **create_voice_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_voice_template() + + + +Create Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy template (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_voice_template(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->create_voice_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_voice_template** +> delete_voice_template(policy_id) + + + +Delete Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_voice_template(policy_id) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->delete_voice_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_voice_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_voice_template(policy_id) + + + +Edit Template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy template (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_voice_template(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->edit_voice_template: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.edit_voice_template(policy_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->edit_voice_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Policy template | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_voice_policy_summary** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_voice_policy_summary() + + + +Get templates that map a device model + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_voice_policy_summary() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->generate_voice_policy_summary: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_voice_template_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_voice_template_list() + + + +Generate template list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_voice_template_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->generate_voice_template_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_list_by_policy_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_list_by_policy_id(policy_id) + + + +Get device list by policy Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_list_by_policy_id(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->get_device_list_by_policy_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_template_by_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_template_by_id(policy_id) + + + +Get templates by policy Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + policy_id = "policyId_example" # str | Policy Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_template_by_id(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->get_template_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_voice_policy_device_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_voice_policy_device_list() + + + +Get all device list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_voice_policy_device_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->get_voice_policy_device_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_voice_templates_for_device** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_voice_templates_for_device(device_model) + + + +Get templates that map a device model + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import configuration_voice_template_policy_api +from openapi_client.model.device_model import DeviceModel +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = configuration_voice_template_policy_api.ConfigurationVoiceTemplatePolicyApi(api_client) + device_model = DeviceModel( + device_model="device_model_example", + ) # DeviceModel | Device model + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_voice_templates_for_device(device_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ConfigurationVoiceTemplatePolicyApi->get_voice_templates_for_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_model** | **DeviceModel**| Device model | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ConnectToNtpServer.md b/docs/ConnectToNtpServer.md new file mode 100644 index 0000000..2af2436 --- /dev/null +++ b/docs/ConnectToNtpServer.md @@ -0,0 +1,13 @@ +# ConnectToNtpServer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip_address** | **str** | | [optional] +**vpn** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ControlStatus.md b/docs/ControlStatus.md new file mode 100644 index 0000000..14f1f89 --- /dev/null +++ b/docs/ControlStatus.md @@ -0,0 +1,14 @@ +# ControlStatus + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**control_down** | **int** | | [optional] +**control_up** | **int** | | [optional] +**partial** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CorporateWifi.md b/docs/CorporateWifi.md new file mode 100644 index 0000000..0e9f2f0 --- /dev/null +++ b/docs/CorporateWifi.md @@ -0,0 +1,17 @@ +# CorporateWifi + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**corporate_wlan** | **bool** | | [optional] +**radius_server** | [**RadiusServer**](RadiusServer.md) | | [optional] +**security_auth_type** | **str** | | [optional] +**ssid** | **str** | | [optional] +**visibility** | **bool** | | [optional] +**wpa_psk_key** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CountryRegionSettings.md b/docs/CountryRegionSettings.md new file mode 100644 index 0000000..b1606df --- /dev/null +++ b/docs/CountryRegionSettings.md @@ -0,0 +1,13 @@ +# CountryRegionSettings + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country_region** | **str** | | [optional] +**regulatory_domain** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateDeviceParams.md b/docs/CreateDeviceParams.md new file mode 100644 index 0000000..8da1114 --- /dev/null +++ b/docs/CreateDeviceParams.md @@ -0,0 +1,18 @@ +# CreateDeviceParams + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_ip** | **str** | | [optional] +**generate_csr** | **bool** | | [optional] +**password** | **str** | | [optional] +**personality** | **str** | | [optional] +**port** | **str** | | [optional] +**protocol** | **str** | | [optional] +**username** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateTenantModel.md b/docs/CreateTenantModel.md new file mode 100644 index 0000000..e19c030 --- /dev/null +++ b/docs/CreateTenantModel.md @@ -0,0 +1,22 @@ +# CreateTenantModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**desc** | **str** | | [optional] +**getv_bond_address** | **str** | | [optional] +**getv_smarts** | **[str]** | | [optional] +**idp_metadata** | **str** | | [optional] +**mode** | **str** | | [optional] +**name** | **str** | | [optional] +**old_idp_metadata** | **str** | | [optional] +**org_name** | **str** | | [optional] +**sp_metadata** | **str** | | [optional] +**sub_domain** | **str** | | [optional] +**wan_edge_forecast** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DHCPPool.md b/docs/DHCPPool.md new file mode 100644 index 0000000..3787cfa --- /dev/null +++ b/docs/DHCPPool.md @@ -0,0 +1,15 @@ +# DHCPPool + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lease_time_day** | **int** | | +**lease_time_hour** | **int** | | +**lease_time_min** | **int** | | +**pool_network** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DataCenter.md b/docs/DataCenter.md new file mode 100644 index 0000000..fe67a0b --- /dev/null +++ b/docs/DataCenter.md @@ -0,0 +1,18 @@ +# DataCenter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dc_personality** | **str** | | [optional] +**members** | [**[Node]**](Node.md) | | [optional] +**mgmt_ip_address** | **str** | | [optional] +**name** | **str** | | [optional] +**nms_personality** | **str** | | [optional] +**password** | **str** | | [optional] +**username** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DataCenterRegistration.md b/docs/DataCenterRegistration.md new file mode 100644 index 0000000..9d2273d --- /dev/null +++ b/docs/DataCenterRegistration.md @@ -0,0 +1,18 @@ +# DataCenterRegistration + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cluster_enc_key** | **str** | | [optional] +**cluster_env_key** | **str** | | [optional] +**data_centers** | [**[DataCenter]**](DataCenter.md) | | [optional] +**disaster_recovery_settings** | [**DisasterRecoverySettings**](DisasterRecoverySettings.md) | | [optional] +**host** | [**Host**](Host.md) | | [optional] +**vbonds** | [**[Node]**](Node.md) | | [optional] +**vmanage_root_ca** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DataCollectionAgentApi.md b/docs/DataCollectionAgentApi.md new file mode 100644 index 0000000..1f1b604 --- /dev/null +++ b/docs/DataCollectionAgentApi.md @@ -0,0 +1,1616 @@ +# openapi_client.DataCollectionAgentApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_dca_analytics_data_file**](DataCollectionAgentApi.md#create_dca_analytics_data_file) | **POST** /dca/settings/configuration/{type}/dca | +[**create_stats**](DataCollectionAgentApi.md#create_stats) | **PUT** /dca/analytics | +[**generate_alarm**](DataCollectionAgentApi.md#generate_alarm) | **POST** /dca/cloudservices/alarm | +[**generate_dca_device_state_data**](DataCollectionAgentApi.md#generate_dca_device_state_data) | **POST** /dca/data/device/state/{state_data_type} | +[**generate_dca_device_statistics_data**](DataCollectionAgentApi.md#generate_dca_device_statistics_data) | **POST** /dca/data/device/statistics/{stats_data_type} | +[**get_access_token**](DataCollectionAgentApi.md#get_access_token) | **GET** /dca/cloudservices/accesstoken | +[**get_all_stats_data_dca**](DataCollectionAgentApi.md#get_all_stats_data_dca) | **POST** /dca/analytics/all | +[**get_cloud_services_configuration_dca**](DataCollectionAgentApi.md#get_cloud_services_configuration_dca) | **GET** /dca/settings/configuration/cloudservices/dca | +[**get_crash_logs**](DataCollectionAgentApi.md#get_crash_logs) | **POST** /dca/device/crashlog/details | +[**get_crash_logs_synced**](DataCollectionAgentApi.md#get_crash_logs_synced) | **GET** /dca/device/crashlog/synced | +[**get_dca_attached_config_to_device**](DataCollectionAgentApi.md#get_dca_attached_config_to_device) | **POST** /dca/template/device/config/attachedconfig | +[**get_dca_tenant_owners**](DataCollectionAgentApi.md#get_dca_tenant_owners) | **GET** /dca/dcatenantowners | +[**get_devices_details_dca**](DataCollectionAgentApi.md#get_devices_details_dca) | **POST** /dca/system/device | +[**get_id_token**](DataCollectionAgentApi.md#get_id_token) | **GET** /dca/cloudservices/idtoken | +[**get_stats_db_index_status**](DataCollectionAgentApi.md#get_stats_db_index_status) | **POST** /dca/statistics/settings/status | +[**get_telemetry_settings**](DataCollectionAgentApi.md#get_telemetry_settings) | **GET** /dca/cloudservices/telemetry | +[**get_template_policy_definitions_dca**](DataCollectionAgentApi.md#get_template_policy_definitions_dca) | **POST** /dca/template/policy/definition/approute | +[**get_vedge_template_list_dca**](DataCollectionAgentApi.md#get_vedge_template_list_dca) | **POST** /dca/template/policy/vedge | +[**get_vpn_lists_dca**](DataCollectionAgentApi.md#get_vpn_lists_dca) | **POST** /dca/template/policy/list/vpn | +[**get_vsmart_template_list_dca**](DataCollectionAgentApi.md#get_vsmart_template_list_dca) | **POST** /dca/template/policy/vsmart | +[**list_all_devices_dca**](DataCollectionAgentApi.md#list_all_devices_dca) | **POST** /dca/device | +[**store_access_token**](DataCollectionAgentApi.md#store_access_token) | **POST** /dca/cloudservices/accesstoken | +[**store_id_token**](DataCollectionAgentApi.md#store_id_token) | **POST** /dca/cloudservices/idtoken | + + +# **create_dca_analytics_data_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dca_analytics_data_file(type) + + + +Create analytics config data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + type = "analytics" # str | Data type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dca_analytics_data_file(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->create_dca_analytics_data_file: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dca_analytics_data_file(type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->create_dca_analytics_data_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Data type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_stats() + + + +Get statistics data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_stats(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->create_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_alarm** +> generate_alarm() + + + +Generate DCA alarms + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | DCA alarm message (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.generate_alarm(body=body) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->generate_alarm: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| DCA alarm message | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_dca_device_state_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_dca_device_state_data(state_data_type) + + + +Get device state data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + state_data_type = "state_data_type_example" # str | Device state data + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_dca_device_state_data(state_data_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->generate_dca_device_state_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_dca_device_state_data(state_data_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->generate_dca_device_state_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| Device state data | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_dca_device_statistics_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_dca_device_statistics_data(stats_data_type) + + + +Get device statistics data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + stats_data_type = "stats_data_type_example" # str | Device statistics data + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_dca_device_statistics_data(stats_data_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->generate_dca_device_statistics_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_dca_device_statistics_data(stats_data_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->generate_dca_device_statistics_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **stats_data_type** | **str**| Device statistics data | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_access_token** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_access_token() + + + +Get DCA access token + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_access_token() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_access_token: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_stats_data_dca** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_stats_data_dca() + + + +Get all statistics setting data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_all_stats_data_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_all_stats_data_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats setting | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_services_configuration_dca** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_services_configuration_dca() + + + +Get DCA cloud service configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_services_configuration_dca() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_cloud_services_configuration_dca: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_crash_logs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_crash_logs() + + + +Get crash log + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_crash_logs(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_crash_logs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_crash_logs_synced** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_crash_logs_synced(device_id) + + + +Get device crash log + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_crash_logs_synced(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_crash_logs_synced: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dca_attached_config_to_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dca_attached_config_to_device() + + + +Get attached config to device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_dca_attached_config_to_device(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_dca_attached_config_to_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dca_tenant_owners** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dca_tenant_owners() + + + +Get DCA tenant owners + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_dca_tenant_owners() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_dca_tenant_owners: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_details_dca** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_devices_details_dca() + + + +Get device details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_devices_details_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_devices_details_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_id_token** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_id_token() + + + +Get DCA Id token + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_id_token() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_id_token: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_db_index_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_db_index_status() + + + +Get statistics setting status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_db_index_status(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_stats_db_index_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats setting | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_telemetry_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_telemetry_settings() + + + +Get DCA telemetry settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_telemetry_settings() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_telemetry_settings: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_template_policy_definitions_dca** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_template_policy_definitions_dca() + + + +Get template policy definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_template_policy_definitions_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_template_policy_definitions_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vedge_template_list_dca** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vedge_template_list_dca() + + + +Get vEdge template list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vedge_template_list_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_vedge_template_list_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpn_lists_dca** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vpn_lists_dca() + + + +Get VPN details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vpn_lists_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_vpn_lists_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vsmart_template_list_dca** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vsmart_template_list_dca() + + + +Get vSmart template list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vsmart_template_list_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->get_vsmart_template_list_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_all_devices_dca** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_all_devices_dca() + + + +Get all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_all_devices_dca(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->list_all_devices_dca: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **store_access_token** +> store_access_token() + + + +Set DCA access token + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | DCA access token (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.store_access_token(body=body) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->store_access_token: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| DCA access token | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **store_id_token** +> store_id_token() + + + +Set DCA Id token + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import data_collection_agent_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_collection_agent_api.DataCollectionAgentApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | DCA Id token (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.store_id_token(body=body) + except openapi_client.ApiException as e: + print("Exception when calling DataCollectionAgentApi->store_id_token: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| DCA Id token | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/DeleteTenantBulkModel.md b/docs/DeleteTenantBulkModel.md new file mode 100644 index 0000000..c52f9fb --- /dev/null +++ b/docs/DeleteTenantBulkModel.md @@ -0,0 +1,13 @@ +# DeleteTenantBulkModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**tenant_id_list** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeleteTenantModel.md b/docs/DeleteTenantModel.md new file mode 100644 index 0000000..432ad5c --- /dev/null +++ b/docs/DeleteTenantModel.md @@ -0,0 +1,12 @@ +# DeleteTenantModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeploymentModeApi.md b/docs/DeploymentModeApi.md new file mode 100644 index 0000000..1553222 --- /dev/null +++ b/docs/DeploymentModeApi.md @@ -0,0 +1,484 @@ +# openapi_client.DeploymentModeApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**config_fedramp_mode**](DeploymentModeApi.md#config_fedramp_mode) | **POST** /fedramp/status | +[**configure_dns_sec**](DeploymentModeApi.md#configure_dns_sec) | **POST** /fedramp/dnssec/config | +[**configure_wazuh_client**](DeploymentModeApi.md#configure_wazuh_client) | **POST** /fedramp/wazuh/config | +[**get_dns_sec_status**](DeploymentModeApi.md#get_dns_sec_status) | **GET** /fedramp/dnssec/status | +[**get_wazuh_agent_status**](DeploymentModeApi.md#get_wazuh_agent_status) | **GET** /fedramp/wazuh/status | +[**reques_dns_sec_actions**](DeploymentModeApi.md#reques_dns_sec_actions) | **GET** /fedramp/dnssec/actions | +[**request_wazuh_actions**](DeploymentModeApi.md#request_wazuh_actions) | **GET** /fedramp/wazuh/actions | + + +# **config_fedramp_mode** +> config_fedramp_mode() + + + +Set network deployment mode + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network deployment mode (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.config_fedramp_mode(body=body) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->config_fedramp_mode: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network deployment mode | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **configure_dns_sec** +> configure_dns_sec() + + + +Configure DNS-Sec + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | DNS sec config request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.configure_dns_sec(body=body) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->configure_dns_sec: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| DNS sec config request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **configure_wazuh_client** +> configure_wazuh_client() + + + +Configure Wazuh agent + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Wazhuh configuration (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.configure_wazuh_client(body=body) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->configure_wazuh_client: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Wazhuh configuration | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dns_sec_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dns_sec_status() + + + +Get DNS-Sec status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_dns_sec_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->get_dns_sec_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wazuh_agent_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_wazuh_agent_status() + + + +Get Wazuh agent status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_wazuh_agent_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->get_wazuh_agent_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reques_dns_sec_actions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} reques_dns_sec_actions(action) + + + +Request DNS-Sec actions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + action = "action_example" # str | DNS-Sec action + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.reques_dns_sec_actions(action) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->reques_dns_sec_actions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **action** | **str**| DNS-Sec action | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **request_wazuh_actions** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] request_wazuh_actions() + + + +Wazuh agent action + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import deployment_mode_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = deployment_mode_api.DeploymentModeApi(api_client) + action = "action_example" # str | Wazhuh Action (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.request_wazuh_actions(action=action) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeploymentModeApi->request_wazuh_actions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **action** | **str**| Wazhuh Action | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Device.md b/docs/Device.md new file mode 100644 index 0000000..0b69128 --- /dev/null +++ b/docs/Device.md @@ -0,0 +1,15 @@ +# Device + +API model encapsulating device information + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_type** | **str** | | [optional] +**system_ip** | **str** | | [optional] +**uuid** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeviceHealthDetails.md b/docs/DeviceHealthDetails.md new file mode 100644 index 0000000..5801274 --- /dev/null +++ b/docs/DeviceHealthDetails.md @@ -0,0 +1,44 @@ +# DeviceHealthDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bfd_sessions** | **int** | | [optional] +**bfd_sessions_up** | **int** | | [optional] +**board_serial_number** | **str** | | [optional] +**chassis_number** | **str** | | [optional] +**connected_vmanages** | **[str]** | | [optional] +**control_connections_to_vsmat** | [**DeviceHealthDetails**](DeviceHealthDetails.md) | | [optional] +**control_connections** | **int** | | [optional] +**control_connections_up** | **int** | | [optional] +**cpu_load** | **float** | | [optional] +**device_groups** | **[str]** | | [optional] +**device_model** | **str** | | [optional] +**device_type** | **str** | | [optional] +**expected_vsmart_connections** | **int** | | [optional] +**has_geo_data** | **bool** | | [optional] +**health** | **str** | | [optional] +**latitude** | **str** | | [optional] +**local_system_ip** | **str** | | [optional] +**location** | **str** | | [optional] +**longitude** | **str** | | [optional] +**memory_utilization** | **float** | | [optional] +**name** | **str** | | [optional] +**omp_peers** | **int** | | [optional] +**omp_peers_up** | **int** | | [optional] +**personality** | **str** | | [optional] +**qoe** | **int** | | [optional] +**reachability** | **str** | | [optional] +**site_id** | **str** | | [optional] +**software_version** | **str** | | [optional] +**system_ip** | **str** | | [optional] +**uptime_date** | **int** | | [optional] +**uuid** | **str** | | [optional] +**vpn_ids** | **[str]** | | [optional] +**vsmart_control_connections** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeviceIP.md b/docs/DeviceIP.md new file mode 100644 index 0000000..f144731 --- /dev/null +++ b/docs/DeviceIP.md @@ -0,0 +1,13 @@ +# DeviceIP + +This is the valid DeviceIP + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_ip** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeviceMessagingApi.md b/docs/DeviceMessagingApi.md new file mode 100644 index 0000000..5d062f6 --- /dev/null +++ b/docs/DeviceMessagingApi.md @@ -0,0 +1,73 @@ +# openapi_client.DeviceMessagingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_device_vmanage_connection_list**](DeviceMessagingApi.md#create_device_vmanage_connection_list) | **GET** /messaging/device/vmanage | + + +# **create_device_vmanage_connection_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_device_vmanage_connection_list() + + + +Create device vManage connection list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import device_messaging_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = device_messaging_api.DeviceMessagingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_device_vmanage_connection_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeviceMessagingApi->create_device_vmanage_connection_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/DeviceModel.md b/docs/DeviceModel.md new file mode 100644 index 0000000..a49d57c --- /dev/null +++ b/docs/DeviceModel.md @@ -0,0 +1,13 @@ +# DeviceModel + +This is the valid DeviceModel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_model** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeviceNetworkApi.md b/docs/DeviceNetworkApi.md new file mode 100644 index 0000000..982d554 --- /dev/null +++ b/docs/DeviceNetworkApi.md @@ -0,0 +1,283 @@ +# openapi_client.DeviceNetworkApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_network_issues_summary**](DeviceNetworkApi.md#get_network_issues_summary) | **GET** /network/issues/summary | +[**get_network_status_summary**](DeviceNetworkApi.md#get_network_status_summary) | **GET** /network/status | +[**get_reboot_count**](DeviceNetworkApi.md#get_reboot_count) | **GET** /network/issues/rebootcount | +[**get_vmanage_control_status**](DeviceNetworkApi.md#get_vmanage_control_status) | **GET** /network/connectionssummary | + + +# **get_network_issues_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_network_issues_summary() + + + +Retrieve network issues summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import device_network_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = device_network_api.DeviceNetworkApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_network_issues_summary() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeviceNetworkApi->get_network_issues_summary: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_network_status_summary** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_network_status_summary() + + + +Retrieve network status summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import device_network_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = device_network_api.DeviceNetworkApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_network_status_summary() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeviceNetworkApi->get_network_status_summary: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reboot_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_reboot_count() + + + +Retrieve reboot count + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import device_network_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = device_network_api.DeviceNetworkApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_reboot_count() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeviceNetworkApi->get_reboot_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_cached** | **bool**| Is cached flag | defaults to False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vmanage_control_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vmanage_control_status() + + + +Retrieve vManage control status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import device_network_api +from openapi_client.model.vpnid import VPNID +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = device_network_api.DeviceNetworkApi(api_client) + is_cached = False # bool | Is cached flag (optional) if omitted the server will use the default value of False + vpn_id = [ + VPNID( + vpn="vpn_example", + ), + ] # [VPNID] | VPN Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vmanage_control_status(is_cached=is_cached, vpn_id=vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling DeviceNetworkApi->get_vmanage_control_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_cached** | **bool**| Is cached flag | [optional] if omitted the server will use the default value of False + **vpn_id** | [**[VPNID]**](VPNID.md)| VPN Id | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/DeviceType.md b/docs/DeviceType.md new file mode 100644 index 0000000..9395ef2 --- /dev/null +++ b/docs/DeviceType.md @@ -0,0 +1,13 @@ +# DeviceType + +This is valid device type + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeviceUuid.md b/docs/DeviceUuid.md new file mode 100644 index 0000000..60de2a5 --- /dev/null +++ b/docs/DeviceUuid.md @@ -0,0 +1,13 @@ +# DeviceUuid + +This is valid DeviceUuid + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**device_uuid** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DevicesHealth.md b/docs/DevicesHealth.md new file mode 100644 index 0000000..8c1a2d0 --- /dev/null +++ b/docs/DevicesHealth.md @@ -0,0 +1,14 @@ +# DevicesHealth + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**devices** | [**[DeviceHealthDetails]**](DeviceHealthDetails.md) | | [optional] +**header** | **{str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}** | | [optional] +**total_devices** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DevicesHealthOverview.md b/docs/DevicesHealthOverview.md new file mode 100644 index 0000000..78c773b --- /dev/null +++ b/docs/DevicesHealthOverview.md @@ -0,0 +1,14 @@ +# DevicesHealthOverview + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fair** | **int** | | [optional] +**good** | **int** | | [optional] +**poor** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DisasterRecoverySettings.md b/docs/DisasterRecoverySettings.md new file mode 100644 index 0000000..c43328b --- /dev/null +++ b/docs/DisasterRecoverySettings.md @@ -0,0 +1,19 @@ +# DisasterRecoverySettings + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**delay_threshold** | **int** | | [optional] +**dr_paused** | **bool** | | [optional] +**ignored_indexes** | **[str]** | | [optional] +**interval** | **int** | | [optional] +**interval_modified** | **bool** | | [optional] +**pause_dr** | [**DisasterRecoverySettings**](DisasterRecoverySettings.md) | | [optional] +**pause_replication** | **bool** | | [optional] +**start_time** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DomainDetail.md b/docs/DomainDetail.md new file mode 100644 index 0000000..3c3d63e --- /dev/null +++ b/docs/DomainDetail.md @@ -0,0 +1,13 @@ +# DomainDetail + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domain** | **str** | | [optional] +**resolved_ip** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EntityOwnershipInfo.md b/docs/EntityOwnershipInfo.md new file mode 100644 index 0000000..60ee135 --- /dev/null +++ b/docs/EntityOwnershipInfo.md @@ -0,0 +1,14 @@ +# EntityOwnershipInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bucket** | **str** | | [optional] +**entity_name** | **str** | | [optional] +**owner** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EquinixCredentials.md b/docs/EquinixCredentials.md new file mode 100644 index 0000000..9881868 --- /dev/null +++ b/docs/EquinixCredentials.md @@ -0,0 +1,13 @@ +# EquinixCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | | [optional] +**client_secret** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EquinixLocationInfo.md b/docs/EquinixLocationInfo.md new file mode 100644 index 0000000..ece069b --- /dev/null +++ b/docs/EquinixLocationInfo.md @@ -0,0 +1,18 @@ +# EquinixLocationInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eq_billing_account_info_list** | [**[MultiCloudEdgeBillingAccountInfo]**](MultiCloudEdgeBillingAccountInfo.md) | | [optional] +**eq_ne_info** | [**EquinixNEInfo**](EquinixNEInfo.md) | | [optional] +**metro_code** | **str** | | [optional] +**metro_name** | **str** | | [optional] +**network_region** | **str** | | [optional] +**site_code** | **str** | | [optional] +**status** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EquinixNEInfo.md b/docs/EquinixNEInfo.md new file mode 100644 index 0000000..869883b --- /dev/null +++ b/docs/EquinixNEInfo.md @@ -0,0 +1,13 @@ +# EquinixNEInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image_name_list** | **[str]** | | [optional] +**product_size_list** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EquinixPartnerPort.md b/docs/EquinixPartnerPort.md new file mode 100644 index 0000000..fcb3f77 --- /dev/null +++ b/docs/EquinixPartnerPort.md @@ -0,0 +1,18 @@ +# EquinixPartnerPort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authorization_key** | **str** | | [optional] +**company_uid** | **str** | | [optional] +**connect_type** | **str** | | [optional] +**product_uid** | **str** | | [optional] +**speed** | **str** | | [optional] +**vxc_id** | **str** | | [optional] +**vxc_permitted** | **bool** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Ethernet.md b/docs/Ethernet.md new file mode 100644 index 0000000..fc12697 --- /dev/null +++ b/docs/Ethernet.md @@ -0,0 +1,20 @@ +# Ethernet + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**ethernet_interface_list** | [**[EthernetInterface]**](EthernetInterface.md) | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EthernetAllOf.md b/docs/EthernetAllOf.md new file mode 100644 index 0000000..95db4db --- /dev/null +++ b/docs/EthernetAllOf.md @@ -0,0 +1,12 @@ +# EthernetAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ethernet_interface_list** | [**[EthernetInterface]**](EthernetInterface.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EthernetInterface.md b/docs/EthernetInterface.md new file mode 100644 index 0000000..c526d08 --- /dev/null +++ b/docs/EthernetInterface.md @@ -0,0 +1,20 @@ +# EthernetInterface + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**admin_state** | **str** | | [optional] +**corporate_lan** | **bool** | | [optional] +**interface_name** | **str** | | [optional] +**ip_assignment** | **str** | | [optional] +**port_type** | **str** | | [optional] +**static_ip_address** | **str** | | [optional] +**static_ip_address_subnet_mask** | **str** | | [optional] +**static_route_ip** | **str** | | [optional] +**wan_configuration** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EventName.md b/docs/EventName.md new file mode 100644 index 0000000..703e24e --- /dev/null +++ b/docs/EventName.md @@ -0,0 +1,13 @@ +# EventName + +This is valid eventName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/FeatureProfile.md b/docs/FeatureProfile.md new file mode 100644 index 0000000..85174b9 --- /dev/null +++ b/docs/FeatureProfile.md @@ -0,0 +1,21 @@ +# FeatureProfile + +List of devices UUIDs associated with this config group + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the feature Profile. Must be unique. | +**solution** | **str** | Solution of the feature Profile. | +**type** | **str** | Type of the feature Profile. | +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**description** | **str** | Description of the feature Profile. | [optional] +**id** | **str** | System generated unique identifier of the feature profile in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GcpCredentials.md b/docs/GcpCredentials.md new file mode 100644 index 0000000..76416c1 --- /dev/null +++ b/docs/GcpCredentials.md @@ -0,0 +1,19 @@ +# GcpCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_email** | **str** | | [optional] +**client_id** | **str** | | [optional] +**cloud_tenant_id** | **str** | | [optional] +**name** | **str** | | [optional] +**private_key_data** | **str** | | [optional] +**private_key** | **str** | | [optional] +**private_key_id** | **str** | | [optional] +**project_id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetO365PreferredPathFromVAnalyticsRequest.md b/docs/GetO365PreferredPathFromVAnalyticsRequest.md new file mode 100644 index 0000000..9bc0a3c --- /dev/null +++ b/docs/GetO365PreferredPathFromVAnalyticsRequest.md @@ -0,0 +1,13 @@ +# GetO365PreferredPathFromVAnalyticsRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value_type** | **str** | | [optional] +**empty** | **bool** | | [optional] +**any string name** | [**GetO365PreferredPathFromVAnalyticsRequestValue**](GetO365PreferredPathFromVAnalyticsRequestValue.md) | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetO365PreferredPathFromVAnalyticsRequestValue.md b/docs/GetO365PreferredPathFromVAnalyticsRequestValue.md new file mode 100644 index 0000000..52f0091 --- /dev/null +++ b/docs/GetO365PreferredPathFromVAnalyticsRequestValue.md @@ -0,0 +1,12 @@ +# GetO365PreferredPathFromVAnalyticsRequestValue + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value_type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GlobalSettings.md b/docs/GlobalSettings.md new file mode 100644 index 0000000..7e827df --- /dev/null +++ b/docs/GlobalSettings.md @@ -0,0 +1,29 @@ +# GlobalSettings + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**basic_name** | **str** | | [optional] +**basic_description** | **str** | | [optional] +**ntp_server** | [**[ConnectToNtpServer]**](ConnectToNtpServer.md) | | [optional] +**systems** | [**Systems**](Systems.md) | | [optional] +**banner** | [**Banner**](Banner.md) | | [optional] +**login_access_to_router** | [**LoginAccessToRouter**](LoginAccessToRouter.md) | | [optional] +**bfd** | [**Bfd**](Bfd.md) | | [optional] +**omp** | [**OMP**](OMP.md) | | [optional] +**ip_sec_security** | [**IpSecSecurity**](IpSecSecurity.md) | | [optional] +**logging_system_messages** | [**LoggingSystemMessages**](LoggingSystemMessages.md) | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GlobalSettingsAllOf.md b/docs/GlobalSettingsAllOf.md new file mode 100644 index 0000000..fb89e3d --- /dev/null +++ b/docs/GlobalSettingsAllOf.md @@ -0,0 +1,21 @@ +# GlobalSettingsAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**basic_name** | **str** | | [optional] +**basic_description** | **str** | | [optional] +**ntp_server** | [**[ConnectToNtpServer]**](ConnectToNtpServer.md) | | [optional] +**systems** | [**Systems**](Systems.md) | | [optional] +**banner** | [**Banner**](Banner.md) | | [optional] +**login_access_to_router** | [**LoginAccessToRouter**](LoginAccessToRouter.md) | | [optional] +**bfd** | [**Bfd**](Bfd.md) | | [optional] +**omp** | [**OMP**](OMP.md) | | [optional] +**ip_sec_security** | [**IpSecSecurity**](IpSecSecurity.md) | | [optional] +**logging_system_messages** | [**LoggingSystemMessages**](LoggingSystemMessages.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GroupId.md b/docs/GroupId.md new file mode 100644 index 0000000..2bcbb9b --- /dev/null +++ b/docs/GroupId.md @@ -0,0 +1,13 @@ +# GroupId + +This is the valid GroupId + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**group_id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GuestWifi.md b/docs/GuestWifi.md new file mode 100644 index 0000000..a8f75ca --- /dev/null +++ b/docs/GuestWifi.md @@ -0,0 +1,15 @@ +# GuestWifi + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**security_auth_type** | **str** | | [optional] +**ssid** | **str** | | [optional] +**visibility** | **bool** | | [optional] +**wpa_psk_key** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HSECApi.md b/docs/HSECApi.md new file mode 100644 index 0000000..7910314 --- /dev/null +++ b/docs/HSECApi.md @@ -0,0 +1,421 @@ +# openapi_client.HSECApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**assign_slac**](HSECApi.md#assign_slac) | **POST** /hsec/assignSlac | +[**device_summmary**](HSECApi.md#device_summmary) | **GET** /hsec/devices | +[**device_summmary1**](HSECApi.md#device_summmary1) | **GET** /hsec/devices/install | +[**download_slac_request_file**](HSECApi.md#download_slac_request_file) | **POST** /hsec/download | +[**fetch_accounts1**](HSECApi.md#fetch_accounts1) | **GET** /hsec/fetchaccounts | +[**upload_slac_file**](HSECApi.md#upload_slac_file) | **POST** /hsec/uploadAuth | + + +# **assign_slac** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} assign_slac() + + + +Assign Hsec License to devices from uploaded SLAC file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_api.HSECApi(api_client) + data = open('/path/to/file', 'rb') # file_type | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.assign_slac(data=data) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECApi->assign_slac: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | **file_type**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **device_summmary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} device_summmary() + + + +Give list of HSEC license devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_api.HSECApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.device_summmary() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECApi->device_summmary: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **device_summmary1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} device_summmary1() + + + +Give list of HSEC license devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_api.HSECApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.device_summmary1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECApi->device_summmary1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_slac_request_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download_slac_request_file() + + + +Download SLAC Request file for CSSM + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_api.HSECApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device List (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.download_slac_request_file(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECApi->download_slac_request_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device List | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fetch_accounts1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} fetch_accounts1(username, pwd, mode) + + + +fetch sava accounts that support HSEC Licensing + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_api.HSECApi(api_client) + username = "username_example" # str | userName + pwd = "pwd_example" # str | password + mode = "mode_example" # str | mode + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.fetch_accounts1(username, pwd, mode) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECApi->fetch_accounts1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **str**| userName | + **pwd** | **str**| password | + **mode** | **str**| mode | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_slac_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} upload_slac_file() + + + +upload SLAC File and fetch device summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_api.HSECApi(api_client) + data = open('/path/to/file', 'rb') # file_type | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.upload_slac_file(data=data) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECApi->upload_slac_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | **file_type**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/HSECLicenseApi.md b/docs/HSECLicenseApi.md new file mode 100644 index 0000000..2ffda1d --- /dev/null +++ b/docs/HSECLicenseApi.md @@ -0,0 +1,78 @@ +# openapi_client.HSECLicenseApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**hsecassign**](HSECLicenseApi.md#hsecassign) | **POST** /hsec/assign | + + +# **hsecassign** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} hsecassign() + + + +hsec + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_license_api.HSECLicenseApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.hsecassign(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling HSECLicenseApi->hsecassign: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Header.md b/docs/Header.md new file mode 100644 index 0000000..e070d84 --- /dev/null +++ b/docs/Header.md @@ -0,0 +1,14 @@ +# Header + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**elements** | [**[HeaderElement]**](HeaderElement.md) | | [optional] +**name** | **str** | | [optional] +**value** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HeaderElement.md b/docs/HeaderElement.md new file mode 100644 index 0000000..b786562 --- /dev/null +++ b/docs/HeaderElement.md @@ -0,0 +1,15 @@ +# HeaderElement + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**parameter_count** | **int** | | [optional] +**parameters** | [**[NameValuePair]**](NameValuePair.md) | | [optional] +**value** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Host.md b/docs/Host.md new file mode 100644 index 0000000..e0da679 --- /dev/null +++ b/docs/Host.md @@ -0,0 +1,17 @@ +# Host + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_center_name** | **str** | | [optional] +**dc_personality** | **str** | | [optional] +**ifname** | **str** | | [optional] +**ip** | **str** | | [optional] +**name** | **str** | | [optional] +**serialno** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HsecActivateApi.md b/docs/HsecActivateApi.md new file mode 100644 index 0000000..c94b6e6 --- /dev/null +++ b/docs/HsecActivateApi.md @@ -0,0 +1,77 @@ +# openapi_client.HsecActivateApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activate_hsec_licenses**](HsecActivateApi.md#activate_hsec_licenses) | **POST** /hsec/activate | + + +# **activate_hsec_licenses** +> activate_hsec_licenses() + + + +Activate Hsec licenses on devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import hsec_activate_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = hsec_activate_api.HsecActivateApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant List (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.activate_hsec_licenses(body=body) + except openapi_client.ApiException as e: + print("Exception when calling HsecActivateApi->activate_hsec_licenses: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant List | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/IkePhase.md b/docs/IkePhase.md new file mode 100644 index 0000000..ecb7a5e --- /dev/null +++ b/docs/IkePhase.md @@ -0,0 +1,15 @@ +# IkePhase + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cipher_suite** | **str** | | +**diffe_hellman_group** | **str** | | [optional] +**ike_version** | **int** | | [optional] +**rekey_timer** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpSecPolicy.md b/docs/IpSecPolicy.md new file mode 100644 index 0000000..57172e6 --- /dev/null +++ b/docs/IpSecPolicy.md @@ -0,0 +1,14 @@ +# IpSecPolicy + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ike_phase1** | [**IkePhase**](IkePhase.md) | | +**ike_phase2_cipher_suite** | **str** | | +**preset** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpSecSecurity.md b/docs/IpSecSecurity.md new file mode 100644 index 0000000..74b272d --- /dev/null +++ b/docs/IpSecSecurity.md @@ -0,0 +1,15 @@ +# IpSecSecurity + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authentication_type** | **str** | | [optional] +**ip_sec_pairwise_keying** | **str** | | [optional] +**rekey_time** | **int** | | [optional] +**replay_window** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LocaleApi.md b/docs/LocaleApi.md new file mode 100644 index 0000000..bd6f4da --- /dev/null +++ b/docs/LocaleApi.md @@ -0,0 +1,73 @@ +# openapi_client.LocaleApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_supported_locales**](LocaleApi.md#get_supported_locales) | **GET** /localization/supportedLocales | + + +# **get_supported_locales** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_supported_locales() + + + +Get Supported locales + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import locale_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = locale_api.LocaleApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_supported_locales() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling LocaleApi->get_supported_locales: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/LoggingSystemMessages.md b/docs/LoggingSystemMessages.md new file mode 100644 index 0000000..8f7f675 --- /dev/null +++ b/docs/LoggingSystemMessages.md @@ -0,0 +1,14 @@ +# LoggingSystemMessages + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_file_size** | **int** | | [optional] +**priority** | **str** | | [optional] +**rotations** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoginAccessToRouter.md b/docs/LoginAccessToRouter.md new file mode 100644 index 0000000..8482fb5 --- /dev/null +++ b/docs/LoginAccessToRouter.md @@ -0,0 +1,14 @@ +# LoginAccessToRouter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authentication_order** | **str** | | [optional] +**local_password** | **str** | | [optional] +**local_user** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LteTimer.md b/docs/LteTimer.md new file mode 100644 index 0000000..d252218 --- /dev/null +++ b/docs/LteTimer.md @@ -0,0 +1,15 @@ +# LteTimer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dscp** | **int** | | [optional] +**hello_interval** | **int** | | [optional] +**multiplier** | **int** | | [optional] +**path_mtu** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MSLAApi.md b/docs/MSLAApi.md new file mode 100644 index 0000000..372bcbf --- /dev/null +++ b/docs/MSLAApi.md @@ -0,0 +1,550 @@ +# openapi_client.MSLAApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_template**](MSLAApi.md#get_all_template) | **GET** /msla/template | +[**get_license_and_device_count**](MSLAApi.md#get_license_and_device_count) | **GET** /msla/monitoring/licensedDeviceCount | +[**get_license_and_device_count1**](MSLAApi.md#get_license_and_device_count1) | **GET** /msla/monitoring/licensedDistributionDetails | +[**get_msla_devices**](MSLAApi.md#get_msla_devices) | **GET** /msla/devices | +[**get_packaging_distribution_details**](MSLAApi.md#get_packaging_distribution_details) | **GET** /msla/monitoring/packagingDistributionDetails | +[**get_subscriptions**](MSLAApi.md#get_subscriptions) | **GET** /msla/va/License | +[**get_subscriptions1**](MSLAApi.md#get_subscriptions1) | **POST** /msla/template/licenses | +[**sync_licenses2**](MSLAApi.md#sync_licenses2) | **POST** /msla/licenses/sync | + + +# **get_all_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_template() + + + +Retrieve all MSLA template + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_template() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_all_template: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_and_device_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_and_device_count() + + + +get license and device count + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_license_and_device_count() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_license_and_device_count: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_and_device_count1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_and_device_count1() + + + +get license and device count + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_license_and_device_count1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_license_and_device_count1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_msla_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_msla_devices() + + + +Retrieve devices subscription + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_msla_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_msla_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_packaging_distribution_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_packaging_distribution_details() + + + +get packaging distribution details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_packaging_distribution_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_packaging_distribution_details: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscriptions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_subscriptions() + + + +Retrieve MSLA subscription/licenses + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + virtual_account_id = "virtual_account_id_example" # str | virtual_account_id (optional) + license_type = "licenseType_example" # str | licenseType (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_subscriptions(virtual_account_id=virtual_account_id, license_type=license_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_subscriptions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **virtual_account_id** | **str**| virtual_account_id | [optional] + **license_type** | **str**| licenseType | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscriptions1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_subscriptions1() + + + +Retrieve MSLA subscription/licenses + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_subscriptions1(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->get_subscriptions1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_licenses2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sync_licenses2() + + + +Retrieve MSLA subscription/licenses + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import msla_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = msla_api.MSLAApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Sync license (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.sync_licenses2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MSLAApi->sync_licenses2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Sync license | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MegaportCredentials.md b/docs/MegaportCredentials.md new file mode 100644 index 0000000..a2be6a6 --- /dev/null +++ b/docs/MegaportCredentials.md @@ -0,0 +1,13 @@ +# MegaportCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**username** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MegaportLocationInfo.md b/docs/MegaportLocationInfo.md new file mode 100644 index 0000000..1702bf7 --- /dev/null +++ b/docs/MegaportLocationInfo.md @@ -0,0 +1,20 @@ +# MegaportLocationInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address** | **str** | | [optional] +**country** | **str** | | [optional] +**live_date** | **str** | | [optional] +**market** | **str** | | [optional] +**metro_name** | **str** | | [optional] +**mp_mve_info** | [**MegaportMVEInfo**](MegaportMVEInfo.md) | | [optional] +**network_region** | **str** | | [optional] +**site_code** | **str** | | [optional] +**status** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MegaportMVEInfo.md b/docs/MegaportMVEInfo.md new file mode 100644 index 0000000..0f1edf3 --- /dev/null +++ b/docs/MegaportMVEInfo.md @@ -0,0 +1,13 @@ +# MegaportMVEInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image_name_list** | **[str]** | | [optional] +**product_size_list** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MegaportPartnerPort.md b/docs/MegaportPartnerPort.md new file mode 100644 index 0000000..51eeb42 --- /dev/null +++ b/docs/MegaportPartnerPort.md @@ -0,0 +1,18 @@ +# MegaportPartnerPort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authorization_key** | **str** | | [optional] +**company_uid** | **str** | | [optional] +**connect_type** | **str** | | [optional] +**product_uid** | **str** | | [optional] +**speed** | **str** | | [optional] +**vxc_id** | **str** | | [optional] +**vxc_permitted** | **bool** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitoringARTApi.md b/docs/MonitoringARTApi.md new file mode 100644 index 0000000..d1f84b1 --- /dev/null +++ b/docs/MonitoringARTApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringARTApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query3**](MonitoringARTApi.md#get_aggregation_data_by_query3) | **GET** /statistics/art/aggregation | +[**get_count5**](MonitoringARTApi.md#get_count5) | **GET** /statistics/art/doccount | +[**get_count_post5**](MonitoringARTApi.md#get_count_post5) | **POST** /statistics/art/doccount | +[**get_post_aggregation_app_data_by_query3**](MonitoringARTApi.md#get_post_aggregation_app_data_by_query3) | **POST** /statistics/art/app-agg/aggregation | +[**get_post_aggregation_data_by_query3**](MonitoringARTApi.md#get_post_aggregation_data_by_query3) | **POST** /statistics/art/aggregation | +[**get_post_stat_bulk_raw_data3**](MonitoringARTApi.md#get_post_stat_bulk_raw_data3) | **POST** /statistics/art/page | +[**get_stat_bulk_raw_data3**](MonitoringARTApi.md#get_stat_bulk_raw_data3) | **GET** /statistics/art/page | +[**get_stat_data_fields5**](MonitoringARTApi.md#get_stat_data_fields5) | **GET** /statistics/art/fields | +[**get_stat_data_raw_data3**](MonitoringARTApi.md#get_stat_data_raw_data3) | **GET** /statistics/art | +[**get_stat_data_raw_data_as_csv3**](MonitoringARTApi.md#get_stat_data_raw_data_as_csv3) | **GET** /statistics/art/csv | +[**get_stat_query_fields5**](MonitoringARTApi.md#get_stat_query_fields5) | **GET** /statistics/art/query/fields | +[**get_stats_raw_data3**](MonitoringARTApi.md#get_stats_raw_data3) | **POST** /statistics/art | + + +# **get_aggregation_data_by_query3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query3() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query3(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_aggregation_data_by_query3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count5(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count5(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_count5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post5() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_count_post5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query3() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_post_aggregation_app_data_by_query3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query3() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_post_aggregation_data_by_query3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data3() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data3(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_post_stat_bulk_raw_data3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data3() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data3(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_stat_bulk_raw_data3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields5() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields5() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_stat_data_fields5: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data3() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data3(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_stat_data_raw_data3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv3** +> str get_stat_data_raw_data_as_csv3() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv3(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_stat_data_raw_data_as_csv3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields5() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields5() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_stat_query_fields5: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data3() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_art_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_art_api.MonitoringARTApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data3(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringARTApi->get_stats_raw_data3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringAlarmsDetailsApi.md b/docs/MonitoringAlarmsDetailsApi.md new file mode 100644 index 0000000..8fc859d --- /dev/null +++ b/docs/MonitoringAlarmsDetailsApi.md @@ -0,0 +1,2361 @@ +# openapi_client.MonitoringAlarmsDetailsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**clear_stale_alarm**](MonitoringAlarmsDetailsApi.md#clear_stale_alarm) | **POST** /alarms/clear | +[**correl_anti_entropy**](MonitoringAlarmsDetailsApi.md#correl_anti_entropy) | **GET** /alarms/reset | +[**create_alarm_query_config**](MonitoringAlarmsDetailsApi.md#create_alarm_query_config) | **GET** /alarms/query/input | +[**disable_enable_alarm**](MonitoringAlarmsDetailsApi.md#disable_enable_alarm) | **POST** /alarms/disabled | +[**dump_correlation_engine_data**](MonitoringAlarmsDetailsApi.md#dump_correlation_engine_data) | **POST** /alarms/dump | +[**enable_disable_link_state_alarm**](MonitoringAlarmsDetailsApi.md#enable_disable_link_state_alarm) | **POST** /alarms/link-state-alarm | +[**get_alarm_aggregation_data**](MonitoringAlarmsDetailsApi.md#get_alarm_aggregation_data) | **GET** /alarms/aggregation | +[**get_alarm_details**](MonitoringAlarmsDetailsApi.md#get_alarm_details) | **GET** /alarms/uuid/{alarm_uuid} | +[**get_alarm_severity_custom_histogram**](MonitoringAlarmsDetailsApi.md#get_alarm_severity_custom_histogram) | **GET** /alarms/severity/summary | +[**get_alarm_severity_mappings**](MonitoringAlarmsDetailsApi.md#get_alarm_severity_mappings) | **GET** /alarms/severitymappings | +[**get_alarm_types_as_key_value**](MonitoringAlarmsDetailsApi.md#get_alarm_types_as_key_value) | **GET** /alarms/rulenamedisplay/keyvalue | +[**get_alarms**](MonitoringAlarmsDetailsApi.md#get_alarms) | **GET** /alarms | +[**get_alarms_by_severity**](MonitoringAlarmsDetailsApi.md#get_alarms_by_severity) | **GET** /alarms/severity | +[**get_count1**](MonitoringAlarmsDetailsApi.md#get_count1) | **GET** /alarms/doccount | +[**get_count_post1**](MonitoringAlarmsDetailsApi.md#get_count_post1) | **POST** /alarms/doccount | +[**get_device_topic**](MonitoringAlarmsDetailsApi.md#get_device_topic) | **GET** /alarms/topic | +[**get_link_state_alarm_config**](MonitoringAlarmsDetailsApi.md#get_link_state_alarm_config) | **GET** /alarms/link-state-alarm | +[**get_master_manager_state**](MonitoringAlarmsDetailsApi.md#get_master_manager_state) | **GET** /alarms/master | +[**get_non_viewed_active_alarms_count**](MonitoringAlarmsDetailsApi.md#get_non_viewed_active_alarms_count) | **GET** /alarms/count | +[**get_non_viewed_alarms**](MonitoringAlarmsDetailsApi.md#get_non_viewed_alarms) | **GET** /alarms/notviewed | +[**get_post_alarm_aggregation_data**](MonitoringAlarmsDetailsApi.md#get_post_alarm_aggregation_data) | **POST** /alarms/aggregation | +[**get_post_stat_bulk_alarm_raw_data**](MonitoringAlarmsDetailsApi.md#get_post_stat_bulk_alarm_raw_data) | **POST** /alarms/page | +[**get_raw_alarm_data**](MonitoringAlarmsDetailsApi.md#get_raw_alarm_data) | **POST** /alarms | +[**get_stat_bulk_alarm_raw_data**](MonitoringAlarmsDetailsApi.md#get_stat_bulk_alarm_raw_data) | **GET** /alarms/page | +[**get_stat_data_fields1**](MonitoringAlarmsDetailsApi.md#get_stat_data_fields1) | **GET** /alarms/fields | +[**get_stat_query_fields1**](MonitoringAlarmsDetailsApi.md#get_stat_query_fields1) | **GET** /alarms/query/fields | +[**get_stats**](MonitoringAlarmsDetailsApi.md#get_stats) | **GET** /alarms/stats | +[**list_disabled_alarm**](MonitoringAlarmsDetailsApi.md#list_disabled_alarm) | **GET** /alarms/disabled | +[**mark_alarms_as_viewed**](MonitoringAlarmsDetailsApi.md#mark_alarms_as_viewed) | **POST** /alarms/markviewed | +[**mark_all_alarms_as_viewed**](MonitoringAlarmsDetailsApi.md#mark_all_alarms_as_viewed) | **POST** /alarms/markallasviewed | +[**restart_correlation_engine**](MonitoringAlarmsDetailsApi.md#restart_correlation_engine) | **GET** /alarms/restart | +[**set_periodic_purge_timer**](MonitoringAlarmsDetailsApi.md#set_periodic_purge_timer) | **GET** /alarms/purgefrequency | +[**start_tracking**](MonitoringAlarmsDetailsApi.md#start_tracking) | **POST** /alarms/starttracking/{testName} | +[**stop_tracking**](MonitoringAlarmsDetailsApi.md#stop_tracking) | **POST** /alarms/stoptracking/{testName} | + + +# **clear_stale_alarm** +> clear_stale_alarm() + + + +Clears specific stale alarm + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + request_body = {"alarm_uuid":"29f9bf31-0fbe-4114-b8f0-e6234699485c"} # [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] | alarm_uuid (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.clear_stale_alarm(request_body=request_body) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->clear_stale_alarm: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]**| alarm_uuid | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **correl_anti_entropy** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} correl_anti_entropy() + + + +Reset correlation engine data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.correl_anti_entropy() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->correl_anti_entropy: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_alarm_query_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_alarm_query_config() + + + +Get query configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_alarm_query_config() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->create_alarm_query_config: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disable_enable_alarm** +> disable_enable_alarm(event_name, disable, time) + + + +Enable/Disable a specific alarm + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + event_name = "eventName_example" # str | Event name + disable = True # bool | Disable + time = 1 # int | time in hours [1, 72], -1 means infinite + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | alarm config (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.disable_enable_alarm(event_name, disable, time) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->disable_enable_alarm: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.disable_enable_alarm(event_name, disable, time, body=body) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->disable_enable_alarm: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **event_name** | **str**| Event name | + **disable** | **bool**| Disable | + **time** | **int**| time in hours [1, 72], -1 means infinite | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| alarm config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **dump_correlation_engine_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} dump_correlation_engine_data() + + + +dump correlation engine server data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.dump_correlation_engine_data() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->dump_correlation_engine_data: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable_disable_link_state_alarm** +> enable_disable_link_state_alarm(link_name, enable) + + + +Enable/Disable a specific link-state alarm + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + link_name = "linkName_example" # str | Link name (bgp, ospf) + enable = True # bool | Enable + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | alarm config (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.enable_disable_link_state_alarm(link_name, enable) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->enable_disable_link_state_alarm: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.enable_disable_link_state_alarm(link_name, enable, body=body) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->enable_disable_link_state_alarm: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **link_name** | **str**| Link name (bgp, ospf) | + **enable** | **bool**| Enable | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| alarm config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarm_aggregation_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarm_aggregation_data() + + + +Gets aggregated list of alarms along with the raw alarm data of each aggregation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["24"],"operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"severity","order":"asc","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"}}}" # str | Alarm query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_alarm_aggregation_data(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarm_aggregation_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Alarm query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarm_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarm_details() + + + +Get alarm detail + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_alarm_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarm_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **alarm_uuid** | **str**| Alarm Id | defaults to "b28d5637-d966-4898-a103-7e7e8d595b50" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarm_severity_custom_histogram** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarm_severity_custom_histogram(query) + + + +Get alarm severity histogram + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + query = "query_example" # str | Alarm histogram query string + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_alarm_severity_custom_histogram(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarm_severity_custom_histogram: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Alarm histogram query string | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarm_severity_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarm_severity_mappings() + + + +Gets alarm severity mappings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_alarm_severity_mappings() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarm_severity_mappings: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarm_types_as_key_value** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarm_types_as_key_value() + + + +Gets alarm type as key value pair + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_alarm_types_as_key_value() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarm_types_as_key_value: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarms** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarms() + + + +Get alarms for last 30min if vManage query is not specified + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + query = "{"query":{"field":"active","type":"boolean","value":["true"],"operator":"equal"}}" # str | Alarm query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_alarms(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarms: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Alarm query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_alarms_by_severity** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_alarms_by_severity(severity_level, device_id, query) + + + +Get alarm by severity + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + severity_level = [ + "major", + ] # [str] | Alarm severity + device_id = [ + "deviceId_example", + ] # [str] | Device Id + query = "query_example" # str | Query filter + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_alarms_by_severity(severity_level, device_id, query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_alarms_by_severity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **severity_level** | **[str]**| Alarm severity | + **device_id** | **[str]**| Device Id | + **query** | **str**| Query filter | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count1(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count1(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_count1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post1() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_count_post1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_topic** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_topic(ip) + + + +Get device topic state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + ip = "172.16.255.14" # str | Query topic + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_topic(ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_device_topic: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ip** | **str**| Query topic | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_link_state_alarm_config** +> get_link_state_alarm_config() + + + +Get configuration for link-state alarm + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_link_state_alarm_config() + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_link_state_alarm_config: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_master_manager_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_master_manager_state() + + + +Get master manager state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_master_manager_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_master_manager_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_non_viewed_active_alarms_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_non_viewed_active_alarms_count() + + + +Get count of the alarms which are active and acknowledged by the user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_non_viewed_active_alarms_count() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_non_viewed_active_alarms_count: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_non_viewed_alarms** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_non_viewed_alarms() + + + +Get alarms which are active and acknowledged by the user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_non_viewed_alarms() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_non_viewed_alarms: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_alarm_aggregation_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_alarm_aggregation_data() + + + +Gets aggregated list of alarms along with the raw alarm data of each aggregation + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Input query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_alarm_aggregation_data(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_post_alarm_aggregation_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Input query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_alarm_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_alarm_raw_data(scroll_id, count) + + + +Get paginated alarm raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | Query offset + count = 10 # int | Query size + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Alarm query string (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_post_stat_bulk_alarm_raw_data(scroll_id, count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_post_stat_bulk_alarm_raw_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_alarm_raw_data(scroll_id, count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_post_stat_bulk_alarm_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| Query offset | + **count** | **int**| Query size | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Alarm query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_raw_alarm_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_raw_alarm_data() + + + +Gets lists of alarms along with the raw alarm data of each. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Alarm query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_raw_alarm_data(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_raw_alarm_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Alarm query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_alarm_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_alarm_raw_data(query, scroll_id, count) + + + +Get paginated alarm raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + query = "{"query":{"field":"active","type":"boolean","value":["true"],"operator":"equal"}}" # str | Alarm query string + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | Query offset + count = 10 # int | Query size + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_stat_bulk_alarm_raw_data(query, scroll_id, count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_stat_bulk_alarm_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Alarm query string | + **scroll_id** | **str**| Query offset | + **count** | **int**| Query size | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields1() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_stat_data_fields1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields1() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields1() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_stat_query_fields1: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats() + + + +Get alarm statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stats() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->get_stats: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_disabled_alarm** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_disabled_alarm() + + + +List all disabled alarms + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_disabled_alarm() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->list_disabled_alarm: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **mark_alarms_as_viewed** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} mark_alarms_as_viewed() + + + +Mark alarms as acknowledged by the user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + request_body = {"uuid":["29f9bf31-0fbe-4114-b8f0-e6234699485c"]} # [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] | List of alarms (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.mark_alarms_as_viewed(request_body=request_body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->mark_alarms_as_viewed: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]**| List of alarms | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **mark_all_alarms_as_viewed** +> mark_all_alarms_as_viewed() + + + +Mark all larms as acknowledged by the user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + type = "type_example" # str | Query filter, possible value are \"active\" \"cleared\" (optional) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.mark_all_alarms_as_viewed(type=type, body=body) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->mark_all_alarms_as_viewed: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Query filter, possible value are \"active\" \"cleared\" | [optional] + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restart_correlation_engine** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} restart_correlation_engine() + + + +Restart correlation engine + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.restart_correlation_engine() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->restart_correlation_engine: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_periodic_purge_timer** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_periodic_purge_timer() + + + +Set alarm purge timer + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + interval = "interval_example" # str | Purge interval (optional) + active_time = "activeTime_example" # str | Purge activeTime (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.set_periodic_purge_timer(interval=interval, active_time=active_time) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->set_periodic_purge_timer: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **interval** | **str**| Purge interval | [optional] + **active_time** | **str**| Purge activeTime | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **start_tracking** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} start_tracking(test_name) + + + +Start tracking events + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + test_name = "testName_example" # str | test name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.start_tracking(test_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->start_tracking: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **test_name** | **str**| test name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stop_tracking** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} stop_tracking(test_name) + + + +Stop tracking events + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_details_api.MonitoringAlarmsDetailsApi(api_client) + test_name = "testName_example" # str | test name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.stop_tracking(test_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsDetailsApi->stop_tracking: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **test_name** | **str**| test name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringAlarmsNotificationApi.md b/docs/MonitoringAlarmsNotificationApi.md new file mode 100644 index 0000000..0f19b40 --- /dev/null +++ b/docs/MonitoringAlarmsNotificationApi.md @@ -0,0 +1,293 @@ +# openapi_client.MonitoringAlarmsNotificationApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_notification_rule**](MonitoringAlarmsNotificationApi.md#create_notification_rule) | **POST** /notifications/rule | +[**delete_notification_rule**](MonitoringAlarmsNotificationApi.md#delete_notification_rule) | **DELETE** /notifications/rules | +[**get_notification_rule**](MonitoringAlarmsNotificationApi.md#get_notification_rule) | **GET** /notifications/rules | +[**update_notification_rule**](MonitoringAlarmsNotificationApi.md#update_notification_rule) | **PUT** /notifications/rule | + + +# **create_notification_rule** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_notification_rule() + + + +Add notification rule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_notification_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_notification_api.MonitoringAlarmsNotificationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Notification rule (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_notification_rule(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsNotificationApi->create_notification_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Notification rule | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Accepted | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_notification_rule** +> delete_notification_rule(rule_id) + + + +Delete notification rule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_notification_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_notification_api.MonitoringAlarmsNotificationApi(api_client) + rule_id = "ruleId_example" # str | Rule Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_notification_rule(rule_id) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsNotificationApi->delete_notification_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **str**| Rule Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_notification_rule** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_notification_rule() + + + +Get all rules or specific notification rule by its Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_notification_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_notification_api.MonitoringAlarmsNotificationApi(api_client) + rule_id = "ruleId_example" # str | Rule Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_notification_rule(rule_id=rule_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsNotificationApi->get_notification_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **str**| Rule Id | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_notification_rule** +> update_notification_rule(rule_id) + + + +Update notification rule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_alarms_notification_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_alarms_notification_api.MonitoringAlarmsNotificationApi(api_client) + rule_id = "ruleId_example" # str | Rule Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Notification rule (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_notification_rule(rule_id) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsNotificationApi->update_notification_rule: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_notification_rule(rule_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAlarmsNotificationApi->update_notification_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **str**| Rule Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Notification rule | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringAppHostingApi.md b/docs/MonitoringAppHostingApi.md new file mode 100644 index 0000000..a2ffe6c --- /dev/null +++ b/docs/MonitoringAppHostingApi.md @@ -0,0 +1,1714 @@ +# openapi_client.MonitoringAppHostingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query**](MonitoringAppHostingApi.md#get_aggregation_data_by_query) | **GET** /statistics/apphostinginterface/aggregation | +[**get_aggregation_data_by_query1**](MonitoringAppHostingApi.md#get_aggregation_data_by_query1) | **GET** /statistics/apphosting/aggregation | +[**get_count2**](MonitoringAppHostingApi.md#get_count2) | **GET** /statistics/apphostinginterface/doccount | +[**get_count3**](MonitoringAppHostingApi.md#get_count3) | **GET** /statistics/apphosting/doccount | +[**get_count_post2**](MonitoringAppHostingApi.md#get_count_post2) | **POST** /statistics/apphostinginterface/doccount | +[**get_count_post3**](MonitoringAppHostingApi.md#get_count_post3) | **POST** /statistics/apphosting/doccount | +[**get_post_aggregation_app_data_by_query**](MonitoringAppHostingApi.md#get_post_aggregation_app_data_by_query) | **POST** /statistics/apphostinginterface/app-agg/aggregation | +[**get_post_aggregation_app_data_by_query1**](MonitoringAppHostingApi.md#get_post_aggregation_app_data_by_query1) | **POST** /statistics/apphosting/app-agg/aggregation | +[**get_post_aggregation_data_by_query**](MonitoringAppHostingApi.md#get_post_aggregation_data_by_query) | **POST** /statistics/apphostinginterface/aggregation | +[**get_post_aggregation_data_by_query1**](MonitoringAppHostingApi.md#get_post_aggregation_data_by_query1) | **POST** /statistics/apphosting/aggregation | +[**get_post_stat_bulk_raw_data**](MonitoringAppHostingApi.md#get_post_stat_bulk_raw_data) | **POST** /statistics/apphostinginterface/page | +[**get_post_stat_bulk_raw_data1**](MonitoringAppHostingApi.md#get_post_stat_bulk_raw_data1) | **POST** /statistics/apphosting/page | +[**get_stat_bulk_raw_data**](MonitoringAppHostingApi.md#get_stat_bulk_raw_data) | **GET** /statistics/apphostinginterface/page | +[**get_stat_bulk_raw_data1**](MonitoringAppHostingApi.md#get_stat_bulk_raw_data1) | **GET** /statistics/apphosting/page | +[**get_stat_data_fields2**](MonitoringAppHostingApi.md#get_stat_data_fields2) | **GET** /statistics/apphostinginterface/fields | +[**get_stat_data_fields3**](MonitoringAppHostingApi.md#get_stat_data_fields3) | **GET** /statistics/apphosting/fields | +[**get_stat_data_raw_data**](MonitoringAppHostingApi.md#get_stat_data_raw_data) | **GET** /statistics/apphostinginterface | +[**get_stat_data_raw_data1**](MonitoringAppHostingApi.md#get_stat_data_raw_data1) | **GET** /statistics/apphosting | +[**get_stat_data_raw_data_as_csv**](MonitoringAppHostingApi.md#get_stat_data_raw_data_as_csv) | **GET** /statistics/apphostinginterface/csv | +[**get_stat_data_raw_data_as_csv1**](MonitoringAppHostingApi.md#get_stat_data_raw_data_as_csv1) | **GET** /statistics/apphosting/csv | +[**get_stat_query_fields2**](MonitoringAppHostingApi.md#get_stat_query_fields2) | **GET** /statistics/apphostinginterface/query/fields | +[**get_stat_query_fields3**](MonitoringAppHostingApi.md#get_stat_query_fields3) | **GET** /statistics/apphosting/query/fields | +[**get_stats_raw_data**](MonitoringAppHostingApi.md#get_stats_raw_data) | **POST** /statistics/apphostinginterface | +[**get_stats_raw_data1**](MonitoringAppHostingApi.md#get_stats_raw_data1) | **POST** /statistics/apphosting | + + +# **get_aggregation_data_by_query** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_aggregation_data_by_query: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query1() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query1(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_aggregation_data_by_query1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count2(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count2(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_count2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count3(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count3(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_count3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post2() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_count_post2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post3() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post3(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_count_post3: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_post_aggregation_app_data_by_query: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query1() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_post_aggregation_app_data_by_query1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_post_aggregation_data_by_query: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query1() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_post_aggregation_data_by_query1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_post_stat_bulk_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data1() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data1(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_post_stat_bulk_raw_data1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_bulk_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data1() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data1(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_bulk_raw_data1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields2() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields2() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_data_fields2: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields3() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields3() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_data_fields3: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_data_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data1() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data1(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_data_raw_data1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv** +> str get_stat_data_raw_data_as_csv() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_data_raw_data_as_csv: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv1** +> str get_stat_data_raw_data_as_csv1() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv1(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_data_raw_data_as_csv1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields2() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields2() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_query_fields2: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields3** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields3() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields3() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stat_query_fields3: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stats_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data1() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_app_hosting_api.MonitoringAppHostingApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data1(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringAppHostingApi->get_stats_raw_data1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringApplicationAwareRoutingApi.md b/docs/MonitoringApplicationAwareRoutingApi.md new file mode 100644 index 0000000..9d43d24 --- /dev/null +++ b/docs/MonitoringApplicationAwareRoutingApi.md @@ -0,0 +1,1547 @@ +# openapi_client.MonitoringApplicationAwareRoutingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_app_route**](MonitoringApplicationAwareRoutingApi.md#get_aggregation_data_app_route) | **POST** /statistics/approute/fec/aggregation | +[**get_aggregation_data_by_query2**](MonitoringApplicationAwareRoutingApi.md#get_aggregation_data_by_query2) | **GET** /statistics/approute/aggregation | +[**get_approute_grid_stat**](MonitoringApplicationAwareRoutingApi.md#get_approute_grid_stat) | **GET** /statistics/approute/device/tunnel/summary | +[**get_count4**](MonitoringApplicationAwareRoutingApi.md#get_count4) | **GET** /statistics/approute/doccount | +[**get_count_post4**](MonitoringApplicationAwareRoutingApi.md#get_count_post4) | **POST** /statistics/approute/doccount | +[**get_post_aggregation_app_data_by_query2**](MonitoringApplicationAwareRoutingApi.md#get_post_aggregation_app_data_by_query2) | **POST** /statistics/approute/app-agg/aggregation | +[**get_post_aggregation_data_by_query2**](MonitoringApplicationAwareRoutingApi.md#get_post_aggregation_data_by_query2) | **POST** /statistics/approute/aggregation | +[**get_post_stat_bulk_raw_data2**](MonitoringApplicationAwareRoutingApi.md#get_post_stat_bulk_raw_data2) | **POST** /statistics/approute/page | +[**get_stat_bulk_raw_data2**](MonitoringApplicationAwareRoutingApi.md#get_stat_bulk_raw_data2) | **GET** /statistics/approute/page | +[**get_stat_data_fields4**](MonitoringApplicationAwareRoutingApi.md#get_stat_data_fields4) | **GET** /statistics/approute/fields | +[**get_stat_data_raw_data2**](MonitoringApplicationAwareRoutingApi.md#get_stat_data_raw_data2) | **GET** /statistics/approute | +[**get_stat_data_raw_data_as_csv2**](MonitoringApplicationAwareRoutingApi.md#get_stat_data_raw_data_as_csv2) | **GET** /statistics/approute/csv | +[**get_stat_query_fields4**](MonitoringApplicationAwareRoutingApi.md#get_stat_query_fields4) | **GET** /statistics/approute/query/fields | +[**get_stats_raw_data2**](MonitoringApplicationAwareRoutingApi.md#get_stats_raw_data2) | **POST** /statistics/approute | +[**get_transport_health**](MonitoringApplicationAwareRoutingApi.md#get_transport_health) | **GET** /statistics/approute/transport/{type} | +[**get_transport_health_summary**](MonitoringApplicationAwareRoutingApi.md#get_transport_health_summary) | **GET** /statistics/approute/transport/summary/{type} | +[**get_tunnel**](MonitoringApplicationAwareRoutingApi.md#get_tunnel) | **GET** /statistics/approute/device/tunnels | +[**get_tunnel_chart**](MonitoringApplicationAwareRoutingApi.md#get_tunnel_chart) | **GET** /statistics/approute/tunnel/{type}/summary | +[**get_tunnels**](MonitoringApplicationAwareRoutingApi.md#get_tunnels) | **GET** /statistics/approute/tunnels/{type} | +[**get_tunnels_health**](MonitoringApplicationAwareRoutingApi.md#get_tunnels_health) | **GET** /statistics/approute/tunnels/health/{type} | +[**get_tunnels_summary**](MonitoringApplicationAwareRoutingApi.md#get_tunnels_summary) | **GET** /statistics/approute/tunnels/summary/{type} | + + +# **get_aggregation_data_app_route** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_app_route() + + + +Get aggregation data and fec recovery rate + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_app_route(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_aggregation_data_app_route: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query2() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query2(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_aggregation_data_by_query2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_approute_grid_stat** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_approute_grid_stat() + + + +Get statistics for top applications per tunnel in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_approute_grid_stat(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_approute_grid_stat: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count4(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count4(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_count4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post4() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_count_post4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query2() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_post_aggregation_app_data_by_query2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query2() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query2(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_post_aggregation_data_by_query2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data2() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data2(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_post_stat_bulk_raw_data2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data2() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data2(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_stat_bulk_raw_data2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields4() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields4() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_stat_data_fields4: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data2() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data2(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_stat_data_raw_data2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv2** +> str get_stat_data_raw_data_as_csv2() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv2(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_stat_data_raw_data_as_csv2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields4() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields4() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_stat_query_fields4: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data2** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data2() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data2(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_stats_raw_data2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transport_health** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_transport_health(type, limit) + + + +Get application-aware routing statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + type = "type_example" # str | Type + limit = "limit_example" # str | Query filter + query = "query_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transport_health(type, limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_transport_health: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transport_health(type, limit, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_transport_health: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type | + **limit** | **str**| Query filter | + **query** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transport_health_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_transport_health_summary(type) + + + +Get application-aware routing statistics summary from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + type = "type_example" # str | Type (example:latency) + limit = 5 # int | Query result size (optional) if omitted the server will use the default value of 5 + query = "{"query":{"condition":"AND","rules":[{"operator":"last_n_hours","value":["12"],"field":"entry_time","type":"date"}],"type":"latency"}}" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transport_health_summary(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_transport_health_summary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transport_health_summary(type, limit=limit, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_transport_health_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type (example:latency) | + **limit** | **int**| Query result size | [optional] if omitted the server will use the default value of 5 + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tunnel** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tunnel() + + + +Get statistics for top applications per tunnel in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_tunnel(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnel: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tunnel_chart** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tunnel_chart(type, query) + + + +Get tunnel top statistics in as chart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + type = "type_example" # str | Type + query = "query_example" # str | Query filter + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tunnel_chart(type, query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnel_chart: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type | + **query** | **str**| Query filter | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tunnels** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tunnels(type) + + + +Get tunnel top statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + type = "type_example" # str | Type + query = "query_example" # str | Query filter (optional) + limit = 1 # int | Query result size (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tunnels(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnels: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_tunnels(type, query=query, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type | + **query** | **str**| Query filter | [optional] + **limit** | **int**| Query result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tunnels_health** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tunnels_health(type) + + + +Get tunnel health + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + type = "type_example" # str | Type (example:latency) + limit = 10 # int | Query result size (optional) if omitted the server will use the default value of 10 + last_n_hours = 3 # int | Time range for health average (optional) if omitted the server will use the default value of 3 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tunnels_health(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnels_health: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_tunnels_health(type, limit=limit, last_n_hours=last_n_hours) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnels_health: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type (example:latency) | + **limit** | **int**| Query result size | [optional] if omitted the server will use the default value of 10 + **last_n_hours** | **int**| Time range for health average | [optional] if omitted the server will use the default value of 3 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tunnels_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tunnels_summary(type) + + + +Get tunnel top statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_api.MonitoringApplicationAwareRoutingApi(api_client) + type = "type_example" # str | Type + query = "query_example" # str | Query filter (optional) + limit = 10 # int | Query result size (optional) if omitted the server will use the default value of 10 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tunnels_summary(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnels_summary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_tunnels_summary(type, query=query, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingApi->get_tunnels_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type | + **query** | **str**| Query filter | [optional] + **limit** | **int**| Query result size | [optional] if omitted the server will use the default value of 10 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringApplicationAwareRoutingStatisticsApi.md b/docs/MonitoringApplicationAwareRoutingStatisticsApi.md new file mode 100644 index 0000000..92cbe12 --- /dev/null +++ b/docs/MonitoringApplicationAwareRoutingStatisticsApi.md @@ -0,0 +1,170 @@ +# openapi_client.MonitoringApplicationAwareRoutingStatisticsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_transport_health**](MonitoringApplicationAwareRoutingStatisticsApi.md#get_transport_health) | **GET** /statistics/approute/transport/{type} | +[**get_transport_health_summary**](MonitoringApplicationAwareRoutingStatisticsApi.md#get_transport_health_summary) | **GET** /statistics/approute/transport/summary/{type} | + + +# **get_transport_health** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_transport_health(type, limit) + + + +Get application-aware routing statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_statistics_api.MonitoringApplicationAwareRoutingStatisticsApi(api_client) + type = "type_example" # str | Type + limit = "limit_example" # str | Query filter + query = "query_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transport_health(type, limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingStatisticsApi->get_transport_health: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transport_health(type, limit, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingStatisticsApi->get_transport_health: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type | + **limit** | **str**| Query filter | + **query** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_transport_health_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_transport_health_summary(type) + + + +Get application-aware routing statistics summary from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_application_aware_routing_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_application_aware_routing_statistics_api.MonitoringApplicationAwareRoutingStatisticsApi(api_client) + type = "type_example" # str | Type (example:latency) + limit = 5 # int | Query result size (optional) if omitted the server will use the default value of 5 + query = "{"query":{"condition":"AND","rules":[{"operator":"last_n_hours","value":["12"],"field":"entry_time","type":"date"}],"type":"latency"}}" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transport_health_summary(type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingStatisticsApi->get_transport_health_summary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transport_health_summary(type, limit=limit, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringApplicationAwareRoutingStatisticsApi->get_transport_health_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Type (example:latency) | + **limit** | **int**| Query result size | [optional] if omitted the server will use the default value of 5 + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringBFDApi.md b/docs/MonitoringBFDApi.md new file mode 100644 index 0000000..3954fee --- /dev/null +++ b/docs/MonitoringBFDApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringBFDApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query4**](MonitoringBFDApi.md#get_aggregation_data_by_query4) | **GET** /statistics/bfd/aggregation | +[**get_count6**](MonitoringBFDApi.md#get_count6) | **GET** /statistics/bfd/doccount | +[**get_count_post6**](MonitoringBFDApi.md#get_count_post6) | **POST** /statistics/bfd/doccount | +[**get_post_aggregation_app_data_by_query4**](MonitoringBFDApi.md#get_post_aggregation_app_data_by_query4) | **POST** /statistics/bfd/app-agg/aggregation | +[**get_post_aggregation_data_by_query4**](MonitoringBFDApi.md#get_post_aggregation_data_by_query4) | **POST** /statistics/bfd/aggregation | +[**get_post_stat_bulk_raw_data4**](MonitoringBFDApi.md#get_post_stat_bulk_raw_data4) | **POST** /statistics/bfd/page | +[**get_stat_bulk_raw_data4**](MonitoringBFDApi.md#get_stat_bulk_raw_data4) | **GET** /statistics/bfd/page | +[**get_stat_data_fields6**](MonitoringBFDApi.md#get_stat_data_fields6) | **GET** /statistics/bfd/fields | +[**get_stat_data_raw_data4**](MonitoringBFDApi.md#get_stat_data_raw_data4) | **GET** /statistics/bfd | +[**get_stat_data_raw_data_as_csv4**](MonitoringBFDApi.md#get_stat_data_raw_data_as_csv4) | **GET** /statistics/bfd/csv | +[**get_stat_query_fields6**](MonitoringBFDApi.md#get_stat_query_fields6) | **GET** /statistics/bfd/query/fields | +[**get_stats_raw_data4**](MonitoringBFDApi.md#get_stats_raw_data4) | **POST** /statistics/bfd | + + +# **get_aggregation_data_by_query4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query4() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query4(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_aggregation_data_by_query4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count6(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count6(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_count6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post6() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_count_post6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query4() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_post_aggregation_app_data_by_query4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query4() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query4(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_post_aggregation_data_by_query4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data4() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data4(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_post_stat_bulk_raw_data4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data4() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data4(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_stat_bulk_raw_data4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields6() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields6() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_stat_data_fields6: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data4() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data4(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_stat_data_raw_data4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv4** +> str get_stat_data_raw_data_as_csv4() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv4(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_stat_data_raw_data_as_csv4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields6() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields6() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_stat_query_fields6: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data4** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data4() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bfd_api.MonitoringBFDApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data4(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBFDApi->get_stats_raw_data4: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringBridgeApi.md b/docs/MonitoringBridgeApi.md new file mode 100644 index 0000000..47cf866 --- /dev/null +++ b/docs/MonitoringBridgeApi.md @@ -0,0 +1,1714 @@ +# openapi_client.MonitoringBridgeApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query5**](MonitoringBridgeApi.md#get_aggregation_data_by_query5) | **GET** /statistics/bridgeinterface/aggregation | +[**get_aggregation_data_by_query6**](MonitoringBridgeApi.md#get_aggregation_data_by_query6) | **GET** /statistics/bridgemac/aggregation | +[**get_count7**](MonitoringBridgeApi.md#get_count7) | **GET** /statistics/bridgeinterface/doccount | +[**get_count8**](MonitoringBridgeApi.md#get_count8) | **GET** /statistics/bridgemac/doccount | +[**get_count_post7**](MonitoringBridgeApi.md#get_count_post7) | **POST** /statistics/bridgeinterface/doccount | +[**get_count_post8**](MonitoringBridgeApi.md#get_count_post8) | **POST** /statistics/bridgemac/doccount | +[**get_post_aggregation_app_data_by_query5**](MonitoringBridgeApi.md#get_post_aggregation_app_data_by_query5) | **POST** /statistics/bridgeinterface/app-agg/aggregation | +[**get_post_aggregation_app_data_by_query6**](MonitoringBridgeApi.md#get_post_aggregation_app_data_by_query6) | **POST** /statistics/bridgemac/app-agg/aggregation | +[**get_post_aggregation_data_by_query5**](MonitoringBridgeApi.md#get_post_aggregation_data_by_query5) | **POST** /statistics/bridgeinterface/aggregation | +[**get_post_aggregation_data_by_query6**](MonitoringBridgeApi.md#get_post_aggregation_data_by_query6) | **POST** /statistics/bridgemac/aggregation | +[**get_post_stat_bulk_raw_data5**](MonitoringBridgeApi.md#get_post_stat_bulk_raw_data5) | **POST** /statistics/bridgeinterface/page | +[**get_post_stat_bulk_raw_data6**](MonitoringBridgeApi.md#get_post_stat_bulk_raw_data6) | **POST** /statistics/bridgemac/page | +[**get_stat_bulk_raw_data5**](MonitoringBridgeApi.md#get_stat_bulk_raw_data5) | **GET** /statistics/bridgeinterface/page | +[**get_stat_bulk_raw_data6**](MonitoringBridgeApi.md#get_stat_bulk_raw_data6) | **GET** /statistics/bridgemac/page | +[**get_stat_data_fields7**](MonitoringBridgeApi.md#get_stat_data_fields7) | **GET** /statistics/bridgeinterface/fields | +[**get_stat_data_fields8**](MonitoringBridgeApi.md#get_stat_data_fields8) | **GET** /statistics/bridgemac/fields | +[**get_stat_data_raw_data5**](MonitoringBridgeApi.md#get_stat_data_raw_data5) | **GET** /statistics/bridgeinterface | +[**get_stat_data_raw_data6**](MonitoringBridgeApi.md#get_stat_data_raw_data6) | **GET** /statistics/bridgemac | +[**get_stat_data_raw_data_as_csv5**](MonitoringBridgeApi.md#get_stat_data_raw_data_as_csv5) | **GET** /statistics/bridgeinterface/csv | +[**get_stat_data_raw_data_as_csv6**](MonitoringBridgeApi.md#get_stat_data_raw_data_as_csv6) | **GET** /statistics/bridgemac/csv | +[**get_stat_query_fields7**](MonitoringBridgeApi.md#get_stat_query_fields7) | **GET** /statistics/bridgeinterface/query/fields | +[**get_stat_query_fields8**](MonitoringBridgeApi.md#get_stat_query_fields8) | **GET** /statistics/bridgemac/query/fields | +[**get_stats_raw_data5**](MonitoringBridgeApi.md#get_stats_raw_data5) | **POST** /statistics/bridgeinterface | +[**get_stats_raw_data6**](MonitoringBridgeApi.md#get_stats_raw_data6) | **POST** /statistics/bridgemac | + + +# **get_aggregation_data_by_query5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query5() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query5(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_aggregation_data_by_query5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query6() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query6(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_aggregation_data_by_query6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count7(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count7(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_count7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count8(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count8(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_count8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post7() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_count_post7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post8() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_count_post8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query5() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_post_aggregation_app_data_by_query5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query6() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_post_aggregation_app_data_by_query6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query5() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query5(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_post_aggregation_data_by_query5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query6() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query6(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_post_aggregation_data_by_query6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data5() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data5(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_post_stat_bulk_raw_data5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data6() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data6(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_post_stat_bulk_raw_data6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data5() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data5(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_bulk_raw_data5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data6() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data6(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_bulk_raw_data6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields7() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields7() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_data_fields7: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields8() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields8() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_data_fields8: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data5() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data5(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_data_raw_data5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data6() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data6(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_data_raw_data6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv5** +> str get_stat_data_raw_data_as_csv5() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv5(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_data_raw_data_as_csv5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv6** +> str get_stat_data_raw_data_as_csv6() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv6(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_data_raw_data_as_csv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields7() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields7() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_query_fields7: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields8() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields8() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stat_query_fields8: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data5** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data5() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data5(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stats_raw_data5: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data6() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_bridge_api.MonitoringBridgeApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data6(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringBridgeApi->get_stats_raw_data6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringCellularEIOLTEApi.md b/docs/MonitoringCellularEIOLTEApi.md new file mode 100644 index 0000000..e013a31 --- /dev/null +++ b/docs/MonitoringCellularEIOLTEApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringCellularEIOLTEApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query7**](MonitoringCellularEIOLTEApi.md#get_aggregation_data_by_query7) | **GET** /statistics/eiolte/aggregation | +[**get_count9**](MonitoringCellularEIOLTEApi.md#get_count9) | **GET** /statistics/eiolte/doccount | +[**get_count_post9**](MonitoringCellularEIOLTEApi.md#get_count_post9) | **POST** /statistics/eiolte/doccount | +[**get_post_aggregation_app_data_by_query7**](MonitoringCellularEIOLTEApi.md#get_post_aggregation_app_data_by_query7) | **POST** /statistics/eiolte/app-agg/aggregation | +[**get_post_aggregation_data_by_query7**](MonitoringCellularEIOLTEApi.md#get_post_aggregation_data_by_query7) | **POST** /statistics/eiolte/aggregation | +[**get_post_stat_bulk_raw_data7**](MonitoringCellularEIOLTEApi.md#get_post_stat_bulk_raw_data7) | **POST** /statistics/eiolte/page | +[**get_stat_bulk_raw_data7**](MonitoringCellularEIOLTEApi.md#get_stat_bulk_raw_data7) | **GET** /statistics/eiolte/page | +[**get_stat_data_fields9**](MonitoringCellularEIOLTEApi.md#get_stat_data_fields9) | **GET** /statistics/eiolte/fields | +[**get_stat_data_raw_data7**](MonitoringCellularEIOLTEApi.md#get_stat_data_raw_data7) | **GET** /statistics/eiolte | +[**get_stat_data_raw_data_as_csv7**](MonitoringCellularEIOLTEApi.md#get_stat_data_raw_data_as_csv7) | **GET** /statistics/eiolte/csv | +[**get_stat_query_fields9**](MonitoringCellularEIOLTEApi.md#get_stat_query_fields9) | **GET** /statistics/eiolte/query/fields | +[**get_stats_raw_data7**](MonitoringCellularEIOLTEApi.md#get_stats_raw_data7) | **POST** /statistics/eiolte | + + +# **get_aggregation_data_by_query7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query7() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query7(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_aggregation_data_by_query7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count9(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count9(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_count9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post9() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_count_post9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query7() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_post_aggregation_app_data_by_query7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query7() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query7(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_post_aggregation_data_by_query7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data7() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data7(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_post_stat_bulk_raw_data7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data7() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data7(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_stat_bulk_raw_data7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields9() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields9() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_stat_data_fields9: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data7() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data7(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_stat_data_raw_data7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv7** +> str get_stat_data_raw_data_as_csv7() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv7(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_stat_data_raw_data_as_csv7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields9() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields9() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_stat_query_fields9: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data7** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data7() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cellular_eiolte_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cellular_eiolte_api.MonitoringCellularEIOLTEApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data7(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCellularEIOLTEApi->get_stats_raw_data7: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringCflowdApi.md b/docs/MonitoringCflowdApi.md new file mode 100644 index 0000000..826089a --- /dev/null +++ b/docs/MonitoringCflowdApi.md @@ -0,0 +1,1937 @@ +# openapi_client.MonitoringCflowdApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_cflow_collector_list**](MonitoringCflowdApi.md#create_cflow_collector_list) | **GET** /device/cflowd/flows | +[**create_cflowd_collector_list**](MonitoringCflowdApi.md#create_cflowd_collector_list) | **GET** /device/cflowd/collector | +[**create_cflowd_flows_count_list**](MonitoringCflowdApi.md#create_cflowd_flows_count_list) | **GET** /device/cflowd/flows-count | +[**create_cflowd_statistics**](MonitoringCflowdApi.md#create_cflowd_statistics) | **GET** /device/cflowd/statistics | +[**create_cflowd_template**](MonitoringCflowdApi.md#create_cflowd_template) | **GET** /device/cflowd/template | +[**create_flow_device_data**](MonitoringCflowdApi.md#create_flow_device_data) | **GET** /statistics/cflowd/device/applications | +[**create_flows_grid**](MonitoringCflowdApi.md#create_flows_grid) | **GET** /statistics/cflowd/applications | +[**create_flowssummary**](MonitoringCflowdApi.md#create_flowssummary) | **GET** /statistics/cflowd/applications/summary | +[**get_aggregation_data_by_query8**](MonitoringCflowdApi.md#get_aggregation_data_by_query8) | **GET** /statistics/cflowd/aggregation | +[**get_cflowd_dpi_device_field_json**](MonitoringCflowdApi.md#get_cflowd_dpi_device_field_json) | **GET** /device/cflowd/application/fields | +[**get_cflowd_dpi_field_json**](MonitoringCflowdApi.md#get_cflowd_dpi_field_json) | **GET** /device/cflowd/device/fields | +[**get_count10**](MonitoringCflowdApi.md#get_count10) | **GET** /statistics/cflowd/doccount | +[**get_count_post10**](MonitoringCflowdApi.md#get_count_post10) | **POST** /statistics/cflowd/doccount | +[**get_fn_f_cache_stats**](MonitoringCflowdApi.md#get_fn_f_cache_stats) | **GET** /device/cflowd/fnf/cache-stats | +[**get_fn_f_export_client_stats**](MonitoringCflowdApi.md#get_fn_f_export_client_stats) | **GET** /device/cflowd/fnf/export-client-stats | +[**get_fn_f_export_stats**](MonitoringCflowdApi.md#get_fn_f_export_stats) | **GET** /device/cflowd/fnf/export-stats | +[**get_fn_f_monitor_stats**](MonitoringCflowdApi.md#get_fn_f_monitor_stats) | **GET** /device/cflowd/fnf/monitor-stats | +[**get_fnf**](MonitoringCflowdApi.md#get_fnf) | **GET** /device/cflowd/fnf/flow-monitor | +[**get_post_aggregation_app_data_by_query8**](MonitoringCflowdApi.md#get_post_aggregation_app_data_by_query8) | **POST** /statistics/cflowd/app-agg/aggregation | +[**get_post_aggregation_data_by_query8**](MonitoringCflowdApi.md#get_post_aggregation_data_by_query8) | **POST** /statistics/cflowd/aggregation | +[**get_post_stat_bulk_raw_data8**](MonitoringCflowdApi.md#get_post_stat_bulk_raw_data8) | **POST** /statistics/cflowd/page | +[**get_stat_bulk_raw_data8**](MonitoringCflowdApi.md#get_stat_bulk_raw_data8) | **GET** /statistics/cflowd/page | +[**get_stat_data_fields10**](MonitoringCflowdApi.md#get_stat_data_fields10) | **GET** /statistics/cflowd/fields | +[**get_stat_data_raw_data8**](MonitoringCflowdApi.md#get_stat_data_raw_data8) | **GET** /statistics/cflowd | +[**get_stat_data_raw_data_as_csv8**](MonitoringCflowdApi.md#get_stat_data_raw_data_as_csv8) | **GET** /statistics/cflowd/csv | +[**get_stat_query_fields10**](MonitoringCflowdApi.md#get_stat_query_fields10) | **GET** /statistics/cflowd/query/fields | +[**get_stats_raw_data8**](MonitoringCflowdApi.md#get_stats_raw_data8) | **POST** /statistics/cflowd | + + +# **create_cflow_collector_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_cflow_collector_list(device_id) + + + +Get list of cflowd flows from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + vpn_id = "0" # str | VPN Id (optional) + src_ip = "src-ip_example" # str | Source IP (optional) + dest_ip = "dest-ip_example" # str | Destination IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cflow_collector_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflow_collector_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cflow_collector_list(device_id, vpn_id=vpn_id, src_ip=src_ip, dest_ip=dest_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflow_collector_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **src_ip** | **str**| Source IP | [optional] + **dest_ip** | **str**| Destination IP | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cflowd_collector_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_cflowd_collector_list(device_id) + + + +Get cflowd collector list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cflowd_collector_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflowd_collector_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cflowd_flows_count_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cflowd_flows_count_list(device_id) + + + +Get cflowd flow count from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + vpn_id = "0" # str | VPN Id (optional) + src_ip = "src-ip_example" # str | Source IP (optional) + dest_ip = "dest-ip_example" # str | Destination IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cflowd_flows_count_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflowd_flows_count_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cflowd_flows_count_list(device_id, vpn_id=vpn_id, src_ip=src_ip, dest_ip=dest_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflowd_flows_count_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **src_ip** | **str**| Source IP | [optional] + **dest_ip** | **str**| Destination IP | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cflowd_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cflowd_statistics(device_id) + + + +Get cflowd statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cflowd_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflowd_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cflowd_template** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cflowd_template(device_id) + + + +Get cflowd template from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cflowd_template(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_cflowd_template: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_flow_device_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_flow_device_data() + + + +Generate cflowd flows list in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + query = "query_example" # str | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_flow_device_data(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_flow_device_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_flows_grid** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_flows_grid() + + + +Generate cflowd flows list in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + vpn = "vpn_example" # str | VPN Id (optional) + device_id = "00r252U250?250" # str | Device IP (optional) + limit = 1 # int | Limit (optional) + query = "query_example" # str | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_flows_grid(vpn=vpn, device_id=device_id, limit=limit, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_flows_grid: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn** | **str**| VPN Id | [optional] + **device_id** | **str**| Device IP | [optional] + **limit** | **int**| Limit | [optional] + **query** | **str**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_flowssummary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_flowssummary() + + + +Generate cflowd flows list in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + limit = 1 # int | Limit (optional) + query = "query_example" # str | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_flowssummary(limit=limit, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->create_flowssummary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int**| Limit | [optional] + **query** | **str**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query8() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query8(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_aggregation_data_by_query8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cflowd_dpi_device_field_json** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cflowd_dpi_device_field_json() + + + +Get Cflowd DPI query field JSON + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + is_device_dash_board = False # bool | Flag whether it is device dashboard request (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cflowd_dpi_device_field_json(is_device_dash_board=is_device_dash_board) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_cflowd_dpi_device_field_json: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_device_dash_board** | **bool**| Flag whether it is device dashboard request | [optional] if omitted the server will use the default value of False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cflowd_dpi_field_json** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cflowd_dpi_field_json() + + + +Get CflowdvDPI query field JSON + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + is_device_dash_board = False # bool | Flag whether it is device dashboard request (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_cflowd_dpi_field_json(is_device_dash_board=is_device_dash_board) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_cflowd_dpi_field_json: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_device_dash_board** | **bool**| Flag whether it is device dashboard request | [optional] if omitted the server will use the default value of False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count10(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count10(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_count10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post10() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_count_post10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_fn_f_cache_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_fn_f_cache_stats(device_id) + + + +Get FnF cache stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_fn_f_cache_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_fn_f_cache_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_fn_f_export_client_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_fn_f_export_client_stats(device_id) + + + +Get FnF export client stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_fn_f_export_client_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_fn_f_export_client_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_fn_f_export_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_fn_f_export_stats(device_id) + + + +Get FnF export stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_fn_f_export_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_fn_f_export_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_fn_f_monitor_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_fn_f_monitor_stats(device_id) + + + +Get FnF monitor stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_fn_f_monitor_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_fn_f_monitor_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_fnf** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_fnf(device_id) + + + +Get FnF from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_fnf(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_fnf: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query8() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_post_aggregation_app_data_by_query8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query8() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query8(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_post_aggregation_data_by_query8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data8() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data8(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_post_stat_bulk_raw_data8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data8() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data8(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_stat_bulk_raw_data8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields10() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields10() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_stat_data_fields10: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data8() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data8(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_stat_data_raw_data8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv8** +> str get_stat_data_raw_data_as_csv8() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv8(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_stat_data_raw_data_as_csv8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields10() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields10() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_stat_query_fields10: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data8** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data8() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cflowd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cflowd_api.MonitoringCflowdApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data8(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCflowdApi->get_stats_raw_data8: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringCloudExpressApi.md b/docs/MonitoringCloudExpressApi.md new file mode 100644 index 0000000..778455c --- /dev/null +++ b/docs/MonitoringCloudExpressApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringCloudExpressApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query9**](MonitoringCloudExpressApi.md#get_aggregation_data_by_query9) | **GET** /statistics/cloudx/aggregation | +[**get_count11**](MonitoringCloudExpressApi.md#get_count11) | **GET** /statistics/cloudx/doccount | +[**get_count_post11**](MonitoringCloudExpressApi.md#get_count_post11) | **POST** /statistics/cloudx/doccount | +[**get_post_aggregation_app_data_by_query9**](MonitoringCloudExpressApi.md#get_post_aggregation_app_data_by_query9) | **POST** /statistics/cloudx/app-agg/aggregation | +[**get_post_aggregation_data_by_query9**](MonitoringCloudExpressApi.md#get_post_aggregation_data_by_query9) | **POST** /statistics/cloudx/aggregation | +[**get_post_stat_bulk_raw_data9**](MonitoringCloudExpressApi.md#get_post_stat_bulk_raw_data9) | **POST** /statistics/cloudx/page | +[**get_stat_bulk_raw_data9**](MonitoringCloudExpressApi.md#get_stat_bulk_raw_data9) | **GET** /statistics/cloudx/page | +[**get_stat_data_fields11**](MonitoringCloudExpressApi.md#get_stat_data_fields11) | **GET** /statistics/cloudx/fields | +[**get_stat_data_raw_data9**](MonitoringCloudExpressApi.md#get_stat_data_raw_data9) | **GET** /statistics/cloudx | +[**get_stat_data_raw_data_as_csv9**](MonitoringCloudExpressApi.md#get_stat_data_raw_data_as_csv9) | **GET** /statistics/cloudx/csv | +[**get_stat_query_fields11**](MonitoringCloudExpressApi.md#get_stat_query_fields11) | **GET** /statistics/cloudx/query/fields | +[**get_stats_raw_data9**](MonitoringCloudExpressApi.md#get_stats_raw_data9) | **POST** /statistics/cloudx | + + +# **get_aggregation_data_by_query9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query9() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query9(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_aggregation_data_by_query9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count11(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count11(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_count11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post11() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_count_post11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query9() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_post_aggregation_app_data_by_query9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query9() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query9(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_post_aggregation_data_by_query9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data9() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data9(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_post_stat_bulk_raw_data9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data9() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data9(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_stat_bulk_raw_data9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields11() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields11() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_stat_data_fields11: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data9() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data9(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_stat_data_raw_data9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv9** +> str get_stat_data_raw_data_as_csv9() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv9(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_stat_data_raw_data_as_csv9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields11() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields11() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_stat_query_fields11: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data9** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data9() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_cloud_express_api.MonitoringCloudExpressApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data9(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringCloudExpressApi->get_stats_raw_data9: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringDPIApi.md b/docs/MonitoringDPIApi.md new file mode 100644 index 0000000..a0d7eb9 --- /dev/null +++ b/docs/MonitoringDPIApi.md @@ -0,0 +1,1384 @@ +# openapi_client.MonitoringDPIApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_dpi_device_and_app_details**](MonitoringDPIApi.md#create_dpi_device_and_app_details) | **GET** /statistics/dpi/device/details/applications | +[**create_dpi_device_grid_data**](MonitoringDPIApi.md#create_dpi_device_grid_data) | **GET** /statistics/dpi/device/applications | +[**create_dpi_flows_grid_list_query**](MonitoringDPIApi.md#create_dpi_flows_grid_list_query) | **GET** /statistics/dpi/applications | +[**create_dpi_summary**](MonitoringDPIApi.md#create_dpi_summary) | **GET** /statistics/dpi/applications/summary | +[**get_aggregation_data_by_query12**](MonitoringDPIApi.md#get_aggregation_data_by_query12) | **GET** /statistics/dpi/aggregation | +[**get_aggregation_data_dpi**](MonitoringDPIApi.md#get_aggregation_data_dpi) | **POST** /statistics/dpi/recovery/aggregation | +[**get_aggregation_data_for_packet_dup**](MonitoringDPIApi.md#get_aggregation_data_for_packet_dup) | **POST** /statistics/dpi/pktdup/aggregation | +[**get_count14**](MonitoringDPIApi.md#get_count14) | **GET** /statistics/dpi/doccount | +[**get_count_post14**](MonitoringDPIApi.md#get_count_post14) | **POST** /statistics/dpi/doccount | +[**get_post_aggregation_app_data**](MonitoringDPIApi.md#get_post_aggregation_app_data) | **POST** /statistics/dpi/agg-app/aggregation | +[**get_post_aggregation_data**](MonitoringDPIApi.md#get_post_aggregation_data) | **POST** /statistics/dpi/aggregation | +[**get_post_stat_bulk_raw_data12**](MonitoringDPIApi.md#get_post_stat_bulk_raw_data12) | **POST** /statistics/dpi/page | +[**get_stat_bulk_raw_data12**](MonitoringDPIApi.md#get_stat_bulk_raw_data12) | **GET** /statistics/dpi/page | +[**get_stat_data_fields14**](MonitoringDPIApi.md#get_stat_data_fields14) | **GET** /statistics/dpi/fields | +[**get_stat_data_raw_data12**](MonitoringDPIApi.md#get_stat_data_raw_data12) | **GET** /statistics/dpi | +[**get_stat_data_raw_data_as_csv12**](MonitoringDPIApi.md#get_stat_data_raw_data_as_csv12) | **GET** /statistics/dpi/csv | +[**get_stat_query_fields14**](MonitoringDPIApi.md#get_stat_query_fields14) | **GET** /statistics/dpi/query/fields | +[**get_stats_raw_data12**](MonitoringDPIApi.md#get_stats_raw_data12) | **POST** /statistics/dpi | +[**get_unique_flow_count**](MonitoringDPIApi.md#get_unique_flow_count) | **GET** /statistics/dpi/device/application/flowcount | + + +# **create_dpi_device_and_app_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dpi_device_and_app_details(query) + + + +Get detailed DPI device and app list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-11-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_device_and_app_details(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_device_and_app_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dpi_device_grid_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dpi_device_grid_data(query) + + + +Get detailed DPI flows list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-11-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string + limit = "limit_example" # str | Query size (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_device_grid_data(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_device_grid_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dpi_device_grid_data(query, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_device_grid_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | + **limit** | **str**| Query size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dpi_flows_grid_list_query** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dpi_flows_grid_list_query(query) + + + +Get detailed DPI application flows list in a grid table + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-11-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string + limit = "limit_example" # str | Query size (example: 10) (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_flows_grid_list_query(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_flows_grid_list_query: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dpi_flows_grid_list_query(query, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_flows_grid_list_query: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | + **limit** | **str**| Query size (example: 10) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dpi_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dpi_summary(query) + + + +Get detailed DPI application flows summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-11-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string + limit = "limit_example" # str | Query size (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_summary(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_summary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dpi_summary(query, limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->create_dpi_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | + **limit** | **str**| Query size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query12() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query12(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_aggregation_data_by_query12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_dpi** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_dpi() + + + +Get aggregation data and fec recovery rate if available + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_dpi(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_aggregation_data_dpi: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_for_packet_dup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_for_packet_dup() + + + +Get time series aggregation data for packet duplication for an application over TLOCs if available + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_for_packet_dup(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_aggregation_data_for_packet_dup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count14(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count14(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_count14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post14() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_count_post14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data() + + + +Get raw aggregated data and display applications with the highest utilization for a device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_post_aggregation_app_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data() + + + +Get raw aggregated data and display applications with the highest utilization for a device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_post_aggregation_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data12() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data12(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_post_stat_bulk_raw_data12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data12() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data12(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_stat_bulk_raw_data12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields14() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields14() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_stat_data_fields14: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data12() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data12(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_stat_data_raw_data12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv12** +> str get_stat_data_raw_data_as_csv12() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv12(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_stat_data_raw_data_as_csv12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields14() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields14() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_stat_query_fields14: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data12() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data12(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_stats_raw_data12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_unique_flow_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_unique_flow_count(device_id, interval, application, window, family) + + + +Get application flow count per tunnel + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpi_api.MonitoringDPIApi(api_client) + device_id = "deviceId_example" # str | Device Id + interval = "interval_example" # str | Interval + application = "application_example" # str | Application + window = "window_example" # str | Window + family = "family_example" # str | Family + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_unique_flow_count(device_id, interval, application, window, family) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIApi->get_unique_flow_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + **interval** | **str**| Interval | + **application** | **str**| Application | + **window** | **str**| Window | + **family** | **str**| Family | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringDPIOnDemandTroubleshootingApi.md b/docs/MonitoringDPIOnDemandTroubleshootingApi.md new file mode 100644 index 0000000..3ffb615 --- /dev/null +++ b/docs/MonitoringDPIOnDemandTroubleshootingApi.md @@ -0,0 +1,355 @@ +# openapi_client.MonitoringDPIOnDemandTroubleshootingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_queue_entry**](MonitoringDPIOnDemandTroubleshootingApi.md#create_queue_entry) | **POST** /statistics/on-demand/queue | +[**delete_queue_entry**](MonitoringDPIOnDemandTroubleshootingApi.md#delete_queue_entry) | **DELETE** /statistics/on-demand/queue/{entryId} | +[**get_queue_entries**](MonitoringDPIOnDemandTroubleshootingApi.md#get_queue_entries) | **GET** /statistics/on-demand/queue | +[**get_queue_properties**](MonitoringDPIOnDemandTroubleshootingApi.md#get_queue_properties) | **GET** /statistics/on-demand/queue/properties | +[**update_queue_entry**](MonitoringDPIOnDemandTroubleshootingApi.md#update_queue_entry) | **PUT** /statistics/on-demand/queue/{entryId} | + + +# **create_queue_entry** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_queue_entry() + + + +Create on-demand troubleshooting queue entry + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpion_demand_troubleshooting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpion_demand_troubleshooting_api.MonitoringDPIOnDemandTroubleshootingApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | On-demand queue entry (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_queue_entry(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIOnDemandTroubleshootingApi->create_queue_entry: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| On-demand queue entry | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_queue_entry** +> delete_queue_entry(entry_id) + + + +removes on-demand queue entry + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpion_demand_troubleshooting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpion_demand_troubleshooting_api.MonitoringDPIOnDemandTroubleshootingApi(api_client) + entry_id = "entryId_example" # str | Entry Id + + # example passing only required values which don't have defaults set + try: + api_instance.delete_queue_entry(entry_id) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIOnDemandTroubleshootingApi->delete_queue_entry: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entry_id** | **str**| Entry Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_queue_entries** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_queue_entries() + + + +gets current on-demand queue entries + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpion_demand_troubleshooting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpion_demand_troubleshooting_api.MonitoringDPIOnDemandTroubleshootingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_queue_entries() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIOnDemandTroubleshootingApi->get_queue_entries: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_queue_properties** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_queue_properties() + + + +gets current size of on-demand queue + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpion_demand_troubleshooting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpion_demand_troubleshooting_api.MonitoringDPIOnDemandTroubleshootingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_queue_properties() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIOnDemandTroubleshootingApi->get_queue_properties: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_queue_entry** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_queue_entry(entry_id) + + + +Updates on-demand troubleshooting queue entry + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_dpion_demand_troubleshooting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_dpion_demand_troubleshooting_api.MonitoringDPIOnDemandTroubleshootingApi(api_client) + entry_id = "entryId_example" # str | Entry Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | On-demand queue entry (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_queue_entry(entry_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIOnDemandTroubleshootingApi->update_queue_entry: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_queue_entry(entry_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDPIOnDemandTroubleshootingApi->update_queue_entry: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entry_id** | **str**| Entry Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| On-demand queue entry | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringDeviceDetailsApi.md b/docs/MonitoringDeviceDetailsApi.md new file mode 100644 index 0000000..b9772d9 --- /dev/null +++ b/docs/MonitoringDeviceDetailsApi.md @@ -0,0 +1,2325 @@ +# openapi_client.MonitoringDeviceDetailsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_tier**](MonitoringDeviceDetailsApi.md#add_tier) | **POST** /device/tier | +[**delete_tier**](MonitoringDeviceDetailsApi.md#delete_tier) | **DELETE** /device/tier/{tierName} | +[**enable_sdavcon_device**](MonitoringDeviceDetailsApi.md#enable_sdavcon_device) | **POST** /device/enableSDAVC/{deviceIP}/{enable} | +[**generate_device_state_data**](MonitoringDeviceDetailsApi.md#generate_device_state_data) | **GET** /data/device/state/{state_data_type} | +[**generate_device_state_data_fields**](MonitoringDeviceDetailsApi.md#generate_device_state_data_fields) | **GET** /data/device/state/{state_data_type}/fields | +[**generate_device_state_data_with_query_string**](MonitoringDeviceDetailsApi.md#generate_device_state_data_with_query_string) | **GET** /data/device/state/{state_data_type}/query | +[**get_all_device_status**](MonitoringDeviceDetailsApi.md#get_all_device_status) | **GET** /device/status | +[**get_device_counters**](MonitoringDeviceDetailsApi.md#get_device_counters) | **GET** /device/counters | +[**get_device_list_as_key_value**](MonitoringDeviceDetailsApi.md#get_device_list_as_key_value) | **GET** /device/keyvalue | +[**get_device_models**](MonitoringDeviceDetailsApi.md#get_device_models) | **GET** /device/models/{uuid} | +[**get_device_only_status**](MonitoringDeviceDetailsApi.md#get_device_only_status) | **GET** /device/devicestatus | +[**get_device_running_config**](MonitoringDeviceDetailsApi.md#get_device_running_config) | **GET** /device/config | +[**get_device_running_config_html**](MonitoringDeviceDetailsApi.md#get_device_running_config_html) | **GET** /device/config/html | +[**get_device_tloc_status**](MonitoringDeviceDetailsApi.md#get_device_tloc_status) | **GET** /device/tloc | +[**get_device_tloc_util**](MonitoringDeviceDetailsApi.md#get_device_tloc_util) | **GET** /device/tlocutil | +[**get_device_tloc_util_details**](MonitoringDeviceDetailsApi.md#get_device_tloc_util_details) | **GET** /device/tlocutil/detail | +[**get_hardware_health_details**](MonitoringDeviceDetailsApi.md#get_hardware_health_details) | **GET** /device/hardwarehealth/detail | +[**get_hardware_health_summary**](MonitoringDeviceDetailsApi.md#get_hardware_health_summary) | **GET** /device/hardwarehealth/summary | +[**get_stats_queues**](MonitoringDeviceDetailsApi.md#get_stats_queues) | **GET** /device/stats | +[**get_sync_queues**](MonitoringDeviceDetailsApi.md#get_sync_queues) | **GET** /device/queues | +[**get_tiers**](MonitoringDeviceDetailsApi.md#get_tiers) | **GET** /device/tier | +[**get_unconfigured**](MonitoringDeviceDetailsApi.md#get_unconfigured) | **GET** /device/unconfigured | +[**get_v_manage_system_ip**](MonitoringDeviceDetailsApi.md#get_v_manage_system_ip) | **GET** /device/vmanage | +[**get_vedge_inventory**](MonitoringDeviceDetailsApi.md#get_vedge_inventory) | **GET** /device/vedgeinventory/detail | +[**get_vedge_inventory_summary**](MonitoringDeviceDetailsApi.md#get_vedge_inventory_summary) | **GET** /device/vedgeinventory/summary | +[**list_all_device_models**](MonitoringDeviceDetailsApi.md#list_all_device_models) | **GET** /device/models | +[**list_all_devices**](MonitoringDeviceDetailsApi.md#list_all_devices) | **GET** /device | +[**list_all_monitor_details_devices**](MonitoringDeviceDetailsApi.md#list_all_monitor_details_devices) | **GET** /device/monitor | +[**list_currently_syncing_devices**](MonitoringDeviceDetailsApi.md#list_currently_syncing_devices) | **GET** /device/sync_status | +[**list_reachable_devices**](MonitoringDeviceDetailsApi.md#list_reachable_devices) | **GET** /device/reachable | +[**list_unreachable_devices**](MonitoringDeviceDetailsApi.md#list_unreachable_devices) | **GET** /device/unreachable | +[**remove_unreachable_device**](MonitoringDeviceDetailsApi.md#remove_unreachable_device) | **DELETE** /device/unreachable/{deviceIP} | +[**set_block_sync**](MonitoringDeviceDetailsApi.md#set_block_sync) | **POST** /device/blockSync | +[**sync_all_devices_mem_db**](MonitoringDeviceDetailsApi.md#sync_all_devices_mem_db) | **POST** /device/syncall/memorydb | + + +# **add_tier** +> add_tier(add_tier) + + + +add tier + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + add_tier = "addTier_example" # str | addTier + + # example passing only required values which don't have defaults set + try: + api_instance.add_tier(add_tier) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->add_tier: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **add_tier** | **str**| addTier | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tier** +> delete_tier(tier_name) + + + +deleteTier + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + tier_name = "tierName_example" # str | deletetier + + # example passing only required values which don't have defaults set + try: + api_instance.delete_tier(tier_name) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->delete_tier: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tier_name** | **str**| deletetier | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable_sdavcon_device** +> enable_sdavcon_device(device_ip, enable) + + + +Enable/Disable SDAVC on device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + enable = True # bool | Enable/Disable flag + + # example passing only required values which don't have defaults set + try: + api_instance.enable_sdavcon_device(device_ip, enable) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->enable_sdavcon_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **enable** | **bool**| Enable/Disable flag | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_device_state_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_device_state_data(state_data_type, start_id) + + + +Get device state data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + state_data_type = "state_data_type_example" # str | State data type + start_id = "startId_example" # str | Start Id + count = "1000" # str | Count (optional) if omitted the server will use the default value of "1000" + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_device_state_data(state_data_type, start_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->generate_device_state_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_device_state_data(state_data_type, start_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->generate_device_state_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| State data type | + **start_id** | **str**| Start Id | + **count** | **str**| Count | [optional] if omitted the server will use the default value of "1000" + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_device_state_data_fields** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_device_state_data_fields(state_data_type) + + + +Get device state data fileds + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + state_data_type = "state_data_type_example" # str | State data type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_device_state_data_fields(state_data_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->generate_device_state_data_fields: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| State data type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_device_state_data_with_query_string** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_device_state_data_with_query_string(state_data_type) + + + +Get device state data fileds + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + state_data_type = "state_data_type_example" # str | State data type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_device_state_data_with_query_string(state_data_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->generate_device_state_data_with_query_string: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| State data type | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_device_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_device_status() + + + +Get devices status for vSmart,vBond,vEdge, and cEdge + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_device_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_all_device_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_counters** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_counters() + + + +Get device counters + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_counters() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_counters: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_list_as_key_value** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_list_as_key_value() + + + +Get vEdge inventory as key value (key as systemIp value as hostName) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_list_as_key_value() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_list_as_key_value: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_models** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_models(uuid) + + + +Get device model for the device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_models(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_models: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_only_status** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_only_status() + + + +Get devices status per type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_only_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_only_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_running_config** +> str get_device_running_config(device_id) + + + +Get device running configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + device_id = [ + "deviceId_example", + ] # [str] | Device Id list + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_running_config(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_running_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **[str]**| Device Id list | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, text/xml + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_running_config_html** +> str get_device_running_config_html(device_id) + + + +Get device running configuration in HTML format + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + device_id = [ + "deviceId_example", + ] # [str] | Device Id list + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_running_config_html(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_running_config_html: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **[str]**| Device Id list | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_tloc_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tloc_status() + + + +Get TLOC status list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + device_id = "deviceId_example" # str | Device Id (optional) + color = "color_example" # str | Status color (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_tloc_status(device_id=device_id, color=color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_tloc_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | [optional] + **color** | **str**| Status color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_tloc_util** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tloc_util() + + + +Get TLOC list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_tloc_util() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_tloc_util: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_tloc_util_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tloc_util_details() + + + +Get detailed TLOC list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + util = "util_example" # str | Tloc util (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_tloc_util_details(util=util) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_device_tloc_util_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **util** | **str**| Tloc util | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_hardware_health_details** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_hardware_health_details() + + + +Get hardware health details for device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + device_id = "deviceId_example" # str | Device Id (optional) + state = "state_example" # str | Device state (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_hardware_health_details(device_id=device_id, state=state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_hardware_health_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | [optional] + **state** | **str**| Device state | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_hardware_health_summary** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_hardware_health_summary(vpn_id) + + + +Get hardware health summary for device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + vpn_id = [ + "vpnId_example", + ] # [str] | VPN Id + is_cached = False # bool | Status cached (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_hardware_health_summary(vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_hardware_health_summary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_hardware_health_summary(vpn_id, is_cached=is_cached) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_hardware_health_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | **[str]**| VPN Id | + **is_cached** | **bool**| Status cached | [optional] if omitted the server will use the default value of False + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_queues** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_queues() + + + +Get stats queue information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stats_queues() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_stats_queues: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sync_queues** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sync_queues() + + + +Get synchronized queue information, returns information about syncing, queued and stuck devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_sync_queues() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_sync_queues: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tiers** +> get_tiers() + + + +getTiers + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_tiers() + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_tiers: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_unconfigured** +> [Device] get_unconfigured() + + + +Get wan edge devices not configured by vManage (that is, those in CLI mode) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from openapi_client.model.device import Device +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_unconfigured() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_unconfigured: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**[Device]**](Device.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_v_manage_system_ip** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_v_manage_system_ip() + + + +Get vManage system IP + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_v_manage_system_ip() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_v_manage_system_ip: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vedge_inventory** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vedge_inventory() + + + +Get detailed vEdge inventory + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + status = "status_example" # str | Device status (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_vedge_inventory(status=status) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_vedge_inventory: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | **str**| Device status | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vedge_inventory_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vedge_inventory_summary() + + + +Get vEdge inventory + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_vedge_inventory_summary() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->get_vedge_inventory_summary: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_all_device_models** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_all_device_models() + + + +Get all device models supported by the vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_all_device_models() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->list_all_device_models: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **list** | **str**| List type of device | defaults to "all" + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_all_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_all_devices() + + + +List all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_all_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->list_all_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_all_monitor_details_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_all_monitor_details_devices() + + + +Get all monitoring details of the devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_all_monitor_details_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->list_all_monitor_details_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_currently_syncing_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_currently_syncing_devices() + + + +Get list of currently syncing devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_currently_syncing_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->list_currently_syncing_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group_id** | **str**| Group Id | defaults to "all" + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_reachable_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_reachable_devices() + + + +Get list of reachable devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_reachable_devices() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->list_reachable_devices: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_unreachable_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_unreachable_devices(personality) + + + +Get list of unreachable devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + personality = "personality_example" # str | Device personality (vedge OR vsmart OR vbond... ) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_unreachable_devices(personality) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->list_unreachable_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **personality** | **str**| Device personality (vedge OR vsmart OR vbond... ) | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_unreachable_device** +> remove_unreachable_device(device_ip) + + + +Delete unreachable device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_instance.remove_unreachable_device(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->remove_unreachable_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_block_sync** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_block_sync(block_sync) + + + +Set collection manager block set flag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + block_sync = "blockSync_example" # str | Block sync flag + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.set_block_sync(block_sync) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->set_block_sync: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **block_sync** | **str**| Block sync flag | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_all_devices_mem_db** +> sync_all_devices_mem_db() + + + +Synchronize memory database for all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_details_api.MonitoringDeviceDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.sync_all_devices_mem_db() + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceDetailsApi->sync_all_devices_mem_db: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringDeviceStatisticsApi.md b/docs/MonitoringDeviceStatisticsApi.md new file mode 100644 index 0000000..2598dd6 --- /dev/null +++ b/docs/MonitoringDeviceStatisticsApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringDeviceStatisticsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query15**](MonitoringDeviceStatisticsApi.md#get_aggregation_data_by_query15) | **GET** /statistics/device/aggregation | +[**get_count17**](MonitoringDeviceStatisticsApi.md#get_count17) | **GET** /statistics/device/doccount | +[**get_count_post17**](MonitoringDeviceStatisticsApi.md#get_count_post17) | **POST** /statistics/device/doccount | +[**get_post_aggregation_app_data_by_query14**](MonitoringDeviceStatisticsApi.md#get_post_aggregation_app_data_by_query14) | **POST** /statistics/device/app-agg/aggregation | +[**get_post_aggregation_data_by_query14**](MonitoringDeviceStatisticsApi.md#get_post_aggregation_data_by_query14) | **POST** /statistics/device/aggregation | +[**get_post_stat_bulk_raw_data15**](MonitoringDeviceStatisticsApi.md#get_post_stat_bulk_raw_data15) | **POST** /statistics/device/page | +[**get_stat_bulk_raw_data15**](MonitoringDeviceStatisticsApi.md#get_stat_bulk_raw_data15) | **GET** /statistics/device/page | +[**get_stat_data_fields17**](MonitoringDeviceStatisticsApi.md#get_stat_data_fields17) | **GET** /statistics/device/fields | +[**get_stat_data_raw_data14**](MonitoringDeviceStatisticsApi.md#get_stat_data_raw_data14) | **GET** /statistics/device | +[**get_stat_data_raw_data_as_csv15**](MonitoringDeviceStatisticsApi.md#get_stat_data_raw_data_as_csv15) | **GET** /statistics/device/csv | +[**get_stat_query_fields17**](MonitoringDeviceStatisticsApi.md#get_stat_query_fields17) | **GET** /statistics/device/query/fields | +[**get_stats_raw_data15**](MonitoringDeviceStatisticsApi.md#get_stats_raw_data15) | **POST** /statistics/device | + + +# **get_aggregation_data_by_query15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query15() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query15(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_aggregation_data_by_query15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count17(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count17(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_count17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post17() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_count_post17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query14() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_post_aggregation_app_data_by_query14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query14() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query14(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_post_aggregation_data_by_query14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data15() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data15(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_post_stat_bulk_raw_data15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data15() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data15(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_stat_bulk_raw_data15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields17() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields17() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_stat_data_fields17: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data14() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data14(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_stat_data_raw_data14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv15** +> str get_stat_data_raw_data_as_csv15() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv15(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_stat_data_raw_data_as_csv15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields17() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields17() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_stat_query_fields17: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data15() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_api.MonitoringDeviceStatisticsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data15(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsApi->get_stats_raw_data15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringDeviceStatisticsDetailsApi.md b/docs/MonitoringDeviceStatisticsDetailsApi.md new file mode 100644 index 0000000..9933e17 --- /dev/null +++ b/docs/MonitoringDeviceStatisticsDetailsApi.md @@ -0,0 +1,397 @@ +# openapi_client.MonitoringDeviceStatisticsDetailsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**generate_device_statistics_data**](MonitoringDeviceStatisticsDetailsApi.md#generate_device_statistics_data) | **GET** /data/device/statistics/{state_data_type} | +[**get_active_alarms**](MonitoringDeviceStatisticsDetailsApi.md#get_active_alarms) | **GET** /data/device/statistics/alarm/active | +[**get_count_with_state_data_type**](MonitoringDeviceStatisticsDetailsApi.md#get_count_with_state_data_type) | **GET** /data/device/statistics/{state_data_type}/doccount | +[**get_stat_data_fields_by_state_data_type**](MonitoringDeviceStatisticsDetailsApi.md#get_stat_data_fields_by_state_data_type) | **GET** /data/device/statistics/{state_data_type}/fields | +[**get_statistics_type**](MonitoringDeviceStatisticsDetailsApi.md#get_statistics_type) | **GET** /data/device/statistics | + + +# **generate_device_statistics_data** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_device_statistics_data(state_data_type) + + + +Get device statistics data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_details_api.MonitoringDeviceStatisticsDetailsApi(api_client) + state_data_type = "state_data_type_example" # str | State data type + scroll_id = "scrollId_example" # str | Scroll Id (optional) + start_date = "startDate_example" # str | Start date (optional) + end_date = "endDate_example" # str | End date (optional) + count = 1 # int | (optional) + time_zone = "timeZone_example" # str | Time zone (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_device_statistics_data(state_data_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->generate_device_statistics_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_device_statistics_data(state_data_type, scroll_id=scroll_id, start_date=start_date, end_date=end_date, count=count, time_zone=time_zone) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->generate_device_statistics_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| State data type | + **scroll_id** | **str**| Scroll Id | [optional] + **start_date** | **str**| Start date | [optional] + **end_date** | **str**| End date | [optional] + **count** | **int**| | [optional] + **time_zone** | **str**| Time zone | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_active_alarms** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_active_alarms(scroll_id) + + + +Get active alarms + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_details_api.MonitoringDeviceStatisticsDetailsApi(api_client) + scroll_id = "scrollId_example" # str | SrollId + start_date = "startDate_example" # str | Start date (optional) + end_date = "endDate_example" # str | End date (optional) + count = 1 # int | count (optional) + time_zone = "timeZone_example" # str | Time zone (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_active_alarms(scroll_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->get_active_alarms: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_active_alarms(scroll_id, start_date=start_date, end_date=end_date, count=count, time_zone=time_zone) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->get_active_alarms: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| SrollId | + **start_date** | **str**| Start date | [optional] + **end_date** | **str**| End date | [optional] + **count** | **int**| count | [optional] + **time_zone** | **str**| Time zone | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_with_state_data_type** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_with_state_data_type(state_data_type, start_date, end_date) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_details_api.MonitoringDeviceStatisticsDetailsApi(api_client) + state_data_type = "state_data_type_example" # str | State data type(example:object) + start_date = "startDate_example" # str | Start date (example:2021-1-1T00:00:00) + end_date = "endDate_example" # str | End date (example:2021-12-1T00:00:00) + time_zone = "timeZone_example" # str | Time zone (example:UTC) (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count_with_state_data_type(state_data_type, start_date, end_date) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->get_count_with_state_data_type: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_with_state_data_type(state_data_type, start_date, end_date, time_zone=time_zone) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->get_count_with_state_data_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| State data type(example:object) | + **start_date** | **str**| Start date (example:2021-1-1T00:00:00) | + **end_date** | **str**| End date (example:2021-12-1T00:00:00) | + **time_zone** | **str**| Time zone (example:UTC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields_by_state_data_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_stat_data_fields_by_state_data_type(state_data_type) + + + +Get statistics fields and types + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_details_api.MonitoringDeviceStatisticsDetailsApi(api_client) + state_data_type = "state_data_type_example" # str | State data type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_stat_data_fields_by_state_data_type(state_data_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->get_stat_data_fields_by_state_data_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state_data_type** | **str**| State data type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statistics_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_statistics_type() + + + +Get statistics types + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_device_statistics_details_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_device_statistics_details_api.MonitoringDeviceStatisticsDetailsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_statistics_type() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringDeviceStatisticsDetailsApi->get_statistics_type: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringEndpointTrackerStatusApi.md b/docs/MonitoringEndpointTrackerStatusApi.md new file mode 100644 index 0000000..8592a6d --- /dev/null +++ b/docs/MonitoringEndpointTrackerStatusApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringEndpointTrackerStatusApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query18**](MonitoringEndpointTrackerStatusApi.md#get_aggregation_data_by_query18) | **GET** /statistics/endpointTracker/aggregation | +[**get_count20**](MonitoringEndpointTrackerStatusApi.md#get_count20) | **GET** /statistics/endpointTracker/doccount | +[**get_count_post20**](MonitoringEndpointTrackerStatusApi.md#get_count_post20) | **POST** /statistics/endpointTracker/doccount | +[**get_post_aggregation_app_data_by_query17**](MonitoringEndpointTrackerStatusApi.md#get_post_aggregation_app_data_by_query17) | **POST** /statistics/endpointTracker/app-agg/aggregation | +[**get_post_aggregation_data_by_query17**](MonitoringEndpointTrackerStatusApi.md#get_post_aggregation_data_by_query17) | **POST** /statistics/endpointTracker/aggregation | +[**get_post_stat_bulk_raw_data18**](MonitoringEndpointTrackerStatusApi.md#get_post_stat_bulk_raw_data18) | **POST** /statistics/endpointTracker/page | +[**get_stat_bulk_raw_data18**](MonitoringEndpointTrackerStatusApi.md#get_stat_bulk_raw_data18) | **GET** /statistics/endpointTracker/page | +[**get_stat_data_fields20**](MonitoringEndpointTrackerStatusApi.md#get_stat_data_fields20) | **GET** /statistics/endpointTracker/fields | +[**get_stat_data_raw_data17**](MonitoringEndpointTrackerStatusApi.md#get_stat_data_raw_data17) | **GET** /statistics/endpointTracker | +[**get_stat_data_raw_data_as_csv18**](MonitoringEndpointTrackerStatusApi.md#get_stat_data_raw_data_as_csv18) | **GET** /statistics/endpointTracker/csv | +[**get_stat_query_fields20**](MonitoringEndpointTrackerStatusApi.md#get_stat_query_fields20) | **GET** /statistics/endpointTracker/query/fields | +[**get_stats_raw_data18**](MonitoringEndpointTrackerStatusApi.md#get_stats_raw_data18) | **POST** /statistics/endpointTracker | + + +# **get_aggregation_data_by_query18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query18() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query18(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_aggregation_data_by_query18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count20(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count20(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_count20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post20() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_count_post20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query17() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_post_aggregation_app_data_by_query17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query17() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query17(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_post_aggregation_data_by_query17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data18() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data18(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_post_stat_bulk_raw_data18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data18() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data18(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_stat_bulk_raw_data18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields20() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields20() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_stat_data_fields20: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data17() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]},"size":10000}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data17(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_stat_data_raw_data17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv18** +> str get_stat_data_raw_data_as_csv18() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv18(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_stat_data_raw_data_as_csv18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields20() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields20() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_stat_query_fields20: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data18() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_endpoint_tracker_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_endpoint_tracker_status_api.MonitoringEndpointTrackerStatusApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data18(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEndpointTrackerStatusApi->get_stats_raw_data18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringEventsApi.md b/docs/MonitoringEventsApi.md new file mode 100644 index 0000000..f968322 --- /dev/null +++ b/docs/MonitoringEventsApi.md @@ -0,0 +1,1418 @@ +# openapi_client.MonitoringEventsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_events_query_config**](MonitoringEventsApi.md#create_events_query_config) | **GET** /event/query/input | +[**enable_events_from_file**](MonitoringEventsApi.md#enable_events_from_file) | **GET** /event/enable/fileprocess | +[**find_events**](MonitoringEventsApi.md#find_events) | **GET** /event/severity | +[**get_aggregation_data_by_query25**](MonitoringEventsApi.md#get_aggregation_data_by_query25) | **GET** /event/aggregation | +[**get_components_as_key_value**](MonitoringEventsApi.md#get_components_as_key_value) | **GET** /event/component/keyvalue | +[**get_count27**](MonitoringEventsApi.md#get_count27) | **GET** /event/doccount | +[**get_count_post27**](MonitoringEventsApi.md#get_count_post27) | **POST** /event/doccount | +[**get_event_types_as_key_value**](MonitoringEventsApi.md#get_event_types_as_key_value) | **GET** /event/types/keyvalue | +[**get_events_by_component**](MonitoringEventsApi.md#get_events_by_component) | **GET** /event/getEventsByComponent | +[**get_listeners_info**](MonitoringEventsApi.md#get_listeners_info) | **GET** /event/listeners | +[**get_post_aggregation_app_data_by_query24**](MonitoringEventsApi.md#get_post_aggregation_app_data_by_query24) | **POST** /event/app-agg/aggregation | +[**get_post_aggregation_data_by_query24**](MonitoringEventsApi.md#get_post_aggregation_data_by_query24) | **POST** /event/aggregation | +[**get_post_stat_bulk_raw_data25**](MonitoringEventsApi.md#get_post_stat_bulk_raw_data25) | **POST** /event/page | +[**get_severity_histogram**](MonitoringEventsApi.md#get_severity_histogram) | **GET** /event/severity/summary | +[**get_stat_bulk_raw_data25**](MonitoringEventsApi.md#get_stat_bulk_raw_data25) | **GET** /event/page | +[**get_stat_data_fields27**](MonitoringEventsApi.md#get_stat_data_fields27) | **GET** /event/fields | +[**get_stat_data_raw_data24**](MonitoringEventsApi.md#get_stat_data_raw_data24) | **GET** /event | +[**get_stat_data_raw_data_as_csv25**](MonitoringEventsApi.md#get_stat_data_raw_data_as_csv25) | **GET** /event/csv | +[**get_stat_query_fields27**](MonitoringEventsApi.md#get_stat_query_fields27) | **GET** /event/query/fields | +[**get_stats_raw_data25**](MonitoringEventsApi.md#get_stats_raw_data25) | **POST** /event | + + +# **create_events_query_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_events_query_config() + + + +Create query configuration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_events_query_config() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->create_events_query_config: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable_events_from_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_events_from_file() + + + +Set enable events from file flag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.enable_events_from_file() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->enable_events_from_file: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find_events** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} find_events(severity_level) + + + +Retrieve events + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + severity_level = [ + "critical", + ] # [str] | Severity level + device_id = "00r252U250?250" # str | Device IP (optional) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.find_events(severity_level) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->find_events: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.find_events(severity_level, device_id=device_id, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->find_events: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **severity_level** | **[str]**| Severity level | + **device_id** | **str**| Device IP | [optional] + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query25() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query25(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_aggregation_data_by_query25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_components_as_key_value** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_components_as_key_value() + + + +Retrieve components as key/value pairs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_components_as_key_value() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_components_as_key_value: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count27(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count27(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_count27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post27() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_count_post27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_types_as_key_value** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_event_types_as_key_value() + + + +Retrieve event types as key/value pairs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_event_types_as_key_value() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_event_types_as_key_value: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_events_by_component** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_events_by_component() + + + +Retrieve components as key/value pairs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_events_by_component(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_events_by_component: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_listeners_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_listeners_info() + + + +Retrieve listener information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_listeners_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_listeners_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query24() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_post_aggregation_app_data_by_query24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query24() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_post_aggregation_data_by_query24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data25() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data25(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_post_stat_bulk_raw_data25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_severity_histogram** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_severity_histogram(device_id) + + + +Retrieve severity histogram + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + device_id = "deviceId_example" # str | Device IP + query = "00r252U250?250" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_severity_histogram(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_severity_histogram: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_severity_histogram(device_id, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_severity_histogram: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data25() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data25(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_stat_bulk_raw_data25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields27() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields27() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_stat_data_fields27: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data24() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data24(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_stat_data_raw_data24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv25** +> str get_stat_data_raw_data_as_csv25() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv25(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_stat_data_raw_data_as_csv25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields27() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields27() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_stat_query_fields27: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data25() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_events_api.MonitoringEventsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data25(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringEventsApi->get_stats_raw_data25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringFlowlogApi.md b/docs/MonitoringFlowlogApi.md new file mode 100644 index 0000000..33fb6cb --- /dev/null +++ b/docs/MonitoringFlowlogApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringFlowlogApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query26**](MonitoringFlowlogApi.md#get_aggregation_data_by_query26) | **GET** /statistics/flowlog/aggregation | +[**get_count28**](MonitoringFlowlogApi.md#get_count28) | **GET** /statistics/flowlog/doccount | +[**get_count_post28**](MonitoringFlowlogApi.md#get_count_post28) | **POST** /statistics/flowlog/doccount | +[**get_post_aggregation_app_data_by_query25**](MonitoringFlowlogApi.md#get_post_aggregation_app_data_by_query25) | **POST** /statistics/flowlog/app-agg/aggregation | +[**get_post_aggregation_data_by_query26**](MonitoringFlowlogApi.md#get_post_aggregation_data_by_query26) | **POST** /statistics/flowlog/aggregation | +[**get_post_stat_bulk_raw_data26**](MonitoringFlowlogApi.md#get_post_stat_bulk_raw_data26) | **POST** /statistics/flowlog/page | +[**get_stat_bulk_raw_data26**](MonitoringFlowlogApi.md#get_stat_bulk_raw_data26) | **GET** /statistics/flowlog/page | +[**get_stat_data_fields28**](MonitoringFlowlogApi.md#get_stat_data_fields28) | **GET** /statistics/flowlog/fields | +[**get_stat_data_raw_data25**](MonitoringFlowlogApi.md#get_stat_data_raw_data25) | **GET** /statistics/flowlog | +[**get_stat_data_raw_data_as_csv26**](MonitoringFlowlogApi.md#get_stat_data_raw_data_as_csv26) | **GET** /statistics/flowlog/csv | +[**get_stat_query_fields28**](MonitoringFlowlogApi.md#get_stat_query_fields28) | **GET** /statistics/flowlog/query/fields | +[**get_stats_raw_data26**](MonitoringFlowlogApi.md#get_stats_raw_data26) | **POST** /statistics/flowlog | + + +# **get_aggregation_data_by_query26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query26() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query26(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_aggregation_data_by_query26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count28(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count28(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_count28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post28() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_count_post28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query25() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_post_aggregation_app_data_by_query25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query26() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_post_aggregation_data_by_query26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data26() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data26(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_post_stat_bulk_raw_data26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data26() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data26(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_stat_bulk_raw_data26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields28() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields28() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_stat_data_fields28: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data25() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data25(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_stat_data_raw_data25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv26** +> str get_stat_data_raw_data_as_csv26() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv26(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_stat_data_raw_data_as_csv26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields28() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields28() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_stat_query_fields28: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data26() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_flowlog_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_flowlog_api.MonitoringFlowlogApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data26(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringFlowlogApi->get_stats_raw_data26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringHealthApi.md b/docs/MonitoringHealthApi.md new file mode 100644 index 0000000..b5a7dbb --- /dev/null +++ b/docs/MonitoringHealthApi.md @@ -0,0 +1,174 @@ +# openapi_client.MonitoringHealthApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_devices_health**](MonitoringHealthApi.md#get_devices_health) | **GET** /health/devices | +[**get_devices_health_overview**](MonitoringHealthApi.md#get_devices_health_overview) | **GET** /health/devices/overview | + + +# **get_devices_health** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_devices_health() + + + +get the devices health properties + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_health_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_health_api.MonitoringHealthApi(api_client) + page = 1 # int | Page Number (optional) + page_size = 1 # int | Page Size (optional) + sort_by = "sortBy_example" # str | Sort By Property (optional) + sort_order = "sortOrder_example" # str | Sort Order (optional) + starting_device_id = "startingDeviceId_example" # str | Optional device ID to start first page (optional) + site_id = "siteId_example" # str | Optional site ID to filter devices (optional) + group_id = "group_id_example" # str | Optional group ID to filter devices (optional) + group_id2 = "groupId_example" # str | Optional group ID to filter devices (optional) + vpn_id = "vpnId_example" # str | Optional vpn ID to filter devices (optional) + reachable = True # bool | (optional) + control_status = "controlStatus_example" # str | (optional) + personality = "personality_example" # str | (optional) + health = "health_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_devices_health(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, starting_device_id=starting_device_id, site_id=site_id, group_id=group_id, group_id2=group_id2, vpn_id=vpn_id, reachable=reachable, control_status=control_status, personality=personality, health=health) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringHealthApi->get_devices_health: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| Page Number | [optional] + **page_size** | **int**| Page Size | [optional] + **sort_by** | **str**| Sort By Property | [optional] + **sort_order** | **str**| Sort Order | [optional] + **starting_device_id** | **str**| Optional device ID to start first page | [optional] + **site_id** | **str**| Optional site ID to filter devices | [optional] + **group_id** | **str**| Optional group ID to filter devices | [optional] + **group_id2** | **str**| Optional group ID to filter devices | [optional] + **vpn_id** | **str**| Optional vpn ID to filter devices | [optional] + **reachable** | **bool**| | [optional] + **control_status** | **str**| | [optional] + **personality** | **str**| | [optional] + **health** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_devices_health_overview** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_devices_health_overview() + + + +gets devices health overview + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_health_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_health_api.MonitoringHealthApi(api_client) + vpn_id = "vpn_id_example" # str | Optional vpn ID to filter devices (optional) + vpn_id2 = "vpnId_example" # str | Optional vpn ID to filter devices (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_devices_health_overview(vpn_id=vpn_id, vpn_id2=vpn_id2) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringHealthApi->get_devices_health_overview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | **str**| Optional vpn ID to filter devices | [optional] + **vpn_id2** | **str**| Optional vpn ID to filter devices | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringIPsAlertApi.md b/docs/MonitoringIPsAlertApi.md new file mode 100644 index 0000000..6835044 --- /dev/null +++ b/docs/MonitoringIPsAlertApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringIPsAlertApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query21**](MonitoringIPsAlertApi.md#get_aggregation_data_by_query21) | **GET** /statistics/ipsalert/aggregation | +[**get_count23**](MonitoringIPsAlertApi.md#get_count23) | **GET** /statistics/ipsalert/doccount | +[**get_count_post23**](MonitoringIPsAlertApi.md#get_count_post23) | **POST** /statistics/ipsalert/doccount | +[**get_post_aggregation_app_data_by_query20**](MonitoringIPsAlertApi.md#get_post_aggregation_app_data_by_query20) | **POST** /statistics/ipsalert/app-agg/aggregation | +[**get_post_aggregation_data_by_query20**](MonitoringIPsAlertApi.md#get_post_aggregation_data_by_query20) | **POST** /statistics/ipsalert/aggregation | +[**get_post_stat_bulk_raw_data21**](MonitoringIPsAlertApi.md#get_post_stat_bulk_raw_data21) | **POST** /statistics/ipsalert/page | +[**get_stat_bulk_raw_data21**](MonitoringIPsAlertApi.md#get_stat_bulk_raw_data21) | **GET** /statistics/ipsalert/page | +[**get_stat_data_fields23**](MonitoringIPsAlertApi.md#get_stat_data_fields23) | **GET** /statistics/ipsalert/fields | +[**get_stat_data_raw_data20**](MonitoringIPsAlertApi.md#get_stat_data_raw_data20) | **GET** /statistics/ipsalert | +[**get_stat_data_raw_data_as_csv21**](MonitoringIPsAlertApi.md#get_stat_data_raw_data_as_csv21) | **GET** /statistics/ipsalert/csv | +[**get_stat_query_fields23**](MonitoringIPsAlertApi.md#get_stat_query_fields23) | **GET** /statistics/ipsalert/query/fields | +[**get_stats_raw_data21**](MonitoringIPsAlertApi.md#get_stats_raw_data21) | **POST** /statistics/ipsalert | + + +# **get_aggregation_data_by_query21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query21() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query21(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_aggregation_data_by_query21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count23(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count23(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_count23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post23() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_count_post23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query20() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_post_aggregation_app_data_by_query20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query20() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query20(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_post_aggregation_data_by_query20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data21() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data21(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_post_stat_bulk_raw_data21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data21() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data21(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_stat_bulk_raw_data21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields23() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields23() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_stat_data_fields23: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data20** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data20() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data20(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_stat_data_raw_data20: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv21** +> str get_stat_data_raw_data_as_csv21() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv21(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_stat_data_raw_data_as_csv21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields23() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields23() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_stat_query_fields23: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data21() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_ips_alert_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_ips_alert_api.MonitoringIPsAlertApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data21(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringIPsAlertApi->get_stats_raw_data21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringInterfaceStatisticsApi.md b/docs/MonitoringInterfaceStatisticsApi.md new file mode 100644 index 0000000..556a834 --- /dev/null +++ b/docs/MonitoringInterfaceStatisticsApi.md @@ -0,0 +1,995 @@ +# openapi_client.MonitoringInterfaceStatisticsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query10**](MonitoringInterfaceStatisticsApi.md#get_aggregation_data_by_query10) | **GET** /statistics/interface/aggregation | +[**get_bandwidth_distribution**](MonitoringInterfaceStatisticsApi.md#get_bandwidth_distribution) | **GET** /statistics/interface/ccapacity/distribution | +[**get_count12**](MonitoringInterfaceStatisticsApi.md#get_count12) | **GET** /statistics/interface/doccount | +[**get_count_post12**](MonitoringInterfaceStatisticsApi.md#get_count_post12) | **POST** /statistics/interface/doccount | +[**get_post_aggregation_app_data_by_query10**](MonitoringInterfaceStatisticsApi.md#get_post_aggregation_app_data_by_query10) | **POST** /statistics/interface/app-agg/aggregation | +[**get_post_aggregation_data_by_query10**](MonitoringInterfaceStatisticsApi.md#get_post_aggregation_data_by_query10) | **POST** /statistics/interface/aggregation | +[**get_post_stat_bulk_raw_data10**](MonitoringInterfaceStatisticsApi.md#get_post_stat_bulk_raw_data10) | **POST** /statistics/interface/page | +[**get_stat_bulk_raw_data10**](MonitoringInterfaceStatisticsApi.md#get_stat_bulk_raw_data10) | **GET** /statistics/interface/page | +[**get_stat_data_fields12**](MonitoringInterfaceStatisticsApi.md#get_stat_data_fields12) | **GET** /statistics/interface/fields | +[**get_stat_data_raw_data10**](MonitoringInterfaceStatisticsApi.md#get_stat_data_raw_data10) | **GET** /statistics/interface | +[**get_stat_data_raw_data_as_csv10**](MonitoringInterfaceStatisticsApi.md#get_stat_data_raw_data_as_csv10) | **GET** /statistics/interface/csv | +[**get_stat_query_fields12**](MonitoringInterfaceStatisticsApi.md#get_stat_query_fields12) | **GET** /statistics/interface/query/fields | +[**get_statistics_per_interface**](MonitoringInterfaceStatisticsApi.md#get_statistics_per_interface) | **GET** /statistics/interface/type | +[**get_stats_raw_data10**](MonitoringInterfaceStatisticsApi.md#get_stats_raw_data10) | **POST** /statistics/interface | + + +# **get_aggregation_data_by_query10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query10() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query10(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_aggregation_data_by_query10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bandwidth_distribution** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bandwidth_distribution() + + + +Get bandwidth distribution + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_bandwidth_distribution() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_bandwidth_distribution: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count12(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count12(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_count12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post12() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_count_post12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query10() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_post_aggregation_app_data_by_query10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query10() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query10(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_post_aggregation_data_by_query10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data10() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data10(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_post_stat_bulk_raw_data10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data10() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data10(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_stat_bulk_raw_data10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields12() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields12() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_stat_data_fields12: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data10() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data10(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_stat_data_raw_data10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv10** +> str get_stat_data_raw_data_as_csv10() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv10(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_stat_data_raw_data_as_csv10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields12() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields12() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_stat_query_fields12: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statistics_per_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_statistics_per_interface(query) + + + +Get statistics per interface + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + query = "query_example" # str | Query filter + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_statistics_per_interface(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_statistics_per_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data10** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data10() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_interface_statistics_api.MonitoringInterfaceStatisticsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data10(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringInterfaceStatisticsApi->get_stats_raw_data10: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringQoSApi.md b/docs/MonitoringQoSApi.md new file mode 100644 index 0000000..d273284 --- /dev/null +++ b/docs/MonitoringQoSApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringQoSApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query13**](MonitoringQoSApi.md#get_aggregation_data_by_query13) | **GET** /statistics/qos/aggregation | +[**get_count15**](MonitoringQoSApi.md#get_count15) | **GET** /statistics/qos/doccount | +[**get_count_post15**](MonitoringQoSApi.md#get_count_post15) | **POST** /statistics/qos/doccount | +[**get_post_aggregation_app_data_by_query12**](MonitoringQoSApi.md#get_post_aggregation_app_data_by_query12) | **POST** /statistics/qos/app-agg/aggregation | +[**get_post_aggregation_data_by_query12**](MonitoringQoSApi.md#get_post_aggregation_data_by_query12) | **POST** /statistics/qos/aggregation | +[**get_post_stat_bulk_raw_data13**](MonitoringQoSApi.md#get_post_stat_bulk_raw_data13) | **POST** /statistics/qos/page | +[**get_stat_bulk_raw_data13**](MonitoringQoSApi.md#get_stat_bulk_raw_data13) | **GET** /statistics/qos/page | +[**get_stat_data_fields15**](MonitoringQoSApi.md#get_stat_data_fields15) | **GET** /statistics/qos/fields | +[**get_stat_data_raw_data13**](MonitoringQoSApi.md#get_stat_data_raw_data13) | **GET** /statistics/qos | +[**get_stat_data_raw_data_as_csv13**](MonitoringQoSApi.md#get_stat_data_raw_data_as_csv13) | **GET** /statistics/qos/csv | +[**get_stat_query_fields15**](MonitoringQoSApi.md#get_stat_query_fields15) | **GET** /statistics/qos/query/fields | +[**get_stats_raw_data13**](MonitoringQoSApi.md#get_stats_raw_data13) | **POST** /statistics/qos | + + +# **get_aggregation_data_by_query13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query13() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query13(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_aggregation_data_by_query13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count15(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count15(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_count15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post15() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_count_post15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query12() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_post_aggregation_app_data_by_query12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query12** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query12() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query12(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_post_aggregation_data_by_query12: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data13() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data13(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_post_stat_bulk_raw_data13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data13() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data13(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_stat_bulk_raw_data13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields15() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields15() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_stat_data_fields15: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data13() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data13(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_stat_data_raw_data13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv13** +> str get_stat_data_raw_data_as_csv13() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv13(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_stat_data_raw_data_as_csv13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields15() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields15() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_stat_query_fields15: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data13() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_qo_s_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_qo_s_api.MonitoringQoSApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data13(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringQoSApi->get_stats_raw_data13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md b/docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md new file mode 100644 index 0000000..833e10e --- /dev/null +++ b/docs/MonitoringSecurityUnifiedLoggingConnectionEventsApi.md @@ -0,0 +1,932 @@ +# openapi_client.MonitoringSecurityUnifiedLoggingConnectionEventsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query14**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_aggregation_data_by_query14) | **GET** /statistics/sul/connections/aggregation | +[**get_count16**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_count16) | **GET** /statistics/sul/connections/doccount | +[**get_count_post16**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_count_post16) | **POST** /statistics/sul/connections/doccount | +[**get_filter_policy_name_list**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_filter_policy_name_list) | **GET** /statistics/sul/connections/filter/policy_name/{policyType} | +[**get_post_aggregation_app_data_by_query13**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_post_aggregation_app_data_by_query13) | **POST** /statistics/sul/connections/app-agg/aggregation | +[**get_post_aggregation_data_by_query13**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_post_aggregation_data_by_query13) | **POST** /statistics/sul/connections/aggregation | +[**get_post_stat_bulk_raw_data14**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_post_stat_bulk_raw_data14) | **POST** /statistics/sul/connections/page | +[**get_stat_bulk_raw_data14**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_bulk_raw_data14) | **GET** /statistics/sul/connections/page | +[**get_stat_data_fields16**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_data_fields16) | **GET** /statistics/sul/connections/fields | +[**get_stat_data_raw_data_as_csv14**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_data_raw_data_as_csv14) | **GET** /statistics/sul/connections/csv | +[**get_stat_query_fields16**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stat_query_fields16) | **GET** /statistics/sul/connections/query/fields | +[**get_stats_raw_data14**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_stats_raw_data14) | **POST** /statistics/sul/connections | +[**get_sul_stat_data_raw_data**](MonitoringSecurityUnifiedLoggingConnectionEventsApi.md#get_sul_stat_data_raw_data) | **GET** /statistics/sul/connections | + + +# **get_aggregation_data_by_query14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query14() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query14(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_aggregation_data_by_query14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count16(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count16(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_count16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post16() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_count_post16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_filter_policy_name_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_filter_policy_name_list(policy_type, query) + + + +Get filter Policy Name list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + policy_type = "zoneBasedFW" # str | Policy type + query = "{"query":{"condition":"AND","rules":[{"field":"vdevice_name","type":"string","operator":"in","value":["172.16.255.15"]}]}}" # str | query string + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_filter_policy_name_list(policy_type, query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_filter_policy_name_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_type** | **str**| Policy type | + **query** | **str**| query string | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query13() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_post_aggregation_app_data_by_query13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query13() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_post_aggregation_data_by_query13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data14() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data14(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_post_stat_bulk_raw_data14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data14() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1"],"field":"vpn_id","type":"int","operator":"in"},{"value":["p1"],"field":"fw_policy","type":"string","operator":"in"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data14(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_stat_bulk_raw_data14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields16() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields16() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_stat_data_fields16: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv14** +> str get_stat_data_raw_data_as_csv14() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1"],"field":"vpn_id","type":"int","operator":"in"},{"value":["p1"],"field":"fw_policy","type":"string","operator":"in"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv14(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_stat_data_raw_data_as_csv14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields16() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields16() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_stat_query_fields16: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data14** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data14() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data14(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_stats_raw_data14: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sul_stat_data_raw_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sul_stat_data_raw_data() + + + +Get security connection events stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_security_unified_logging_connection_events_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_security_unified_logging_connection_events_api.MonitoringSecurityUnifiedLoggingConnectionEventsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sul_stat_data_raw_data(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSecurityUnifiedLoggingConnectionEventsApi->get_sul_stat_data_raw_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringServerInfoApi.md b/docs/MonitoringServerInfoApi.md new file mode 100644 index 0000000..30199c3 --- /dev/null +++ b/docs/MonitoringServerInfoApi.md @@ -0,0 +1,73 @@ +# openapi_client.MonitoringServerInfoApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_server_info**](MonitoringServerInfoApi.md#create_server_info) | **GET** /server/info | + + +# **create_server_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_server_info() + + + +Get Server info + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_server_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_server_info_api.MonitoringServerInfoApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_server_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringServerInfoApi->create_server_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringStatsDownloadApi.md b/docs/MonitoringStatsDownloadApi.md new file mode 100644 index 0000000..3d6080f --- /dev/null +++ b/docs/MonitoringStatsDownloadApi.md @@ -0,0 +1,232 @@ +# openapi_client.MonitoringStatsDownloadApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**download1**](MonitoringStatsDownloadApi.md#download1) | **GET** /statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName} | +[**download_list**](MonitoringStatsDownloadApi.md#download_list) | **POST** /statistics/download/{processType}/filelist | +[**fetch_list**](MonitoringStatsDownloadApi.md#fetch_list) | **GET** /statistics/download/{processType}/fetchvManageList | + + +# **download1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download1(process_type, file_type, queue, device_ip, token, file_name) + + + +Downloading stats file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_download_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_download_api.MonitoringStatsDownloadApi(api_client) + process_type = "processType_example" # str | Process type + file_type = "fileType_example" # str | File type + queue = "queue_example" # str | Queue name + device_ip = "deviceIp_example" # str | Device IP + token = "token_example" # str | Token + file_name = "fileName_example" # str | File name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download1(process_type, file_type, queue, device_ip, token, file_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsDownloadApi->download1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_type** | **str**| Process type | + **file_type** | **str**| File type | + **queue** | **str**| Queue name | + **device_ip** | **str**| Device IP | + **token** | **str**| Token | + **file_name** | **str**| File name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_list** +> download_list(process_type) + + + +Downloading list of stats file + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_download_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_download_api.MonitoringStatsDownloadApi(api_client) + process_type = "processType_example" # str | Possible types are: remoteprocessing, dr + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.download_list(process_type) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsDownloadApi->download_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.download_list(process_type, get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsDownloadApi->download_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_type** | **str**| Possible types are: remoteprocessing, dr | + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fetch_list** +> fetch_list(process_type) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_download_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_download_api.MonitoringStatsDownloadApi(api_client) + process_type = "processType_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.fetch_list(process_type) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsDownloadApi->fetch_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_type** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringStatsProcessingApi.md b/docs/MonitoringStatsProcessingApi.md new file mode 100644 index 0000000..09c66da --- /dev/null +++ b/docs/MonitoringStatsProcessingApi.md @@ -0,0 +1,606 @@ +# openapi_client.MonitoringStatsProcessingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**enable_statistics_demo_mode**](MonitoringStatsProcessingApi.md#enable_statistics_demo_mode) | **GET** /statistics/demomode | +[**generate_stats_collect_thread_report**](MonitoringStatsProcessingApi.md#generate_stats_collect_thread_report) | **GET** /statistics/collect/thread/status | +[**generate_stats_process_report**](MonitoringStatsProcessingApi.md#generate_stats_process_report) | **GET** /statistics/process/status | +[**generate_stats_process_thread_report**](MonitoringStatsProcessingApi.md#generate_stats_process_thread_report) | **GET** /statistics/process/thread/status | +[**get_statistic_type**](MonitoringStatsProcessingApi.md#get_statistic_type) | **GET** /statistics | +[**get_statistics_processing_counters**](MonitoringStatsProcessingApi.md#get_statistics_processing_counters) | **GET** /statistics/process/counters | +[**process_statistics_data**](MonitoringStatsProcessingApi.md#process_statistics_data) | **GET** /statistics/process | +[**reset_stats_collection**](MonitoringStatsProcessingApi.md#reset_stats_collection) | **GET** /statistics/collection/reset/{processQueue} | +[**start_stats_collection**](MonitoringStatsProcessingApi.md#start_stats_collection) | **GET** /statistics/collect | + + +# **enable_statistics_demo_mode** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_statistics_demo_mode() + + + +Enable statistic demo mode + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + enable = True # bool | Demo mode flag (optional) if omitted the server will use the default value of True + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.enable_statistics_demo_mode(enable=enable) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->enable_statistics_demo_mode: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enable** | **bool**| Demo mode flag | [optional] if omitted the server will use the default value of True + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_stats_collect_thread_report** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_stats_collect_thread_report() + + + +Get stats collect thread report + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_stats_collect_thread_report() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->generate_stats_collect_thread_report: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_stats_process_report** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_stats_process_report() + + + +Get stats process report + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + process_queue = 1 # int | Process queue (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_stats_process_report(process_queue=process_queue) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->generate_stats_process_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_queue** | **int**| Process queue | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_stats_process_thread_report** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] generate_stats_process_thread_report() + + + +Get stats process thread report + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.generate_stats_process_thread_report() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->generate_stats_process_thread_report: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statistic_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_statistic_type() + + + +Get statistics types + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_statistic_type() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->get_statistic_type: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statistics_processing_counters** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_statistics_processing_counters() + + + +Get statistics processing counters + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_statistics_processing_counters() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->get_statistics_processing_counters: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_statistics_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} process_statistics_data() + + + +Process stats data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.process_statistics_data() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->process_statistics_data: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reset_stats_collection** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} reset_stats_collection() + + + +Reset stats collect thread report + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.reset_stats_collection() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->reset_stats_collection: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **process_queue** | **int**| Process queue | defaults to -1 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **start_stats_collection** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} start_stats_collection() + + + +Start stats collect + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_stats_processing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_stats_processing_api.MonitoringStatsProcessingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.start_stats_collection() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatsProcessingApi->start_stats_collection: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringStatusApi.md b/docs/MonitoringStatusApi.md new file mode 100644 index 0000000..5e15a87 --- /dev/null +++ b/docs/MonitoringStatusApi.md @@ -0,0 +1,359 @@ +# openapi_client.MonitoringStatusApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_disabled_device_list**](MonitoringStatusApi.md#get_disabled_device_list) | **GET** /statistics/settings/disable/devicelist/{indexName} | +[**get_enabled_index_for_device**](MonitoringStatusApi.md#get_enabled_index_for_device) | **GET** /statistics/settings/status/device | +[**get_statistics_settings**](MonitoringStatusApi.md#get_statistics_settings) | **GET** /statistics/settings/status | +[**update_statistics_device_list**](MonitoringStatusApi.md#update_statistics_device_list) | **PUT** /statistics/settings/disable/devicelist/{indexName} | +[**update_statistics_settings**](MonitoringStatusApi.md#update_statistics_settings) | **PUT** /statistics/settings/status | + + +# **get_disabled_device_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_disabled_device_list(index_name) + + + +Get list of disabled devices for a statistics index + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_status_api.MonitoringStatusApi(api_client) + index_name = "indexName_example" # str | Index name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_disabled_device_list(index_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatusApi->get_disabled_device_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_name** | **str**| Index name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_enabled_index_for_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_enabled_index_for_device(device_id) + + + +Get list of enabled device for statistics index + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_status_api.MonitoringStatusApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_enabled_index_for_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatusApi->get_enabled_index_for_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statistics_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_statistics_settings() + + + +Get statistics settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_status_api.MonitoringStatusApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_statistics_settings() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatusApi->get_statistics_settings: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_statistics_device_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_statistics_device_list(index_name) + + + +Update list of disabled devices for a statistics index + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_status_api.MonitoringStatusApi(api_client) + index_name = "indexName_example" # str | Index name + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Disabled device (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_statistics_device_list(index_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatusApi->update_statistics_device_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_statistics_device_list(index_name, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatusApi->update_statistics_device_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_name** | **str**| Index name | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Disabled device | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_statistics_settings** +> update_statistics_settings() + + + +Update statistics settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_status_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_status_api.MonitoringStatusApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats setting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_statistics_settings(body=body) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringStatusApi->update_statistics_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats setting | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringSystemStatusStatsApi.md b/docs/MonitoringSystemStatusStatsApi.md new file mode 100644 index 0000000..23a5d55 --- /dev/null +++ b/docs/MonitoringSystemStatusStatsApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringSystemStatusStatsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query17**](MonitoringSystemStatusStatsApi.md#get_aggregation_data_by_query17) | **GET** /statistics/system/stats/aggregation | +[**get_count19**](MonitoringSystemStatusStatsApi.md#get_count19) | **GET** /statistics/system/stats/doccount | +[**get_count_post19**](MonitoringSystemStatusStatsApi.md#get_count_post19) | **POST** /statistics/system/stats/doccount | +[**get_post_aggregation_app_data_by_query16**](MonitoringSystemStatusStatsApi.md#get_post_aggregation_app_data_by_query16) | **POST** /statistics/system/stats/app-agg/aggregation | +[**get_post_aggregation_data_by_query16**](MonitoringSystemStatusStatsApi.md#get_post_aggregation_data_by_query16) | **POST** /statistics/system/stats/aggregation | +[**get_post_stat_bulk_raw_data17**](MonitoringSystemStatusStatsApi.md#get_post_stat_bulk_raw_data17) | **POST** /statistics/system/stats/page | +[**get_stat_bulk_raw_data17**](MonitoringSystemStatusStatsApi.md#get_stat_bulk_raw_data17) | **GET** /statistics/system/stats/page | +[**get_stat_data_fields19**](MonitoringSystemStatusStatsApi.md#get_stat_data_fields19) | **GET** /statistics/system/stats/fields | +[**get_stat_data_raw_data16**](MonitoringSystemStatusStatsApi.md#get_stat_data_raw_data16) | **GET** /statistics/system/stats | +[**get_stat_data_raw_data_as_csv17**](MonitoringSystemStatusStatsApi.md#get_stat_data_raw_data_as_csv17) | **GET** /statistics/system/stats/csv | +[**get_stat_query_fields19**](MonitoringSystemStatusStatsApi.md#get_stat_query_fields19) | **GET** /statistics/system/stats/query/fields | +[**get_stats_raw_data17**](MonitoringSystemStatusStatsApi.md#get_stats_raw_data17) | **POST** /statistics/system/stats | + + +# **get_aggregation_data_by_query17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query17() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query17(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_aggregation_data_by_query17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count19(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count19(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_count19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post19() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post19(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_count_post19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query16() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_post_aggregation_app_data_by_query16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query16() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query16(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_post_aggregation_data_by_query16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data17() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data17(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_post_stat_bulk_raw_data17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data17() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data17(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_stat_bulk_raw_data17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields19() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields19() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_stat_data_fields19: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data16() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data16(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_stat_data_raw_data16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv17** +> str get_stat_data_raw_data_as_csv17() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv17(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_stat_data_raw_data_as_csv17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields19() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields19() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_stat_query_fields19: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data17** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data17() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_system_status_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_system_status_stats_api.MonitoringSystemStatusStatsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data17(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringSystemStatusStatsApi->get_stats_raw_data17: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringURLFilteringApi.md b/docs/MonitoringURLFilteringApi.md new file mode 100644 index 0000000..1b5ac49 --- /dev/null +++ b/docs/MonitoringURLFilteringApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringURLFilteringApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query22**](MonitoringURLFilteringApi.md#get_aggregation_data_by_query22) | **GET** /statistics/urlf/aggregation | +[**get_count24**](MonitoringURLFilteringApi.md#get_count24) | **GET** /statistics/urlf/doccount | +[**get_count_post24**](MonitoringURLFilteringApi.md#get_count_post24) | **POST** /statistics/urlf/doccount | +[**get_post_aggregation_app_data_by_query21**](MonitoringURLFilteringApi.md#get_post_aggregation_app_data_by_query21) | **POST** /statistics/urlf/app-agg/aggregation | +[**get_post_aggregation_data_by_query21**](MonitoringURLFilteringApi.md#get_post_aggregation_data_by_query21) | **POST** /statistics/urlf/aggregation | +[**get_post_stat_bulk_raw_data22**](MonitoringURLFilteringApi.md#get_post_stat_bulk_raw_data22) | **POST** /statistics/urlf/page | +[**get_stat_bulk_raw_data22**](MonitoringURLFilteringApi.md#get_stat_bulk_raw_data22) | **GET** /statistics/urlf/page | +[**get_stat_data_fields24**](MonitoringURLFilteringApi.md#get_stat_data_fields24) | **GET** /statistics/urlf/fields | +[**get_stat_data_raw_data21**](MonitoringURLFilteringApi.md#get_stat_data_raw_data21) | **GET** /statistics/urlf | +[**get_stat_data_raw_data_as_csv22**](MonitoringURLFilteringApi.md#get_stat_data_raw_data_as_csv22) | **GET** /statistics/urlf/csv | +[**get_stat_query_fields24**](MonitoringURLFilteringApi.md#get_stat_query_fields24) | **GET** /statistics/urlf/query/fields | +[**get_stats_raw_data22**](MonitoringURLFilteringApi.md#get_stats_raw_data22) | **POST** /statistics/urlf | + + +# **get_aggregation_data_by_query22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query22() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query22(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_aggregation_data_by_query22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count24(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count24(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_count24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post24() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post24(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_count_post24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query21() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_post_aggregation_app_data_by_query21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query21() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_post_aggregation_data_by_query21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data22() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data22(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_post_stat_bulk_raw_data22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data22() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data22(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_stat_bulk_raw_data22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields24() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields24() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_stat_data_fields24: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data21() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data21(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_stat_data_raw_data21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv22** +> str get_stat_data_raw_data_as_csv22() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv22(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_stat_data_raw_data_as_csv22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields24() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields24() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_stat_query_fields24: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data22() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_url_filtering_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_url_filtering_api.MonitoringURLFilteringApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data22(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringURLFilteringApi->get_stats_raw_data22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringUmbrellaApi.md b/docs/MonitoringUmbrellaApi.md new file mode 100644 index 0000000..107f8a6 --- /dev/null +++ b/docs/MonitoringUmbrellaApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringUmbrellaApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query24**](MonitoringUmbrellaApi.md#get_aggregation_data_by_query24) | **GET** /statistics/umbrella/aggregation | +[**get_count26**](MonitoringUmbrellaApi.md#get_count26) | **GET** /statistics/umbrella/doccount | +[**get_count_post26**](MonitoringUmbrellaApi.md#get_count_post26) | **POST** /statistics/umbrella/doccount | +[**get_post_aggregation_app_data_by_query23**](MonitoringUmbrellaApi.md#get_post_aggregation_app_data_by_query23) | **POST** /statistics/umbrella/app-agg/aggregation | +[**get_post_aggregation_data_by_query23**](MonitoringUmbrellaApi.md#get_post_aggregation_data_by_query23) | **POST** /statistics/umbrella/aggregation | +[**get_post_stat_bulk_raw_data24**](MonitoringUmbrellaApi.md#get_post_stat_bulk_raw_data24) | **POST** /statistics/umbrella/page | +[**get_stat_bulk_raw_data24**](MonitoringUmbrellaApi.md#get_stat_bulk_raw_data24) | **GET** /statistics/umbrella/page | +[**get_stat_data_fields26**](MonitoringUmbrellaApi.md#get_stat_data_fields26) | **GET** /statistics/umbrella/fields | +[**get_stat_data_raw_data23**](MonitoringUmbrellaApi.md#get_stat_data_raw_data23) | **GET** /statistics/umbrella | +[**get_stat_data_raw_data_as_csv24**](MonitoringUmbrellaApi.md#get_stat_data_raw_data_as_csv24) | **GET** /statistics/umbrella/csv | +[**get_stat_query_fields26**](MonitoringUmbrellaApi.md#get_stat_query_fields26) | **GET** /statistics/umbrella/query/fields | +[**get_stats_raw_data24**](MonitoringUmbrellaApi.md#get_stats_raw_data24) | **POST** /statistics/umbrella | + + +# **get_aggregation_data_by_query24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query24() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query24(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_aggregation_data_by_query24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count26(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count26(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_count26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post26() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_count_post26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query23() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_post_aggregation_app_data_by_query23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query23() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query23(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_post_aggregation_data_by_query23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data24() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data24(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_post_stat_bulk_raw_data24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data24() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data24(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_stat_bulk_raw_data24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields26() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields26() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_stat_data_fields26: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data23() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data23(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_stat_data_raw_data23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv24** +> str get_stat_data_raw_data_as_csv24() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv24(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_stat_data_raw_data_as_csv24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields26() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields26() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_stat_query_fields26: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data24** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data24() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_api.MonitoringUmbrellaApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data24(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaApi->get_stats_raw_data24: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringUmbrellaPatternsApi.md b/docs/MonitoringUmbrellaPatternsApi.md new file mode 100644 index 0000000..796370d --- /dev/null +++ b/docs/MonitoringUmbrellaPatternsApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringUmbrellaPatternsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query23**](MonitoringUmbrellaPatternsApi.md#get_aggregation_data_by_query23) | **GET** /statistics/fwall/aggregation | +[**get_count25**](MonitoringUmbrellaPatternsApi.md#get_count25) | **GET** /statistics/fwall/doccount | +[**get_count_post25**](MonitoringUmbrellaPatternsApi.md#get_count_post25) | **POST** /statistics/fwall/doccount | +[**get_post_aggregation_app_data_by_query22**](MonitoringUmbrellaPatternsApi.md#get_post_aggregation_app_data_by_query22) | **POST** /statistics/fwall/app-agg/aggregation | +[**get_post_aggregation_data_by_query22**](MonitoringUmbrellaPatternsApi.md#get_post_aggregation_data_by_query22) | **POST** /statistics/fwall/aggregation | +[**get_post_stat_bulk_raw_data23**](MonitoringUmbrellaPatternsApi.md#get_post_stat_bulk_raw_data23) | **POST** /statistics/fwall/page | +[**get_stat_bulk_raw_data23**](MonitoringUmbrellaPatternsApi.md#get_stat_bulk_raw_data23) | **GET** /statistics/fwall/page | +[**get_stat_data_fields25**](MonitoringUmbrellaPatternsApi.md#get_stat_data_fields25) | **GET** /statistics/fwall/fields | +[**get_stat_data_raw_data22**](MonitoringUmbrellaPatternsApi.md#get_stat_data_raw_data22) | **GET** /statistics/fwall | +[**get_stat_data_raw_data_as_csv23**](MonitoringUmbrellaPatternsApi.md#get_stat_data_raw_data_as_csv23) | **GET** /statistics/fwall/csv | +[**get_stat_query_fields25**](MonitoringUmbrellaPatternsApi.md#get_stat_query_fields25) | **GET** /statistics/fwall/query/fields | +[**get_stats_raw_data23**](MonitoringUmbrellaPatternsApi.md#get_stats_raw_data23) | **POST** /statistics/fwall | + + +# **get_aggregation_data_by_query23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query23() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query23(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_aggregation_data_by_query23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count25(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count25(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_count25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post25() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post25(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_count_post25: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query22() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_post_aggregation_app_data_by_query22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query22() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query22(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_post_aggregation_data_by_query22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data23() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data23(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_post_stat_bulk_raw_data23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data23() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data23(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_bulk_raw_data23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields25() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields25() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_data_fields25: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data22** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data22() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data22(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_data_raw_data22: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv23** +> str get_stat_data_raw_data_as_csv23() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv23(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_data_raw_data_as_csv23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields25** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields25() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields25() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_query_fields25: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data23** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data23() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_umbrella_patterns_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data23(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringUmbrellaPatternsApi->get_stats_raw_data23: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringVNFInterfaceStatisticsApi.md b/docs/MonitoringVNFInterfaceStatisticsApi.md new file mode 100644 index 0000000..b8964e6 --- /dev/null +++ b/docs/MonitoringVNFInterfaceStatisticsApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringVNFInterfaceStatisticsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query11**](MonitoringVNFInterfaceStatisticsApi.md#get_aggregation_data_by_query11) | **GET** /statistics/vnfstatistics/aggregation | +[**get_count13**](MonitoringVNFInterfaceStatisticsApi.md#get_count13) | **GET** /statistics/vnfstatistics/doccount | +[**get_count_post13**](MonitoringVNFInterfaceStatisticsApi.md#get_count_post13) | **POST** /statistics/vnfstatistics/doccount | +[**get_post_aggregation_app_data_by_query11**](MonitoringVNFInterfaceStatisticsApi.md#get_post_aggregation_app_data_by_query11) | **POST** /statistics/vnfstatistics/app-agg/aggregation | +[**get_post_aggregation_data_by_query11**](MonitoringVNFInterfaceStatisticsApi.md#get_post_aggregation_data_by_query11) | **POST** /statistics/vnfstatistics/aggregation | +[**get_post_stat_bulk_raw_data11**](MonitoringVNFInterfaceStatisticsApi.md#get_post_stat_bulk_raw_data11) | **POST** /statistics/vnfstatistics/page | +[**get_stat_bulk_raw_data11**](MonitoringVNFInterfaceStatisticsApi.md#get_stat_bulk_raw_data11) | **GET** /statistics/vnfstatistics/page | +[**get_stat_data_fields13**](MonitoringVNFInterfaceStatisticsApi.md#get_stat_data_fields13) | **GET** /statistics/vnfstatistics/fields | +[**get_stat_data_raw_data11**](MonitoringVNFInterfaceStatisticsApi.md#get_stat_data_raw_data11) | **GET** /statistics/vnfstatistics | +[**get_stat_data_raw_data_as_csv11**](MonitoringVNFInterfaceStatisticsApi.md#get_stat_data_raw_data_as_csv11) | **GET** /statistics/vnfstatistics/csv | +[**get_stat_query_fields13**](MonitoringVNFInterfaceStatisticsApi.md#get_stat_query_fields13) | **GET** /statistics/vnfstatistics/query/fields | +[**get_stats_raw_data11**](MonitoringVNFInterfaceStatisticsApi.md#get_stats_raw_data11) | **POST** /statistics/vnfstatistics | + + +# **get_aggregation_data_by_query11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query11() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query11(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_aggregation_data_by_query11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count13(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count13(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_count13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post13() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post13(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_count_post13: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query11() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_post_aggregation_app_data_by_query11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query11() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query11(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_post_aggregation_data_by_query11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data11() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data11(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_post_stat_bulk_raw_data11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data11() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data11(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_stat_bulk_raw_data11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields13() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields13() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_stat_data_fields13: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data11() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data11(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_stat_data_raw_data11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv11** +> str get_stat_data_raw_data_as_csv11() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv11(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_stat_data_raw_data_as_csv11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields13** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields13() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields13() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_stat_query_fields13: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data11** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data11() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_vnf_interface_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_vnf_interface_statistics_api.MonitoringVNFInterfaceStatisticsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data11(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringVNFInterfaceStatisticsApi->get_stats_raw_data11: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MonitoringWlanClientInfoApi.md b/docs/MonitoringWlanClientInfoApi.md new file mode 100644 index 0000000..292562c --- /dev/null +++ b/docs/MonitoringWlanClientInfoApi.md @@ -0,0 +1,861 @@ +# openapi_client.MonitoringWlanClientInfoApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aggregation_data_by_query19**](MonitoringWlanClientInfoApi.md#get_aggregation_data_by_query19) | **GET** /statistics/wlanclientinfo/aggregation | +[**get_count21**](MonitoringWlanClientInfoApi.md#get_count21) | **GET** /statistics/wlanclientinfo/doccount | +[**get_count_post21**](MonitoringWlanClientInfoApi.md#get_count_post21) | **POST** /statistics/wlanclientinfo/doccount | +[**get_post_aggregation_app_data_by_query18**](MonitoringWlanClientInfoApi.md#get_post_aggregation_app_data_by_query18) | **POST** /statistics/wlanclientinfo/app-agg/aggregation | +[**get_post_aggregation_data_by_query18**](MonitoringWlanClientInfoApi.md#get_post_aggregation_data_by_query18) | **POST** /statistics/wlanclientinfo/aggregation | +[**get_post_stat_bulk_raw_data19**](MonitoringWlanClientInfoApi.md#get_post_stat_bulk_raw_data19) | **POST** /statistics/wlanclientinfo/page | +[**get_stat_bulk_raw_data19**](MonitoringWlanClientInfoApi.md#get_stat_bulk_raw_data19) | **GET** /statistics/wlanclientinfo/page | +[**get_stat_data_fields21**](MonitoringWlanClientInfoApi.md#get_stat_data_fields21) | **GET** /statistics/wlanclientinfo/fields | +[**get_stat_data_raw_data18**](MonitoringWlanClientInfoApi.md#get_stat_data_raw_data18) | **GET** /statistics/wlanclientinfo | +[**get_stat_data_raw_data_as_csv19**](MonitoringWlanClientInfoApi.md#get_stat_data_raw_data_as_csv19) | **GET** /statistics/wlanclientinfo/csv | +[**get_stat_query_fields21**](MonitoringWlanClientInfoApi.md#get_stat_query_fields21) | **GET** /statistics/wlanclientinfo/query/fields | +[**get_stats_raw_data19**](MonitoringWlanClientInfoApi.md#get_stats_raw_data19) | **POST** /statistics/wlanclientinfo | + + +# **get_aggregation_data_by_query19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query19() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query19(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_aggregation_data_by_query19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count21(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count21(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_count21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post21() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post21(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_count_post21: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query18() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_post_aggregation_app_data_by_query18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query18() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_post_aggregation_data_by_query18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data19() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data19(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_post_stat_bulk_raw_data19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data19() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data19(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_stat_bulk_raw_data19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields21() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields21() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_stat_data_fields21: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data18() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data18(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_stat_data_raw_data18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv19** +> str get_stat_data_raw_data_as_csv19() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv19(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_stat_data_raw_data_as_csv19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields21** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields21() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields21() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_stat_query_fields21: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data19** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data19() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import monitoring_wlan_client_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = monitoring_wlan_client_info_api.MonitoringWlanClientInfoApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data19(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MonitoringWlanClientInfoApi->get_stats_raw_data19: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/MplsTimer.md b/docs/MplsTimer.md new file mode 100644 index 0000000..aeb2671 --- /dev/null +++ b/docs/MplsTimer.md @@ -0,0 +1,15 @@ +# MplsTimer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dscp** | **int** | | [optional] +**hello_interval** | **int** | | [optional] +**multiplier** | **int** | | [optional] +**path_mtu** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultiCloudAccountInfo.md b/docs/MultiCloudAccountInfo.md new file mode 100644 index 0000000..805849b --- /dev/null +++ b/docs/MultiCloudAccountInfo.md @@ -0,0 +1,32 @@ +# MultiCloudAccountInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_credentials** | **str** | | [optional] +**account_id** | **str** | | [optional] +**account_name** | **str** | | [optional] +**aws_cloud_gateway_with_tvpc_enabled** | **bool** | | [optional] +**aws_iam_credentials** | [**AwsIamCredentials**](AwsIamCredentials.md) | | [optional] +**aws_key_credentials** | [**AwsKeyCredentials**](AwsKeyCredentials.md) | | [optional] +**az_o365_enabled** | **bool** | | [optional] +**azure_credentials** | [**AzureCredentials**](AzureCredentials.md) | | [optional] +**client_email** | **str** | | [optional] +**cloud_gateway_enabled** | **bool** | | [optional] +**cloud_type** | **str** | | [optional] +**cred_type** | **str** | | [optional] +**description** | **str** | | [optional] +**gcp_billing_id** | **str** | | [optional] +**gcp_credentials** | [**GcpCredentials**](GcpCredentials.md) | | [optional] +**host_vpc_enabled** | **bool** | | [optional] +**org_name** | **str** | | [optional] +**private_key_id** | **str** | | [optional] +**region_list** | **[str]** | | [optional] +**service_discovery_enabled** | **bool** | | [optional] +**vnet_enabled** | **bool** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultiCloudEdgeAccountInfo.md b/docs/MultiCloudEdgeAccountInfo.md new file mode 100644 index 0000000..8a70838 --- /dev/null +++ b/docs/MultiCloudEdgeAccountInfo.md @@ -0,0 +1,24 @@ +# MultiCloudEdgeAccountInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_credentials** | **str** | | [optional] +**cred_type** | **str** | | [optional] +**description** | **str** | | [optional] +**edge_account_id** | **str** | | [optional] +**edge_account_name** | **str** | | [optional] +**edge_billing_account_info** | [**MultiCloudEdgeBillingAccountInfo**](MultiCloudEdgeBillingAccountInfo.md) | | [optional] +**edge_location_info_list** | [**[MultiCloudEdgeLocationInfo]**](MultiCloudEdgeLocationInfo.md) | | [optional] +**edge_partner_ports_list** | [**[MultiCloudEdgePartnerPort]**](MultiCloudEdgePartnerPort.md) | | [optional] +**edge_type** | **str** | | [optional] +**equinix_credentials** | [**EquinixCredentials**](EquinixCredentials.md) | | [optional] +**megaport_credentials** | [**MegaportCredentials**](MegaportCredentials.md) | | [optional] +**org_name** | **str** | | [optional] +**region_list** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultiCloudEdgeBillingAccountInfo.md b/docs/MultiCloudEdgeBillingAccountInfo.md new file mode 100644 index 0000000..2137c25 --- /dev/null +++ b/docs/MultiCloudEdgeBillingAccountInfo.md @@ -0,0 +1,14 @@ +# MultiCloudEdgeBillingAccountInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**edge_billing_account_id** | **str** | | [optional] +**edge_billing_account_name** | **str** | | [optional] +**edge_type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultiCloudEdgeLocationInfo.md b/docs/MultiCloudEdgeLocationInfo.md new file mode 100644 index 0000000..12dcc90 --- /dev/null +++ b/docs/MultiCloudEdgeLocationInfo.md @@ -0,0 +1,16 @@ +# MultiCloudEdgeLocationInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**edge_type** | **str** | | [optional] +**eq_location_info** | [**EquinixLocationInfo**](EquinixLocationInfo.md) | | [optional] +**location_id** | **str** | | [optional] +**location_name** | **str** | | [optional] +**mp_location_info** | [**MegaportLocationInfo**](MegaportLocationInfo.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultiCloudEdgePartnerPort.md b/docs/MultiCloudEdgePartnerPort.md new file mode 100644 index 0000000..4b0982f --- /dev/null +++ b/docs/MultiCloudEdgePartnerPort.md @@ -0,0 +1,17 @@ +# MultiCloudEdgePartnerPort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cloud_type** | **str** | | [optional] +**edge_type** | **str** | | [optional] +**eq_partner_port** | [**EquinixPartnerPort**](EquinixPartnerPort.md) | | [optional] +**location_id** | **str** | | [optional] +**mp_partner_port** | [**MegaportPartnerPort**](MegaportPartnerPort.md) | | [optional] +**name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultitenantAPIsProviderApi.md b/docs/MultitenantAPIsProviderApi.md new file mode 100644 index 0000000..38dba05 --- /dev/null +++ b/docs/MultitenantAPIsProviderApi.md @@ -0,0 +1,1457 @@ +# openapi_client.MultitenantAPIsProviderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_tenant**](MultitenantAPIsProviderApi.md#create_tenant) | **POST** /tenant | +[**create_tenant_async**](MultitenantAPIsProviderApi.md#create_tenant_async) | **POST** /tenant/async | +[**create_tenant_async_bulk**](MultitenantAPIsProviderApi.md#create_tenant_async_bulk) | **POST** /tenant/bulk/async | +[**delete_tenant**](MultitenantAPIsProviderApi.md#delete_tenant) | **POST** /tenant/{tenantId}/delete | +[**delete_tenant_async_bulk**](MultitenantAPIsProviderApi.md#delete_tenant_async_bulk) | **DELETE** /tenant/bulk/async | +[**delete_tenant_backup**](MultitenantAPIsProviderApi.md#delete_tenant_backup) | **DELETE** /tenantbackup/delete | +[**download_existing_backup_file**](MultitenantAPIsProviderApi.md#download_existing_backup_file) | **GET** /tenantbackup/download/{path} | +[**export_tenant_backup**](MultitenantAPIsProviderApi.md#export_tenant_backup) | **GET** /tenantbackup/export | +[**force_status_collection**](MultitenantAPIsProviderApi.md#force_status_collection) | **POST** /tenantstatus/force | +[**get_all_tenant_statuses**](MultitenantAPIsProviderApi.md#get_all_tenant_statuses) | **GET** /tenantstatus | +[**get_all_tenants**](MultitenantAPIsProviderApi.md#get_all_tenants) | **GET** /tenant | +[**get_tenant**](MultitenantAPIsProviderApi.md#get_tenant) | **GET** /tenant/{tenantId} | +[**get_tenant_hosting_capacity_onv_smarts**](MultitenantAPIsProviderApi.md#get_tenant_hosting_capacity_onv_smarts) | **GET** /tenant/vsmart/capacity | +[**get_tenantv_smart_mapping**](MultitenantAPIsProviderApi.md#get_tenantv_smart_mapping) | **GET** /tenant/vsmart | +[**import_tenant_backup**](MultitenantAPIsProviderApi.md#import_tenant_backup) | **POST** /tenantbackup/import | +[**list_tenant_backup**](MultitenantAPIsProviderApi.md#list_tenant_backup) | **GET** /tenantbackup/list | +[**switch_tenant**](MultitenantAPIsProviderApi.md#switch_tenant) | **POST** /tenant/{tenantId}/switch | +[**tenantv_smart_mt_migrate**](MultitenantAPIsProviderApi.md#tenantv_smart_mt_migrate) | **POST** /tenant/vsmart-mt/migrate | +[**update_tenant**](MultitenantAPIsProviderApi.md#update_tenant) | **PUT** /tenant/{tenantId} | +[**update_tenantv_smart_placement**](MultitenantAPIsProviderApi.md#update_tenantv_smart_placement) | **PUT** /tenant/{tenantId}/vsmart | +[**v_session_id**](MultitenantAPIsProviderApi.md#v_session_id) | **POST** /tenant/{tenantId}/vsessionid | + + +# **create_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tenant() + + + +Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tenant(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->create_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tenant_async** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tenant_async() + + + +Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tenant_async(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->create_tenant_async: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tenant_async_bulk** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tenant_async_bulk() + + + +Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tenant_async_bulk(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->create_tenant_async_bulk: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tenant** +> delete_tenant(tenant_id) + + + +Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.delete_tenant(tenant_id) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->delete_tenant: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_tenant(tenant_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->delete_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tenant_async_bulk** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_tenant_async_bulk() + + + +Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_tenant_async_bulk(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->delete_tenant_async_bulk: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_tenant_backup(file_name) + + + +Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + file_name = "fileName_example" # str | File name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_tenant_backup(file_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->delete_tenant_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file_name** | **str**| File name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_existing_backup_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download_existing_backup_file(path) + + + +Download a Backup File that is already stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + path = "path_example" # str | File path + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download_existing_backup_file(path) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->download_existing_backup_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| File path | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **export_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} export_tenant_backup() + + + +Trigger a backup of configuration database and store it in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.export_tenant_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->export_tenant_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **force_status_collection** +> force_status_collection() + + + +Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.force_status_collection() + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->force_status_collection: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_tenant_statuses** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_tenant_statuses() + + + +List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_tenant_statuses() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->get_all_tenant_statuses: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_tenants** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_tenants() + + + +Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + device_id = "deviceId_example" # str | List all tenants associated with a vSmart (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_all_tenants(device_id=device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->get_all_tenants: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| List all tenants associated with a vSmart | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tenant(tenant_id) + + + +Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tenant(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->get_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenant_hosting_capacity_onv_smarts** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_tenant_hosting_capacity_onv_smarts() + + + +Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenant_hosting_capacity_onv_smarts() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->get_tenant_hosting_capacity_onv_smarts: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenantv_smart_mapping** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_tenantv_smart_mapping() + + + +Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenantv_smart_mapping() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->get_tenantv_smart_mapping: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **import_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} import_tenant_backup() + + + +Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.import_tenant_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->import_tenant_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_tenant_backup() + + + +List all backup files of a tenant stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_tenant_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->list_tenant_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **switch_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} switch_tenant(tenant_id) + + + +Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.switch_tenant(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->switch_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tenantv_smart_mt_migrate** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] tenantv_smart_mt_migrate() + + + +Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.tenantv_smart_mt_migrate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->tenantv_smart_mt_migrate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_tenant(tenant_id) + + + +Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_tenant(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->update_tenant: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_tenant(tenant_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->update_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_tenantv_smart_placement** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] update_tenantv_smart_placement(tenant_id) + + + +Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_tenantv_smart_placement(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->update_tenantv_smart_placement: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_tenantv_smart_placement(tenant_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->update_tenantv_smart_placement: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **v_session_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} v_session_id(tenant_id) + + + +Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import multitenant_apis_provider_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = multitenant_apis_provider_api.MultitenantAPIsProviderApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.v_session_id(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling MultitenantAPIsProviderApi->v_session_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/NATRule.md b/docs/NATRule.md new file mode 100644 index 0000000..27eaa42 --- /dev/null +++ b/docs/NATRule.md @@ -0,0 +1,17 @@ +# NATRule + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | | +**in_port** | **int** | | +**inside_ip** | **str** | | +**interface** | **str** | | +**out_port** | **int** | | +**protocol** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NWPIApi.md b/docs/NWPIApi.md new file mode 100644 index 0000000..4175bf1 --- /dev/null +++ b/docs/NWPIApi.md @@ -0,0 +1,748 @@ +# openapi_client.NWPIApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_agg_flow**](NWPIApi.md#get_agg_flow) | **GET** /stream/device/nwpi/aggFlow | +[**get_app_qos_data**](NWPIApi.md#get_app_qos_data) | **GET** /stream/device/nwpi/appQosData | +[**get_app_qos_state**](NWPIApi.md#get_app_qos_state) | **GET** /stream/device/nwpi/appQosState | +[**get_concurrent_data**](NWPIApi.md#get_concurrent_data) | **GET** /stream/device/nwpi/concurrentData | +[**get_concurrent_domain_data**](NWPIApi.md#get_concurrent_domain_data) | **GET** /stream/device/nwpi/concurrentDomainData | +[**get_event_app_hop_list**](NWPIApi.md#get_event_app_hop_list) | **GET** /stream/device/nwpi/eventAppHopList | +[**get_event_app_score_bandwidth**](NWPIApi.md#get_event_app_score_bandwidth) | **GET** /stream/device/nwpi/eventAppScoreBandwidth | +[**get_event_flow_from_app_hop**](NWPIApi.md#get_event_flow_from_app_hop) | **GET** /stream/device/nwpi/eventFlowFromAppHop | +[**get_event_readout**](NWPIApi.md#get_event_readout) | **GET** /stream/device/nwpi/eventReadout | +[**get_routing_detail_from_local**](NWPIApi.md#get_routing_detail_from_local) | **GET** /stream/device/nwpi/routingDetail | + + +# **get_agg_flow** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_agg_flow(trace_id, timestamp, trace_state) + + + +Get aggregated flow data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + trace_state = "traceState_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_agg_flow(trace_id, timestamp, trace_state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_agg_flow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **trace_state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_qos_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_qos_data(trace_id, timestamp, received_timestamp) + + + +Get QoS Application data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + received_timestamp = 1 # int | received timestamp + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_qos_data(trace_id, timestamp, received_timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_app_qos_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **received_timestamp** | **int**| received timestamp | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_qos_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_qos_state(trace_id, timestamp, trace_state) + + + +Get QoS Application state to received timestamp mapping for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + trace_state = "traceState_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_qos_state(trace_id, timestamp, trace_state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_app_qos_state: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **trace_state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_concurrent_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_concurrent_data(trace_id, timestamp) + + + +Get concurrent data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_concurrent_data(trace_id, timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_concurrent_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_concurrent_domain_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_concurrent_domain_data(trace_id, timestamp) + + + +Get concurrent domain data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_concurrent_domain_data(trace_id, timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_concurrent_domain_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_app_hop_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_app_hop_list(trace_id, timestamp, state) + + + +Get Trace Application and HopList for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_app_hop_list(trace_id, timestamp, state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_event_app_hop_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_app_score_bandwidth** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_app_score_bandwidth(trace_id, timestamp, state, received_timestamp) + + + +Get Trace Event Application Performance Score and Bandwidth for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + received_timestamp = 1 # int | received timestamp + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_app_score_bandwidth(trace_id, timestamp, state, received_timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_event_app_score_bandwidth: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + **received_timestamp** | **int**| received timestamp | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_flow_from_app_hop** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_flow_from_app_hop(trace_id, timestamp, state, application, direction, _from, to, device_trace_id) + + + +Get Trace Event Flow From Application And Hop for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + application = "application_example" # str | app name + direction = "direction_example" # str | direction + _from = "from_example" # str | from + to = "to_example" # str | to + device_trace_id = 1 # int | deviceTraceId + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_flow_from_app_hop(trace_id, timestamp, state, application, direction, _from, to, device_trace_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_event_flow_from_app_hop: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + **application** | **str**| app name | + **direction** | **str**| direction | + **_from** | **str**| from | + **to** | **str**| to | + **device_trace_id** | **int**| deviceTraceId | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_readout** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_readout(trace_id, timestamp, state) + + + +Get Trace Event Readout for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_readout(trace_id, timestamp, state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_event_readout: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_detail_from_local** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_routing_detail_from_local(trace_id, timestamp, trace_state, route_prefixs) + + + +Get Routing Details for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import nwpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = nwpi_api.NWPIApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + trace_state = "traceState_example" # str | trace state + route_prefixs = "routePrefixs_example" # str | route prefixs + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_detail_from_local(trace_id, timestamp, trace_state, route_prefixs) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling NWPIApi->get_routing_detail_from_local: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **trace_state** | **str**| trace state | + **route_prefixs** | **str**| route prefixs | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/NameValuePair.md b/docs/NameValuePair.md new file mode 100644 index 0000000..853c0a6 --- /dev/null +++ b/docs/NameValuePair.md @@ -0,0 +1,13 @@ +# NameValuePair + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**value** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NetworkProtocol.md b/docs/NetworkProtocol.md new file mode 100644 index 0000000..a86737b --- /dev/null +++ b/docs/NetworkProtocol.md @@ -0,0 +1,24 @@ +# NetworkProtocol + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**dhcp_pool** | [**DHCPPool**](DHCPPool.md) | | [optional] +**dns_settings** | **str** | | [optional] +**ntp_settings** | **[str]** | | [optional] +**nat_rules** | [**[NATRule]**](NATRule.md) | | [optional] +**ntp_inherit** | **bool** | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NetworkProtocolAllOf.md b/docs/NetworkProtocolAllOf.md new file mode 100644 index 0000000..a1ecbec --- /dev/null +++ b/docs/NetworkProtocolAllOf.md @@ -0,0 +1,16 @@ +# NetworkProtocolAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dhcp_pool** | [**DHCPPool**](DHCPPool.md) | | [optional] +**dns_settings** | **str** | | [optional] +**ntp_settings** | **[str]** | | [optional] +**nat_rules** | [**[NATRule]**](NATRule.md) | | [optional] +**ntp_inherit** | **bool** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Node.md b/docs/Node.md new file mode 100644 index 0000000..484849f --- /dev/null +++ b/docs/Node.md @@ -0,0 +1,18 @@ +# Node + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ip** | **str** | | [optional] +**name** | **str** | | [optional] +**password** | **str** | | [optional] +**serialno** | **str** | | [optional] +**status** | **str** | | [optional] +**username** | **str** | | [optional] +**uuid** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NwpiDomainMonitor.md b/docs/NwpiDomainMonitor.md new file mode 100644 index 0000000..b46dd6e --- /dev/null +++ b/docs/NwpiDomainMonitor.md @@ -0,0 +1,17 @@ +# NwpiDomainMonitor + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_ip** | **str** | | [optional] +**device_to_domain_id** | [**[UuidToDomainId]**](UuidToDomainId.md) | | [optional] +**domain_app_grp** | **str** | | [optional] +**domain_app_vis** | **str** | | [optional] +**domain_list** | [**[DomainDetail]**](DomainDetail.md) | | [optional] +**trace_id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/OMP.md b/docs/OMP.md new file mode 100644 index 0000000..5acfc40 --- /dev/null +++ b/docs/OMP.md @@ -0,0 +1,18 @@ +# OMP + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**advertisement_interval** | **int** | | [optional] +**advertisements** | **str** | | [optional] +**ecmp_limit** | **int** | | [optional] +**eor_timer** | **int** | | [optional] +**graceful_restart** | **int** | | [optional] +**hold_time** | **int** | | [optional] +**paths_advertised_per_prefix** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/OnDemandQueueEntry.md b/docs/OnDemandQueueEntry.md new file mode 100644 index 0000000..f520ddf --- /dev/null +++ b/docs/OnDemandQueueEntry.md @@ -0,0 +1,24 @@ +# OnDemandQueueEntry + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**complete** | **bool** | | [optional] +**completion_time** | **int** | | [optional] +**creation_time** | **int** | | [optional] +**data_type** | **str** | | [optional] +**device_id** | **str** | | [optional] +**end_time** | **int** | | [optional] +**id** | **str** | | [optional] +**start_processing_time** | **int** | | [optional] +**start_time** | **int** | | [optional] +**status** | **str** | | [optional] +**tenant_id** | **str** | | [optional] +**time_period** | **str** | | [optional] +**value** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PartnerACIPolicyBuilderApi.md b/docs/PartnerACIPolicyBuilderApi.md new file mode 100644 index 0000000..81bf204 --- /dev/null +++ b/docs/PartnerACIPolicyBuilderApi.md @@ -0,0 +1,584 @@ +# openapi_client.PartnerACIPolicyBuilderApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_dscp_mappings**](PartnerACIPolicyBuilderApi.md#create_dscp_mappings) | **POST** /partner/aci/policy/dscpmapping/{partnerId} | +[**delete_dscp_mappings**](PartnerACIPolicyBuilderApi.md#delete_dscp_mappings) | **DELETE** /partner/aci/policy/dscpmapping/{partnerId} | +[**get_aci_definitions**](PartnerACIPolicyBuilderApi.md#get_aci_definitions) | **GET** /partner/aci/policy | +[**get_data_prefix_mappings**](PartnerACIPolicyBuilderApi.md#get_data_prefix_mappings) | **GET** /partner/aci/policy/prefixmapping/{partnerId} | +[**get_data_prefix_sequences**](PartnerACIPolicyBuilderApi.md#get_data_prefix_sequences) | **GET** /partner/aci/policy/sequences | +[**get_dscp_mappings**](PartnerACIPolicyBuilderApi.md#get_dscp_mappings) | **GET** /partner/aci/policy/dscpmapping/{partnerId} | +[**get_events**](PartnerACIPolicyBuilderApi.md#get_events) | **GET** /partner/aci/policy/events/{partnerId} | +[**set_data_prefix_mappings**](PartnerACIPolicyBuilderApi.md#set_data_prefix_mappings) | **POST** /partner/aci/policy/prefixmapping/{partnerId} | + + +# **create_dscp_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dscp_mappings(partner_id) + + + +Create an ACI definition entry + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | ACI definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dscp_mappings(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->create_dscp_mappings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dscp_mappings(partner_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->create_dscp_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| ACI definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_dscp_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_dscp_mappings(partner_id) + + + +Delete DSCP mapping + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_dscp_mappings(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->delete_dscp_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aci_definitions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aci_definitions() + + + +Get ACI definitions + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_aci_definitions() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->get_aci_definitions: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_data_prefix_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_data_prefix_mappings(partner_id) + + + +Get prefix mapping + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_data_prefix_mappings(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->get_data_prefix_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_data_prefix_sequences** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_data_prefix_sequences() + + + +Get data prefix sequence + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_data_prefix_sequences() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->get_data_prefix_sequences: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dscp_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dscp_mappings(partner_id) + + + +Get DSCP policy + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dscp_mappings(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->get_dscp_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_events** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_events(partner_id) + + + +Get ACI events + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + starttime = 1 # int | Start time (optional) + endtime = 1 # int | End time (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_events(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->get_events: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_events(partner_id, starttime=starttime, endtime=endtime) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->get_events: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **starttime** | **int**| Start time | [optional] + **endtime** | **int**| End time | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_data_prefix_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_data_prefix_mappings(partner_id) + + + +Create data prefix mapping + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_aci_policy_builder_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_aci_policy_builder_api.PartnerACIPolicyBuilderApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Prefix definition (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.set_data_prefix_mappings(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->set_data_prefix_mappings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.set_data_prefix_mappings(partner_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerACIPolicyBuilderApi->set_data_prefix_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Prefix definition | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PartnerDNACSDAAPIApi.md b/docs/PartnerDNACSDAAPIApi.md new file mode 100644 index 0000000..df18121 --- /dev/null +++ b/docs/PartnerDNACSDAAPIApi.md @@ -0,0 +1,440 @@ +# openapi_client.PartnerDNACSDAAPIApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_sda_config**](PartnerDNACSDAAPIApi.md#create_sda_config) | **POST** /partner/dnac/sda/config/{partnerId} | +[**create_sda_config_from_netconf**](PartnerDNACSDAAPIApi.md#create_sda_config_from_netconf) | **POST** /partner/dnac/sda/netconfconfig/{partnerId} | +[**get_device_details**](PartnerDNACSDAAPIApi.md#get_device_details) | **GET** /partner/dnac/sda/device/{partnerId}/{uuid} | +[**get_overlay_vpn_list**](PartnerDNACSDAAPIApi.md#get_overlay_vpn_list) | **GET** /partner/dnac/sda/vpn | +[**get_sda_enabled_devices**](PartnerDNACSDAAPIApi.md#get_sda_enabled_devices) | **GET** /partner/dnac/sda/device/{partnerId} | +[**get_sites_for_partner**](PartnerDNACSDAAPIApi.md#get_sites_for_partner) | **GET** /partner/dnac/sda/site/{partnerId} | + + +# **create_sda_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_sda_config(partner_id) + + + +Create SDA enabled device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_dnacsdaapi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_dnacsdaapi_api.PartnerDNACSDAAPIApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device SDA configuration (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_sda_config(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->create_sda_config: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sda_config(partner_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->create_sda_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device SDA configuration | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sda_config_from_netconf** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_sda_config_from_netconf(partner_id) + + + +Create SDA enabled device from Netconf + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_dnacsdaapi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_dnacsdaapi_api.PartnerDNACSDAAPIApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device SDA configuration (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_sda_config_from_netconf(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->create_sda_config_from_netconf: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sda_config_from_netconf(partner_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->create_sda_config_from_netconf: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device SDA configuration | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_details** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_device_details(partner_id, uuid) + + + +Get SDA enabled devices detail + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_dnacsdaapi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_dnacsdaapi_api.PartnerDNACSDAAPIApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + uuid = "C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_details(partner_id, uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->get_device_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **uuid** | **str**| Device uuid | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_overlay_vpn_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_overlay_vpn_list() + + + +Get Overlay VPN list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_dnacsdaapi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_dnacsdaapi_api.PartnerDNACSDAAPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_overlay_vpn_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->get_overlay_vpn_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sda_enabled_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_sda_enabled_devices(partner_id) + + + +Get SDA enabled devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_dnacsdaapi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_dnacsdaapi_api.PartnerDNACSDAAPIApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sda_enabled_devices(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->get_sda_enabled_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sites_for_partner** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_sites_for_partner(partner_id) + + + +Get SDA enabled devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_dnacsdaapi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_dnacsdaapi_api.PartnerDNACSDAAPIApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sites_for_partner(partner_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerDNACSDAAPIApi->get_sites_for_partner: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PartnerRegistrationApi.md b/docs/PartnerRegistrationApi.md new file mode 100644 index 0000000..ac2222b --- /dev/null +++ b/docs/PartnerRegistrationApi.md @@ -0,0 +1,906 @@ +# openapi_client.PartnerRegistrationApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_device_mapping**](PartnerRegistrationApi.md#delete_device_mapping) | **POST** /partner/{partnerType}/unmap/{nmsId} | +[**delete_partner**](PartnerRegistrationApi.md#delete_partner) | **DELETE** /partner/{partnerType}/{nmsId} | +[**get_data_change_info**](PartnerRegistrationApi.md#get_data_change_info) | **GET** /serverlongpoll/event/poll/{partnerId} | +[**get_partner**](PartnerRegistrationApi.md#get_partner) | **GET** /partner/{partnerType}/{nmsId} | +[**get_partner_devices**](PartnerRegistrationApi.md#get_partner_devices) | **GET** /partner/{partnerType}/map/{nmsId} | +[**get_partners**](PartnerRegistrationApi.md#get_partners) | **GET** /partner | +[**get_partners_by_partner_type**](PartnerRegistrationApi.md#get_partners_by_partner_type) | **GET** /partner/{partnerType} | +[**get_vpn_list**](PartnerRegistrationApi.md#get_vpn_list) | **GET** /partner/vpn | +[**map_devices**](PartnerRegistrationApi.md#map_devices) | **POST** /partner/{partnerType}/map/{nmsId} | +[**register_partner**](PartnerRegistrationApi.md#register_partner) | **POST** /partner/{partnerType} | +[**unmap_devices**](PartnerRegistrationApi.md#unmap_devices) | **DELETE** /partner/{partnerType}/map/{nmsId} | +[**update_partner**](PartnerRegistrationApi.md#update_partner) | **PUT** /partner/{partnerType}/{nmsId} | + + +# **delete_device_mapping** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_device_mapping(partner_type, nms_id) + + + +Unmap a set of devices for the partner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = "dnac" # str | Partner type + nms_id = "341e4f9a-e72c-4d34-9c9a-e6c82248743f" # str | NMS Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | List of devices (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_device_mapping(partner_type, nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->delete_device_mapping: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_device_mapping(partner_type, nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->delete_device_mapping: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **str**| Partner type | + **nms_id** | **str**| NMS Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| List of devices | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_partner** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_partner(partner_type, nms_id) + + + +Delete NMS partner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from openapi_client.model.partner_type import PartnerType +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = PartnerType( + partner_type="aci", + ) # PartnerType | Partner type + nms_id = "341e4f9a-e72c-4d34-9c9a-e6c82248743f" # str | NMS Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_partner(partner_type, nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->delete_partner: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **PartnerType**| Partner type | + **nms_id** | **str**| NMS Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_data_change_info** +> get_data_change_info(partner_id) + + + +Retrieve registration change information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from openapi_client.model.event_name import EventName +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_id = "partnerId_example" # str | Partner Id + event_id = "event_id_example" # str | Continuation token of ongoing event-polling session (optional) + event_names = [ + EventName( + event_name="event_name_example", + ), + ] # [EventName] | Names of type of events to filter on (optional) + wait_time = 0 # int | Maximum polling wait time in seconds (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + try: + api_instance.get_data_change_info(partner_id) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_data_change_info: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_data_change_info(partner_id, event_id=event_id, event_names=event_names, wait_time=wait_time) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_data_change_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_id** | **str**| Partner Id | + **event_id** | **str**| Continuation token of ongoing event-polling session | [optional] + **event_names** | [**[EventName]**](EventName.md)| Names of type of events to filter on | [optional] + **wait_time** | **int**| Maximum polling wait time in seconds | [optional] if omitted the server will use the default value of 0 + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_partner** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_partner(partner_type, nms_id) + + + +Get NMS partners by partner type and Id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = "dnac" # str | Partner type + nms_id = "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" # str | NMS Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_partner(partner_type, nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_partner: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **str**| Partner type | + **nms_id** | **str**| NMS Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_partner_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_partner_devices(partner_type, nms_id) + + + +List mapped devices for the partner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from openapi_client.model.partner_type import PartnerType +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = PartnerType( + partner_type="aci", + ) # PartnerType | Partner type + nms_id = "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" # str | NMS Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_partner_devices(partner_type, nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_partner_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **PartnerType**| Partner type | + **nms_id** | **str**| NMS Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_partners** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_partners() + + + +Get all NMS partners + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_partners() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_partners: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_partners_by_partner_type** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_partners_by_partner_type(partner_type) + + + +Get NMS partners by partner type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = "dnac" # str | Partner type + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_partners_by_partner_type(partner_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_partners_by_partner_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **str**| Partner type | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vpn_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vpn_list() + + + +Get all VPNs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_vpn_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->get_vpn_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **map_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} map_devices(partner_type, nms_id) + + + +Map devices for the partner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = "dnac" # str | Partner type + nms_id = "341e4f9a-e72c-4d34-9c9a-e6c82248743f" # str | NMS Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | List of devices (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.map_devices(partner_type, nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->map_devices: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.map_devices(partner_type, nms_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->map_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **str**| Partner type | + **nms_id** | **str**| NMS Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| List of devices | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **register_partner** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} register_partner(partner_type) + + + +Register NMS partner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = "dnac" # str | Partner type + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.register_partner(partner_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->register_partner: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.register_partner(partner_type, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->register_partner: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **str**| Partner type | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unmap_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} unmap_devices(partner_type, nms_id) + + + +Unmap all devices for the partner + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from openapi_client.model.partner_type import PartnerType +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = PartnerType( + partner_type="aci", + ) # PartnerType | Partner type + nms_id = "341e4f9a-e72c-4d34-9c9a-e6c82248743f" # str | NMS Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.unmap_devices(partner_type, nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->unmap_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **PartnerType**| Partner type | + **nms_id** | **str**| NMS Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_partner** +> update_partner(partner_type, nms_id) + + + +Update NMS partner details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_registration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_registration_api.PartnerRegistrationApi(api_client) + partner_type = "dnac" # str | Partner type + nms_id = "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" # str | NMS Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.update_partner(partner_type, nms_id) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->update_partner: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.update_partner(partner_type, nms_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling PartnerRegistrationApi->update_partner: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partner_type** | **str**| Partner type | + **nms_id** | **str**| NMS Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PartnerType.md b/docs/PartnerType.md new file mode 100644 index 0000000..a06d149 --- /dev/null +++ b/docs/PartnerType.md @@ -0,0 +1,13 @@ +# PartnerType + +This is valid Partner Type + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**partner_type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PartnerWCMConfigsApi.md b/docs/PartnerWCMConfigsApi.md new file mode 100644 index 0000000..046e18f --- /dev/null +++ b/docs/PartnerWCMConfigsApi.md @@ -0,0 +1,87 @@ +# openapi_client.PartnerWCMConfigsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**push_netconf_configs**](PartnerWCMConfigsApi.md#push_netconf_configs) | **POST** /partner/wcm/netconf/{nmsId} | + + +# **push_netconf_configs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} push_netconf_configs(nms_id) + + + +Push device configs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import partner_wcm_configs_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = partner_wcm_configs_api.PartnerWCMConfigsApi(api_client) + nms_id = "nmsId_example" # str | NMS Id + request_body = [] # [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] | Netconf configuration (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.push_netconf_configs(nms_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerWCMConfigsApi->push_netconf_configs: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.push_netconf_configs(nms_id, request_body=request_body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling PartnerWCMConfigsApi->push_netconf_configs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nms_id** | **str**| NMS Id | + **request_body** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]**| Netconf configuration | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PolicyRule.md b/docs/PolicyRule.md new file mode 100644 index 0000000..e847f95 --- /dev/null +++ b/docs/PolicyRule.md @@ -0,0 +1,17 @@ +# PolicyRule + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **str** | | [optional] +**dest_ip** | **str** | | [optional] +**dest_port** | **int** | | [optional] +**protocol_type** | **[str]** | | [optional] +**source_ip** | **str** | | [optional] +**source_port** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ProfileParcel.md b/docs/ProfileParcel.md new file mode 100644 index 0000000..b34ebdc --- /dev/null +++ b/docs/ProfileParcel.md @@ -0,0 +1,19 @@ +# ProfileParcel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PropertyDefinition.md b/docs/PropertyDefinition.md new file mode 100644 index 0000000..23b9ea4 --- /dev/null +++ b/docs/PropertyDefinition.md @@ -0,0 +1,14 @@ +# PropertyDefinition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**samples** | **[str]** | | [optional] +**type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PublicInternetTimer.md b/docs/PublicInternetTimer.md new file mode 100644 index 0000000..76cab72 --- /dev/null +++ b/docs/PublicInternetTimer.md @@ -0,0 +1,15 @@ +# PublicInternetTimer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dscp** | **int** | | [optional] +**hello_interval** | **int** | | [optional] +**multiplier** | **int** | | [optional] +**path_mtu** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/QueueEntries.md b/docs/QueueEntries.md new file mode 100644 index 0000000..71468a3 --- /dev/null +++ b/docs/QueueEntries.md @@ -0,0 +1,12 @@ +# QueueEntries + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entries** | [**[OnDemandQueueEntry]**](OnDemandQueueEntry.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/QueueProperties.md b/docs/QueueProperties.md new file mode 100644 index 0000000..8779975 --- /dev/null +++ b/docs/QueueProperties.md @@ -0,0 +1,15 @@ +# QueueProperties + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**current_size** | **int** | | [optional] +**max_size** | **int** | | [optional] +**tenant_current_size** | **int** | | [optional] +**tenant_max_size** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RadioBandSetting24G.md b/docs/RadioBandSetting24G.md new file mode 100644 index 0000000..9ec660b --- /dev/null +++ b/docs/RadioBandSetting24G.md @@ -0,0 +1,15 @@ +# RadioBandSetting24G + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**band** | **str** | | [optional] +**channel** | **str** | | [optional] +**channel_width** | **str** | | [optional] +**transmit_power** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RadioBandSetting5G.md b/docs/RadioBandSetting5G.md new file mode 100644 index 0000000..bbe4755 --- /dev/null +++ b/docs/RadioBandSetting5G.md @@ -0,0 +1,15 @@ +# RadioBandSetting5G + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**band** | **str** | | [optional] +**channel** | **str** | | [optional] +**channel_width** | **str** | | [optional] +**transmit_power** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RadiusServer.md b/docs/RadiusServer.md new file mode 100644 index 0000000..fbfa988 --- /dev/null +++ b/docs/RadiusServer.md @@ -0,0 +1,14 @@ +# RadiusServer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **str** | | [optional] +**port** | **int** | | [optional] +**secret** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RealTimeMonitoringAAAApi.md b/docs/RealTimeMonitoringAAAApi.md new file mode 100644 index 0000000..29a4119 --- /dev/null +++ b/docs/RealTimeMonitoringAAAApi.md @@ -0,0 +1,491 @@ +# openapi_client.RealTimeMonitoringAAAApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aa_aservers**](RealTimeMonitoringAAAApi.md#get_aa_aservers) | **GET** /device/aaa/servers | +[**get_aaa_users**](RealTimeMonitoringAAAApi.md#get_aaa_users) | **GET** /device/aaa/users | +[**get_acl_match_counter_users**](RealTimeMonitoringAAAApi.md#get_acl_match_counter_users) | **GET** /device/acl/matchcounter | +[**get_all_device_users**](RealTimeMonitoringAAAApi.md#get_all_device_users) | **GET** /device/users/list | +[**get_logging_from_device**](RealTimeMonitoringAAAApi.md#get_logging_from_device) | **GET** /device/logging | +[**get_unclaimed_vedges**](RealTimeMonitoringAAAApi.md#get_unclaimed_vedges) | **GET** /device/unclaimed/vedges | +[**get_users_from_device**](RealTimeMonitoringAAAApi.md#get_users_from_device) | **GET** /device/users | + + +# **get_aa_aservers** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aa_aservers(device_id) + + + +Get AAA servers from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aa_aservers(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_aa_aservers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aaa_users** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aaa_users(device_id) + + + +Get AAA users from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aaa_users(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_aaa_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_acl_match_counter_users** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_acl_match_counter_users(device_id) + + + +Get ACL match counters from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "deviceId_example" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_acl_match_counter_users(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_acl_match_counter_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_device_users** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_device_users(device_id) + + + +Get all users from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "169.254.10.10" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_all_device_users(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_all_device_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_logging_from_device** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_logging_from_device(device_id) + + + +Get logging from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_logging_from_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_logging_from_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_unclaimed_vedges** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_unclaimed_vedges(device_id) + + + +Get unclaimed vEdges from vbond + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_unclaimed_vedges(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_unclaimed_vedges: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_users_from_device** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_users_from_device(device_id) + + + +Get users from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_aaa_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_aaa_api.RealTimeMonitoringAAAApi(api_client) + device_id = "169.254.10.10" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_users_from_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAAAApi->get_users_from_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringARPApi.md b/docs/RealTimeMonitoringARPApi.md new file mode 100644 index 0000000..45c6d91 --- /dev/null +++ b/docs/RealTimeMonitoringARPApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringARPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_arp_interface**](RealTimeMonitoringARPApi.md#get_arp_interface) | **GET** /device/arp | + + +# **get_arp_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_arp_interface(device_id) + + + +Get ARP interfaces from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_arp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_arp_api.RealTimeMonitoringARPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_arp_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringARPApi->get_arp_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringAppHostingApi.md b/docs/RealTimeMonitoringAppHostingApi.md new file mode 100644 index 0000000..314d61e --- /dev/null +++ b/docs/RealTimeMonitoringAppHostingApi.md @@ -0,0 +1,560 @@ +# openapi_client.RealTimeMonitoringAppHostingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_app_hosting_attached_devices**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_attached_devices) | **GET** /device/app-hosting/attached-devices | +[**get_app_hosting_details**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_details) | **GET** /device/app-hosting/details | +[**get_app_hosting_guest_routes**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_guest_routes) | **GET** /device/app-hosting/guest-routes | +[**get_app_hosting_network_devices**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_network_devices) | **GET** /device/app-hosting/network-interfaces | +[**get_app_hosting_network_utils**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_network_utils) | **GET** /device/app-hosting/network-utilization | +[**get_app_hosting_processes**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_processes) | **GET** /device/app-hosting/processes | +[**get_app_hosting_storage_utils**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_storage_utils) | **GET** /device/app-hosting/storage-utilization | +[**get_app_hosting_utilization**](RealTimeMonitoringAppHostingApi.md#get_app_hosting_utilization) | **GET** /device/app-hosting/utilization | + + +# **get_app_hosting_attached_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_attached_devices(device_id) + + + +Get App hosting attached device from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_attached_devices(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_attached_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_details(device_id) + + + +Get App hosting details from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_details(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_guest_routes** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_guest_routes(device_id) + + + +Get App hosting guest routes from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_guest_routes(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_guest_routes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_network_devices** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_network_devices(device_id) + + + +Get App hosting network interface from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_network_devices(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_network_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_network_utils** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_network_utils(device_id) + + + +Get App hosting network utilization from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_network_utils(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_network_utils: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_processes** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_processes(device_id) + + + +Get App hosting processes from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_processes(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_processes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_storage_utils** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_storage_utils(device_id) + + + +Get App hosting storage utilization from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_storage_utils(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_storage_utils: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_hosting_utilization** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_hosting_utilization(device_id) + + + +Get App hosting utilization from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_hosting_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_hosting_api.RealTimeMonitoringAppHostingApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_hosting_utilization(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppHostingApi->get_app_hosting_utilization: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringAppLogsApi.md b/docs/RealTimeMonitoringAppLogsApi.md new file mode 100644 index 0000000..9462bcf --- /dev/null +++ b/docs/RealTimeMonitoringAppLogsApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringAppLogsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_app_log_flow_count**](RealTimeMonitoringAppLogsApi.md#get_app_log_flow_count) | **GET** /device/app/log/flow-count | +[**get_app_log_flows**](RealTimeMonitoringAppLogsApi.md#get_app_log_flows) | **GET** /device/app/log/flows | + + +# **get_app_log_flow_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_log_flow_count(device_id) + + + +Get App log flows count from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_logs_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_logs_api.RealTimeMonitoringAppLogsApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_log_flow_count(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppLogsApi->get_app_log_flow_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_log_flows** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_log_flows(device_id) + + + +Get App log flows from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_app_logs_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_app_logs_api.RealTimeMonitoringAppLogsApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_log_flows(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppLogsApi->get_app_log_flows: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringApplicationAwareRouteApi.md b/docs/RealTimeMonitoringApplicationAwareRouteApi.md new file mode 100644 index 0000000..a043a45 --- /dev/null +++ b/docs/RealTimeMonitoringApplicationAwareRouteApi.md @@ -0,0 +1,160 @@ +# openapi_client.RealTimeMonitoringApplicationAwareRouteApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_app_route_sla_class_list**](RealTimeMonitoringApplicationAwareRouteApi.md#create_app_route_sla_class_list) | **GET** /device/app-route/sla-class | +[**create_app_route_statistics_list**](RealTimeMonitoringApplicationAwareRouteApi.md#create_app_route_statistics_list) | **GET** /device/app-route/statistics | + + +# **create_app_route_sla_class_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_app_route_sla_class_list(device_id) + + + +Get SLA class list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_application_aware_route_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_application_aware_route_api.RealTimeMonitoringApplicationAwareRouteApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_app_route_sla_class_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringApplicationAwareRouteApi->create_app_route_sla_class_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_app_route_statistics_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_app_route_statistics_list(device_id) + + + +Get application-aware routing statistics from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_application_aware_route_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_application_aware_route_api.RealTimeMonitoringApplicationAwareRouteApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_system_ip = "remote-system-ip_example" # str | Remote system IP (optional) + local_color = "default" # str | Local color (optional) + remote_color = "default" # str | Remote color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_app_route_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringApplicationAwareRouteApi->create_app_route_statistics_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_app_route_statistics_list(device_id, remote_system_ip=remote_system_ip, local_color=local_color, remote_color=remote_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringApplicationAwareRouteApi->create_app_route_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_system_ip** | **str**| Remote system IP | [optional] + **local_color** | **str**| Local color | [optional] + **remote_color** | **str**| Remote color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringAppqoeApi.md b/docs/RealTimeMonitoringAppqoeApi.md new file mode 100644 index 0000000..f3a0900 --- /dev/null +++ b/docs/RealTimeMonitoringAppqoeApi.md @@ -0,0 +1,1132 @@ +# openapi_client.RealTimeMonitoringAppqoeApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_appqoe_active_flow_id_details**](RealTimeMonitoringAppqoeApi.md#create_appqoe_active_flow_id_details) | **GET** /device/appqoe/active-flow-id | +[**create_appqoe_flow_id_expired_details**](RealTimeMonitoringAppqoeApi.md#create_appqoe_flow_id_expired_details) | **GET** /device/appqoe/expired-flow-id | +[**create_appqoe_vpn_id_list**](RealTimeMonitoringAppqoeApi.md#create_appqoe_vpn_id_list) | **GET** /device/appqoe/vpn-id | +[**get_appqoe_cluster_summary**](RealTimeMonitoringAppqoeApi.md#get_appqoe_cluster_summary) | **GET** /device/appqoe/cluster-summary | +[**get_appqoe_error_recent**](RealTimeMonitoringAppqoeApi.md#get_appqoe_error_recent) | **GET** /device/appqoe/error-recent | +[**get_appqoe_expired**](RealTimeMonitoringAppqoeApi.md#get_appqoe_expired) | **GET** /device/appqoe/flow-expired | +[**get_appqoe_flow_closed_error**](RealTimeMonitoringAppqoeApi.md#get_appqoe_flow_closed_error) | **GET** /device/appqoe/flow-closed-error | +[**get_appqoe_hput_stats**](RealTimeMonitoringAppqoeApi.md#get_appqoe_hput_stats) | **GET** /device/appqoe/appqoe-hput-stats | +[**get_appqoe_nat_stats**](RealTimeMonitoringAppqoeApi.md#get_appqoe_nat_stats) | **GET** /device/appqoe/appqoe-nat-stats | +[**get_appqoe_rm_resources**](RealTimeMonitoringAppqoeApi.md#get_appqoe_rm_resources) | **GET** /device/appqoe/appqoe-rm-resource | +[**get_appqoe_rm_stats**](RealTimeMonitoringAppqoeApi.md#get_appqoe_rm_stats) | **GET** /device/appqoe/appqoe-rm-stats | +[**get_appqoe_service_controllers**](RealTimeMonitoringAppqoeApi.md#get_appqoe_service_controllers) | **GET** /device/appqoe/service-controllers | +[**get_appqoe_services_status**](RealTimeMonitoringAppqoeApi.md#get_appqoe_services_status) | **GET** /device/appqoe/appqoe-services-status | +[**get_appqoe_sppi_pipe_stats**](RealTimeMonitoringAppqoeApi.md#get_appqoe_sppi_pipe_stats) | **GET** /device/appqoe/appqoe-sppi-pipe-resource | +[**get_appqoe_sppi_queue_stats**](RealTimeMonitoringAppqoeApi.md#get_appqoe_sppi_queue_stats) | **GET** /device/appqoe/appqoe-sppi-queue-resource | +[**get_appqoe_status**](RealTimeMonitoringAppqoeApi.md#get_appqoe_status) | **GET** /device/appqoe/status | + + +# **create_appqoe_active_flow_id_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_appqoe_active_flow_id_details(flow_id, device_id) + + + +Get Appqoe Active flow Id details from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + flow_id = "flow-id_example" # str | Flow Id + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_appqoe_active_flow_id_details(flow_id, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->create_appqoe_active_flow_id_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **flow_id** | **str**| Flow Id | + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_appqoe_flow_id_expired_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_appqoe_flow_id_expired_details(flow_id, device_id) + + + +Get Appqoe Expired flow Id details from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + flow_id = "flow-id_example" # str | Flow Id + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_appqoe_flow_id_expired_details(flow_id, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->create_appqoe_flow_id_expired_details: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **flow_id** | **str**| Flow Id | + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_appqoe_vpn_id_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_appqoe_vpn_id_list(vpn_id, device_id) + + + +Get Appqoe Active vpn Id details from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + vpn_id = "vpn-id_example" # str | VPN Id + device_id = "00r252U250?250" # str | Device IP + client_ip = "client-ip_example" # str | Client Ip (optional) + server_ip = "server-ip_example" # str | Server Ip (optional) + server_port = "server-port_example" # str | Server-Port (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_appqoe_vpn_id_list(vpn_id, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->create_appqoe_vpn_id_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_appqoe_vpn_id_list(vpn_id, device_id, client_ip=client_ip, server_ip=server_ip, server_port=server_port) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->create_appqoe_vpn_id_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | **str**| VPN Id | + **device_id** | **str**| Device IP | + **client_ip** | **str**| Client Ip | [optional] + **server_ip** | **str**| Server Ip | [optional] + **server_port** | **str**| Server-Port | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_cluster_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_cluster_summary(device_id) + + + +Get Appqoe Cluster Summary from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_cluster_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_cluster_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_error_recent** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_error_recent(device_id) + + + +Get Appqoe error recent from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_error_recent(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_error_recent: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_expired** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_expired(device_id) + + + +Get Appqoe expired from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_expired(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_expired: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_flow_closed_error** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_flow_closed_error(device_id) + + + +Get Appqoe flow closed error from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_flow_closed_error(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_flow_closed_error: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_hput_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_hput_stats(device_id) + + + +Get Appqoe Hput Statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_hput_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_hput_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_nat_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_nat_stats(device_id) + + + +Get Appqoe Nat Statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_nat_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_nat_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_rm_resources** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_rm_resources(device_id) + + + +Get Appqoe Resource Manager resources from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_rm_resources(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_rm_resources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_rm_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_rm_stats(device_id) + + + +Get Appqoe RM Statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_rm_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_rm_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_service_controllers** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_service_controllers(device_id) + + + +Get Appqoe service controllers from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_service_controllers(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_service_controllers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_services_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_services_status(device_id) + + + +Get Appqoe Services Status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_services_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_services_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_sppi_pipe_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_sppi_pipe_stats(device_id) + + + +Get Appqoe Sppi Pipe Stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_sppi_pipe_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_sppi_pipe_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_sppi_queue_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_sppi_queue_stats(device_id) + + + +Get Appqoe Sppi Queue Stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_sppi_queue_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_sppi_queue_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_appqoe_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_appqoe_status(device_id) + + + +Get Appqoe status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_appqoe_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_appqoe_api.RealTimeMonitoringAppqoeApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_appqoe_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringAppqoeApi->get_appqoe_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringBFDApi.md b/docs/RealTimeMonitoringBFDApi.md new file mode 100644 index 0000000..86c8570 --- /dev/null +++ b/docs/RealTimeMonitoringBFDApi.md @@ -0,0 +1,954 @@ +# openapi_client.RealTimeMonitoringBFDApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_bfd_history_list**](RealTimeMonitoringBFDApi.md#create_bfd_history_list) | **GET** /device/bfd/history | +[**create_bfd_link_list**](RealTimeMonitoringBFDApi.md#create_bfd_link_list) | **GET** /device/bfd/links | +[**create_bfd_sessions**](RealTimeMonitoringBFDApi.md#create_bfd_sessions) | **GET** /device/bfd/sessions | +[**create_bfd_summary**](RealTimeMonitoringBFDApi.md#create_bfd_summary) | **GET** /device/bfd/summary | +[**create_synced_bfd_session**](RealTimeMonitoringBFDApi.md#create_synced_bfd_session) | **GET** /device/bfd/synced/sessions | +[**create_tloc_summary**](RealTimeMonitoringBFDApi.md#create_tloc_summary) | **GET** /device/bfd/tloc | +[**get_bfd_site_state_detail**](RealTimeMonitoringBFDApi.md#get_bfd_site_state_detail) | **GET** /device/bfd/sites/detail | +[**get_bfd_sites_summary**](RealTimeMonitoringBFDApi.md#get_bfd_sites_summary) | **GET** /device/bfd/sites/summary | +[**get_device_bfd_state_summary**](RealTimeMonitoringBFDApi.md#get_device_bfd_state_summary) | **GET** /device/bfd/state/device | +[**get_device_bfd_state_summary_tloc**](RealTimeMonitoringBFDApi.md#get_device_bfd_state_summary_tloc) | **GET** /device/bfd/state/device/tloc | +[**get_device_bfd_status**](RealTimeMonitoringBFDApi.md#get_device_bfd_status) | **GET** /device/bfd/status | +[**get_device_bfd_status_summary**](RealTimeMonitoringBFDApi.md#get_device_bfd_status_summary) | **GET** /device/bfd/summary/device | +[**get_device_tloc_to_intf_list**](RealTimeMonitoringBFDApi.md#get_device_tloc_to_intf_list) | **GET** /device/bfd/state/device/tlocInterfaceMap | + + +# **create_bfd_history_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_bfd_history_list(device_id) + + + +Get BFD session history from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + system_ip = "system-ip_example" # str | System IP (optional) + color = "default" # str | Remote color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bfd_history_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_bfd_history_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_bfd_history_list(device_id, system_ip=system_ip, color=color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_bfd_history_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **system_ip** | **str**| System IP | [optional] + **color** | **str**| Remote color | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_bfd_link_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_bfd_link_list(state) + + + +Get list of BFD connections + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + state = "state_example" # str | Device state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bfd_link_list(state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_bfd_link_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state** | **str**| Device state | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_bfd_sessions** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_bfd_sessions(device_id) + + + +Get list of BFD sessions from vManage (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + system_ip = "system-ip_example" # str | System IP (optional) + color = "default" # str | Remote color (optional) + local_color = "default" # str | Source color (optional) + region_type = "core" # str | Region type (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bfd_sessions(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_bfd_sessions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_bfd_sessions(device_id, system_ip=system_ip, color=color, local_color=local_color, region_type=region_type) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_bfd_sessions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **system_ip** | **str**| System IP | [optional] + **color** | **str**| Remote color | [optional] + **local_color** | **str**| Source color | [optional] + **region_type** | **str**| Region type | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_bfd_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_bfd_summary(device_id) + + + +Get BFD summary from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bfd_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_bfd_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_bfd_session** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_synced_bfd_session(device_id) + + + +Get list of BFD sessions from vManage synchronously + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + system_ip = "system-ip_example" # str | System IP (optional) + color = "default" # str | Remote color (optional) + local_color = "default" # str | Source color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_bfd_session(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_synced_bfd_session: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_synced_bfd_session(device_id, system_ip=system_ip, color=color, local_color=local_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_synced_bfd_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **system_ip** | **str**| System IP | [optional] + **color** | **str**| Remote color | [optional] + **local_color** | **str**| Source color | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tloc_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tloc_summary(device_id) + + + +Get TLOC summary from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_tloc_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->create_tloc_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bfd_site_state_detail** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bfd_site_state_detail() + + + +Get detailed BFD site details + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_bfd_site_state_detail() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_bfd_site_state_detail: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bfd_sites_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bfd_sites_summary(vpn_id) + + + +Get BFD site summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from openapi_client.model.vpnid import VPNID +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + vpn_id = [ + VPNID( + vpn="vpn_example", + ), + ] # [VPNID] | Filter VPN + is_cached = False # bool | Flag for caching (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bfd_sites_summary(vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_bfd_sites_summary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_bfd_sites_summary(vpn_id, is_cached=is_cached) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_bfd_sites_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | [**[VPNID]**](VPNID.md)| Filter VPN | + **is_cached** | **bool**| Flag for caching | [optional] if omitted the server will use the default value of False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_bfd_state_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_bfd_state_summary(device_id) + + + +Get device BFD state summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_bfd_state_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_device_bfd_state_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_bfd_state_summary_tloc** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_bfd_state_summary_tloc(device_id) + + + +Get device BFD state summary with tloc color + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_bfd_state_summary_tloc(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_device_bfd_state_summary_tloc: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_bfd_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_bfd_status() + + + +Get device BFD status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_bfd_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_device_bfd_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_bfd_status_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_bfd_status_summary(device_id) + + + +Get device BFD status summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_bfd_status_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_device_bfd_status_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_tloc_to_intf_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tloc_to_intf_list(device_id) + + + +Get device tloc color to Intf Mapping Relationship + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bfd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bfd_api.RealTimeMonitoringBFDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_tloc_to_intf_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBFDApi->get_device_tloc_to_intf_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringBGPApi.md b/docs/RealTimeMonitoringBGPApi.md new file mode 100644 index 0000000..1dbd0e0 --- /dev/null +++ b/docs/RealTimeMonitoringBGPApi.md @@ -0,0 +1,243 @@ +# openapi_client.RealTimeMonitoringBGPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_bgp_neighbors_list**](RealTimeMonitoringBGPApi.md#create_bgp_neighbors_list) | **GET** /device/bgp/neighbors | +[**create_bgp_routes_list**](RealTimeMonitoringBGPApi.md#create_bgp_routes_list) | **GET** /device/bgp/routes | +[**create_bgp_summary**](RealTimeMonitoringBGPApi.md#create_bgp_summary) | **GET** /device/bgp/summary | + + +# **create_bgp_neighbors_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_bgp_neighbors_list(device_id) + + + +Get BGP neighbors list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bgp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bgp_api.RealTimeMonitoringBGPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + peer_addr = "peer-addr_example" # str | Peer address (optional) + _as = "as_example" # str | AS number (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bgp_neighbors_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBGPApi->create_bgp_neighbors_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_bgp_neighbors_list(device_id, vpn_id=vpn_id, peer_addr=peer_addr, _as=_as) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBGPApi->create_bgp_neighbors_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **peer_addr** | **str**| Peer address | [optional] + **_as** | **str**| AS number | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_bgp_routes_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_bgp_routes_list(device_id) + + + +Get BGP routes list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bgp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bgp_api.RealTimeMonitoringBGPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + prefix = "prefix_example" # str | IP prefix (optional) + nexthop = "nexthop_example" # str | Next hop (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bgp_routes_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBGPApi->create_bgp_routes_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_bgp_routes_list(device_id, vpn_id=vpn_id, prefix=prefix, nexthop=nexthop) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBGPApi->create_bgp_routes_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **prefix** | **str**| IP prefix | [optional] + **nexthop** | **str**| Next hop | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_bgp_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_bgp_summary(device_id) + + + +Get BGP summary (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bgp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bgp_api.RealTimeMonitoringBGPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bgp_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBGPApi->create_bgp_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringBridgeApi.md b/docs/RealTimeMonitoringBridgeApi.md new file mode 100644 index 0000000..f51d6cf --- /dev/null +++ b/docs/RealTimeMonitoringBridgeApi.md @@ -0,0 +1,229 @@ +# openapi_client.RealTimeMonitoringBridgeApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_bridge_interface_list**](RealTimeMonitoringBridgeApi.md#get_bridge_interface_list) | **GET** /device/bridge/interface | +[**get_bridge_interface_mac**](RealTimeMonitoringBridgeApi.md#get_bridge_interface_mac) | **GET** /device/bridge/mac | +[**get_bridge_interface_table**](RealTimeMonitoringBridgeApi.md#get_bridge_interface_table) | **GET** /device/bridge/table | + + +# **get_bridge_interface_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bridge_interface_list(device_id) + + + +Get device bridge interface list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bridge_api.RealTimeMonitoringBridgeApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bridge_interface_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBridgeApi->get_bridge_interface_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bridge_interface_mac** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bridge_interface_mac(device_id) + + + +Get device bridge interface MAC (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bridge_api.RealTimeMonitoringBridgeApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + bridge_id = "bridge-id_example" # str | Bridge ID (optional) + if_name = "ge0/0" # str | Interface name (optional) + mac_address = "mac-address_example" # str | MAC address (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bridge_interface_mac(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBridgeApi->get_bridge_interface_mac: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_bridge_interface_mac(device_id, bridge_id=bridge_id, if_name=if_name, mac_address=mac_address) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBridgeApi->get_bridge_interface_mac: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **bridge_id** | **str**| Bridge ID | [optional] + **if_name** | **str**| Interface name | [optional] + **mac_address** | **str**| MAC address | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_bridge_interface_table** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_bridge_interface_table(device_id) + + + +Get device bridge interface table (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_bridge_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_bridge_api.RealTimeMonitoringBridgeApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_bridge_interface_table(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringBridgeApi->get_bridge_interface_table: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCFMApi.md b/docs/RealTimeMonitoringCFMApi.md new file mode 100644 index 0000000..28fbb88 --- /dev/null +++ b/docs/RealTimeMonitoringCFMApi.md @@ -0,0 +1,328 @@ +# openapi_client.RealTimeMonitoringCFMApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_mp_database**](RealTimeMonitoringCFMApi.md#get_mp_database) | **GET** /device/cfm/mp/database | +[**get_mp_local_mep**](RealTimeMonitoringCFMApi.md#get_mp_local_mep) | **GET** /device/cfm/mp/local/mep | +[**get_mp_local_mip**](RealTimeMonitoringCFMApi.md#get_mp_local_mip) | **GET** /device/cfm/mp/local/mip | +[**get_mp_remote_mep**](RealTimeMonitoringCFMApi.md#get_mp_remote_mep) | **GET** /device/cfm/mp/remotemep | + + +# **get_mp_database** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mp_database(device_id) + + + +Get mp database from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cfm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cfm_api.RealTimeMonitoringCFMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mp_database(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_database: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mp_local_mep** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mp_local_mep(device_id) + + + +Get mp local mep from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cfm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cfm_api.RealTimeMonitoringCFMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + domain = "domain_example" # str | Domain Name (optional) + service = "service_example" # str | Service Name (optional) + mep_id = 3.14 # float | MEP ID (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mp_local_mep(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_local_mep: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_mp_local_mep(device_id, domain=domain, service=service, mep_id=mep_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_local_mep: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **domain** | **str**| Domain Name | [optional] + **service** | **str**| Service Name | [optional] + **mep_id** | **float**| MEP ID | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mp_local_mip** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mp_local_mip(device_id) + + + +Get mp local mip from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cfm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cfm_api.RealTimeMonitoringCFMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + level = 3.14 # float | Level (optional) + port = "port_example" # str | Port (optional) + svc_inst = 3.14 # float | Service Instance (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mp_local_mip(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_local_mip: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_mp_local_mip(device_id, level=level, port=port, svc_inst=svc_inst) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_local_mip: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **level** | **float**| Level | [optional] + **port** | **str**| Port | [optional] + **svc_inst** | **float**| Service Instance | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_mp_remote_mep** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_mp_remote_mep(device_id) + + + +Get mp remote mep from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cfm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cfm_api.RealTimeMonitoringCFMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + domain = "domain_example" # str | Domain Name (optional) + service = "service_example" # str | Service Name (optional) + local_mep_id = 3.14 # float | Local MEP ID (optional) + remote_mep_id = 3.14 # float | Remote MEP ID (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_mp_remote_mep(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_remote_mep: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_mp_remote_mep(device_id, domain=domain, service=service, local_mep_id=local_mep_id, remote_mep_id=remote_mep_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCFMApi->get_mp_remote_mep: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **domain** | **str**| Domain Name | [optional] + **service** | **str**| Service Name | [optional] + **local_mep_id** | **float**| Local MEP ID | [optional] + **remote_mep_id** | **float**| Remote MEP ID | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCellularAONIpsecInterfaceApi.md b/docs/RealTimeMonitoringCellularAONIpsecInterfaceApi.md new file mode 100644 index 0000000..cc2b3d9 --- /dev/null +++ b/docs/RealTimeMonitoringCellularAONIpsecInterfaceApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringCellularAONIpsecInterfaceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_aon_ipsec_interface_counters_info**](RealTimeMonitoringCellularAONIpsecInterfaceApi.md#get_aon_ipsec_interface_counters_info) | **GET** /device/cellularEiolte/ipsec/interface/counters | +[**get_aon_ipsec_interface_sessionnfo**](RealTimeMonitoringCellularAONIpsecInterfaceApi.md#get_aon_ipsec_interface_sessionnfo) | **GET** /device/cellularEiolte/ipsec/interface/session | + + +# **get_aon_ipsec_interface_counters_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aon_ipsec_interface_counters_info(device_id) + + + +Get cellular ipsec interface info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_aon_ipsec_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_aon_ipsec_interface_api.RealTimeMonitoringCellularAONIpsecInterfaceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aon_ipsec_interface_counters_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularAONIpsecInterfaceApi->get_aon_ipsec_interface_counters_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aon_ipsec_interface_sessionnfo** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aon_ipsec_interface_sessionnfo(device_id) + + + +Get cellular ipsec interface info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_aon_ipsec_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_aon_ipsec_interface_api.RealTimeMonitoringCellularAONIpsecInterfaceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aon_ipsec_interface_sessionnfo(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularAONIpsecInterfaceApi->get_aon_ipsec_interface_sessionnfo: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCellularApi.md b/docs/RealTimeMonitoringCellularApi.md new file mode 100644 index 0000000..fd8a798 --- /dev/null +++ b/docs/RealTimeMonitoringCellularApi.md @@ -0,0 +1,572 @@ +# openapi_client.RealTimeMonitoringCellularApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_cellular_connection_list**](RealTimeMonitoringCellularApi.md#create_cellular_connection_list) | **GET** /device/cellular/connection | +[**create_hardware_list**](RealTimeMonitoringCellularApi.md#create_hardware_list) | **GET** /device/cellular/hardware | +[**create_modem_list**](RealTimeMonitoringCellularApi.md#create_modem_list) | **GET** /device/cellular/modem | +[**create_network_list**](RealTimeMonitoringCellularApi.md#create_network_list) | **GET** /device/cellular/network | +[**create_profile_list**](RealTimeMonitoringCellularApi.md#create_profile_list) | **GET** /device/cellular/profiles | +[**create_radio_list**](RealTimeMonitoringCellularApi.md#create_radio_list) | **GET** /device/cellular/radio | +[**create_sessions_list**](RealTimeMonitoringCellularApi.md#create_sessions_list) | **GET** /device/cellular/sessions | +[**get_cellular_status_list**](RealTimeMonitoringCellularApi.md#get_cellular_status_list) | **GET** /device/cellular/status | + + +# **create_cellular_connection_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_cellular_connection_list(device_id) + + + +Get cellular connection list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cellular_connection_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_cellular_connection_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_hardware_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_hardware_list(device_id) + + + +Get cellular hardware list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_hardware_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_hardware_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_modem_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_modem_list(policy_id) + + + +Get cellular modem list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + policy_id = "00r252U250?250" # str | Policy IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_modem_list(policy_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_modem_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **policy_id** | **str**| Policy IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_network_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_network_list(device_id) + + + +Get cellular network list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_network_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_network_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_profile_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_profile_list(device_id) + + + +Get cellular profile list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_profile_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_profile_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_radio_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_radio_list(device_id) + + + +Get cellular radio list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_radio_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_radio_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_sessions_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_sessions_list(device_id) + + + +Get cellular session list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + if_name = "ge0/0" # str | Interface name (optional) + ipv4_dns_pri = "ipv4-dns-pri_example" # str | DNS primary IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_sessions_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_sessions_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_sessions_list(device_id, if_name=if_name, ipv4_dns_pri=ipv4_dns_pri) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->create_sessions_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **if_name** | **str**| Interface name | [optional] + **ipv4_dns_pri** | **str**| DNS primary IP | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cellular_status_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_cellular_status_list(device_id) + + + +Get cellular status list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_api.RealTimeMonitoringCellularApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cellular_status_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularApi->get_cellular_status_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md b/docs/RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md new file mode 100644 index 0000000..48b8fc0 --- /dev/null +++ b/docs/RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringCellularEIOLTEConnectionServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_eiolte_connection_info**](RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md#get_eiolte_connection_info) | **GET** /device/cellularEiolte/connections | +[**get_eiolte_radio_info**](RealTimeMonitoringCellularEIOLTEConnectionServiceApi.md#get_eiolte_radio_info) | **GET** /device/cellularEiolte/radio | + + +# **get_eiolte_connection_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_eiolte_connection_info(device_id) + + + +Get cellular connection info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_eiolte_connection_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_eiolte_connection_service_api.RealTimeMonitoringCellularEIOLTEConnectionServiceApi(api_client) + device_id = "deviceId_example" # str | Device Ip address, example:172.16.255.111 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_eiolte_connection_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularEIOLTEConnectionServiceApi->get_eiolte_connection_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Ip address, example:172.16.255.111 | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_eiolte_radio_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_eiolte_radio_info(device_id) + + + +Get cellular radio info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_eiolte_connection_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_eiolte_connection_service_api.RealTimeMonitoringCellularEIOLTEConnectionServiceApi(api_client) + device_id = "deviceId_example" # str | Device Ip address, example:172.16.255.111 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_eiolte_radio_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularEIOLTEConnectionServiceApi->get_eiolte_radio_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Ip address, example:172.16.255.111 | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCellularEIOLTEHardwareServiceApi.md b/docs/RealTimeMonitoringCellularEIOLTEHardwareServiceApi.md new file mode 100644 index 0000000..6da1394 --- /dev/null +++ b/docs/RealTimeMonitoringCellularEIOLTEHardwareServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringCellularEIOLTEHardwareServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_eiolte_hardware_info**](RealTimeMonitoringCellularEIOLTEHardwareServiceApi.md#get_eiolte_hardware_info) | **GET** /device/cellularEiolte/hardware | + + +# **get_eiolte_hardware_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_eiolte_hardware_info(device_id) + + + +Get cellular hardware info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_eiolte_hardware_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_eiolte_hardware_service_api.RealTimeMonitoringCellularEIOLTEHardwareServiceApi(api_client) + device_id = "deviceId_example" # str | Device Ip address, example:172.16.255.111 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_eiolte_hardware_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularEIOLTEHardwareServiceApi->get_eiolte_hardware_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Ip address, example:172.16.255.111 | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCellularEIOLTENetworkServiceApi.md b/docs/RealTimeMonitoringCellularEIOLTENetworkServiceApi.md new file mode 100644 index 0000000..c69fd08 --- /dev/null +++ b/docs/RealTimeMonitoringCellularEIOLTENetworkServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringCellularEIOLTENetworkServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_eiolte_network_info**](RealTimeMonitoringCellularEIOLTENetworkServiceApi.md#get_eiolte_network_info) | **GET** /device/cellularEiolte/network | + + +# **get_eiolte_network_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_eiolte_network_info(device_id) + + + +Get cellular network info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_eiolte_network_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_eiolte_network_service_api.RealTimeMonitoringCellularEIOLTENetworkServiceApi(api_client) + device_id = "deviceId_example" # str | Device Ip address, example:172.16.255.111 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_eiolte_network_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularEIOLTENetworkServiceApi->get_eiolte_network_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Ip address, example:172.16.255.111 | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCellularEIOLTESimServiceApi.md b/docs/RealTimeMonitoringCellularEIOLTESimServiceApi.md new file mode 100644 index 0000000..2d7c869 --- /dev/null +++ b/docs/RealTimeMonitoringCellularEIOLTESimServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringCellularEIOLTESimServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_eiolte_sim_info**](RealTimeMonitoringCellularEIOLTESimServiceApi.md#get_eiolte_sim_info) | **GET** /device/cellularEiolte/sim | + + +# **get_eiolte_sim_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_eiolte_sim_info(device_id) + + + +Get cellular sim info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cellular_eiolte_sim_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cellular_eiolte_sim_service_api.RealTimeMonitoringCellularEIOLTESimServiceApi(api_client) + device_id = "deviceId_example" # str | Device Ip address, example:172.16.255.111 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_eiolte_sim_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCellularEIOLTESimServiceApi->get_eiolte_sim_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Ip address, example:172.16.255.111 | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCloudExpressApi.md b/docs/RealTimeMonitoringCloudExpressApi.md new file mode 100644 index 0000000..3242628 --- /dev/null +++ b/docs/RealTimeMonitoringCloudExpressApi.md @@ -0,0 +1,392 @@ +# openapi_client.RealTimeMonitoringCloudExpressApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_applications_detail_list**](RealTimeMonitoringCloudExpressApi.md#create_applications_detail_list) | **GET** /device/cloudx/application/detail | +[**create_applications_list**](RealTimeMonitoringCloudExpressApi.md#create_applications_list) | **GET** /device/cloudx/applications | +[**create_gateway_exits_list**](RealTimeMonitoringCloudExpressApi.md#create_gateway_exits_list) | **GET** /device/cloudx/gatewayexits | +[**create_lb_applications_list**](RealTimeMonitoringCloudExpressApi.md#create_lb_applications_list) | **GET** /device/cloudx/loadbalance | +[**create_local_exits_list**](RealTimeMonitoringCloudExpressApi.md#create_local_exits_list) | **GET** /device/cloudx/localexits | + + +# **create_applications_detail_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_applications_detail_list() + + + +Get list of cloudexpress applications from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cloud_express_api.RealTimeMonitoringCloudExpressApi(api_client) + vpn_id = "0" # str | VPN Id (optional) + application = "application_example" # str | Application (optional) + query = "query_example" # str | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_applications_detail_list(vpn_id=vpn_id, application=application, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_applications_detail_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | **str**| VPN Id | [optional] + **application** | **str**| Application | [optional] + **query** | **str**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_applications_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_applications_list() + + + +Get list of cloudexpress applications from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cloud_express_api.RealTimeMonitoringCloudExpressApi(api_client) + vpn_id = "0" # str | VPN Id (optional) + application = "application_example" # str | Application (optional) + query = "query_example" # str | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_applications_list(vpn_id=vpn_id, application=application, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_applications_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | **str**| VPN Id | [optional] + **application** | **str**| Application | [optional] + **query** | **str**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_gateway_exits_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_gateway_exits_list(device_id) + + + +Get list of cloudexpress gateway exits from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cloud_express_api.RealTimeMonitoringCloudExpressApi(api_client) + device_id = "00r252U250?250" # str | Device IP + vpn_id = "0" # str | VPN Id (optional) + application = "application_example" # str | Application (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_gateway_exits_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_gateway_exits_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_gateway_exits_list(device_id, vpn_id=vpn_id, application=application) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_gateway_exits_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **application** | **str**| Application | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_lb_applications_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_lb_applications_list() + + + +Get list of cloudexpress load balance applications from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cloud_express_api.RealTimeMonitoringCloudExpressApi(api_client) + vpn_id = "0" # str | VPN Id (optional) + application = "application_example" # str | Application (optional) + query = "query_example" # str | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_lb_applications_list(vpn_id=vpn_id, application=application, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_lb_applications_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn_id** | **str**| VPN Id | [optional] + **application** | **str**| Application | [optional] + **query** | **str**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_local_exits_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_local_exits_list(device_id) + + + +Get list of cloudexpress local exits from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_cloud_express_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_cloud_express_api.RealTimeMonitoringCloudExpressApi(api_client) + device_id = "00r252U250?250" # str | Device IP + vpn_id = "0" # str | VPN Id (optional) + application = "application_example" # str | Application (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_local_exits_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_local_exits_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_local_exits_list(device_id, vpn_id=vpn_id, application=application) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCloudExpressApi->create_local_exits_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **application** | **str**| Application | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCommitListApi.md b/docs/RealTimeMonitoringCommitListApi.md new file mode 100644 index 0000000..9d3779c --- /dev/null +++ b/docs/RealTimeMonitoringCommitListApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringCommitListApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_device_configuration_commit_list**](RealTimeMonitoringCommitListApi.md#get_device_configuration_commit_list) | **GET** /device/configuration/commit-list | + + +# **get_device_configuration_commit_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_configuration_commit_list(device_id) + + + +Get device commit list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_commit_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_commit_list_api.RealTimeMonitoringCommitListApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_configuration_commit_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCommitListApi->get_device_configuration_commit_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringContainerLifecycleApi.md b/docs/RealTimeMonitoringContainerLifecycleApi.md new file mode 100644 index 0000000..044e230 --- /dev/null +++ b/docs/RealTimeMonitoringContainerLifecycleApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringContainerLifecycleApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_device_containers_info**](RealTimeMonitoringContainerLifecycleApi.md#create_device_containers_info) | **GET** /device/csp/containers/container | + + +# **create_device_containers_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_containers_info(device_id) + + + +Get device container from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_container_lifecycle_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_container_lifecycle_api.RealTimeMonitoringContainerLifecycleApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_containers_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringContainerLifecycleApi->create_device_containers_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringCrashLogApi.md b/docs/RealTimeMonitoringCrashLogApi.md new file mode 100644 index 0000000..fc334d2 --- /dev/null +++ b/docs/RealTimeMonitoringCrashLogApi.md @@ -0,0 +1,282 @@ +# openapi_client.RealTimeMonitoringCrashLogApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_device_crash_logs**](RealTimeMonitoringCrashLogApi.md#get_all_device_crash_logs) | **GET** /device/crashlog/details | +[**get_device_crash_information**](RealTimeMonitoringCrashLogApi.md#get_device_crash_information) | **GET** /device/crashlog/log | +[**get_device_crash_logs**](RealTimeMonitoringCrashLogApi.md#get_device_crash_logs) | **GET** /device/crashlog | +[**get_device_crash_logs_synced**](RealTimeMonitoringCrashLogApi.md#get_device_crash_logs_synced) | **GET** /device/crashlog/synced | + + +# **get_all_device_crash_logs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_device_crash_logs() + + + +Get device crash logs for all device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_crash_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_crash_log_api.RealTimeMonitoringCrashLogApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_device_crash_logs() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCrashLogApi->get_all_device_crash_logs: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_crash_information** +> str get_device_crash_information(device_id, filename) + + + +Get device crash info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_crash_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_crash_log_api.RealTimeMonitoringCrashLogApi(api_client) + device_id = "00r252U250?250" # str | Device IP + filename = "filename_example" # str | Crash file name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_crash_information(device_id, filename) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCrashLogApi->get_device_crash_information: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **filename** | **str**| Crash file name | + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_crash_logs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_crash_logs(device_id) + + + +Get device crash logs from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_crash_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_crash_log_api.RealTimeMonitoringCrashLogApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_crash_logs(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCrashLogApi->get_device_crash_logs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_crash_logs_synced** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_crash_logs_synced(device_id) + + + +Get device crash logs synchronously from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_crash_log_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_crash_log_api.RealTimeMonitoringCrashLogApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_crash_logs_synced(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringCrashLogApi->get_device_crash_logs_synced: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDHCPApi.md b/docs/RealTimeMonitoringDHCPApi.md new file mode 100644 index 0000000..d001759 --- /dev/null +++ b/docs/RealTimeMonitoringDHCPApi.md @@ -0,0 +1,284 @@ +# openapi_client.RealTimeMonitoringDHCPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_dhcp_client**](RealTimeMonitoringDHCPApi.md#get_dhcp_client) | **GET** /device/dhcp/client | +[**get_dhcp_interface**](RealTimeMonitoringDHCPApi.md#get_dhcp_interface) | **GET** /device/dhcp/interface | +[**get_dhcp_server**](RealTimeMonitoringDHCPApi.md#get_dhcp_server) | **GET** /device/dhcp/server | +[**get_dhcpv6_interface**](RealTimeMonitoringDHCPApi.md#get_dhcpv6_interface) | **GET** /device/dhcpv6/interface | + + +# **get_dhcp_client** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dhcp_client(device_id) + + + +Get DHCP client from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dhcp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dhcp_api.RealTimeMonitoringDHCPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dhcp_client(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDHCPApi->get_dhcp_client: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dhcp_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dhcp_interface(device_id) + + + +Get DHCP interfaces from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dhcp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dhcp_api.RealTimeMonitoringDHCPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dhcp_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDHCPApi->get_dhcp_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dhcp_server** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dhcp_server(device_id) + + + +Get DHCP server from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dhcp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dhcp_api.RealTimeMonitoringDHCPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dhcp_server(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDHCPApi->get_dhcp_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dhcpv6_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dhcpv6_interface(device_id) + + + +Get DHCPv6 interfaces from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dhcp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dhcp_api.RealTimeMonitoringDHCPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dhcpv6_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDHCPApi->get_dhcpv6_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDOT1xApi.md b/docs/RealTimeMonitoringDOT1xApi.md new file mode 100644 index 0000000..09e9458 --- /dev/null +++ b/docs/RealTimeMonitoringDOT1xApi.md @@ -0,0 +1,215 @@ +# openapi_client.RealTimeMonitoringDOT1xApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_dot1x_radius**](RealTimeMonitoringDOT1xApi.md#get_dot1x_radius) | **GET** /device/dot1x/radius | +[**get_wlandot1x_clients**](RealTimeMonitoringDOT1xApi.md#get_wlandot1x_clients) | **GET** /device/dot1x/clients | +[**get_wlandot1x_interfaces**](RealTimeMonitoringDOT1xApi.md#get_wlandot1x_interfaces) | **GET** /device/dot1x/interfaces | + + +# **get_dot1x_radius** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dot1x_radius(device_id) + + + +Get DOT1x Radius from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dot1x_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dot1x_api.RealTimeMonitoringDOT1xApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dot1x_radius(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDOT1xApi->get_dot1x_radius: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wlandot1x_clients** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wlandot1x_clients(device_id) + + + +Get DOT1x client from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dot1x_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dot1x_api.RealTimeMonitoringDOT1xApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wlandot1x_clients(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDOT1xApi->get_wlandot1x_clients: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wlandot1x_interfaces** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wlandot1x_interfaces(device_id) + + + +Get DOT1x interface from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dot1x_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dot1x_api.RealTimeMonitoringDOT1xApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wlandot1x_interfaces(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDOT1xApi->get_wlandot1x_interfaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDPIApi.md b/docs/RealTimeMonitoringDPIApi.md new file mode 100644 index 0000000..d9ac08e --- /dev/null +++ b/docs/RealTimeMonitoringDPIApi.md @@ -0,0 +1,786 @@ +# openapi_client.RealTimeMonitoringDPIApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_dpi_collector_list**](RealTimeMonitoringDPIApi.md#create_dpi_collector_list) | **GET** /device/dpi/applications | +[**create_dpi_flows_list**](RealTimeMonitoringDPIApi.md#create_dpi_flows_list) | **GET** /device/dpi/flows | +[**create_dpi_statistics**](RealTimeMonitoringDPIApi.md#create_dpi_statistics) | **GET** /device/dpi/supported-applications | +[**create_dpi_summary_real_time**](RealTimeMonitoringDPIApi.md#create_dpi_summary_real_time) | **GET** /device/dpi/summary | +[**get_common_application_list**](RealTimeMonitoringDPIApi.md#get_common_application_list) | **GET** /device/dpi/common/applications | +[**get_dpi_device_details_field_json**](RealTimeMonitoringDPIApi.md#get_dpi_device_details_field_json) | **GET** /device/dpi/devicedetails/fields | +[**get_dpi_device_field_json**](RealTimeMonitoringDPIApi.md#get_dpi_device_field_json) | **GET** /device/dpi/application/fields | +[**get_dpi_field_json**](RealTimeMonitoringDPIApi.md#get_dpi_field_json) | **GET** /device/dpi/device/fields | +[**get_qosmos_application_list**](RealTimeMonitoringDPIApi.md#get_qosmos_application_list) | **GET** /device/dpi/qosmos/applications | +[**get_qosmos_static_application_list**](RealTimeMonitoringDPIApi.md#get_qosmos_static_application_list) | **GET** /device/dpi/qosmos-static/applications | +[**get_supported_application_list**](RealTimeMonitoringDPIApi.md#get_supported_application_list) | **GET** /device/dpi/application-mapping | + + +# **create_dpi_collector_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_dpi_collector_list(device_id) + + + +Get DPI applications from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + application = "application_example" # str | Application (optional) + family = "family_example" # str | Family (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_collector_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_collector_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dpi_collector_list(device_id, vpn_id=vpn_id, application=application, family=family) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_collector_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **application** | **str**| Application | [optional] + **family** | **str**| Family | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dpi_flows_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_dpi_flows_list(device_id) + + + +Get DPI flow list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + src_ip = "src-ip_example" # str | Source IP (optional) + application = "application_example" # str | Application (optional) + family = "family_example" # str | Family (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_flows_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_flows_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dpi_flows_list(device_id, vpn_id=vpn_id, src_ip=src_ip, application=application, family=family) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_flows_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **src_ip** | **str**| Source IP | [optional] + **application** | **str**| Application | [optional] + **family** | **str**| Family | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dpi_statistics** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_dpi_statistics(device_id) + + + +Get supported applications from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + application = "application_example" # str | Application (optional) + family = "family_example" # str | Family (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_statistics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_dpi_statistics(device_id, application=application, family=family) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **application** | **str**| Application | [optional] + **family** | **str**| Family | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_dpi_summary_real_time** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_dpi_summary_real_time(device_id) + + + +Get DPI summary from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_dpi_summary_real_time(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->create_dpi_summary_real_time: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_common_application_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_common_application_list() + + + +Get DPI common application list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_common_application_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_common_application_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dpi_device_details_field_json** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dpi_device_details_field_json() + + + +Get DPI detailed field from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_dpi_device_details_field_json() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_dpi_device_details_field_json: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dpi_device_field_json** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dpi_device_field_json() + + + +Get DPI query field from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + is_device_dash_board = False # bool | Flag whether is device dashboard request (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_dpi_device_field_json(is_device_dash_board=is_device_dash_board) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_dpi_device_field_json: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_device_dash_board** | **bool**| Flag whether is device dashboard request | [optional] if omitted the server will use the default value of False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dpi_field_json** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dpi_field_json() + + + +Get DPI field from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_dpi_field_json() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_dpi_field_json: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_qosmos_application_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_qosmos_application_list() + + + +Get DPI QoSMos application list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_qosmos_application_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_qosmos_application_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_qosmos_static_application_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_qosmos_static_application_list() + + + +Get DPI QoSMos static application list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_qosmos_static_application_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_qosmos_static_application_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_supported_application_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_supported_application_list() + + + +Get DPI supported application list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dpi_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dpi_api.RealTimeMonitoringDPIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_supported_application_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDPIApi->get_supported_application_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDREApi.md b/docs/RealTimeMonitoringDREApi.md new file mode 100644 index 0000000..372ef23 --- /dev/null +++ b/docs/RealTimeMonitoringDREApi.md @@ -0,0 +1,308 @@ +# openapi_client.RealTimeMonitoringDREApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_dre_auto_bypass_stats**](RealTimeMonitoringDREApi.md#get_dre_auto_bypass_stats) | **GET** /device/dre/auto-bypass-stats | +[**get_dre_peer_stats**](RealTimeMonitoringDREApi.md#get_dre_peer_stats) | **GET** /device/dre/peer-stats | +[**get_dre_stats**](RealTimeMonitoringDREApi.md#get_dre_stats) | **GET** /device/dre/dre-stats | +[**get_dre_status**](RealTimeMonitoringDREApi.md#get_dre_status) | **GET** /device/dre/dre-status | + + +# **get_dre_auto_bypass_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dre_auto_bypass_stats(device_id) + + + +Get DRE auto-bypass statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dre_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dre_api.RealTimeMonitoringDREApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + appqoe_dre_auto_bypass_server_ip = "00r252U250?250" # str | Server IP (optional) + appqoe_dre_auto_bypass_port = 3.14 # float | Port (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dre_auto_bypass_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDREApi->get_dre_auto_bypass_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_dre_auto_bypass_stats(device_id, appqoe_dre_auto_bypass_server_ip=appqoe_dre_auto_bypass_server_ip, appqoe_dre_auto_bypass_port=appqoe_dre_auto_bypass_port) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDREApi->get_dre_auto_bypass_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **appqoe_dre_auto_bypass_server_ip** | **str**| Server IP | [optional] + **appqoe_dre_auto_bypass_port** | **float**| Port | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dre_peer_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dre_peer_stats(device_id) + + + +Get DRE peer statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dre_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dre_api.RealTimeMonitoringDREApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + appqoe_dre_stats_peer_system_ip = "00r252U250?250" # str | System IP (optional) + appqoe_dre_stats_peer_peer_no = 3.14 # float | Peer Number (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dre_peer_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDREApi->get_dre_peer_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_dre_peer_stats(device_id, appqoe_dre_stats_peer_system_ip=appqoe_dre_stats_peer_system_ip, appqoe_dre_stats_peer_peer_no=appqoe_dre_stats_peer_peer_no) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDREApi->get_dre_peer_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **appqoe_dre_stats_peer_system_ip** | **str**| System IP | [optional] + **appqoe_dre_stats_peer_peer_no** | **float**| Peer Number | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dre_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dre_stats(device_id) + + + +Get DRE statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dre_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dre_api.RealTimeMonitoringDREApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dre_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDREApi->get_dre_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dre_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dre_status(device_id) + + + +Get DRE status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dre_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dre_api.RealTimeMonitoringDREApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dre_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDREApi->get_dre_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDeviceApi.md b/docs/RealTimeMonitoringDeviceApi.md new file mode 100644 index 0000000..d75a141 --- /dev/null +++ b/docs/RealTimeMonitoringDeviceApi.md @@ -0,0 +1,80 @@ +# openapi_client.RealTimeMonitoringDeviceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_ipv6_data**](RealTimeMonitoringDeviceApi.md#get_ipv6_data) | **GET** /device/ipv6/nd6 | + + +# **get_ipv6_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ipv6_data(device_id) + + + +Get ipv6 data from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_api.RealTimeMonitoringDeviceApi(api_client) + device_id = DeviceIP( + device_ip="device_ip_example", + ) # DeviceIP | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ipv6_data(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceApi->get_ipv6_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **DeviceIP**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDeviceControlApi.md b/docs/RealTimeMonitoringDeviceControlApi.md new file mode 100644 index 0000000..6ab820f --- /dev/null +++ b/docs/RealTimeMonitoringDeviceControlApi.md @@ -0,0 +1,1503 @@ +# openapi_client.RealTimeMonitoringDeviceControlApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_connection_history_list_real_time**](RealTimeMonitoringDeviceControlApi.md#create_connection_history_list_real_time) | **GET** /device/control/connectionshistory | +[**create_connections_summary**](RealTimeMonitoringDeviceControlApi.md#create_connections_summary) | **GET** /device/control/summary | +[**create_link_list**](RealTimeMonitoringDeviceControlApi.md#create_link_list) | **GET** /device/control/links | +[**create_local_properties_list_list_real_t_ime**](RealTimeMonitoringDeviceControlApi.md#create_local_properties_list_list_real_t_ime) | **GET** /device/control/localproperties | +[**create_local_properties_synced_list**](RealTimeMonitoringDeviceControlApi.md#create_local_properties_synced_list) | **GET** /device/control/synced/localproperties | +[**create_real_time_connection_list**](RealTimeMonitoringDeviceControlApi.md#create_real_time_connection_list) | **GET** /device/control/connections | +[**create_real_time_connection_list1**](RealTimeMonitoringDeviceControlApi.md#create_real_time_connection_list1) | **GET** /device/control/connectionsinfo | +[**create_synced_connection_list**](RealTimeMonitoringDeviceControlApi.md#create_synced_connection_list) | **GET** /device/control/synced/connections | +[**create_valid_devices_list_real_time**](RealTimeMonitoringDeviceControlApi.md#create_valid_devices_list_real_time) | **GET** /device/control/validdevices | +[**create_valid_v_smarts_list_real_time**](RealTimeMonitoringDeviceControlApi.md#create_valid_v_smarts_list_real_time) | **GET** /device/control/validvsmarts | +[**create_wan_interface_list_list**](RealTimeMonitoringDeviceControlApi.md#create_wan_interface_list_list) | **GET** /device/control/waninterface | +[**create_wan_interface_synced_list**](RealTimeMonitoringDeviceControlApi.md#create_wan_interface_synced_list) | **GET** /device/control/synced/waninterface | +[**get_affinity_config**](RealTimeMonitoringDeviceControlApi.md#get_affinity_config) | **GET** /device/control/affinity/config | +[**get_affinity_status**](RealTimeMonitoringDeviceControlApi.md#get_affinity_status) | **GET** /device/control/affinity/status | +[**get_connection_statistics**](RealTimeMonitoringDeviceControlApi.md#get_connection_statistics) | **GET** /device/control/statistics | +[**get_device_control_status_summary**](RealTimeMonitoringDeviceControlApi.md#get_device_control_status_summary) | **GET** /device/control/summary/device | +[**get_local_device_status**](RealTimeMonitoringDeviceControlApi.md#get_local_device_status) | **GET** /device/control/status | +[**get_port_hop_color**](RealTimeMonitoringDeviceControlApi.md#get_port_hop_color) | **GET** /device/control/waninterface/color | +[**get_total_count_for_device_states**](RealTimeMonitoringDeviceControlApi.md#get_total_count_for_device_states) | **GET** /device/control/count | +[**get_valid_v_manage_id_real_time**](RealTimeMonitoringDeviceControlApi.md#get_valid_v_manage_id_real_time) | **GET** /device/control/validvmanageid | +[**network_summary**](RealTimeMonitoringDeviceControlApi.md#network_summary) | **GET** /device/control/networksummary | + + +# **create_connection_history_list_real_time** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_connection_history_list_real_time(device_id) + + + +Get connections history list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + peer_type = "vedge" # str | Peer type (optional) + system_ip = "system-ip_example" # str | Peer system IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_connection_history_list_real_time(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_connection_history_list_real_time: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_connection_history_list_real_time(device_id, peer_type=peer_type, system_ip=system_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_connection_history_list_real_time: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **peer_type** | **str**| Peer type | [optional] + **system_ip** | **str**| Peer system IP | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_connections_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_connections_summary(device_id) + + + +Get connections summary from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_connections_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_connections_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_link_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_link_list(state) + + + +Get connections list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + state = "up" # str | Device State + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_link_list(state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_link_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state** | **str**| Device State | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_local_properties_list_list_real_t_ime** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_local_properties_list_list_real_t_ime(device_id) + + + +Get local properties list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_local_properties_list_list_real_t_ime(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_local_properties_list_list_real_t_ime: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_local_properties_synced_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_local_properties_synced_list(device_id) + + + +Get local properties list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_local_properties_synced_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_local_properties_synced_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_real_time_connection_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_real_time_connection_list(device_id) + + + +Get connections list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + peer_type = "vedge" # str | Peer type (optional) + system_ip = "system-ip_example" # str | Peer system IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_real_time_connection_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_real_time_connection_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_real_time_connection_list(device_id, peer_type=peer_type, system_ip=system_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_real_time_connection_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **peer_type** | **str**| Peer type | [optional] + **system_ip** | **str**| Peer system IP | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_real_time_connection_list1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_real_time_connection_list1(device_id) + + + +Get connections list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + peer_type = "vedge" # str | Peer type (optional) + system_ip = "system-ip_example" # str | Peer system IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_real_time_connection_list1(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_real_time_connection_list1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_real_time_connection_list1(device_id, peer_type=peer_type, system_ip=system_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_real_time_connection_list1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **peer_type** | **str**| Peer type | [optional] + **system_ip** | **str**| Peer system IP | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_connection_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_synced_connection_list(device_id) + + + +Get connections list from vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + peer_type = "vedge" # str | Peer type (optional) + system_ip = "system-ip_example" # str | Peer system IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_connection_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_synced_connection_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_synced_connection_list(device_id, peer_type=peer_type, system_ip=system_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_synced_connection_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **peer_type** | **str**| Peer type | [optional] + **system_ip** | **str**| Peer system IP | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_valid_devices_list_real_time** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_valid_devices_list_real_time(device_id) + + + +Get vmanage valid device list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_valid_devices_list_real_time(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_valid_devices_list_real_time: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_valid_v_smarts_list_real_time** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_valid_v_smarts_list_real_time(device_id) + + + +Get valid vSmart list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_valid_v_smarts_list_real_time(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_valid_v_smarts_list_real_time: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_interface_list_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_wan_interface_list_list(device_id) + + + +Get WAN interface list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_interface_list_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_wan_interface_list_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_wan_interface_synced_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_wan_interface_synced_list(device_id) + + + +Get WAN interface list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_wan_interface_synced_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->create_wan_interface_synced_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_affinity_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_affinity_config(device_id) + + + +Get affinity config from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_affinity_config(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_affinity_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_affinity_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_affinity_status(device_id) + + + +Get affinity status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_affinity_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_affinity_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_connection_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_connection_statistics(device_id) + + + +Get connection statistics from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_connection_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_connection_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_control_status_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_control_status_summary(device_id) + + + +Get device control status summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_control_status_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_device_control_status_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_local_device_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_local_device_status() + + + +Get local device status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_local_device_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_local_device_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_port_hop_color** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_port_hop_color(device_id) + + + +Get port hop colors + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_port_hop_color(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_port_hop_color: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_total_count_for_device_states** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_total_count_for_device_states() + + + +Get number of vedges and vsmart device in different control states + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + is_cached = False # bool | Device State cached (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_total_count_for_device_states(is_cached=is_cached) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_total_count_for_device_states: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **is_cached** | **bool**| Device State cached | [optional] if omitted the server will use the default value of False + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_valid_v_manage_id_real_time** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_valid_v_manage_id_real_time(device_id) + + + +Get valid vManage from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_valid_v_manage_id_real_time(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->get_valid_v_manage_id_real_time: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **network_summary** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] network_summary() + + + +Get list of unreachable devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_control_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_control_api.RealTimeMonitoringDeviceControlApi(api_client) + state = "up" # str | Device State (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.network_summary(state=state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceControlApi->network_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state** | **str**| Device State | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDeviceFeatureListApi.md b/docs/RealTimeMonitoringDeviceFeatureListApi.md new file mode 100644 index 0000000..2161c23 --- /dev/null +++ b/docs/RealTimeMonitoringDeviceFeatureListApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringDeviceFeatureListApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_feature_list**](RealTimeMonitoringDeviceFeatureListApi.md#get_feature_list) | **GET** /device/featurelist | +[**get_synced_feature_list**](RealTimeMonitoringDeviceFeatureListApi.md#get_synced_feature_list) | **GET** /device/featurelist/synced | + + +# **get_feature_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_feature_list(device_id) + + + +Get feature lists from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_feature_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_feature_list_api.RealTimeMonitoringDeviceFeatureListApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_feature_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceFeatureListApi->get_feature_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_synced_feature_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_synced_feature_list(device_id) + + + +Get feature lists synchronously from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_feature_list_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_feature_list_api.RealTimeMonitoringDeviceFeatureListApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_synced_feature_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceFeatureListApi->get_synced_feature_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDeviceSystemStatsApi.md b/docs/RealTimeMonitoringDeviceSystemStatsApi.md new file mode 100644 index 0000000..acc0e02 --- /dev/null +++ b/docs/RealTimeMonitoringDeviceSystemStatsApi.md @@ -0,0 +1,1003 @@ +# openapi_client.RealTimeMonitoringDeviceSystemStatsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_device_system_cpu_stat**](RealTimeMonitoringDeviceSystemStatsApi.md#create_device_system_cpu_stat) | **GET** /statistics/system/cpu | +[**create_device_system_memory_stat**](RealTimeMonitoringDeviceSystemStatsApi.md#create_device_system_memory_stat) | **GET** /statistics/system/memory | +[**get_aggregation_data_by_query16**](RealTimeMonitoringDeviceSystemStatsApi.md#get_aggregation_data_by_query16) | **GET** /statistics/system/aggregation | +[**get_count18**](RealTimeMonitoringDeviceSystemStatsApi.md#get_count18) | **GET** /statistics/system/doccount | +[**get_count_post18**](RealTimeMonitoringDeviceSystemStatsApi.md#get_count_post18) | **POST** /statistics/system/doccount | +[**get_post_aggregation_app_data_by_query15**](RealTimeMonitoringDeviceSystemStatsApi.md#get_post_aggregation_app_data_by_query15) | **POST** /statistics/system/app-agg/aggregation | +[**get_post_aggregation_data_by_query15**](RealTimeMonitoringDeviceSystemStatsApi.md#get_post_aggregation_data_by_query15) | **POST** /statistics/system/aggregation | +[**get_post_stat_bulk_raw_data16**](RealTimeMonitoringDeviceSystemStatsApi.md#get_post_stat_bulk_raw_data16) | **POST** /statistics/system/page | +[**get_stat_bulk_raw_data16**](RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_bulk_raw_data16) | **GET** /statistics/system/page | +[**get_stat_data_fields18**](RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_data_fields18) | **GET** /statistics/system/fields | +[**get_stat_data_raw_data15**](RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_data_raw_data15) | **GET** /statistics/system | +[**get_stat_data_raw_data_as_csv16**](RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_data_raw_data_as_csv16) | **GET** /statistics/system/csv | +[**get_stat_query_fields18**](RealTimeMonitoringDeviceSystemStatsApi.md#get_stat_query_fields18) | **GET** /statistics/system/query/fields | +[**get_stats_raw_data16**](RealTimeMonitoringDeviceSystemStatsApi.md#get_stats_raw_data16) | **POST** /statistics/system | + + +# **create_device_system_cpu_stat** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_cpu_stat(query, device_id) + + + +Get device system CPU stats list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "query_example" # str | Query filter + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_cpu_stat(query, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->create_device_system_cpu_stat: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_memory_stat** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_memory_stat(query, device_id) + + + +Get device system memory stats list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "query_example" # str | Query filter + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_memory_stat(query, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->create_device_system_memory_stat: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query16() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query16(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_aggregation_data_by_query16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count18(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count18(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_count18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post18() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post18(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_count_post18: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query15() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_post_aggregation_app_data_by_query15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query15() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query15(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_post_aggregation_data_by_query15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data16() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data16(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_post_stat_bulk_raw_data16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data16() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data16(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_stat_bulk_raw_data16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields18() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields18() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_stat_data_fields18: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data15** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data15() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data15(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_stat_data_raw_data15: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv16** +> str get_stat_data_raw_data_as_csv16() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv16(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_stat_data_raw_data_as_csv16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields18** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields18() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields18() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_stat_query_fields18: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data16** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data16() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_device_system_stats_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_device_system_stats_api.RealTimeMonitoringDeviceSystemStatsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data16(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDeviceSystemStatsApi->get_stats_raw_data16: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringDualStaticRouteTrackerServiceApi.md b/docs/RealTimeMonitoringDualStaticRouteTrackerServiceApi.md new file mode 100644 index 0000000..82557f1 --- /dev/null +++ b/docs/RealTimeMonitoringDualStaticRouteTrackerServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringDualStaticRouteTrackerServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_dual_static_route_tracker_info**](RealTimeMonitoringDualStaticRouteTrackerServiceApi.md#get_dual_static_route_tracker_info) | **GET** /device/dualStaticRouteTracker | + + +# **get_dual_static_route_tracker_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dual_static_route_tracker_info(device_id) + + + +Get dual static route tracker info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_dual_static_route_tracker_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_dual_static_route_tracker_service_api.RealTimeMonitoringDualStaticRouteTrackerServiceApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dual_static_route_tracker_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringDualStaticRouteTrackerServiceApi->get_dual_static_route_tracker_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringEIGRPApi.md b/docs/RealTimeMonitoringEIGRPApi.md new file mode 100644 index 0000000..8a32971 --- /dev/null +++ b/docs/RealTimeMonitoringEIGRPApi.md @@ -0,0 +1,215 @@ +# openapi_client.RealTimeMonitoringEIGRPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_eigrp_interface**](RealTimeMonitoringEIGRPApi.md#create_eigrp_interface) | **GET** /device/eigrp/interface | +[**create_eigrp_route**](RealTimeMonitoringEIGRPApi.md#create_eigrp_route) | **GET** /device/eigrp/route | +[**create_eigrp_topology**](RealTimeMonitoringEIGRPApi.md#create_eigrp_topology) | **GET** /device/eigrp/topology | + + +# **create_eigrp_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_eigrp_interface(device_id) + + + +Get EIGRP interface list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_eigrp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_eigrp_api.RealTimeMonitoringEIGRPApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_eigrp_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringEIGRPApi->create_eigrp_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_eigrp_route** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_eigrp_route(device_id) + + + +Get EIGRP route from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_eigrp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_eigrp_api.RealTimeMonitoringEIGRPApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_eigrp_route(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringEIGRPApi->create_eigrp_route: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_eigrp_topology** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_eigrp_topology(device_id) + + + +Get EIGRP topology info from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_eigrp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_eigrp_api.RealTimeMonitoringEIGRPApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_eigrp_topology(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringEIGRPApi->create_eigrp_topology: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringEndpointTrackerGroupServiceApi.md b/docs/RealTimeMonitoringEndpointTrackerGroupServiceApi.md new file mode 100644 index 0000000..97d254b --- /dev/null +++ b/docs/RealTimeMonitoringEndpointTrackerGroupServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringEndpointTrackerGroupServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_endpoint_tracker_group_info**](RealTimeMonitoringEndpointTrackerGroupServiceApi.md#get_endpoint_tracker_group_info) | **GET** /device/endpointTrackerGroup | + + +# **get_endpoint_tracker_group_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_endpoint_tracker_group_info(device_id) + + + +Get endpoint tracker group info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_endpoint_tracker_group_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_endpoint_tracker_group_service_api.RealTimeMonitoringEndpointTrackerGroupServiceApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_endpoint_tracker_group_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringEndpointTrackerGroupServiceApi->get_endpoint_tracker_group_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringEndpointTrackerServiceApi.md b/docs/RealTimeMonitoringEndpointTrackerServiceApi.md new file mode 100644 index 0000000..e888bca --- /dev/null +++ b/docs/RealTimeMonitoringEndpointTrackerServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringEndpointTrackerServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_endpoint_tracker_info**](RealTimeMonitoringEndpointTrackerServiceApi.md#get_endpoint_tracker_info) | **GET** /device/endpointTracker | + + +# **get_endpoint_tracker_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_endpoint_tracker_info(device_id) + + + +Get endpoint tracker info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_endpoint_tracker_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_endpoint_tracker_service_api.RealTimeMonitoringEndpointTrackerServiceApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_endpoint_tracker_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringEndpointTrackerServiceApi->get_endpoint_tracker_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringGeoFencingApi.md b/docs/RealTimeMonitoringGeoFencingApi.md new file mode 100644 index 0000000..c188b3f --- /dev/null +++ b/docs/RealTimeMonitoringGeoFencingApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringGeoFencingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_geofence_status**](RealTimeMonitoringGeoFencingApi.md#get_geofence_status) | **GET** /device/geofence/status | + + +# **get_geofence_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_geofence_status(device_id) + + + +Get Geo-fencing Status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_geo_fencing_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_geo_fencing_api.RealTimeMonitoringGeoFencingApi(api_client) + device_id = "169.254.10.10" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_geofence_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringGeoFencingApi->get_geofence_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringHardwareApi.md b/docs/RealTimeMonitoringHardwareApi.md new file mode 100644 index 0000000..6e54344 --- /dev/null +++ b/docs/RealTimeMonitoringHardwareApi.md @@ -0,0 +1,694 @@ +# openapi_client.RealTimeMonitoringHardwareApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_alarm_list**](RealTimeMonitoringHardwareApi.md#create_alarm_list) | **GET** /device/hardware/alarms | +[**create_environment_list**](RealTimeMonitoringHardwareApi.md#create_environment_list) | **GET** /device/hardware/environment | +[**create_error_alarm_list**](RealTimeMonitoringHardwareApi.md#create_error_alarm_list) | **GET** /device/hardware/errors | +[**create_inventory_list**](RealTimeMonitoringHardwareApi.md#create_inventory_list) | **GET** /device/hardware/inventory | +[**create_status_summary**](RealTimeMonitoringHardwareApi.md#create_status_summary) | **GET** /device/hardware/status/summary | +[**create_synced_alarm_list**](RealTimeMonitoringHardwareApi.md#create_synced_alarm_list) | **GET** /device/hardware/synced/alarms | +[**create_synced_environment_list**](RealTimeMonitoringHardwareApi.md#create_synced_environment_list) | **GET** /device/hardware/synced/environment | +[**create_synced_inventory_list**](RealTimeMonitoringHardwareApi.md#create_synced_inventory_list) | **GET** /device/hardware/synced/inventory | +[**create_system_list**](RealTimeMonitoringHardwareApi.md#create_system_list) | **GET** /device/hardware/system | +[**create_temp_threshold_list**](RealTimeMonitoringHardwareApi.md#create_temp_threshold_list) | **GET** /device/hardware/threshold | + + +# **create_alarm_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_alarm_list(device_id) + + + +Get hardware alarm list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_alarm_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_alarm_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_environment_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_environment_list(device_id) + + + +Get hardware environment list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_environment_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_environment_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_error_alarm_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_error_alarm_list() + + + +Get hardware error list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.create_error_alarm_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_error_alarm_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_inventory_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_inventory_list(device_id) + + + +Get hardware inventory list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_inventory_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_inventory_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_status_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_status_summary(device_id) + + + +Get hardware status summary from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_status_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_status_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_alarm_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_synced_alarm_list(device_id) + + + +Get hardware alarm list synchronously from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_alarm_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_synced_alarm_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_environment_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_synced_environment_list(device_id) + + + +Get hardware environment list synchronously from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_environment_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_synced_environment_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_inventory_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_synced_inventory_list(device_id) + + + +Get hardware inventory list synchronously from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_inventory_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_synced_inventory_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_system_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_system_list(device_id) + + + +Get hardware system data list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_system_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_system_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_temp_threshold_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_temp_threshold_list(device_id) + + + +Get hardware temperature list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_hardware_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_hardware_api.RealTimeMonitoringHardwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_temp_threshold_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringHardwareApi->create_temp_threshold_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringIGMPApi.md b/docs/RealTimeMonitoringIGMPApi.md new file mode 100644 index 0000000..88ae34e --- /dev/null +++ b/docs/RealTimeMonitoringIGMPApi.md @@ -0,0 +1,284 @@ +# openapi_client.RealTimeMonitoringIGMPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_igmp_groups_list**](RealTimeMonitoringIGMPApi.md#create_igmp_groups_list) | **GET** /device/igmp/groups | +[**create_igmp_interface_list**](RealTimeMonitoringIGMPApi.md#create_igmp_interface_list) | **GET** /device/igmp/interface | +[**create_igmp_statistics_list**](RealTimeMonitoringIGMPApi.md#create_igmp_statistics_list) | **GET** /device/igmp/statistics | +[**create_igmp_summary**](RealTimeMonitoringIGMPApi.md#create_igmp_summary) | **GET** /device/igmp/summary | + + +# **create_igmp_groups_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_igmp_groups_list(device_id) + + + +Get IGMP neighbor list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_igmp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_igmp_api.RealTimeMonitoringIGMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_igmp_groups_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIGMPApi->create_igmp_groups_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_igmp_interface_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_igmp_interface_list(device_id) + + + +Get IGMP interface list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_igmp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_igmp_api.RealTimeMonitoringIGMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_igmp_interface_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIGMPApi->create_igmp_interface_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_igmp_statistics_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_igmp_statistics_list(device_id) + + + +Get IGMP statistics list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_igmp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_igmp_api.RealTimeMonitoringIGMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_igmp_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIGMPApi->create_igmp_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_igmp_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_igmp_summary(device_id) + + + +Get IGMP summary from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_igmp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_igmp_api.RealTimeMonitoringIGMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_igmp_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIGMPApi->create_igmp_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringIPApi.md b/docs/RealTimeMonitoringIPApi.md new file mode 100644 index 0000000..d507637 --- /dev/null +++ b/docs/RealTimeMonitoringIPApi.md @@ -0,0 +1,835 @@ +# openapi_client.RealTimeMonitoringIPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_fib_list**](RealTimeMonitoringIPApi.md#create_fib_list) | **GET** /device/ip/fib | +[**create_ietf_routing_list**](RealTimeMonitoringIPApi.md#create_ietf_routing_list) | **GET** /device/ip/ipRoutes | +[**create_ip_mfib_oil_list**](RealTimeMonitoringIPApi.md#create_ip_mfib_oil_list) | **GET** /device/ip/mfiboil | +[**create_ip_mfib_stats_list**](RealTimeMonitoringIPApi.md#create_ip_mfib_stats_list) | **GET** /device/ip/mfibstats | +[**create_ip_mfib_summary_list**](RealTimeMonitoringIPApi.md#create_ip_mfib_summary_list) | **GET** /device/ip/mfibsummary | +[**create_nat64_translation_list**](RealTimeMonitoringIPApi.md#create_nat64_translation_list) | **GET** /device/ip/nat64/translation | +[**create_nat_filter_list**](RealTimeMonitoringIPApi.md#create_nat_filter_list) | **GET** /device/ip/nat/filter | +[**create_nat_interface_list**](RealTimeMonitoringIPApi.md#create_nat_interface_list) | **GET** /device/ip/nat/interface | +[**create_nat_interface_statistics_list**](RealTimeMonitoringIPApi.md#create_nat_interface_statistics_list) | **GET** /device/ip/nat/interfacestatistics | +[**create_nat_translation_list**](RealTimeMonitoringIPApi.md#create_nat_translation_list) | **GET** /device/ip/nat/translation | +[**create_route_table_list**](RealTimeMonitoringIPApi.md#create_route_table_list) | **GET** /device/ip/routetable | + + +# **create_fib_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_fib_list(device_id) + + + +Get FIB list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + address_family = "IPv4" # str | Address family (optional) + prefix = "prefix_example" # str | IP prefix (optional) + tloc = "tloc_example" # str | tloc IP (optional) + color = "default" # str | tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_fib_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_fib_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_fib_list(device_id, vpn_id=vpn_id, address_family=address_family, prefix=prefix, tloc=tloc, color=color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_fib_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **address_family** | **str**| Address family | [optional] + **prefix** | **str**| IP prefix | [optional] + **tloc** | **str**| tloc IP | [optional] + **color** | **str**| tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ietf_routing_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ietf_routing_list(device_id) + + + +Get ietf routing list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + routing_instance_name = "routing-instance-name_example" # str | VPN Id (optional) + address_family = "address-family_example" # str | Address family (optional) + outgoing_interface = "outgoing-interface_example" # str | Outgoing Interface (optional) + source_protocol = "source-protocol_example" # str | Source Protocol (optional) + next_hop_address = "next-hop-address_example" # str | Next Hop Address (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ietf_routing_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_ietf_routing_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ietf_routing_list(device_id, routing_instance_name=routing_instance_name, address_family=address_family, outgoing_interface=outgoing_interface, source_protocol=source_protocol, next_hop_address=next_hop_address) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_ietf_routing_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **routing_instance_name** | **str**| VPN Id | [optional] + **address_family** | **str**| Address family | [optional] + **outgoing_interface** | **str**| Outgoing Interface | [optional] + **source_protocol** | **str**| Source Protocol | [optional] + **next_hop_address** | **str**| Next Hop Address | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ip_mfib_oil_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ip_mfib_oil_list(device_id) + + + +Get IP MFIB OIL list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ip_mfib_oil_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_ip_mfib_oil_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ip_mfib_stats_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ip_mfib_stats_list(device_id) + + + +Get IP MFIB statistics list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ip_mfib_stats_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_ip_mfib_stats_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ip_mfib_summary_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ip_mfib_summary_list(device_id) + + + +Get IP MFIB summary list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ip_mfib_summary_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_ip_mfib_summary_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_nat64_translation_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_nat64_translation_list(device_id) + + + +Get NAT64 interface list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_nat64_translation_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_nat64_translation_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_nat_filter_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_nat_filter_list(device_id) + + + +Get NAT filter list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + nat_vpn_id = "nat-vpn-id_example" # str | NAT VPN Id (optional) + nat_ifname = "nat-ifname_example" # str | NAT interface name (optional) + private_source_address = "private-source-address_example" # str | Private source address (optional) + proto = "icm" # str | Protocol (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_nat_filter_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_nat_filter_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_nat_filter_list(device_id, nat_vpn_id=nat_vpn_id, nat_ifname=nat_ifname, private_source_address=private_source_address, proto=proto) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_nat_filter_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **nat_vpn_id** | **str**| NAT VPN Id | [optional] + **nat_ifname** | **str**| NAT interface name | [optional] + **private_source_address** | **str**| Private source address | [optional] + **proto** | **str**| Protocol | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_nat_interface_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_nat_interface_list(device_id) + + + +Get NAT interface list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_nat_interface_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_nat_interface_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_nat_interface_statistics_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_nat_interface_statistics_list(device_id) + + + +Get NAT interface statistics list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_nat_interface_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_nat_interface_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_nat_translation_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_nat_translation_list(device_id) + + + +Get NAT translation list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_nat_translation_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_nat_translation_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_route_table_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_route_table_list(device_id) + + + +Get route table list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ip_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ip_api.RealTimeMonitoringIPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + address_family = "IPv4" # str | Address family (optional) + prefix = "prefix_example" # str | IP prefix (optional) + protocol = "protocol_example" # str | IP protocol (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_route_table_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_route_table_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_route_table_list(device_id, vpn_id=vpn_id, address_family=address_family, prefix=prefix, protocol=protocol) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPApi->create_route_table_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **address_family** | **str**| Address family | [optional] + **prefix** | **str**| IP prefix | [optional] + **protocol** | **str**| IP protocol | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringIPsecApi.md b/docs/RealTimeMonitoringIPsecApi.md new file mode 100644 index 0000000..5cf364e --- /dev/null +++ b/docs/RealTimeMonitoringIPsecApi.md @@ -0,0 +1,942 @@ +# openapi_client.RealTimeMonitoringIPsecApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_crypto_ipsec_identity**](RealTimeMonitoringIPsecApi.md#create_crypto_ipsec_identity) | **GET** /device/ipsec/identity | +[**create_cryptov1_local_sa_list**](RealTimeMonitoringIPsecApi.md#create_cryptov1_local_sa_list) | **GET** /device/ipsec/ikev1 | +[**create_cryptov2_local_sa_list**](RealTimeMonitoringIPsecApi.md#create_cryptov2_local_sa_list) | **GET** /device/ipsec/ikev2 | +[**create_i_psec_pwk_inbound_connections**](RealTimeMonitoringIPsecApi.md#create_i_psec_pwk_inbound_connections) | **GET** /device/ipsec/pwk/inbound | +[**create_i_psec_pwk_local_sa**](RealTimeMonitoringIPsecApi.md#create_i_psec_pwk_local_sa) | **GET** /device/ipsec/pwk/localsa | +[**create_i_psec_pwk_outbound_connections**](RealTimeMonitoringIPsecApi.md#create_i_psec_pwk_outbound_connections) | **GET** /device/ipsec/pwk/outbound | +[**create_ike_inbound_list**](RealTimeMonitoringIPsecApi.md#create_ike_inbound_list) | **GET** /device/ipsec/ike/inbound | +[**create_ike_outbound_list**](RealTimeMonitoringIPsecApi.md#create_ike_outbound_list) | **GET** /device/ipsec/ike/outbound | +[**create_ike_sessions**](RealTimeMonitoringIPsecApi.md#create_ike_sessions) | **GET** /device/ipsec/ike/sessions | +[**create_in_bound_list**](RealTimeMonitoringIPsecApi.md#create_in_bound_list) | **GET** /device/ipsec/inbound | +[**create_local_sa_list**](RealTimeMonitoringIPsecApi.md#create_local_sa_list) | **GET** /device/ipsec/localsa | +[**create_out_bound_list**](RealTimeMonitoringIPsecApi.md#create_out_bound_list) | **GET** /device/ipsec/outbound | + + +# **create_crypto_ipsec_identity** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_crypto_ipsec_identity(device_id) + + + +Get Crypto IPSEC identity entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + local_tloc_color = "default" # str | Local tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_crypto_ipsec_identity(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_crypto_ipsec_identity: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_crypto_ipsec_identity(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color, local_tloc_color=local_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_crypto_ipsec_identity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + **local_tloc_color** | **str**| Local tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cryptov1_local_sa_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cryptov1_local_sa_list(device_id) + + + +Get Crypto IKEv1 SA entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cryptov1_local_sa_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_cryptov1_local_sa_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_cryptov1_local_sa_list(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_cryptov1_local_sa_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_cryptov2_local_sa_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_cryptov2_local_sa_list(device_id) + + + +Get Crypto IKEv2 SA entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_cryptov2_local_sa_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_cryptov2_local_sa_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_i_psec_pwk_inbound_connections** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_i_psec_pwk_inbound_connections(device_id) + + + +Get IPSEC pairwise key inbound entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + local_tloc_color = "default" # str | Local tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_i_psec_pwk_inbound_connections(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_i_psec_pwk_inbound_connections: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_i_psec_pwk_inbound_connections(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color, local_tloc_color=local_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_i_psec_pwk_inbound_connections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + **local_tloc_color** | **str**| Local tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_i_psec_pwk_local_sa** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_i_psec_pwk_local_sa(device_id) + + + +Get IPSEC pairwise key local SA entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + local_tloc_color = "default" # str | Local tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_i_psec_pwk_local_sa(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_i_psec_pwk_local_sa: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_i_psec_pwk_local_sa(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color, local_tloc_color=local_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_i_psec_pwk_local_sa: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + **local_tloc_color** | **str**| Local tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_i_psec_pwk_outbound_connections** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_i_psec_pwk_outbound_connections(device_id) + + + +Get IPSEC pairwise key outbound entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + local_tloc_color = "default" # str | Local tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_i_psec_pwk_outbound_connections(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_i_psec_pwk_outbound_connections: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_i_psec_pwk_outbound_connections(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color, local_tloc_color=local_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_i_psec_pwk_outbound_connections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + **local_tloc_color** | **str**| Local tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ike_inbound_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ike_inbound_list(device_id) + + + +Get IPsec IKE inbound connection list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ike_inbound_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_ike_inbound_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ike_outbound_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ike_outbound_list(device_id) + + + +Get IPsec IKE outbound connection list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ike_outbound_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_ike_outbound_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ike_sessions** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ike_sessions(device_id) + + + +Get IPsec IKE sessions from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ike_sessions(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_ike_sessions: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ike_sessions(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_ike_sessions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_in_bound_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_in_bound_list(device_id) + + + +Get IPsec inbound connection list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + local_tloc_color = "default" # str | Local tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_in_bound_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_in_bound_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_in_bound_list(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color, local_tloc_color=local_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_in_bound_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + **local_tloc_color** | **str**| Local tloc color | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_local_sa_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_local_sa_list(device_id) + + + +Get IPsec local SA list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_local_sa_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_local_sa_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_out_bound_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_out_bound_list(device_id) + + + +Get IPsec outbound connection list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_i_psec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_i_psec_api.RealTimeMonitoringIPsecApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_out_bound_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_out_bound_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_out_bound_list(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPsecApi->create_out_bound_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringIPv4FIBApi.md b/docs/RealTimeMonitoringIPv4FIBApi.md new file mode 100644 index 0000000..c9e0331 --- /dev/null +++ b/docs/RealTimeMonitoringIPv4FIBApi.md @@ -0,0 +1,93 @@ +# openapi_client.RealTimeMonitoringIPv4FIBApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_ipv4_fib_list**](RealTimeMonitoringIPv4FIBApi.md#create_ipv4_fib_list) | **GET** /device/ip/v4fib | + + +# **create_ipv4_fib_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ipv4_fib_list(device_id) + + + +Get IPv4 FIB list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ipv4_fib_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ipv4_fib_api.RealTimeMonitoringIPv4FIBApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + prefix = "prefix_example" # str | IP prefix (optional) + tloc = "tloc_example" # str | tloc IP (optional) + color = "default" # str | tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ipv4_fib_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPv4FIBApi->create_ipv4_fib_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ipv4_fib_list(device_id, vpn_id=vpn_id, prefix=prefix, tloc=tloc, color=color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPv4FIBApi->create_ipv4_fib_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **prefix** | **str**| IP prefix | [optional] + **tloc** | **str**| tloc IP | [optional] + **color** | **str**| tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringIPv6FIBApi.md b/docs/RealTimeMonitoringIPv6FIBApi.md new file mode 100644 index 0000000..b6a26a0 --- /dev/null +++ b/docs/RealTimeMonitoringIPv6FIBApi.md @@ -0,0 +1,93 @@ +# openapi_client.RealTimeMonitoringIPv6FIBApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_ipv6_fib_list**](RealTimeMonitoringIPv6FIBApi.md#create_ipv6_fib_list) | **GET** /device/ip/v6fib | + + +# **create_ipv6_fib_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ipv6_fib_list(device_id) + + + +Get IPv6 FIB list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ipv6_fib_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ipv6_fib_api.RealTimeMonitoringIPv6FIBApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + prefix = "prefix_example" # str | IP prefix (optional) + tloc = "tloc_example" # str | tloc IP (optional) + color = "default" # str | tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ipv6_fib_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPv6FIBApi->create_ipv6_fib_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ipv6_fib_list(device_id, vpn_id=vpn_id, prefix=prefix, tloc=tloc, color=color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPv6FIBApi->create_ipv6_fib_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **prefix** | **str**| IP prefix | [optional] + **tloc** | **str**| tloc IP | [optional] + **color** | **str**| tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringIPv6NeighboursApi.md b/docs/RealTimeMonitoringIPv6NeighboursApi.md new file mode 100644 index 0000000..196c08f --- /dev/null +++ b/docs/RealTimeMonitoringIPv6NeighboursApi.md @@ -0,0 +1,91 @@ +# openapi_client.RealTimeMonitoringIPv6NeighboursApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_ipv6_interface**](RealTimeMonitoringIPv6NeighboursApi.md#get_ipv6_interface) | **GET** /device/ndv6 | + + +# **get_ipv6_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ipv6_interface(device_id) + + + +Get IPv6 Neighbors from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ipv6_neighbours_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ipv6_neighbours_api.RealTimeMonitoringIPv6NeighboursApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "0" # str | VPN Id (optional) + if_name = "ge0/0" # str | Interface name (optional) + mac = "mac_example" # str | Mac address (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ipv6_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPv6NeighboursApi->get_ipv6_interface: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_ipv6_interface(device_id, vpn_id=vpn_id, if_name=if_name, mac=mac) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringIPv6NeighboursApi->get_ipv6_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **if_name** | **str**| Interface name | [optional] + **mac** | **str**| Mac address | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringInterfaceApi.md b/docs/RealTimeMonitoringInterfaceApi.md new file mode 100644 index 0000000..63a2b79 --- /dev/null +++ b/docs/RealTimeMonitoringInterfaceApi.md @@ -0,0 +1,1059 @@ +# openapi_client.RealTimeMonitoringInterfaceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**generate_device_interface_vpn**](RealTimeMonitoringInterfaceApi.md#generate_device_interface_vpn) | **GET** /device/interface/vpn | +[**get_device_interface**](RealTimeMonitoringInterfaceApi.md#get_device_interface) | **GET** /device/interface | +[**get_device_interface_arp_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_arp_stats) | **GET** /device/interface/arp_stats | +[**get_device_interface_error_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_error_stats) | **GET** /device/interface/error_stats | +[**get_device_interface_ipv6_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_ipv6_stats) | **GET** /device/interface/ipv6Stats | +[**get_device_interface_pkt_sizes**](RealTimeMonitoringInterfaceApi.md#get_device_interface_pkt_sizes) | **GET** /device/interface/pkt_size | +[**get_device_interface_port_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_port_stats) | **GET** /device/interface/port_stats | +[**get_device_interface_qos_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_qos_stats) | **GET** /device/interface/qosStats | +[**get_device_interface_queue_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_queue_stats) | **GET** /device/interface/queue_stats | +[**get_device_interface_stats**](RealTimeMonitoringInterfaceApi.md#get_device_interface_stats) | **GET** /device/interface/stats | +[**get_device_serial_interface**](RealTimeMonitoringInterfaceApi.md#get_device_serial_interface) | **GET** /device/interface/serial | +[**get_synced_device_interface**](RealTimeMonitoringInterfaceApi.md#get_synced_device_interface) | **GET** /device/interface/synced | +[**trustsec**](RealTimeMonitoringInterfaceApi.md#trustsec) | **GET** /device/interface/trustsec | + + +# **generate_device_interface_vpn** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} generate_device_interface_vpn(device_id) + + + +Get device interfaces per VPN + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_device_interface_vpn(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->generate_device_interface_vpn: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface(af_type, device_id) + + + +Get device interfaces + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_arp_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_arp_stats(af_type, device_id) + + + +Get interface ARP statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_arp_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_arp_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_arp_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_arp_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_error_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_error_stats(af_type, device_id) + + + +Get interface error stats + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_error_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_error_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_error_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_error_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_ipv6_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_ipv6_stats(af_type, device_id) + + + +Get interface IPv6 stats + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_ipv6_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_ipv6_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_ipv6_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_ipv6_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_pkt_sizes** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_pkt_sizes(af_type, device_id) + + + +Get interface packet size + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_pkt_sizes(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_pkt_sizes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_pkt_sizes(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_pkt_sizes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_port_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_port_stats(af_type, device_id) + + + +Get interface port stats + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_port_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_port_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_port_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_port_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_qos_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_qos_stats(af_type, device_id) + + + +Get interface QOS stats + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_qos_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_qos_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_qos_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_qos_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_queue_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_queue_stats(af_type, device_id) + + + +Get interface queue stats + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_queue_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_queue_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_queue_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_queue_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_interface_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_interface_stats(af_type, device_id) + + + +Get interface stats + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_interface_stats(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_interface_stats(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_interface_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_serial_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_serial_interface(af_type, device_id) + + + +Get serial interface + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_serial_interface(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_serial_interface: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_serial_interface(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_device_serial_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_synced_device_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_synced_device_interface(af_type, device_id) + + + +Get device interfaces synchronously + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + af_type = "ipv4" # str | AF Type + device_id = "169.254.10.10" # str | deviceId - Device IP + vpn_id = "vpn-id_example" # str | VPN Id (optional) + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_synced_device_interface(af_type, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_synced_device_interface: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_synced_device_interface(af_type, device_id, vpn_id=vpn_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->get_synced_device_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **af_type** | **str**| AF Type | + **device_id** | **str**| deviceId - Device IP | + **vpn_id** | **str**| VPN Id | [optional] + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trustsec** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} trustsec(device_id) + + + +Get policy filter memory usage from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_interface_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_interface_api.RealTimeMonitoringInterfaceApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.trustsec(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringInterfaceApi->trustsec: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringLicenseInfoApi.md b/docs/RealTimeMonitoringLicenseInfoApi.md new file mode 100644 index 0000000..39021db --- /dev/null +++ b/docs/RealTimeMonitoringLicenseInfoApi.md @@ -0,0 +1,422 @@ +# openapi_client.RealTimeMonitoringLicenseInfoApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_license_eval_info**](RealTimeMonitoringLicenseInfoApi.md#get_license_eval_info) | **GET** /device/license/evaluation | +[**get_license_pak_info**](RealTimeMonitoringLicenseInfoApi.md#get_license_pak_info) | **GET** /device/license/pak | +[**get_license_privacy_info**](RealTimeMonitoringLicenseInfoApi.md#get_license_privacy_info) | **GET** /device/license/privacy | +[**get_license_reg_info**](RealTimeMonitoringLicenseInfoApi.md#get_license_reg_info) | **GET** /device/license/registration | +[**get_license_udi_info**](RealTimeMonitoringLicenseInfoApi.md#get_license_udi_info) | **GET** /device/license/udi | +[**get_license_usage_info**](RealTimeMonitoringLicenseInfoApi.md#get_license_usage_info) | **GET** /device/license/usage | + + +# **get_license_eval_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_eval_info(device_id) + + + +Get license evaluation info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_license_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_license_info_api.RealTimeMonitoringLicenseInfoApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_license_eval_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringLicenseInfoApi->get_license_eval_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_pak_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_pak_info(device_id) + + + +Get license pak info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_license_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_license_info_api.RealTimeMonitoringLicenseInfoApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_license_pak_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringLicenseInfoApi->get_license_pak_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_privacy_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_privacy_info(device_id) + + + +Get license privacy info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_license_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_license_info_api.RealTimeMonitoringLicenseInfoApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_license_privacy_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringLicenseInfoApi->get_license_privacy_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_reg_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_reg_info(device_id) + + + +Get license registration info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_license_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_license_info_api.RealTimeMonitoringLicenseInfoApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_license_reg_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringLicenseInfoApi->get_license_reg_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_udi_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_udi_info(device_id) + + + +Get license UDI info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_license_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_license_info_api.RealTimeMonitoringLicenseInfoApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_license_udi_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringLicenseInfoApi->get_license_udi_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_license_usage_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_license_usage_info(device_id) + + + +Get license usage info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_license_info_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_license_info_api.RealTimeMonitoringLicenseInfoApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_license_usage_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringLicenseInfoApi->get_license_usage_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringMulticastApi.md b/docs/RealTimeMonitoringMulticastApi.md new file mode 100644 index 0000000..b0e099e --- /dev/null +++ b/docs/RealTimeMonitoringMulticastApi.md @@ -0,0 +1,284 @@ +# openapi_client.RealTimeMonitoringMulticastApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_pim_tunnel_list**](RealTimeMonitoringMulticastApi.md#create_pim_tunnel_list) | **GET** /device/multicast/tunnel | +[**create_replicator_list**](RealTimeMonitoringMulticastApi.md#create_replicator_list) | **GET** /device/multicast/replicator | +[**create_rpf_list**](RealTimeMonitoringMulticastApi.md#create_rpf_list) | **GET** /device/multicast/rpf | +[**create_topology_list**](RealTimeMonitoringMulticastApi.md#create_topology_list) | **GET** /device/multicast/topology | + + +# **create_pim_tunnel_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_pim_tunnel_list(device_id) + + + +Get PIM tunnel from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_multicast_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_multicast_api.RealTimeMonitoringMulticastApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pim_tunnel_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringMulticastApi->create_pim_tunnel_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_replicator_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_replicator_list(device_id) + + + +Get replicator list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_multicast_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_multicast_api.RealTimeMonitoringMulticastApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_replicator_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringMulticastApi->create_replicator_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_rpf_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_rpf_list(device_id) + + + +Get RPF list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_multicast_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_multicast_api.RealTimeMonitoringMulticastApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_rpf_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringMulticastApi->create_rpf_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_topology_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_topology_list(device_id) + + + +Get topology list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_multicast_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_multicast_api.RealTimeMonitoringMulticastApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_topology_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringMulticastApi->create_topology_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringNMSApi.md b/docs/RealTimeMonitoringNMSApi.md new file mode 100644 index 0000000..5caf114 --- /dev/null +++ b/docs/RealTimeMonitoringNMSApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringNMSApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_running**](RealTimeMonitoringNMSApi.md#get_running) | **GET** /device/nms/running | + + +# **get_running** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_running(device_id) + + + +Get nms running state from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_nms_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_nms_api.RealTimeMonitoringNMSApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_running(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNMSApi->get_running: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringNTPApi.md b/docs/RealTimeMonitoringNTPApi.md new file mode 100644 index 0000000..8cfabc6 --- /dev/null +++ b/docs/RealTimeMonitoringNTPApi.md @@ -0,0 +1,422 @@ +# openapi_client.RealTimeMonitoringNTPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_associations_list**](RealTimeMonitoringNTPApi.md#create_associations_list) | **GET** /device/ntp/associations | +[**create_ntp_status_list**](RealTimeMonitoringNTPApi.md#create_ntp_status_list) | **GET** /device/ntp/status | +[**create_peer_list**](RealTimeMonitoringNTPApi.md#create_peer_list) | **GET** /device/ntp/peer | +[**create_te_list**](RealTimeMonitoringNTPApi.md#create_te_list) | **GET** /device/virtualApplication/te | +[**create_utd_list**](RealTimeMonitoringNTPApi.md#create_utd_list) | **GET** /device/virtualApplication/utd | +[**create_waas_list**](RealTimeMonitoringNTPApi.md#create_waas_list) | **GET** /device/virtualApplication/waas | + + +# **create_associations_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_associations_list(device_id) + + + +Get NTP peer associations list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ntp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ntp_api.RealTimeMonitoringNTPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_associations_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNTPApi->create_associations_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ntp_status_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ntp_status_list(device_id) + + + +Get NTP status list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ntp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ntp_api.RealTimeMonitoringNTPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ntp_status_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNTPApi->create_ntp_status_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_peer_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_peer_list(device_id) + + + +Get NTP peer list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ntp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ntp_api.RealTimeMonitoringNTPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_peer_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNTPApi->create_peer_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_te_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_te_list(device_id) + + + +Get ThousandEyes app list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ntp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ntp_api.RealTimeMonitoringNTPApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_te_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNTPApi->create_te_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_utd_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_utd_list(device_id) + + + +Get Utd apps list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ntp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ntp_api.RealTimeMonitoringNTPApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_utd_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNTPApi->create_utd_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_waas_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_waas_list(device_id) + + + +Get Waas apps list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ntp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ntp_api.RealTimeMonitoringNTPApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_waas_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNTPApi->create_waas_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringNetworkHubResourcesApi.md b/docs/RealTimeMonitoringNetworkHubResourcesApi.md new file mode 100644 index 0000000..8d5acb9 --- /dev/null +++ b/docs/RealTimeMonitoringNetworkHubResourcesApi.md @@ -0,0 +1,215 @@ +# openapi_client.RealTimeMonitoringNetworkHubResourcesApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_allocation_info**](RealTimeMonitoringNetworkHubResourcesApi.md#get_allocation_info) | **GET** /device/csp/resources/cpu-info/allocation | +[**get_cpu_info**](RealTimeMonitoringNetworkHubResourcesApi.md#get_cpu_info) | **GET** /device/csp/resources/cpu-info/cpus | +[**get_vnf_info**](RealTimeMonitoringNetworkHubResourcesApi.md#get_vnf_info) | **GET** /device/csp/resources/cpu-info/vnfs | + + +# **get_allocation_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_allocation_info(device_id) + + + +Get NetworkHub CPU allocation info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_network_hub_resources_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_network_hub_resources_api.RealTimeMonitoringNetworkHubResourcesApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_allocation_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNetworkHubResourcesApi->get_allocation_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cpu_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cpu_info(device_id) + + + +Get NetworkHub CPU info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_network_hub_resources_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_network_hub_resources_api.RealTimeMonitoringNetworkHubResourcesApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cpu_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNetworkHubResourcesApi->get_cpu_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnf_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vnf_info(device_id) + + + +Get NetworkHub CPU VNF info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_network_hub_resources_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_network_hub_resources_api.RealTimeMonitoringNetworkHubResourcesApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vnf_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringNetworkHubResourcesApi->get_vnf_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringOMPApi.md b/docs/RealTimeMonitoringOMPApi.md new file mode 100644 index 0000000..2cf1d31 --- /dev/null +++ b/docs/RealTimeMonitoringOMPApi.md @@ -0,0 +1,1177 @@ +# openapi_client.RealTimeMonitoringOMPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_advertised_routes_list**](RealTimeMonitoringOMPApi.md#create_advertised_routes_list) | **GET** /device/omp/routes/advertised | +[**create_advertised_routes_list_ipv6**](RealTimeMonitoringOMPApi.md#create_advertised_routes_list_ipv6) | **GET** /device/omp/routes/advertised/ompIpv6 | +[**create_advertised_tlocs_list**](RealTimeMonitoringOMPApi.md#create_advertised_tlocs_list) | **GET** /device/omp/tlocs/advertised | +[**create_omp_cloud_x_recv**](RealTimeMonitoringOMPApi.md#create_omp_cloud_x_recv) | **GET** /device/omp/cloudx | +[**create_omp_link_list**](RealTimeMonitoringOMPApi.md#create_omp_link_list) | **GET** /device/omp/links | +[**create_omp_mcast_auto_discover_advt**](RealTimeMonitoringOMPApi.md#create_omp_mcast_auto_discover_advt) | **GET** /device/omp/mcastautodiscoveradvt | +[**create_omp_mcast_auto_discover_recv**](RealTimeMonitoringOMPApi.md#create_omp_mcast_auto_discover_recv) | **GET** /device/omp/mcastautodiscoverrecv | +[**create_omp_mcast_routes_advt**](RealTimeMonitoringOMPApi.md#create_omp_mcast_routes_advt) | **GET** /device/omp/mcastroutesadvt | +[**create_omp_mcast_routes_recv**](RealTimeMonitoringOMPApi.md#create_omp_mcast_routes_recv) | **GET** /device/omp/mcastroutesrecv | +[**create_omp_services**](RealTimeMonitoringOMPApi.md#create_omp_services) | **GET** /device/omp/services | +[**create_omp_session_list**](RealTimeMonitoringOMPApi.md#create_omp_session_list) | **GET** /device/omp/peers | +[**create_omp_summary**](RealTimeMonitoringOMPApi.md#create_omp_summary) | **GET** /device/omp/summary | +[**create_received_routes_list**](RealTimeMonitoringOMPApi.md#create_received_routes_list) | **GET** /device/omp/routes/received | +[**create_received_routes_list_ipv6**](RealTimeMonitoringOMPApi.md#create_received_routes_list_ipv6) | **GET** /device/omp/routes/received/ompIpv6 | +[**create_received_tlocs_list**](RealTimeMonitoringOMPApi.md#create_received_tlocs_list) | **GET** /device/omp/tlocs/received | +[**create_synced_omp_session_list**](RealTimeMonitoringOMPApi.md#create_synced_omp_session_list) | **GET** /device/omp/synced/peers | +[**get_device_omp_status**](RealTimeMonitoringOMPApi.md#get_device_omp_status) | **GET** /device/omp/status | + + +# **create_advertised_routes_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_advertised_routes_list(device_id) + + + +Get OMP advertised routes list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_advertised_routes_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_advertised_routes_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_advertised_routes_list_ipv6** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_advertised_routes_list_ipv6(device_id) + + + +Get OMP advertised routes list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_advertised_routes_list_ipv6(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_advertised_routes_list_ipv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_advertised_tlocs_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_advertised_tlocs_list(device_id) + + + +Get advertised TLOCs list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_advertised_tlocs_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_advertised_tlocs_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_cloud_x_recv** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_cloud_x_recv(device_id) + + + +Get CloudExpress routes received list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_cloud_x_recv(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_cloud_x_recv: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_link_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_omp_link_list(state) + + + +Get OMP connection list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + state = "state_example" # str | Connection state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_link_list(state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_link_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state** | **str**| Connection state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_mcast_auto_discover_advt** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_mcast_auto_discover_advt(device_id) + + + +Get OMP multicast autodiscover advertised list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_mcast_auto_discover_advt(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_mcast_auto_discover_advt: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_mcast_auto_discover_recv** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_mcast_auto_discover_recv(device_id) + + + +Get OMP multicast autodiscover received list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_mcast_auto_discover_recv(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_mcast_auto_discover_recv: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_mcast_routes_advt** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_mcast_routes_advt(device_id) + + + +Get OMP multicast routes advertised list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_mcast_routes_advt(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_mcast_routes_advt: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_mcast_routes_recv** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_mcast_routes_recv(device_id) + + + +Get OMP multicast routes received list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_mcast_routes_recv(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_mcast_routes_recv: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_services** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_services(device_id) + + + +Get OMP services list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_services(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_services: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_session_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_omp_session_list(device_id) + + + +Get OMP session list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_session_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_session_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_omp_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_omp_summary(device_id) + + + +Get OMP summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_omp_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_omp_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_received_routes_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_received_routes_list(device_id) + + + +Get OMP received routes list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_received_routes_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_received_routes_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_received_routes_list_ipv6** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_received_routes_list_ipv6(device_id) + + + +Get OMP received routes list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_received_routes_list_ipv6(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_received_routes_list_ipv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_received_tlocs_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_received_tlocs_list(device_id) + + + +Get received TLOCs list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_received_tlocs_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_received_tlocs_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_omp_session_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_synced_omp_session_list(device_id) + + + +Get OP session list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_omp_session_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->create_synced_omp_session_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_omp_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_omp_status() + + + +Get device OMP status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_omp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_omp_api.RealTimeMonitoringOMPApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_omp_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOMPApi->get_device_omp_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringOSPFApi.md b/docs/RealTimeMonitoringOSPFApi.md new file mode 100644 index 0000000..292e3b7 --- /dev/null +++ b/docs/RealTimeMonitoringOSPFApi.md @@ -0,0 +1,629 @@ +# openapi_client.RealTimeMonitoringOSPFApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_ospf_database_external**](RealTimeMonitoringOSPFApi.md#create_ospf_database_external) | **GET** /device/ospf/databaseexternal | +[**create_ospf_database_list**](RealTimeMonitoringOSPFApi.md#create_ospf_database_list) | **GET** /device/ospf/database | +[**create_ospf_database_summary_list**](RealTimeMonitoringOSPFApi.md#create_ospf_database_summary_list) | **GET** /device/ospf/databasesummary | +[**create_ospf_interface**](RealTimeMonitoringOSPFApi.md#create_ospf_interface) | **GET** /device/ospf/interface | +[**create_ospf_neighbors**](RealTimeMonitoringOSPFApi.md#create_ospf_neighbors) | **GET** /device/ospf/neighbor | +[**create_ospf_process**](RealTimeMonitoringOSPFApi.md#create_ospf_process) | **GET** /device/ospf/process | +[**create_ospf_routes_list**](RealTimeMonitoringOSPFApi.md#create_ospf_routes_list) | **GET** /device/ospf/routes | +[**create_ospfv3_interface**](RealTimeMonitoringOSPFApi.md#create_ospfv3_interface) | **GET** /device/ospf/v3interface | +[**create_ospfv3_neighbors**](RealTimeMonitoringOSPFApi.md#create_ospfv3_neighbors) | **GET** /device/ospf/v3neighbor | + + +# **create_ospf_database_external** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_database_external(device_id) + + + +Get OSPF external database list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_database_external(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_database_external: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospf_database_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_database_list(device_id) + + + +Get OSPF database list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_database_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_database_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospf_database_summary_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_database_summary_list(device_id) + + + +Get OSPF database summary list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_database_summary_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_database_summary_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospf_interface** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_interface(device_id) + + + +Get OSPF interface list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospf_neighbors** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_neighbors(device_id) + + + +Get OSPF neighbor list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_neighbors(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_neighbors: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospf_process** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_process(device_id) + + + +Get OSPF process list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_process(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_process: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospf_routes_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospf_routes_list(device_id) + + + +Get OSPF route list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospf_routes_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospf_routes_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospfv3_interface** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospfv3_interface(device_id) + + + +Get OSPF v3 interface list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospfv3_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospfv3_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ospfv3_neighbors** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ospfv3_neighbors(device_id) + + + +Get OSPF v3 neighbor list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ospf_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ospf_api.RealTimeMonitoringOSPFApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ospfv3_neighbors(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOSPFApi->create_ospfv3_neighbors: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringOrchestratorApi.md b/docs/RealTimeMonitoringOrchestratorApi.md new file mode 100644 index 0000000..468ba60 --- /dev/null +++ b/docs/RealTimeMonitoringOrchestratorApi.md @@ -0,0 +1,629 @@ +# openapi_client.RealTimeMonitoringOrchestratorApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_connection_history_list**](RealTimeMonitoringOrchestratorApi.md#create_connection_history_list) | **GET** /device/orchestrator/connectionshistory | +[**create_connection_list_from_device**](RealTimeMonitoringOrchestratorApi.md#create_connection_list_from_device) | **GET** /device/orchestrator/connections | +[**create_connection_summary**](RealTimeMonitoringOrchestratorApi.md#create_connection_summary) | **GET** /device/orchestrator/summary | +[**create_local_properties_list_list**](RealTimeMonitoringOrchestratorApi.md#create_local_properties_list_list) | **GET** /device/orchestrator/localproperties | +[**create_reverse_proxy_mapping_list**](RealTimeMonitoringOrchestratorApi.md#create_reverse_proxy_mapping_list) | **GET** /device/orchestrator/proxymapping | +[**create_valid_devices_list**](RealTimeMonitoringOrchestratorApi.md#create_valid_devices_list) | **GET** /device/orchestrator/validvedges | +[**create_valid_v_smarts_list**](RealTimeMonitoringOrchestratorApi.md#create_valid_v_smarts_list) | **GET** /device/orchestrator/validvsmarts | +[**get_statistics**](RealTimeMonitoringOrchestratorApi.md#get_statistics) | **GET** /device/orchestrator/statistics | +[**get_valid_v_manage_id**](RealTimeMonitoringOrchestratorApi.md#get_valid_v_manage_id) | **GET** /device/orchestrator/validvmanageid | + + +# **create_connection_history_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_connection_history_list(device_id) + + + +Get connection history list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_connection_history_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_connection_history_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_connection_list_from_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_connection_list_from_device(device_id) + + + +Get connection list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_connection_list_from_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_connection_list_from_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_connection_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_connection_summary(device_id) + + + +Get connection summary from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_connection_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_connection_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_local_properties_list_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_local_properties_list_list(device_id) + + + +Get local properties list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_local_properties_list_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_local_properties_list_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_reverse_proxy_mapping_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_reverse_proxy_mapping_list(device_id) + + + +Get reverse proxy mapping from vbond + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_reverse_proxy_mapping_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_reverse_proxy_mapping_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_valid_devices_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_valid_devices_list(device_id) + + + +Get valid device list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_valid_devices_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_valid_devices_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_valid_v_smarts_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_valid_v_smarts_list(device_id) + + + +Get valid vSmart list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_valid_v_smarts_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->create_valid_v_smarts_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_statistics(device_id) + + + +Get statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->get_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_valid_v_manage_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_valid_v_manage_id(device_id) + + + +Get valid vManage Id from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_orchestrator_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_orchestrator_api.RealTimeMonitoringOrchestratorApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_valid_v_manage_id(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringOrchestratorApi->get_valid_v_manage_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringPIMApi.md b/docs/RealTimeMonitoringPIMApi.md new file mode 100644 index 0000000..8b20ed8 --- /dev/null +++ b/docs/RealTimeMonitoringPIMApi.md @@ -0,0 +1,353 @@ +# openapi_client.RealTimeMonitoringPIMApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_pim_interface_list**](RealTimeMonitoringPIMApi.md#create_pim_interface_list) | **GET** /device/pim/interface | +[**create_pim_neighbor_list**](RealTimeMonitoringPIMApi.md#create_pim_neighbor_list) | **GET** /device/pim/neighbor | +[**create_pim_statistics_list**](RealTimeMonitoringPIMApi.md#create_pim_statistics_list) | **GET** /device/pim/statistics | +[**create_pimrp_mapping_list**](RealTimeMonitoringPIMApi.md#create_pimrp_mapping_list) | **GET** /device/pim/rp-mapping | +[**create_ppp_interface_list**](RealTimeMonitoringPIMApi.md#create_ppp_interface_list) | **GET** /device/ppp/interface | + + +# **create_pim_interface_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_pim_interface_list(device_id) + + + +Get PIM interface list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pim_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pim_api.RealTimeMonitoringPIMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pim_interface_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPIMApi->create_pim_interface_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_pim_neighbor_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_pim_neighbor_list(device_id) + + + +Get PIM neighbor list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pim_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pim_api.RealTimeMonitoringPIMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pim_neighbor_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPIMApi->create_pim_neighbor_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_pim_statistics_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_pim_statistics_list(device_id) + + + +Get PIM statistics list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pim_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pim_api.RealTimeMonitoringPIMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pim_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPIMApi->create_pim_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_pimrp_mapping_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_pimrp_mapping_list(device_id) + + + +Get PIM Rp-mapping list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pim_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pim_api.RealTimeMonitoringPIMApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pimrp_mapping_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPIMApi->create_pimrp_mapping_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ppp_interface_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_ppp_interface_list(device_id) + + + +Get PPP interface list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pim_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pim_api.RealTimeMonitoringPIMApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ppp_interface_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPIMApi->create_ppp_interface_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringPPPoEApi.md b/docs/RealTimeMonitoringPPPoEApi.md new file mode 100644 index 0000000..ec1bbd5 --- /dev/null +++ b/docs/RealTimeMonitoringPPPoEApi.md @@ -0,0 +1,152 @@ +# openapi_client.RealTimeMonitoringPPPoEApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_pppo_e_interface_list**](RealTimeMonitoringPPPoEApi.md#create_pppo_e_interface_list) | **GET** /device/pppoe/session | +[**create_pppo_e_neighbor_list**](RealTimeMonitoringPPPoEApi.md#create_pppo_e_neighbor_list) | **GET** /device/pppoe/statistic | + + +# **create_pppo_e_interface_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_pppo_e_interface_list(device_id) + + + +Get PPPoE session list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pppo_e_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pppo_e_api.RealTimeMonitoringPPPoEApi(api_client) + device_id = DeviceIP( + device_ip="device_ip_example", + ) # DeviceIP | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pppo_e_interface_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPPPoEApi->create_pppo_e_interface_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **DeviceIP**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_pppo_e_neighbor_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_pppo_e_neighbor_list(device_id) + + + +Get PPPoE statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_pppo_e_api +from openapi_client.model.device_ip import DeviceIP +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_pppo_e_api.RealTimeMonitoringPPPoEApi(api_client) + device_id = DeviceIP( + device_ip="device_ip_example", + ) # DeviceIP | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_pppo_e_neighbor_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPPPoEApi->create_pppo_e_neighbor_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **DeviceIP**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringPolicerApi.md b/docs/RealTimeMonitoringPolicerApi.md new file mode 100644 index 0000000..87e1413 --- /dev/null +++ b/docs/RealTimeMonitoringPolicerApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringPolicerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_policed_interface**](RealTimeMonitoringPolicerApi.md#get_policed_interface) | **GET** /device/policer | + + +# **get_policed_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policed_interface(device_id) + + + +Get policed interface list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policer_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policer_api.RealTimeMonitoringPolicerApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_policed_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicerApi->get_policed_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringPolicyApi.md b/docs/RealTimeMonitoringPolicyApi.md new file mode 100644 index 0000000..5ac9070 --- /dev/null +++ b/docs/RealTimeMonitoringPolicyApi.md @@ -0,0 +1,1664 @@ +# openapi_client.RealTimeMonitoringPolicyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_polic_data_policy_filter**](RealTimeMonitoringPolicyApi.md#create_polic_data_policy_filter) | **GET** /device/policy/datapolicyfilter | +[**create_polic_qos_map_info**](RealTimeMonitoringPolicyApi.md#create_polic_qos_map_info) | **GET** /device/policy/qosmapinfo | +[**create_polic_qos_scheduler_info**](RealTimeMonitoringPolicyApi.md#create_polic_qos_scheduler_info) | **GET** /device/policy/qosschedulerinfo | +[**create_policy_access_list_associations**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_associations) | **GET** /device/policy/accesslistassociations | +[**create_policy_access_list_associations_ipv6**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_associations_ipv6) | **GET** /device/policy/ipv6/accesslistassociations | +[**create_policy_access_list_counters**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_counters) | **GET** /device/policy/accesslistcounters | +[**create_policy_access_list_counters_ipv6**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_counters_ipv6) | **GET** /device/policy/ipv6/accesslistcounters | +[**create_policy_access_list_names**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_names) | **GET** /device/policy/accesslistnames | +[**create_policy_access_list_names_ipv6**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_names_ipv6) | **GET** /device/policy/ipv6/accesslistnames | +[**create_policy_access_list_policers**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_policers) | **GET** /device/policy/accesslistpolicers | +[**create_policy_access_list_policers_ipv6**](RealTimeMonitoringPolicyApi.md#create_policy_access_list_policers_ipv6) | **GET** /device/policy/ipv6/accesslistpolicers | +[**create_policy_app_route_policy_filter**](RealTimeMonitoringPolicyApi.md#create_policy_app_route_policy_filter) | **GET** /device/policy/approutepolicyfilter | +[**create_policy_filter_memory_usage**](RealTimeMonitoringPolicyApi.md#create_policy_filter_memory_usage) | **GET** /device/policy/filtermemoryusage | +[**create_policy_rewrite_associations_info**](RealTimeMonitoringPolicyApi.md#create_policy_rewrite_associations_info) | **GET** /device/policy/rewriteassociations | +[**get_zbfw_statistics**](RealTimeMonitoringPolicyApi.md#get_zbfw_statistics) | **GET** /device/policy/zbfwstatistics | +[**get_zone_drop_statistics**](RealTimeMonitoringPolicyApi.md#get_zone_drop_statistics) | **GET** /device/policy/zbfwdropstatistics | +[**get_zone_pair_sessions**](RealTimeMonitoringPolicyApi.md#get_zone_pair_sessions) | **GET** /device/policy/zonepairsessions | +[**get_zone_pairs**](RealTimeMonitoringPolicyApi.md#get_zone_pairs) | **GET** /device/policy/zonepairstatistics | +[**get_zone_policy_filters**](RealTimeMonitoringPolicyApi.md#get_zone_policy_filters) | **GET** /device/policy/zonepolicyfilter | +[**show_sdwan_policy_from_vsmart**](RealTimeMonitoringPolicyApi.md#show_sdwan_policy_from_vsmart) | **GET** /device/policy/vsmart | +[**show_vsmart_ipto_user_binding**](RealTimeMonitoringPolicyApi.md#show_vsmart_ipto_user_binding) | **GET** /device/policy/iptouserbindings | +[**show_vsmart_px_grid_status**](RealTimeMonitoringPolicyApi.md#show_vsmart_px_grid_status) | **GET** /device/policy/pxgridstatus | +[**show_vsmart_px_grid_user_sessions**](RealTimeMonitoringPolicyApi.md#show_vsmart_px_grid_user_sessions) | **GET** /device/policy/pxgridusersessions | +[**show_vsmart_user_usergroup_bindings**](RealTimeMonitoringPolicyApi.md#show_vsmart_user_usergroup_bindings) | **GET** /device/policy/userusergroupbindings | + + +# **create_polic_data_policy_filter** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_polic_data_policy_filter(device_id) + + + +Get data policy filters from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_polic_data_policy_filter(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_polic_data_policy_filter: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_polic_qos_map_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_polic_qos_map_info(device_id) + + + +Get QoS map information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_polic_qos_map_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_polic_qos_map_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_polic_qos_scheduler_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_polic_qos_scheduler_info(device_id) + + + +Get QoS scheduler information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_polic_qos_scheduler_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_polic_qos_scheduler_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_associations** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_associations(device_id) + + + +Get access list associations from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_associations(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_associations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_associations_ipv6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_associations_ipv6(device_id) + + + +Get access list associations from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_associations_ipv6(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_associations_ipv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_counters** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_counters(device_id) + + + +Get access list counter from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_counters(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_counters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_counters_ipv6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_counters_ipv6(device_id) + + + +Get access list counters from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_counters_ipv6(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_counters_ipv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_names** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_names(device_id) + + + +Get access list names from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_names(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_names: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_names_ipv6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_names_ipv6(device_id) + + + +Get access list names from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_names_ipv6(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_names_ipv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_policers** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_policers(device_id) + + + +Get access list policers from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_policers(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_policers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_access_list_policers_ipv6** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_access_list_policers_ipv6(device_id) + + + +Get access list policers from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_access_list_policers_ipv6(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_access_list_policers_ipv6: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_app_route_policy_filter** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_app_route_policy_filter(device_id) + + + +Get approute policy filter from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_app_route_policy_filter(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_app_route_policy_filter: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_filter_memory_usage** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_filter_memory_usage(device_id) + + + +Get data policy filter memory usage from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_filter_memory_usage(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_filter_memory_usage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_policy_rewrite_associations_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_rewrite_associations_info(device_id) + + + +Get rewrite associations information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_policy_rewrite_associations_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->create_policy_rewrite_associations_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_zbfw_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_zbfw_statistics(device_id) + + + +Get zone based firewall statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_zbfw_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->get_zbfw_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_zone_drop_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_zone_drop_statistics(device_id) + + + +Get zone drop statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_zone_drop_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->get_zone_drop_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_zone_pair_sessions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_zone_pair_sessions(device_id) + + + +Get zone pair sessions from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_zone_pair_sessions(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->get_zone_pair_sessions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_zone_pairs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_zone_pairs(device_id) + + + +Get zone pair statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_zone_pairs(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->get_zone_pairs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_zone_policy_filters** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_zone_policy_filters(device_id) + + + +Get zone policy filter from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_zone_policy_filters(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->get_zone_policy_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **show_sdwan_policy_from_vsmart** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} show_sdwan_policy_from_vsmart(device_id) + + + +show Sdwan Policy From Vsmart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.show_sdwan_policy_from_vsmart(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->show_sdwan_policy_from_vsmart: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **show_vsmart_ipto_user_binding** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} show_vsmart_ipto_user_binding(device_id) + + + +show ip to user binding from Vsmart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.show_vsmart_ipto_user_binding(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->show_vsmart_ipto_user_binding: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **show_vsmart_px_grid_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} show_vsmart_px_grid_status(device_id) + + + +show Pxgrid status From Vsmart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.show_vsmart_px_grid_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->show_vsmart_px_grid_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **show_vsmart_px_grid_user_sessions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} show_vsmart_px_grid_user_sessions(device_id) + + + +show Pxgrid sessions From Vsmart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.show_vsmart_px_grid_user_sessions(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->show_vsmart_px_grid_user_sessions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **show_vsmart_user_usergroup_bindings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} show_vsmart_user_usergroup_bindings(device_id) + + + +Show User-Usergroup bindings from Vsmart + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_policy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_policy_api.RealTimeMonitoringPolicyApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.show_vsmart_user_usergroup_bindings(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringPolicyApi->show_vsmart_user_usergroup_bindings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringRBACApi.md b/docs/RealTimeMonitoringRBACApi.md new file mode 100644 index 0000000..0eada32 --- /dev/null +++ b/docs/RealTimeMonitoringRBACApi.md @@ -0,0 +1,215 @@ +# openapi_client.RealTimeMonitoringRBACApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_pnic_stats**](RealTimeMonitoringRBACApi.md#get_pnic_stats) | **GET** /device/csp/pnic | +[**get_pnic_stats_from_device**](RealTimeMonitoringRBACApi.md#get_pnic_stats_from_device) | **GET** /device/csp/pnic/synced | +[**get_rbac_interface**](RealTimeMonitoringRBACApi.md#get_rbac_interface) | **GET** /device/csp/rbac | + + +# **get_pnic_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_pnic_stats(device_id) + + + +Get pnic interfaces from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_rbac_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_rbac_api.RealTimeMonitoringRBACApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_pnic_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringRBACApi->get_pnic_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pnic_stats_from_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_pnic_stats_from_device(device_id) + + + +Get pnic stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_rbac_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_rbac_api.RealTimeMonitoringRBACApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_pnic_stats_from_device(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringRBACApi->get_pnic_stats_from_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_rbac_interface** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_rbac_interface(device_id) + + + +Get RBAC interfaces from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_rbac_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_rbac_api.RealTimeMonitoringRBACApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_rbac_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringRBACApi->get_rbac_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringRebootHistoryApi.md b/docs/RealTimeMonitoringRebootHistoryApi.md new file mode 100644 index 0000000..5db5782 --- /dev/null +++ b/docs/RealTimeMonitoringRebootHistoryApi.md @@ -0,0 +1,211 @@ +# openapi_client.RealTimeMonitoringRebootHistoryApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_reboot_history_list**](RealTimeMonitoringRebootHistoryApi.md#create_reboot_history_list) | **GET** /device/reboothistory | +[**create_synced_reboot_history_list**](RealTimeMonitoringRebootHistoryApi.md#create_synced_reboot_history_list) | **GET** /device/reboothistory/synced | +[**get_reboot_history_details**](RealTimeMonitoringRebootHistoryApi.md#get_reboot_history_details) | **GET** /device/reboothistory/details | + + +# **create_reboot_history_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_reboot_history_list(device_id) + + + +Get device reboot history + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_reboot_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_reboot_history_api.RealTimeMonitoringRebootHistoryApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_reboot_history_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringRebootHistoryApi->create_reboot_history_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_reboot_history_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_synced_reboot_history_list(device_id) + + + +Get device reboot history synchronously + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_reboot_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_reboot_history_api.RealTimeMonitoringRebootHistoryApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_reboot_history_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringRebootHistoryApi->create_synced_reboot_history_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reboot_history_details** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_reboot_history_details() + + + +Get detailed reboot history list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_reboot_history_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_reboot_history_api.RealTimeMonitoringRebootHistoryApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_reboot_history_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringRebootHistoryApi->get_reboot_history_details: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSDWANStatisticsApi.md b/docs/RealTimeMonitoringSDWANStatisticsApi.md new file mode 100644 index 0000000..6a7336c --- /dev/null +++ b/docs/RealTimeMonitoringSDWANStatisticsApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringSDWANStatisticsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_sd_wan_global_drop_statistics**](RealTimeMonitoringSDWANStatisticsApi.md#get_sd_wan_global_drop_statistics) | **GET** /device/sdwan-global-drop-statistics | +[**get_sd_wan_stats**](RealTimeMonitoringSDWANStatisticsApi.md#get_sd_wan_stats) | **GET** /device/sdwan-stats | + + +# **get_sd_wan_global_drop_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sd_wan_global_drop_statistics(device_id) + + + +Get SD-WAN global drop statistics detail from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sdwan_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sdwan_statistics_api.RealTimeMonitoringSDWANStatisticsApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sd_wan_global_drop_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSDWANStatisticsApi->get_sd_wan_global_drop_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sd_wan_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sd_wan_stats(device_id) + + + +Get SD-WAN statistics detail from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sdwan_statistics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sdwan_statistics_api.RealTimeMonitoringSDWANStatisticsApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sd_wan_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSDWANStatisticsApi->get_sd_wan_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSFPApi.md b/docs/RealTimeMonitoringSFPApi.md new file mode 100644 index 0000000..96eec07 --- /dev/null +++ b/docs/RealTimeMonitoringSFPApi.md @@ -0,0 +1,324 @@ +# openapi_client.RealTimeMonitoringSFPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_detail**](RealTimeMonitoringSFPApi.md#get_detail) | **GET** /device/sfp/detail | +[**get_diagnostic**](RealTimeMonitoringSFPApi.md#get_diagnostic) | **GET** /device/sfp/diagnostic | +[**get_diagnostic_measurement_alarm**](RealTimeMonitoringSFPApi.md#get_diagnostic_measurement_alarm) | **GET** /device/sfp/diagnosticMeasurementAlarm | +[**get_diagnostic_measurement_value**](RealTimeMonitoringSFPApi.md#get_diagnostic_measurement_value) | **GET** /device/sfp/diagnosticMeasurementValue | + + +# **get_detail** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_detail(device_id) + + + +Get SFP detail + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sfp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sfp_api.RealTimeMonitoringSFPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_detail(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_detail: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_detail(device_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_detail: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_diagnostic** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_diagnostic(device_id) + + + +Get SFP diagnostic + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sfp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sfp_api.RealTimeMonitoringSFPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_diagnostic(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_diagnostic: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_diagnostic(device_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_diagnostic: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_diagnostic_measurement_alarm** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_diagnostic_measurement_alarm(device_id) + + + +Get SFP diagnostic measurement alarm + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sfp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sfp_api.RealTimeMonitoringSFPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_diagnostic_measurement_alarm(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_diagnostic_measurement_alarm: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_diagnostic_measurement_alarm(device_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_diagnostic_measurement_alarm: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_diagnostic_measurement_value** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_diagnostic_measurement_value(device_id) + + + +Get SFP diagnostic measurement value + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sfp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sfp_api.RealTimeMonitoringSFPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + ifname = "ge0/0" # str | IF Name (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_diagnostic_measurement_value(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_diagnostic_measurement_value: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_diagnostic_measurement_value(device_id, ifname=ifname) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSFPApi->get_diagnostic_measurement_value: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + **ifname** | **str**| IF Name | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSIGApi.md b/docs/RealTimeMonitoringSIGApi.md new file mode 100644 index 0000000..212b981 --- /dev/null +++ b/docs/RealTimeMonitoringSIGApi.md @@ -0,0 +1,350 @@ +# openapi_client.RealTimeMonitoringSIGApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_sig_tunnel_list**](RealTimeMonitoringSIGApi.md#get_sig_tunnel_list) | **GET** /device/sig/getSigTunnelList | +[**get_sig_tunnel_total**](RealTimeMonitoringSIGApi.md#get_sig_tunnel_total) | **GET** /device/sig/getSigTunnelTotal | +[**get_sig_umbrella_tunnels**](RealTimeMonitoringSIGApi.md#get_sig_umbrella_tunnels) | **GET** /device/sig/umbrella/tunnels | +[**get_sig_zscaler_tunnels**](RealTimeMonitoringSIGApi.md#get_sig_zscaler_tunnels) | **GET** /device/sig/zscaler/tunnels | +[**tunnel_dashboard**](RealTimeMonitoringSIGApi.md#tunnel_dashboard) | **GET** /device/sig/tunnelDashboard | + + +# **get_sig_tunnel_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sig_tunnel_list() + + + +get Sig TunnelList + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sig_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sig_api.RealTimeMonitoringSIGApi(api_client) + page_size = "pageSize_example" # str | Page Size (optional) + offset = "offset_example" # str | Page offset (optional) + last_n_hours = "lastNHours_example" # str | last n hours (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_sig_tunnel_list(page_size=page_size, offset=offset, last_n_hours=last_n_hours) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSIGApi->get_sig_tunnel_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page_size** | **str**| Page Size | [optional] + **offset** | **str**| Page offset | [optional] + **last_n_hours** | **str**| last n hours | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sig_tunnel_total** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sig_tunnel_total() + + + +get Sig Tunnel Total coount + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sig_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sig_api.RealTimeMonitoringSIGApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_sig_tunnel_total() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSIGApi->get_sig_tunnel_total: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sig_umbrella_tunnels** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sig_umbrella_tunnels(device_id) + + + +Get SIG Umbrella tunnels from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sig_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sig_api.RealTimeMonitoringSIGApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sig_umbrella_tunnels(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSIGApi->get_sig_umbrella_tunnels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sig_zscaler_tunnels** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sig_zscaler_tunnels(device_id) + + + +Get SIG Zscaler tunnels from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sig_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sig_api.RealTimeMonitoringSIGApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sig_zscaler_tunnels(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSIGApi->get_sig_zscaler_tunnels: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tunnel_dashboard** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} tunnel_dashboard() + + + +Get SIG Zscaler tunnels from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sig_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sig_api.RealTimeMonitoringSIGApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.tunnel_dashboard() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSIGApi->tunnel_dashboard: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSecurityApi.md b/docs/RealTimeMonitoringSecurityApi.md new file mode 100644 index 0000000..312c709 --- /dev/null +++ b/docs/RealTimeMonitoringSecurityApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringSecurityApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_session_list**](RealTimeMonitoringSecurityApi.md#create_session_list) | **GET** /device/security/information | + + +# **create_session_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_session_list(device_id) + + + +Get security information from devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_security_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_security_api.RealTimeMonitoringSecurityApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_session_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSecurityApi->create_session_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringShowOnDemandLocalApi.md b/docs/RealTimeMonitoringShowOnDemandLocalApi.md new file mode 100644 index 0000000..79a80e4 --- /dev/null +++ b/docs/RealTimeMonitoringShowOnDemandLocalApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringShowOnDemandLocalApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_on_demand_local**](RealTimeMonitoringShowOnDemandLocalApi.md#get_on_demand_local) | **GET** /device/ondemand/local | + + +# **get_on_demand_local** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_on_demand_local(device_id) + + + +Get on-demand local (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_show_on_demand_local_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_show_on_demand_local_api.RealTimeMonitoringShowOnDemandLocalApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_on_demand_local(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringShowOnDemandLocalApi->get_on_demand_local: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringShowOnDemandRemoteApi.md b/docs/RealTimeMonitoringShowOnDemandRemoteApi.md new file mode 100644 index 0000000..e19d376 --- /dev/null +++ b/docs/RealTimeMonitoringShowOnDemandRemoteApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringShowOnDemandRemoteApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_on_demand_remote**](RealTimeMonitoringShowOnDemandRemoteApi.md#get_on_demand_remote) | **GET** /device/ondemand/remote | + + +# **get_on_demand_remote** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_on_demand_remote(device_id) + + + +Get on-demand remote (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_show_on_demand_remote_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_show_on_demand_remote_api.RealTimeMonitoringShowOnDemandRemoteApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_on_demand_remote(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringShowOnDemandRemoteApi->get_on_demand_remote: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSoftwareApi.md b/docs/RealTimeMonitoringSoftwareApi.md new file mode 100644 index 0000000..55e2794 --- /dev/null +++ b/docs/RealTimeMonitoringSoftwareApi.md @@ -0,0 +1,284 @@ +# openapi_client.RealTimeMonitoringSoftwareApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_smu_list**](RealTimeMonitoringSoftwareApi.md#create_smu_list) | **GET** /device/smu | +[**create_synced_smu_list**](RealTimeMonitoringSoftwareApi.md#create_synced_smu_list) | **GET** /device/smu/synced | +[**create_synced_software_list**](RealTimeMonitoringSoftwareApi.md#create_synced_software_list) | **GET** /device/software/synced | +[**get_aaa_ucreate_software_listsers**](RealTimeMonitoringSoftwareApi.md#get_aaa_ucreate_software_listsers) | **GET** /device/software | + + +# **create_smu_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_smu_list(device_id) + + + +Get software list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_software_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_software_api.RealTimeMonitoringSoftwareApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_smu_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSoftwareApi->create_smu_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_smu_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_synced_smu_list(device_id) + + + +Get software list from device synchronously + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_software_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_software_api.RealTimeMonitoringSoftwareApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_smu_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSoftwareApi->create_synced_smu_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_software_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_synced_software_list(device_id) + + + +Get software list from device synchronously + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_software_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_software_api.RealTimeMonitoringSoftwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_software_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSoftwareApi->create_synced_software_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aaa_ucreate_software_listsers** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_aaa_ucreate_software_listsers(device_id) + + + +Get software list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_software_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_software_api.RealTimeMonitoringSoftwareApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_aaa_ucreate_software_listsers(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSoftwareApi->get_aaa_ucreate_software_listsers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSslproxyApi.md b/docs/RealTimeMonitoringSslproxyApi.md new file mode 100644 index 0000000..64ed4dd --- /dev/null +++ b/docs/RealTimeMonitoringSslproxyApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringSslproxyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_ssl_proxy_statistics**](RealTimeMonitoringSslproxyApi.md#get_ssl_proxy_statistics) | **GET** /device/sslproxy/statistics | +[**get_ssl_proxy_status**](RealTimeMonitoringSslproxyApi.md#get_ssl_proxy_status) | **GET** /device/sslproxy/status | + + +# **get_ssl_proxy_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ssl_proxy_statistics(device_id) + + + +Get ssl proxy statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sslproxy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sslproxy_api.RealTimeMonitoringSslproxyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ssl_proxy_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSslproxyApi->get_ssl_proxy_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ssl_proxy_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_ssl_proxy_status(device_id) + + + +Get ssl proxy status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_sslproxy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_sslproxy_api.RealTimeMonitoringSslproxyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ssl_proxy_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSslproxyApi->get_ssl_proxy_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringStaticRouteTrackerServiceApi.md b/docs/RealTimeMonitoringStaticRouteTrackerServiceApi.md new file mode 100644 index 0000000..7f7869f --- /dev/null +++ b/docs/RealTimeMonitoringStaticRouteTrackerServiceApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringStaticRouteTrackerServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_static_route_tracker_info**](RealTimeMonitoringStaticRouteTrackerServiceApi.md#get_static_route_tracker_info) | **GET** /device/staticRouteTracker | + + +# **get_static_route_tracker_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_static_route_tracker_info(device_id) + + + +Get single static route tracker info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_static_route_tracker_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_static_route_tracker_service_api.RealTimeMonitoringStaticRouteTrackerServiceApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_static_route_tracker_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringStaticRouteTrackerServiceApi->get_static_route_tracker_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringSystemApi.md b/docs/RealTimeMonitoringSystemApi.md new file mode 100644 index 0000000..49bacd4 --- /dev/null +++ b/docs/RealTimeMonitoringSystemApi.md @@ -0,0 +1,631 @@ +# openapi_client.RealTimeMonitoringSystemApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_device_info_list**](RealTimeMonitoringSystemApi.md#create_device_info_list) | **GET** /device/system/info | +[**create_device_system_process_list**](RealTimeMonitoringSystemApi.md#create_device_system_process_list) | **GET** /device/csp/system/processlist | +[**create_device_system_setting**](RealTimeMonitoringSystemApi.md#create_device_system_setting) | **GET** /device/csp/system/settings | +[**create_device_system_setting_native_info**](RealTimeMonitoringSystemApi.md#create_device_system_setting_native_info) | **GET** /device/csp/system/native | +[**create_device_system_stats_list**](RealTimeMonitoringSystemApi.md#create_device_system_stats_list) | **GET** /device/system/statistics | +[**create_device_system_status**](RealTimeMonitoringSystemApi.md#create_device_system_status) | **GET** /device/csp/system/status | +[**create_device_system_status_list**](RealTimeMonitoringSystemApi.md#create_device_system_status_list) | **GET** /device/system/status | +[**create_synced_device_system_status_list**](RealTimeMonitoringSystemApi.md#create_synced_device_system_status_list) | **GET** /device/system/synced/status | +[**get_device_system_clock**](RealTimeMonitoringSystemApi.md#get_device_system_clock) | **GET** /device/system/clock | + + +# **create_device_info_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_info_list(device_id) + + + +Get device information list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = [ + "169.254.10.10", + ] # [str] | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_info_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_info_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **[str]**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_process_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_process_list(device_id) + + + +Get device system process list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_process_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_system_process_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_setting** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_setting(device_id) + + + +Get device system settings from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_setting(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_system_setting: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_setting_native_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_setting_native_info(device_id) + + + +Get device system native settings from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_setting_native_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_system_setting_native_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_stats_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_stats_list(device_id) + + + +Get device system stats list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_stats_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_system_stats_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_status(device_id) + + + +Get device system status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_system_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_device_system_status_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_device_system_status_list(device_id) + + + +Get device system status list (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_device_system_status_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_device_system_status_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_synced_device_system_status_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_synced_device_system_status_list(device_id) + + + +Get device system stats list synchronously + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_synced_device_system_status_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->create_synced_device_system_status_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_system_clock** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_system_clock(device_id) + + + +Get device system clock + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_system_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_system_api.RealTimeMonitoringSystemApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_system_clock(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringSystemApi->get_device_system_clock: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringTCPOptimizationApi.md b/docs/RealTimeMonitoringTCPOptimizationApi.md new file mode 100644 index 0000000..356eccb --- /dev/null +++ b/docs/RealTimeMonitoringTCPOptimizationApi.md @@ -0,0 +1,215 @@ +# openapi_client.RealTimeMonitoringTCPOptimizationApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_active_tcp_flows**](RealTimeMonitoringTCPOptimizationApi.md#get_active_tcp_flows) | **GET** /device/tcpopt/activeflows | +[**get_expired_tcp_flows**](RealTimeMonitoringTCPOptimizationApi.md#get_expired_tcp_flows) | **GET** /device/tcpopt/expiredflows | +[**get_tcp_summary**](RealTimeMonitoringTCPOptimizationApi.md#get_tcp_summary) | **GET** /device/tcpopt/summary | + + +# **get_active_tcp_flows** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_active_tcp_flows(device_id) + + + +Get TCP optimized active flows from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tcp_optimization_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tcp_optimization_api.RealTimeMonitoringTCPOptimizationApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_active_tcp_flows(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTCPOptimizationApi->get_active_tcp_flows: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_expired_tcp_flows** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_expired_tcp_flows(device_id) + + + +Get TCP optimized expired flows from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tcp_optimization_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tcp_optimization_api.RealTimeMonitoringTCPOptimizationApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_expired_tcp_flows(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTCPOptimizationApi->get_expired_tcp_flows: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tcp_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tcp_summary(device_id) + + + +Get TCP optimization summary from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tcp_optimization_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tcp_optimization_api.RealTimeMonitoringTCPOptimizationApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tcp_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTCPOptimizationApi->get_tcp_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringTcpproxyApi.md b/docs/RealTimeMonitoringTcpproxyApi.md new file mode 100644 index 0000000..126e55b --- /dev/null +++ b/docs/RealTimeMonitoringTcpproxyApi.md @@ -0,0 +1,146 @@ +# openapi_client.RealTimeMonitoringTcpproxyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_tcp_proxy_statistics**](RealTimeMonitoringTcpproxyApi.md#get_tcp_proxy_statistics) | **GET** /device/tcpproxy/statistics | +[**get_tcp_proxy_status**](RealTimeMonitoringTcpproxyApi.md#get_tcp_proxy_status) | **GET** /device/tcpproxy/status | + + +# **get_tcp_proxy_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tcp_proxy_statistics(device_id) + + + +Get tcp proxy statistics from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tcpproxy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tcpproxy_api.RealTimeMonitoringTcpproxyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tcp_proxy_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTcpproxyApi->get_tcp_proxy_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tcp_proxy_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tcp_proxy_status(device_id) + + + +Get tcp proxy status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tcpproxy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tcpproxy_api.RealTimeMonitoringTcpproxyApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tcp_proxy_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTcpproxyApi->get_tcp_proxy_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringToolsApi.md b/docs/RealTimeMonitoringToolsApi.md new file mode 100644 index 0000000..8ff4a25 --- /dev/null +++ b/docs/RealTimeMonitoringToolsApi.md @@ -0,0 +1,381 @@ +# openapi_client.RealTimeMonitoringToolsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_device_tools_n_slookup**](RealTimeMonitoringToolsApi.md#get_device_tools_n_slookup) | **GET** /device/tools/nslookup | +[**get_device_tools_netstat**](RealTimeMonitoringToolsApi.md#get_device_tools_netstat) | **GET** /device/tools/netstat | +[**get_device_tools_ss**](RealTimeMonitoringToolsApi.md#get_device_tools_ss) | **GET** /device/tools/ss | +[**get_real_timeinfo**](RealTimeMonitoringToolsApi.md#get_real_timeinfo) | **GET** /device/tools/realtimeinfo | +[**get_system_netfilter**](RealTimeMonitoringToolsApi.md#get_system_netfilter) | **GET** /device/tools/system-netfilter | + + +# **get_device_tools_n_slookup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tools_n_slookup(vpn, dns, device_id) + + + +Get device tool nslookup + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tools_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tools_api.RealTimeMonitoringToolsApi(api_client) + vpn = "0" # str | VPN + dns = "8.8.8.8" # str | DNS + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_tools_n_slookup(vpn, dns, device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_device_tools_n_slookup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vpn** | **str**| VPN | + **dns** | **str**| DNS | + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_tools_netstat** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tools_netstat(device_id) + + + +Get device tool net stat + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tools_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tools_api.RealTimeMonitoringToolsApi(api_client) + device_id = "deviceId_example" # str | Device Id + vpn = "0" # str | VPN (optional) + options = "options_example" # str | Options (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_tools_netstat(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_device_tools_netstat: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_tools_netstat(device_id, vpn=vpn, options=options) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_device_tools_netstat: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + **vpn** | **str**| VPN | [optional] + **options** | **str**| Options | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_tools_ss** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_tools_ss(device_id) + + + +Get device tool ss + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tools_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tools_api.RealTimeMonitoringToolsApi(api_client) + device_id = "deviceId_example" # str | Device Id + vpn = "0" # str | VPN (optional) + options = "options_example" # str | Options (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_tools_ss(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_device_tools_ss: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_device_tools_ss(device_id, vpn=vpn, options=options) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_device_tools_ss: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + **vpn** | **str**| VPN | [optional] + **options** | **str**| Options | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_real_timeinfo** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_real_timeinfo(device_id) + + + +Get hardware real time info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tools_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tools_api.RealTimeMonitoringToolsApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_real_timeinfo(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_real_timeinfo: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_system_netfilter** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_system_netfilter(device_id) + + + +Get system netfilter info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tools_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tools_api.RealTimeMonitoringToolsApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_system_netfilter(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringToolsApi->get_system_netfilter: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringTransportApi.md b/docs/RealTimeMonitoringTransportApi.md new file mode 100644 index 0000000..f0cce87 --- /dev/null +++ b/docs/RealTimeMonitoringTransportApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringTransportApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_transport_connection_list**](RealTimeMonitoringTransportApi.md#create_transport_connection_list) | **GET** /device/transport/connection | + + +# **create_transport_connection_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] create_transport_connection_list(device_id) + + + +Get transport connection list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_transport_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_transport_api.RealTimeMonitoringTransportApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_transport_connection_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTransportApi->create_transport_connection_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringTrustsecApi.md b/docs/RealTimeMonitoringTrustsecApi.md new file mode 100644 index 0000000..c3c2414 --- /dev/null +++ b/docs/RealTimeMonitoringTrustsecApi.md @@ -0,0 +1,629 @@ +# openapi_client.RealTimeMonitoringTrustsecApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_cts_pac**](RealTimeMonitoringTrustsecApi.md#get_cts_pac) | **GET** /device/ctsPac | +[**get_environment_data**](RealTimeMonitoringTrustsecApi.md#get_environment_data) | **GET** /device/environmentData | +[**get_radius_server**](RealTimeMonitoringTrustsecApi.md#get_radius_server) | **GET** /device/environmentData/radiusServer | +[**get_role_based_counters**](RealTimeMonitoringTrustsecApi.md#get_role_based_counters) | **GET** /device/roleBasedCounters | +[**get_role_based_ipv6_counters**](RealTimeMonitoringTrustsecApi.md#get_role_based_ipv6_counters) | **GET** /device/roleBasedIpv6Counters | +[**get_role_based_ipv6_permissions**](RealTimeMonitoringTrustsecApi.md#get_role_based_ipv6_permissions) | **GET** /device/roleBasedIpv6Permissions | +[**get_role_based_permissions**](RealTimeMonitoringTrustsecApi.md#get_role_based_permissions) | **GET** /device/roleBasedPermissions | +[**get_role_based_sgt_map**](RealTimeMonitoringTrustsecApi.md#get_role_based_sgt_map) | **GET** /device/roleBasedSgtMap | +[**get_sxp_connections**](RealTimeMonitoringTrustsecApi.md#get_sxp_connections) | **GET** /device/sxpConnections | + + +# **get_cts_pac** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cts_pac(device_id) + + + +get Cisco TrustSec PAC information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cts_pac(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_cts_pac: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_environment_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_environment_data(device_id) + + + +get Cisco TrustSec Environment Data information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_environment_data(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_environment_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_radius_server** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_radius_server(device_id) + + + +get Cisco TrustSec Environment Data Radius Server list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_radius_server(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_radius_server: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_role_based_counters** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_role_based_counters(device_id) + + + +get Cisco TrustSec Role Based Counters information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_role_based_counters(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_role_based_counters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_role_based_ipv6_counters** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_role_based_ipv6_counters(device_id) + + + +get Cisco TrustSec Role Based Ipv6 Counters information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_role_based_ipv6_counters(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_role_based_ipv6_counters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_role_based_ipv6_permissions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_role_based_ipv6_permissions(device_id) + + + +get Cisco TrustSec Role Based ipv6 Permissions information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_role_based_ipv6_permissions(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_role_based_ipv6_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_role_based_permissions** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_role_based_permissions(device_id) + + + +get Cisco TrustSec Role Based Permissions information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_role_based_permissions(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_role_based_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_role_based_sgt_map** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_role_based_sgt_map(device_id) + + + +get Cisco TrustSec Role Based SGT Map information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_role_based_sgt_map(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_role_based_sgt_map: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sxp_connections** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sxp_connections(device_id) + + + +get Cisco TrustSec SXP Connections information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_trustsec_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_trustsec_api.RealTimeMonitoringTrustsecApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sxp_connections(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTrustsecApi->get_sxp_connections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringTunnelApi.md b/docs/RealTimeMonitoringTunnelApi.md new file mode 100644 index 0000000..1eb6a3d --- /dev/null +++ b/docs/RealTimeMonitoringTunnelApi.md @@ -0,0 +1,422 @@ +# openapi_client.RealTimeMonitoringTunnelApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_bfd_statistics_list**](RealTimeMonitoringTunnelApi.md#create_bfd_statistics_list) | **GET** /device/tunnel/bfd_statistics | +[**create_fec_statistics**](RealTimeMonitoringTunnelApi.md#create_fec_statistics) | **GET** /device/tunnel/fec_statistics | +[**create_gre_keepalives_list**](RealTimeMonitoringTunnelApi.md#create_gre_keepalives_list) | **GET** /device/tunnel/gre-keepalives | +[**create_ipsec_statistics_list**](RealTimeMonitoringTunnelApi.md#create_ipsec_statistics_list) | **GET** /device/tunnel/ipsec_statistics | +[**create_packet_duplicate_statistics**](RealTimeMonitoringTunnelApi.md#create_packet_duplicate_statistics) | **GET** /device/tunnel/packet-duplicate | +[**create_statistics_list**](RealTimeMonitoringTunnelApi.md#create_statistics_list) | **GET** /device/tunnel/statistics | + + +# **create_bfd_statistics_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_bfd_statistics_list(device_id) + + + +Get tunnel BFD statistics all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tunnel_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tunnel_api.RealTimeMonitoringTunnelApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_bfd_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTunnelApi->create_bfd_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_fec_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_fec_statistics(device_id) + + + +Get tunnel fec statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tunnel_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tunnel_api.RealTimeMonitoringTunnelApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_fec_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTunnelApi->create_fec_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_gre_keepalives_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_gre_keepalives_list(device_id) + + + +Get GRE keep alive information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tunnel_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tunnel_api.RealTimeMonitoringTunnelApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_gre_keepalives_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTunnelApi->create_gre_keepalives_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_ipsec_statistics_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ipsec_statistics_list(device_id) + + + +Get tunnel IPSec statistics all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tunnel_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tunnel_api.RealTimeMonitoringTunnelApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ipsec_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTunnelApi->create_ipsec_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_packet_duplicate_statistics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_packet_duplicate_statistics(device_id) + + + +Get tunnel statistics packet duplication statistics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tunnel_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tunnel_api.RealTimeMonitoringTunnelApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_packet_duplicate_statistics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTunnelApi->create_packet_duplicate_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_statistics_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_statistics_list(device_id) + + + +Get tunnel statistics all devices + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_tunnel_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_tunnel_api.RealTimeMonitoringTunnelApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_statistics_list(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringTunnelApi->create_statistics_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringUTDApi.md b/docs/RealTimeMonitoringUTDApi.md new file mode 100644 index 0000000..496e4af --- /dev/null +++ b/docs/RealTimeMonitoringUTDApi.md @@ -0,0 +1,905 @@ +# openapi_client.RealTimeMonitoringUTDApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_signature_version_info**](RealTimeMonitoringUTDApi.md#get_signature_version_info) | **GET** /device/utd/signature/version/details | +[**get_utd_dataplane_config**](RealTimeMonitoringUTDApi.md#get_utd_dataplane_config) | **GET** /device/utd/dataplane-config | +[**get_utd_dataplane_global**](RealTimeMonitoringUTDApi.md#get_utd_dataplane_global) | **GET** /device/utd/dataplane-global | +[**get_utd_dataplane_stats**](RealTimeMonitoringUTDApi.md#get_utd_dataplane_stats) | **GET** /device/utd/dataplane-stats | +[**get_utd_dataplane_stats_summary**](RealTimeMonitoringUTDApi.md#get_utd_dataplane_stats_summary) | **GET** /device/utd/dataplane-stats-summary | +[**get_utd_engine_instance_status**](RealTimeMonitoringUTDApi.md#get_utd_engine_instance_status) | **GET** /device/utd/engine-instance-status | +[**get_utd_engine_status**](RealTimeMonitoringUTDApi.md#get_utd_engine_status) | **GET** /device/utd/engine-status | +[**get_utd_file_analysis_status**](RealTimeMonitoringUTDApi.md#get_utd_file_analysis_status) | **GET** /device/utd/file-analysis-status | +[**get_utd_file_reputation_status**](RealTimeMonitoringUTDApi.md#get_utd_file_reputation_status) | **GET** /device/utd/file-reputation-status | +[**get_utd_ips_update_status**](RealTimeMonitoringUTDApi.md#get_utd_ips_update_status) | **GET** /device/utd/ips-update-status | +[**get_utd_urlf_connection_status**](RealTimeMonitoringUTDApi.md#get_utd_urlf_connection_status) | **GET** /device/utd/urlf-con-status | +[**get_utd_urlf_update_status**](RealTimeMonitoringUTDApi.md#get_utd_urlf_update_status) | **GET** /device/utd/urlf-update-status | +[**get_utd_version_status**](RealTimeMonitoringUTDApi.md#get_utd_version_status) | **GET** /device/utd/version-status | + + +# **get_signature_version_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_signature_version_info(device_id) + + + +Get UTD Signature version information from Device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_signature_version_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_signature_version_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_dataplane_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_dataplane_config(device_id) + + + +Get data plane config from Device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_dataplane_config(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_dataplane_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_dataplane_global** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_dataplane_global(device_id) + + + +Get data plane global from Device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_dataplane_global(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_dataplane_global: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_dataplane_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_dataplane_stats(device_id) + + + +Get data plane stats from Device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_dataplane_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_dataplane_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_dataplane_stats_summary** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_dataplane_stats_summary(device_id) + + + +Get data plane stats summary + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_dataplane_stats_summary(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_dataplane_stats_summary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_engine_instance_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_engine_instance_status(device_id) + + + +Get UTD engine instance status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_engine_instance_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_engine_instance_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_engine_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_engine_status(device_id) + + + +Get UTD engine status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_engine_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_engine_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_file_analysis_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_file_analysis_status(device_id) + + + +Get UTD file analysis status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_file_analysis_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_file_analysis_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_file_reputation_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_file_reputation_status(device_id) + + + +Get UTD file reputation status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_file_reputation_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_file_reputation_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_ips_update_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_ips_update_status(device_id) + + + +Get UTD IPS update status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_ips_update_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_ips_update_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_urlf_connection_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_urlf_connection_status(device_id) + + + +Get UTD URLF Connection status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_urlf_connection_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_urlf_connection_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_urlf_update_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_urlf_update_status(device_id) + + + +Get UTD URLF update status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_urlf_update_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_urlf_update_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_utd_version_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_utd_version_status(device_id) + + + +Get UTD version status from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_utd_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_utd_api.RealTimeMonitoringUTDApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_utd_version_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUTDApi->get_utd_version_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringUcseApi.md b/docs/RealTimeMonitoringUcseApi.md new file mode 100644 index 0000000..126d167 --- /dev/null +++ b/docs/RealTimeMonitoringUcseApi.md @@ -0,0 +1,91 @@ +# openapi_client.RealTimeMonitoringUcseApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_ucse_stats**](RealTimeMonitoringUcseApi.md#create_ucse_stats) | **GET** /device/ucse/stats | + + +# **create_ucse_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ucse_stats(device_id) + + + +Get UCSE stats entry from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_ucse_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_ucse_api.RealTimeMonitoringUcseApi(api_client) + device_id = "00r252U250?250" # str | Device IP + remote_tloc_address = "remote-tloc-address_example" # str | Remote TLOC address (optional) + remote_tloc_color = "default" # str | Remote tloc color (optional) + local_tloc_color = "default" # str | Local tloc color (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ucse_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUcseApi->create_ucse_stats: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_ucse_stats(device_id, remote_tloc_address=remote_tloc_address, remote_tloc_color=remote_tloc_color, local_tloc_color=local_tloc_color) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUcseApi->create_ucse_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + **remote_tloc_address** | **str**| Remote TLOC address | [optional] + **remote_tloc_color** | **str**| Remote tloc color | [optional] + **local_tloc_color** | **str**| Local tloc color | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringUmbrellaApi.md b/docs/RealTimeMonitoringUmbrellaApi.md new file mode 100644 index 0000000..1ebc385 --- /dev/null +++ b/docs/RealTimeMonitoringUmbrellaApi.md @@ -0,0 +1,353 @@ +# openapi_client.RealTimeMonitoringUmbrellaApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_umbrella_config**](RealTimeMonitoringUmbrellaApi.md#get_umbrella_config) | **GET** /device/umbrella/umbrella-config | +[**get_umbrella_dev_reg**](RealTimeMonitoringUmbrellaApi.md#get_umbrella_dev_reg) | **GET** /device/umbrella/device-registration | +[**get_umbrella_dns_crypt**](RealTimeMonitoringUmbrellaApi.md#get_umbrella_dns_crypt) | **GET** /device/umbrella/dnscrypt | +[**get_umbrella_dp_stats**](RealTimeMonitoringUmbrellaApi.md#get_umbrella_dp_stats) | **GET** /device/umbrella/dp-stats | +[**get_umbrella_overview**](RealTimeMonitoringUmbrellaApi.md#get_umbrella_overview) | **GET** /device/umbrella/overview | + + +# **get_umbrella_config** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_umbrella_config(device_id) + + + +Get Umbrella configuration from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_umbrella_api.RealTimeMonitoringUmbrellaApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_umbrella_config(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUmbrellaApi->get_umbrella_config: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_umbrella_dev_reg** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_umbrella_dev_reg(device_id) + + + +Get Umbrella device registration from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_umbrella_api.RealTimeMonitoringUmbrellaApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_umbrella_dev_reg(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUmbrellaApi->get_umbrella_dev_reg: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_umbrella_dns_crypt** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_umbrella_dns_crypt(device_id) + + + +Get Umbrella DNScrypt information from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_umbrella_api.RealTimeMonitoringUmbrellaApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_umbrella_dns_crypt(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUmbrellaApi->get_umbrella_dns_crypt: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_umbrella_dp_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_umbrella_dp_stats(device_id) + + + +Get Umbrella dp-stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_umbrella_api.RealTimeMonitoringUmbrellaApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_umbrella_dp_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUmbrellaApi->get_umbrella_dp_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_umbrella_overview** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_umbrella_overview(device_id) + + + +Get Umbrella overview from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_umbrella_api.RealTimeMonitoringUmbrellaApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_umbrella_overview(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringUmbrellaApi->get_umbrella_overview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringVDSLServiceApi.md b/docs/RealTimeMonitoringVDSLServiceApi.md new file mode 100644 index 0000000..8209ebe --- /dev/null +++ b/docs/RealTimeMonitoringVDSLServiceApi.md @@ -0,0 +1,491 @@ +# openapi_client.RealTimeMonitoringVDSLServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_co_line_specific_stats**](RealTimeMonitoringVDSLServiceApi.md#get_co_line_specific_stats) | **GET** /device/vdslService/coLineSpecificStats | +[**get_co_stats**](RealTimeMonitoringVDSLServiceApi.md#get_co_stats) | **GET** /device/vdslService/coStats | +[**get_cpe_line_specific_stats**](RealTimeMonitoringVDSLServiceApi.md#get_cpe_line_specific_stats) | **GET** /device/vdslService/cpeLineSpecificStats | +[**get_cpe_stats**](RealTimeMonitoringVDSLServiceApi.md#get_cpe_stats) | **GET** /device/vdslService/cpeStats | +[**get_line_bonding_stats**](RealTimeMonitoringVDSLServiceApi.md#get_line_bonding_stats) | **GET** /device/vdslService/lineBondingStats | +[**get_line_specific_stats**](RealTimeMonitoringVDSLServiceApi.md#get_line_specific_stats) | **GET** /device/vdslService/lineSpecificStats | +[**get_vdsl_info**](RealTimeMonitoringVDSLServiceApi.md#get_vdsl_info) | **GET** /device/vdslService/vdslInfo | + + +# **get_co_line_specific_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_co_line_specific_stats(device_id) + + + +Get VDSL service line bonding stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_co_line_specific_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_co_line_specific_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_co_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_co_stats(device_id) + + + +Get CO stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_co_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_co_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cpe_line_specific_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cpe_line_specific_stats(device_id) + + + +Get VDSL service CPE line specific stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cpe_line_specific_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_cpe_line_specific_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cpe_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cpe_stats(device_id) + + + +Get CPE stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cpe_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_cpe_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_line_bonding_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_line_bonding_stats(device_id) + + + +Get VDSL service line bonding stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_line_bonding_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_line_bonding_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_line_specific_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_line_specific_stats(device_id) + + + +Get VDSL service line specific stats from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_line_specific_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_line_specific_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vdsl_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vdsl_info(device_id) + + + +Get VDSL info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vdsl_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vdsl_service_api.RealTimeMonitoringVDSLServiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vdsl_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVDSLServiceApi->get_vdsl_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringVMApi.md b/docs/RealTimeMonitoringVMApi.md new file mode 100644 index 0000000..be88026 --- /dev/null +++ b/docs/RealTimeMonitoringVMApi.md @@ -0,0 +1,284 @@ +# openapi_client.RealTimeMonitoringVMApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_cloud_dock_vm_lifecycle_nics**](RealTimeMonitoringVMApi.md#get_cloud_dock_vm_lifecycle_nics) | **GET** /device/vm/notifications | +[**get_vbranch_vm_lifecycle**](RealTimeMonitoringVMApi.md#get_vbranch_vm_lifecycle) | **GET** /device/vm/oper/state | +[**get_vbranch_vm_lifecycle_nics**](RealTimeMonitoringVMApi.md#get_vbranch_vm_lifecycle_nics) | **GET** /device/vm/nics | +[**get_vm_life_cycle_state**](RealTimeMonitoringVMApi.md#get_vm_life_cycle_state) | **GET** /device/vm/state | + + +# **get_cloud_dock_vm_lifecycle_nics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_dock_vm_lifecycle_nics(user_group) + + + +Get CloudDock vm lifecycle state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vm_api.RealTimeMonitoringVMApi(api_client) + user_group = "00r252U250?250" # str | userGroup Name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_cloud_dock_vm_lifecycle_nics(user_group) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVMApi->get_cloud_dock_vm_lifecycle_nics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_group** | **str**| userGroup Name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vbranch_vm_lifecycle** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vbranch_vm_lifecycle(device_id) + + + +Get vbranch vm lifecycle state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vm_api.RealTimeMonitoringVMApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vbranch_vm_lifecycle(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVMApi->get_vbranch_vm_lifecycle: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vbranch_vm_lifecycle_nics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vbranch_vm_lifecycle_nics(device_id) + + + +Get vbranch vm lifecycle state (NIC) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vm_api.RealTimeMonitoringVMApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vbranch_vm_lifecycle_nics(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVMApi->get_vbranch_vm_lifecycle_nics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vm_life_cycle_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vm_life_cycle_state(device_id) + + + +Get vm lifecycle state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vm_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vm_api.RealTimeMonitoringVMApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vm_life_cycle_state(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVMApi->get_vm_life_cycle_state: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringVPNApi.md b/docs/RealTimeMonitoringVPNApi.md new file mode 100644 index 0000000..371d4c2 --- /dev/null +++ b/docs/RealTimeMonitoringVPNApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringVPNApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_vpn_instances**](RealTimeMonitoringVPNApi.md#get_vpn_instances) | **GET** /device/vpn | + + +# **get_vpn_instances** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_vpn_instances(device_id) + + + +Get VPN instance list from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vpn_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vpn_api.RealTimeMonitoringVPNApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vpn_instances(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVPNApi->get_vpn_instances: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringVRRPApi.md b/docs/RealTimeMonitoringVRRPApi.md new file mode 100644 index 0000000..ad114cd --- /dev/null +++ b/docs/RealTimeMonitoringVRRPApi.md @@ -0,0 +1,77 @@ +# openapi_client.RealTimeMonitoringVRRPApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_vrrp_interface**](RealTimeMonitoringVRRPApi.md#get_vrrp_interface) | **GET** /device/vrrp | + + +# **get_vrrp_interface** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_vrrp_interface(device_id) + + + +Get VRRP interface list from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_vrrp_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_vrrp_api.RealTimeMonitoringVRRPApi(api_client) + device_id = "169.254.10.10" # str | deviceId - Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_vrrp_interface(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVRRPApi->get_vrrp_interface: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| deviceId - Device IP | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringVoiceApi.md b/docs/RealTimeMonitoringVoiceApi.md new file mode 100644 index 0000000..aa11340 --- /dev/null +++ b/docs/RealTimeMonitoringVoiceApi.md @@ -0,0 +1,698 @@ +# openapi_client.RealTimeMonitoringVoiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_controller_t1e1_info_current15_min_stats**](RealTimeMonitoringVoiceApi.md#get_controller_t1e1_info_current15_min_stats) | **GET** /device/voicet1e1controllerinfo/current15minstats | +[**get_controller_t1e1_info_total_stats**](RealTimeMonitoringVoiceApi.md#get_controller_t1e1_info_total_stats) | **GET** /device/voicet1e1controllerinfo/totalstats | +[**get_dsp_active**](RealTimeMonitoringVoiceApi.md#get_dsp_active) | **GET** /device/voice/dspActive | +[**get_dsp_farm_profiles**](RealTimeMonitoringVoiceApi.md#get_dsp_farm_profiles) | **GET** /device/voice/profiles | +[**get_phone_info**](RealTimeMonitoringVoiceApi.md#get_phone_info) | **GET** /device/voice/phoneInfo | +[**get_sccp_ccm_groups**](RealTimeMonitoringVoiceApi.md#get_sccp_ccm_groups) | **GET** /device/voice/sccpCcmGroups | +[**get_sccp_connections**](RealTimeMonitoringVoiceApi.md#get_sccp_connections) | **GET** /device/voice/sccpConnections | +[**get_t1e1_isdn_status**](RealTimeMonitoringVoiceApi.md#get_t1e1_isdn_status) | **GET** /device/voiceisdninfo/isdnstatus | +[**get_voice_calls**](RealTimeMonitoringVoiceApi.md#get_voice_calls) | **GET** /device/voice/voiceCalls | +[**get_voip_calls**](RealTimeMonitoringVoiceApi.md#get_voip_calls) | **GET** /device/voice/voipCalls | + + +# **get_controller_t1e1_info_current15_min_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_controller_t1e1_info_current15_min_stats(device_id) + + + +Retrieve T1E1 controller last 15 min stats from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_controller_t1e1_info_current15_min_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_controller_t1e1_info_current15_min_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_controller_t1e1_info_total_stats** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_controller_t1e1_info_total_stats(device_id) + + + +Retrieve T1E1 controller total stats from device (Real Time) + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_controller_t1e1_info_total_stats(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_controller_t1e1_info_total_stats: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dsp_active** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dsp_active(device_id) + + + +Get DSPFarm Active DSP info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dsp_active(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_dsp_active: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dsp_farm_profiles** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dsp_farm_profiles(device_id) + + + +Get DSPFarm Profiles info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_dsp_farm_profiles(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_dsp_farm_profiles: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_phone_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_phone_info(device_id) + + + +Get phone registration info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_phone_info(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_phone_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sccp_ccm_groups** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sccp_ccm_groups(device_id) + + + +Get DSPFarm SCCP CCM Groups info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sccp_ccm_groups(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_sccp_ccm_groups: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sccp_connections** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sccp_connections(device_id) + + + +Get DSPFarm SCCP Connections info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_sccp_connections(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_sccp_connections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_t1e1_isdn_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_t1e1_isdn_status(device_id) + + + +Retrieve Voice ISDN Status from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_t1e1_isdn_status(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_t1e1_isdn_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_voice_calls** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_voice_calls(device_id) + + + +Get voice call info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_voice_calls(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_voice_calls: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_voip_calls** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_voip_calls(device_id) + + + +Get VOIP call info from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_voice_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client) + device_id = "deviceId_example" # str | Device Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_voip_calls(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringVoiceApi->get_voip_calls: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringWLANApi.md b/docs/RealTimeMonitoringWLANApi.md new file mode 100644 index 0000000..54f0be9 --- /dev/null +++ b/docs/RealTimeMonitoringWLANApi.md @@ -0,0 +1,284 @@ +# openapi_client.RealTimeMonitoringWLANApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_wlan_clients**](RealTimeMonitoringWLANApi.md#get_wlan_clients) | **GET** /device/wlan/clients | +[**get_wlan_interfaces**](RealTimeMonitoringWLANApi.md#get_wlan_interfaces) | **GET** /device/wlan/interfaces | +[**get_wlan_radios**](RealTimeMonitoringWLANApi.md#get_wlan_radios) | **GET** /device/wlan/radios | +[**get_wlan_radius**](RealTimeMonitoringWLANApi.md#get_wlan_radius) | **GET** /device/wlan/radius | + + +# **get_wlan_clients** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wlan_clients(device_id) + + + +Get WLAN client from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wlan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wlan_api.RealTimeMonitoringWLANApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wlan_clients(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWLANApi->get_wlan_clients: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wlan_interfaces** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wlan_interfaces(device_id) + + + +Get WLAN interface from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wlan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wlan_api.RealTimeMonitoringWLANApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wlan_interfaces(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWLANApi->get_wlan_interfaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wlan_radios** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wlan_radios(device_id) + + + +Get WLAN Radios from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wlan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wlan_api.RealTimeMonitoringWLANApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wlan_radios(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWLANApi->get_wlan_radios: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wlan_radius** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wlan_radius(device_id) + + + +Get WLAN RADIUS authentication from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wlan_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wlan_api.RealTimeMonitoringWLANApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wlan_radius(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWLANApi->get_wlan_radius: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RealTimeMonitoringWirelessApi.md b/docs/RealTimeMonitoringWirelessApi.md new file mode 100644 index 0000000..bd12a2a --- /dev/null +++ b/docs/RealTimeMonitoringWirelessApi.md @@ -0,0 +1,215 @@ +# openapi_client.RealTimeMonitoringWirelessApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_wireless_clients**](RealTimeMonitoringWirelessApi.md#get_wireless_clients) | **GET** /device/wireless/client | +[**get_wireless_radios**](RealTimeMonitoringWirelessApi.md#get_wireless_radios) | **GET** /device/wireless/radio | +[**get_wireless_ssid**](RealTimeMonitoringWirelessApi.md#get_wireless_ssid) | **GET** /device/wireless/ssid | + + +# **get_wireless_clients** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wireless_clients(device_id) + + + +Get wireless clients from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wireless_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wireless_api.RealTimeMonitoringWirelessApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wireless_clients(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWirelessApi->get_wireless_clients: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wireless_radios** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wireless_radios(device_id) + + + +Get wireless Radios from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wireless_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wireless_api.RealTimeMonitoringWirelessApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wireless_radios(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWirelessApi->get_wireless_radios: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_wireless_ssid** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_wireless_ssid(device_id) + + + +Get wireless SSID from device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import real_time_monitoring_wireless_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = real_time_monitoring_wireless_api.RealTimeMonitoringWirelessApi(api_client) + device_id = "00r252U250?250" # str | Device IP + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_wireless_ssid(device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling RealTimeMonitoringWirelessApi->get_wireless_ssid: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| Device IP | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ResourceGroup.md b/docs/ResourceGroup.md new file mode 100644 index 0000000..897067f --- /dev/null +++ b/docs/ResourceGroup.md @@ -0,0 +1,19 @@ +# ResourceGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**desc** | **str** | | [optional] +**device_ips** | **[str]** | | [optional] +**device_ips** | **[str]** | | [optional] +**id** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] +**mgmt_sytem_ips_map** | **{str: (str,)}** | | [optional] +**name** | **str** | | [optional] +**site_ids** | **[int]** | | [optional] +**uuid_sytem_ips_map** | **{str: (str,)}** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ResourcePoolApi.md b/docs/ResourcePoolApi.md new file mode 100644 index 0000000..01d84e7 --- /dev/null +++ b/docs/ResourcePoolApi.md @@ -0,0 +1,218 @@ +# openapi_client.ResourcePoolApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_resources**](ResourcePoolApi.md#create_resources) | **PUT** /resourcepool/resource/vpn | +[**delete_resources**](ResourcePoolApi.md#delete_resources) | **DELETE** /resourcepool/resource/vpn | +[**get_resources**](ResourcePoolApi.md#get_resources) | **GET** /resourcepool/resource/vpn | + + +# **create_resources** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_resources() + + + +Create Vpn resource pool and return tenant device vpn + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import resource_pool_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = resource_pool_api.ResourcePoolApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | create resources from resource pool (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_resources(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ResourcePoolApi->create_resources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| create resources from resource pool | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_resources** +> delete_resources(tenant_id, tenant_vpn) + + + +Delete tenant device vpn and release the resource + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import resource_pool_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = resource_pool_api.ResourcePoolApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + tenant_vpn = 1 # int | Tenant Vpn Number + + # example passing only required values which don't have defaults set + try: + api_instance.delete_resources(tenant_id, tenant_vpn) + except openapi_client.ApiException as e: + print("Exception when calling ResourcePoolApi->delete_resources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **tenant_vpn** | **int**| Tenant Vpn Number | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_resources** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_resources(tenant_id, tenant_vpn) + + + +Get tenant device vpn resource + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import resource_pool_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = resource_pool_api.ResourcePoolApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + tenant_vpn = 1 # int | Tenant Vpn Number + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_resources(tenant_id, tenant_vpn) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ResourcePoolApi->get_resources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **tenant_vpn** | **int**| Tenant Vpn Number | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SDAVCCloudConnectorApi.md b/docs/SDAVCCloudConnectorApi.md new file mode 100644 index 0000000..d42a5b5 --- /dev/null +++ b/docs/SDAVCCloudConnectorApi.md @@ -0,0 +1,288 @@ +# openapi_client.SDAVCCloudConnectorApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**disable_cloud_connector**](SDAVCCloudConnectorApi.md#disable_cloud_connector) | **PUT** /sdavc/cloudconnector | +[**enable_cloud_connector**](SDAVCCloudConnectorApi.md#enable_cloud_connector) | **POST** /sdavc/cloudconnector | +[**get_cloud_connector**](SDAVCCloudConnectorApi.md#get_cloud_connector) | **GET** /sdavc/cloudconnector | +[**get_cloud_connector_status**](SDAVCCloudConnectorApi.md#get_cloud_connector_status) | **GET** /sdavc/cloudconnector/status | + + +# **disable_cloud_connector** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} disable_cloud_connector() + + + +Disable SD_AVC Cloud Connector + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import sdavc_cloud_connector_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = sdavc_cloud_connector_api.SDAVCCloudConnectorApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.disable_cloud_connector(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SDAVCCloudConnectorApi->disable_cloud_connector: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable_cloud_connector** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_cloud_connector() + + + +Enable SD_AVC Cloud Connector + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import sdavc_cloud_connector_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = sdavc_cloud_connector_api.SDAVCCloudConnectorApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.enable_cloud_connector(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SDAVCCloudConnectorApi->enable_cloud_connector: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_connector** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_connector() + + + +Get SD_AVC Cloud Connector Config + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import sdavc_cloud_connector_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = sdavc_cloud_connector_api.SDAVCCloudConnectorApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_connector() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SDAVCCloudConnectorApi->get_cloud_connector: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_connector_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_connector_status() + + + +Get SD_AVC Cloud Connector Status + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import sdavc_cloud_connector_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = sdavc_cloud_connector_api.SDAVCCloudConnectorApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_connector_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SDAVCCloudConnectorApi->get_cloud_connector_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SDAVCDomainBasedAppRulesApi.md b/docs/SDAVCDomainBasedAppRulesApi.md new file mode 100644 index 0000000..315388f --- /dev/null +++ b/docs/SDAVCDomainBasedAppRulesApi.md @@ -0,0 +1,73 @@ +# openapi_client.SDAVCDomainBasedAppRulesApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_cloud_connector_domain_app_rules**](SDAVCDomainBasedAppRulesApi.md#get_cloud_connector_domain_app_rules) | **GET** /monitor/sdavccloudconnector/domain | + + +# **get_cloud_connector_domain_app_rules** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_connector_domain_app_rules() + + + +Get SD_AVC App Rules based on Domain + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import sdavc_domain_based_app_rules_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = sdavc_domain_based_app_rules_api.SDAVCDomainBasedAppRulesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_connector_domain_app_rules() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SDAVCDomainBasedAppRulesApi->get_cloud_connector_domain_app_rules: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SDAVCIPAddressBasedAppRulesApi.md b/docs/SDAVCIPAddressBasedAppRulesApi.md new file mode 100644 index 0000000..667b185 --- /dev/null +++ b/docs/SDAVCIPAddressBasedAppRulesApi.md @@ -0,0 +1,73 @@ +# openapi_client.SDAVCIPAddressBasedAppRulesApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_cloud_connector_ip_address_app_rules**](SDAVCIPAddressBasedAppRulesApi.md#get_cloud_connector_ip_address_app_rules) | **GET** /monitor/sdavccloudconnector/ipaddress | + + +# **get_cloud_connector_ip_address_app_rules** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_connector_ip_address_app_rules() + + + +Get SD_AVC App Rules based on IP Address + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import sdavcip_address_based_app_rules_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = sdavcip_address_based_app_rules_api.SDAVCIPAddressBasedAppRulesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_connector_ip_address_app_rules() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SDAVCIPAddressBasedAppRulesApi->get_cloud_connector_ip_address_app_rules: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SSIDConfig.md b/docs/SSIDConfig.md new file mode 100644 index 0000000..ce5eeb6 --- /dev/null +++ b/docs/SSIDConfig.md @@ -0,0 +1,16 @@ +# SSIDConfig + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**qos_settings** | **str** | | [optional] +**security_auth_type** | **str** | | [optional] +**ssid** | **str** | | [optional] +**visibility** | **bool** | | [optional] +**wpa_psk_key** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScheduledBackupRestoreApi.md b/docs/ScheduledBackupRestoreApi.md new file mode 100644 index 0000000..ffef02a --- /dev/null +++ b/docs/ScheduledBackupRestoreApi.md @@ -0,0 +1,771 @@ +# openapi_client.ScheduledBackupRestoreApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_schduled_backup**](ScheduledBackupRestoreApi.md#delete_schduled_backup) | **DELETE** /backup/backupinfo | +[**delete_schedule**](ScheduledBackupRestoreApi.md#delete_schedule) | **DELETE** /schedule/{schedulerId} | +[**download_backup_file**](ScheduledBackupRestoreApi.md#download_backup_file) | **GET** /backup/download/{path} | +[**export_backup**](ScheduledBackupRestoreApi.md#export_backup) | **POST** /backup/export | +[**get_local_backup_info**](ScheduledBackupRestoreApi.md#get_local_backup_info) | **GET** /backup/backupinfo/{localBackupInfoId} | +[**get_schedule_record_for_backup**](ScheduledBackupRestoreApi.md#get_schedule_record_for_backup) | **GET** /schedule/{schedulerId} | +[**import_scheduled_backup**](ScheduledBackupRestoreApi.md#import_scheduled_backup) | **POST** /restore/import | +[**list_backup**](ScheduledBackupRestoreApi.md#list_backup) | **GET** /backup/list | +[**list_schedules**](ScheduledBackupRestoreApi.md#list_schedules) | **GET** /schedule/list | +[**remote_import_backup**](ScheduledBackupRestoreApi.md#remote_import_backup) | **POST** /restore/remoteimport | +[**schedule_backup**](ScheduledBackupRestoreApi.md#schedule_backup) | **POST** /schedule/create | + + +# **delete_schduled_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_schduled_backup() + + + +Delete all or a specific backup file stored in vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + task_id = "taskId_example" # str | task id (optional) + backup_info_id = "backupInfoId_example" # str | Local Backup Info Id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_schduled_backup(task_id=task_id, backup_info_id=backup_info_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->delete_schduled_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **task_id** | **str**| task id | [optional] + **backup_info_id** | **str**| Local Backup Info Id | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_schedule** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_schedule(scheduler_id) + + + +Delete a schedule record for backup in vManage by scheduler id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + scheduler_id = "schedulerId_example" # str | scheduler id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_schedule(scheduler_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->delete_schedule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scheduler_id** | **str**| scheduler id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_backup_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download_backup_file(path) + + + +Download a Backup File that is already stored in vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + path = "path_example" # str | File path + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download_backup_file(path) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->download_backup_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| File path | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **export_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} export_backup() + + + +Trigger a backup of configuration database and statstics database and store it in vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | backup request information (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.export_backup(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->export_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| backup request information | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_local_backup_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_local_backup_info(local_backup_info_id) + + + +Get a localBackupInfo record by localBackupInfoId + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + local_backup_info_id = "localBackupInfoId_example" # str | localBackupInfo Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_local_backup_info(local_backup_info_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->get_local_backup_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **local_backup_info_id** | **str**| localBackupInfo Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_schedule_record_for_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_schedule_record_for_backup(scheduler_id) + + + +Get a schedule record for backup by scheduler id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + scheduler_id = "schedulerId_example" # str | scheduler id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_schedule_record_for_backup(scheduler_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->get_schedule_record_for_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scheduler_id** | **str**| scheduler id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **import_scheduled_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} import_scheduled_backup() + + + +Submit a previously backed up file and import the data and apply it to the configuraion database + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.import_scheduled_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->import_scheduled_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_backup() + + + +List all backup files of a tenant stored in vManage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + size = "size_example" # str | size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_backup(size=size) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->list_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **size** | **str**| size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_schedules** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_schedules() + + + +Get a schedule record for backup by scheduler id + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + limit = 100 # int | size (optional) if omitted the server will use the default value of 100 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_schedules(limit=limit) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->list_schedules: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int**| size | [optional] if omitted the server will use the default value of 100 + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remote_import_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} remote_import_backup() + + + +Remote import backup from a remote URL and import the data and apply it to the configuraion database + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.remote_import_backup(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->remote_import_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **schedule_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} schedule_backup() + + + +create backup scheduler config-db and statstics database with startDateTime and persist to config-db + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import scheduled_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = scheduled_backup_restore_api.ScheduledBackupRestoreApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | schedule request information (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.schedule_backup(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ScheduledBackupRestoreApi->schedule_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| schedule request information | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SchemaDefinition.md b/docs/SchemaDefinition.md new file mode 100644 index 0000000..4231660 --- /dev/null +++ b/docs/SchemaDefinition.md @@ -0,0 +1,18 @@ +# SchemaDefinition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count_of_uniqueu_vertex_and_edge_objects_created** | **int** | | [optional] +**count_of_vertex_and_edges_registered_with_device_data_manager** | **int** | | [optional] +**vertex_definitions_for_data_collection** | **[str]** | | [optional] +**vertex_definitions_found_in_db_with_data** | [**[VertexDefinition]**](VertexDefinition.md) | | [optional] +**vertex_definitions_found_in_db_without_data** | **[str]** | | [optional] +**vertex_definitions_not_found_in_db** | **[str]** | | [optional] +**vertex_definitions_not_registered_with_device_data_manager** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SecurityPolicy.md b/docs/SecurityPolicy.md new file mode 100644 index 0000000..6b969d2 --- /dev/null +++ b/docs/SecurityPolicy.md @@ -0,0 +1,22 @@ +# SecurityPolicy + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**policy_name** | **str** | | [optional] +**default_action** | **str** | | [optional] +**policy_rules** | [**[PolicyRule]**](PolicyRule.md) | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SecurityPolicyAllOf.md b/docs/SecurityPolicyAllOf.md new file mode 100644 index 0000000..d38229b --- /dev/null +++ b/docs/SecurityPolicyAllOf.md @@ -0,0 +1,14 @@ +# SecurityPolicyAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy_name** | **str** | | [optional] +**default_action** | **str** | | [optional] +**policy_rules** | [**[PolicyRule]**](PolicyRule.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SimSlotConfig.md b/docs/SimSlotConfig.md new file mode 100644 index 0000000..6f223a7 --- /dev/null +++ b/docs/SimSlotConfig.md @@ -0,0 +1,16 @@ +# SimSlotConfig + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attach_profile_id** | **int** | | +**profile_list** | [**[CellularProfile]**](CellularProfile.md) | | +**slot_number** | **int** | | +**carrier_name** | **str** | | [optional] +**data_profile_id_list** | **[int]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SiteHealth.md b/docs/SiteHealth.md new file mode 100644 index 0000000..c9105fc --- /dev/null +++ b/docs/SiteHealth.md @@ -0,0 +1,14 @@ +# SiteHealth + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**full_connectivity** | **int** | | [optional] +**no_connectivity** | **int** | | [optional] +**partial_connectivity** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SiteToSiteVpn.md b/docs/SiteToSiteVpn.md new file mode 100644 index 0000000..a6b2acd --- /dev/null +++ b/docs/SiteToSiteVpn.md @@ -0,0 +1,18 @@ +# SiteToSiteVpn + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**local_interface** | **str** | | +**local_private_subnet** | **str** | | +**pre_shared_secret** | **str** | | +**remote_private_subnets** | **str** | | +**remote_public_ip** | **str** | | +**name** | **str** | | [optional] +**tunnel_dns_address** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SmartAccountModel.md b/docs/SmartAccountModel.md new file mode 100644 index 0000000..89d5502 --- /dev/null +++ b/docs/SmartAccountModel.md @@ -0,0 +1,16 @@ +# SmartAccountModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**env** | **str** | | [optional] +**organization_name** | **str** | | [optional] +**password** | **str** | | [optional] +**username** | **str** | | [optional] +**validity_string** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SmartLicenseApi.md b/docs/SmartLicenseApi.md new file mode 100644 index 0000000..dbc3470 --- /dev/null +++ b/docs/SmartLicenseApi.md @@ -0,0 +1,587 @@ +# openapi_client.SmartLicenseApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**fetch_accounts**](SmartLicenseApi.md#fetch_accounts) | **GET** /smartLicensing/fetchAccounts | +[**fetch_reports**](SmartLicenseApi.md#fetch_reports) | **GET** /smartLicensing/fetchReportsForSa | +[**fetch_reports1**](SmartLicenseApi.md#fetch_reports1) | **GET** /smartLicensing/fetchAllSa | +[**get_settings**](SmartLicenseApi.md#get_settings) | **GET** /smartLicensing/getUserSettings | +[**sleauthenticate**](SmartLicenseApi.md#sleauthenticate) | **POST** /smartLicensing/authenticate | +[**sync_licenses**](SmartLicenseApi.md#sync_licenses) | **POST** /smartLicensing/syncLicenses | +[**sync_licenses1**](SmartLicenseApi.md#sync_licenses1) | **POST** /smartLicensing/removeSaVaSelection | +[**upload_ack**](SmartLicenseApi.md#upload_ack) | **POST** /smartLicensing/uploadAck | + + +# **fetch_accounts** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} fetch_accounts(mode) + + + +fetch sava for sle + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + mode = "mode_example" # str | mode + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.fetch_accounts(mode) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->fetch_accounts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.fetch_accounts(mode, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->fetch_accounts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mode** | **str**| mode | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fetch_reports** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} fetch_reports(sa_domain, sa_id) + + + +fetch reports offline for sle + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + sa_domain = "saDomain_example" # str | saDomain + sa_id = "saId_example" # str | saId + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.fetch_reports(sa_domain, sa_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->fetch_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.fetch_reports(sa_domain, sa_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->fetch_reports: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sa_domain** | **str**| saDomain | + **sa_id** | **str**| saId | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fetch_reports1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} fetch_reports1() + + + +fetch reports offline for sle + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.fetch_reports1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->fetch_reports1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_settings() + + + +get settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_settings() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->get_settings: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sleauthenticate** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sleauthenticate() + + + +authenticate user for sle + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.sleauthenticate(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->sleauthenticate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_licenses** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sync_licenses() + + + +get all licenses for sa/va + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + data = "data_example" # str | (optional) + name = open('/path/to/file', 'rb') # file_type | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.sync_licenses(data=data, name=name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->sync_licenses: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | **str**| | [optional] + **name** | **file_type**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_licenses1** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} sync_licenses1() + + + +get all licenses for sa/va + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Partner (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.sync_licenses1(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->sync_licenses1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Partner | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_ack** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} upload_ack() + + + +upload ack file for sa/va + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import smart_license_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = smart_license_api.SmartLicenseApi(api_client) + data = open('/path/to/file', 'rb') # file_type | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.upload_ack(data=data) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SmartLicenseApi->upload_ack: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | **file_type**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SoftwareUploadFileData.md b/docs/SoftwareUploadFileData.md new file mode 100644 index 0000000..1bd4759 --- /dev/null +++ b/docs/SoftwareUploadFileData.md @@ -0,0 +1,13 @@ +# SoftwareUploadFileData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**empty** | **bool** | | [optional] +**value_type** | **str** | | [optional] +**any string name** | [**GetO365PreferredPathFromVAnalyticsRequestValue**](GetO365PreferredPathFromVAnalyticsRequestValue.md) | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StatisticsProcessingCounters.md b/docs/StatisticsProcessingCounters.md new file mode 100644 index 0000000..9014602 --- /dev/null +++ b/docs/StatisticsProcessingCounters.md @@ -0,0 +1,12 @@ +# StatisticsProcessingCounters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**counters** | [**[StatsTypeProcessingCounters]**](StatsTypeProcessingCounters.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StatsTypeProcessingCounters.md b/docs/StatsTypeProcessingCounters.md new file mode 100644 index 0000000..89dc844 --- /dev/null +++ b/docs/StatsTypeProcessingCounters.md @@ -0,0 +1,17 @@ +# StatsTypeProcessingCounters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**compressed_size** | **int** | | [optional] +**files_number** | **int** | | [optional] +**processing_time** | **int** | | [optional] +**records_number** | **int** | | [optional] +**stats_type** | **str** | | [optional] +**uncompressed_size** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SystemCloudServiceApi.md b/docs/SystemCloudServiceApi.md new file mode 100644 index 0000000..a393608 --- /dev/null +++ b/docs/SystemCloudServiceApi.md @@ -0,0 +1,1337 @@ +# openapi_client.SystemCloudServiceApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_cloud_credentials**](SystemCloudServiceApi.md#add_cloud_credentials) | **POST** /cloudservices/credentials | +[**connect**](SystemCloudServiceApi.md#connect) | **GET** /cloudservices/connect | +[**delete_webex_data_centers**](SystemCloudServiceApi.md#delete_webex_data_centers) | **DELETE** /webex/datacenter | +[**entity_ownership_info**](SystemCloudServiceApi.md#entity_ownership_info) | **GET** /entityownership/tree | +[**get_access_tokenfor_device**](SystemCloudServiceApi.md#get_access_tokenfor_device) | **GET** /cloudservices/accesstoken | +[**get_azure_token**](SystemCloudServiceApi.md#get_azure_token) | **POST** /cloudservices/authtoken | +[**get_cloud_credentials**](SystemCloudServiceApi.md#get_cloud_credentials) | **GET** /cloudservices/credentials | +[**get_cloud_settings**](SystemCloudServiceApi.md#get_cloud_settings) | **GET** /dca/cloudservices | +[**get_device_code**](SystemCloudServiceApi.md#get_device_code) | **POST** /cloudservices/devicecode | +[**get_o365_preferred_path_from_v_analytics**](SystemCloudServiceApi.md#get_o365_preferred_path_from_v_analytics) | **POST** /cloudservices/m365/preferredpath | +[**get_otp**](SystemCloudServiceApi.md#get_otp) | **GET** /dca/cloudservices/otp | +[**get_telemetry_state**](SystemCloudServiceApi.md#get_telemetry_state) | **GET** /cloudservices/telemetry | +[**getv_analytics**](SystemCloudServiceApi.md#getv_analytics) | **POST** /dca/cloudservices/vanalytics | +[**is_staging**](SystemCloudServiceApi.md#is_staging) | **GET** /cloudservices/staging | +[**list_entity_ownership_info**](SystemCloudServiceApi.md#list_entity_ownership_info) | **GET** /entityownership/list | +[**opt_in**](SystemCloudServiceApi.md#opt_in) | **PUT** /cloudservices/telemetry/optin | +[**opt_out**](SystemCloudServiceApi.md#opt_out) | **DELETE** /cloudservices/telemetry/optout | +[**set_webex_data_centers_sync_status**](SystemCloudServiceApi.md#set_webex_data_centers_sync_status) | **PUT** /webex/datacenter/syncstatus | +[**update_webex_data_centers**](SystemCloudServiceApi.md#update_webex_data_centers) | **POST** /webex/datacenter/sync | +[**updatet_otp**](SystemCloudServiceApi.md#updatet_otp) | **PUT** /dca/cloudservices/otp | + + +# **add_cloud_credentials** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} add_cloud_credentials() + + + +Get cloud service settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_cloud_credentials(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->add_cloud_credentials: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **connect** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} connect() + + + +Telemetry Opt In + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.connect() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->connect: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_webex_data_centers** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_webex_data_centers() + + + +Delete webex data center data in DB + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete_webex_data_centers() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->delete_webex_data_centers: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **entity_ownership_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} entity_ownership_info() + + + +Entity ownership info grouped by buckets + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.entity_ownership_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->entity_ownership_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_access_tokenfor_device** +> get_access_tokenfor_device() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_access_tokenfor_device() + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_access_tokenfor_device: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_azure_token** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_azure_token() + + + +Get Azure token + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_azure_token(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_azure_token: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_credentials** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_credentials() + + + +Get cloud service credentials + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_credentials() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_cloud_credentials: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_cloud_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_cloud_settings() + + + +Get cloud service settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_cloud_settings() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_cloud_settings: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_code** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_code() + + + +Get Azure device code + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_device_code() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_device_code: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_o365_preferred_path_from_v_analytics** +> get_o365_preferred_path_from_v_analytics() + + + +Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_o365_preferred_path_from_v_analytics(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_o365_preferred_path_from_v_analytics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_otp** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_otp() + + + +Get cloud service OTP value + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_otp() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_otp: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_telemetry_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_telemetry_state() + + + +Get Telemetry state + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_telemetry_state() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->get_telemetry_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getv_analytics** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} getv_analytics() + + + +Get session from DCS for vAnalytics + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.getv_analytics(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->getv_analytics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **is_staging** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} is_staging() + + + +Check if testbed or production + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.is_staging() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->is_staging: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_entity_ownership_info** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_entity_ownership_info() + + + +List all entity ownership info + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_entity_ownership_info() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->list_entity_ownership_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **opt_in** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} opt_in() + + + +Telemetry Opt In + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.opt_in(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->opt_in: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **opt_out** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} opt_out() + + + +Telemetry Opt Out + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.opt_out(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->opt_out: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_webex_data_centers_sync_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} set_webex_data_centers_sync_status() + + + +Set webex data center sync needed to false + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.set_webex_data_centers_sync_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->set_webex_data_centers_sync_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_webex_data_centers** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_webex_data_centers() + + + +TEMP-Update webex data center data in DB with data from Webex API + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.update_webex_data_centers() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->update_webex_data_centers: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatet_otp** +> updatet_otp() + + + +Update cloud service OTP value + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_api.SystemCloudServiceApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Cloud service OTP value (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.updatet_otp(body=body) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceApi->updatet_otp: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Cloud service OTP value | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/octet-stream + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SystemCloudServiceWebexApi.md b/docs/SystemCloudServiceWebexApi.md new file mode 100644 index 0000000..44ea9a7 --- /dev/null +++ b/docs/SystemCloudServiceWebexApi.md @@ -0,0 +1,143 @@ +# openapi_client.SystemCloudServiceWebexApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_webex_data_centers**](SystemCloudServiceWebexApi.md#get_webex_data_centers) | **POST** /webex/datacenter | +[**get_webex_data_centers_sync_status**](SystemCloudServiceWebexApi.md#get_webex_data_centers_sync_status) | **GET** /webex/datacenter/syncstatus | + + +# **get_webex_data_centers** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_webex_data_centers() + + + +TEMP-Insert webex data center details manually for test setup + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_webex_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_webex_api.SystemCloudServiceWebexApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_webex_data_centers(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceWebexApi->get_webex_data_centers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_webex_data_centers_sync_status** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_webex_data_centers_sync_status() + + + +Get webex data center sync status from DB + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_cloud_service_webex_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_cloud_service_webex_api.SystemCloudServiceWebexApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_webex_data_centers_sync_status() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemCloudServiceWebexApi->get_webex_data_centers_sync_status: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SystemContainerApi.md b/docs/SystemContainerApi.md new file mode 100644 index 0000000..22fabe6 --- /dev/null +++ b/docs/SystemContainerApi.md @@ -0,0 +1,599 @@ +# openapi_client.SystemContainerApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activate_container**](SystemContainerApi.md#activate_container) | **POST** /sdavc/task/{taskId} | +[**activate_container_on_remote_host**](SystemContainerApi.md#activate_container_on_remote_host) | **POST** /container-manager/activate/{containerName} | +[**de_activate_container**](SystemContainerApi.md#de_activate_container) | **POST** /container-manager/deactivate/{containerName} | +[**does_valid_image_exist**](SystemContainerApi.md#does_valid_image_exist) | **GET** /container-manager/doesValidImageExist/{containerName} | +[**get_container_inspect_data**](SystemContainerApi.md#get_container_inspect_data) | **GET** /container-manager/inspect/{containerName} | +[**get_container_settings**](SystemContainerApi.md#get_container_settings) | **GET** /container-manager/settings/{containerName} | +[**get_custom_app**](SystemContainerApi.md#get_custom_app) | **GET** /sdavc/customapps | +[**test_load_balancer**](SystemContainerApi.md#test_load_balancer) | **POST** /sdavc/test | + + +# **activate_container** +> activate_container(task_id) + + + +Activate container + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + task_id = "taskId_example" # str | Task Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Container task config (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.activate_container(task_id) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->activate_container: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.activate_container(task_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->activate_container: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **task_id** | **str**| Task Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Container task config | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **activate_container_on_remote_host** +> activate_container_on_remote_host(container_name) + + + +Activate container on remote host + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + container_name = "containerName_example" # str | Container name + url = "url_example" # str | Container image URL (optional) + host_ip = "hostIp_example" # str | Container host IP (optional) + checksum = "checksum_example" # str | Container image checksum (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.activate_container_on_remote_host(container_name) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->activate_container_on_remote_host: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.activate_container_on_remote_host(container_name, url=url, host_ip=host_ip, checksum=checksum) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->activate_container_on_remote_host: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **container_name** | **str**| Container name | + **url** | **str**| Container image URL | [optional] + **host_ip** | **str**| Container host IP | [optional] + **checksum** | **str**| Container image checksum | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **de_activate_container** +> de_activate_container(container_name) + + + +Deactivate container on remote host + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + container_name = "containerName_example" # str | Container name + host_ip = "hostIp_example" # str | Container host IP (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.de_activate_container(container_name) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->de_activate_container: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.de_activate_container(container_name, host_ip=host_ip) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->de_activate_container: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **container_name** | **str**| Container name | + **host_ip** | **str**| Container host IP | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **does_valid_image_exist** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} does_valid_image_exist(container_name) + + + +Get container image checksum + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + container_name = "containerName_example" # str | Container name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.does_valid_image_exist(container_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->does_valid_image_exist: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **container_name** | **str**| Container name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_container_inspect_data** +> str get_container_inspect_data(container_name) + + + +Get container inspect data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + container_name = "containerName_example" # str | Container name + host_ip = "hostIp_example" # str | Container host IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_container_inspect_data(container_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->get_container_inspect_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_container_inspect_data(container_name, host_ip=host_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->get_container_inspect_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **container_name** | **str**| Container name | + **host_ip** | **str**| Container host IP | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_container_settings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_container_settings(container_name) + + + +Get container settings + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + container_name = "containerName_example" # str | Container name + host_ip = "hostIp_example" # str | Container host IP (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_container_settings(container_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->get_container_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_container_settings(container_name, host_ip=host_ip) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->get_container_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **container_name** | **str**| Container name | + **host_ip** | **str**| Container host IP | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_custom_app** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_custom_app() + + + +Displays the user-defined applications + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_custom_app() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->get_custom_app: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **test_load_balancer** +> test_load_balancer() + + + +Test SD_AVC load balancer + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_container_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_container_api.SystemContainerApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.test_load_balancer() + except openapi_client.ApiException as e: + print("Exception when calling SystemContainerApi->test_load_balancer: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SystemReverseProxyApi.md b/docs/SystemReverseProxyApi.md new file mode 100644 index 0000000..608b31f --- /dev/null +++ b/docs/SystemReverseProxyApi.md @@ -0,0 +1,154 @@ +# openapi_client.SystemReverseProxyApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_reverse_proxy_mappings**](SystemReverseProxyApi.md#create_reverse_proxy_mappings) | **POST** /system/reverseproxy/{uuid} | +[**get_reverse_proxy_mappings**](SystemReverseProxyApi.md#get_reverse_proxy_mappings) | **GET** /system/reverseproxy/{uuid} | + + +# **create_reverse_proxy_mappings** +> create_reverse_proxy_mappings(uuid) + + + +Create reverse proxy IP/Port mappings for controller + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_reverse_proxy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_reverse_proxy_api.SystemReverseProxyApi(api_client) + uuid = "uuid_example" # str | Device uuid + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device reverse proxy mappings (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.create_reverse_proxy_mappings(uuid) + except openapi_client.ApiException as e: + print("Exception when calling SystemReverseProxyApi->create_reverse_proxy_mappings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_reverse_proxy_mappings(uuid, body=body) + except openapi_client.ApiException as e: + print("Exception when calling SystemReverseProxyApi->create_reverse_proxy_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device reverse proxy mappings | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reverse_proxy_mappings** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_reverse_proxy_mappings(uuid) + + + +Get reverse proxy IP/Port mappings for controller + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import system_reverse_proxy_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = system_reverse_proxy_api.SystemReverseProxyApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_reverse_proxy_mappings(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling SystemReverseProxyApi->get_reverse_proxy_mappings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Systems.md b/docs/Systems.md new file mode 100644 index 0000000..9e48e7e --- /dev/null +++ b/docs/Systems.md @@ -0,0 +1,25 @@ +# Systems + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**console_baud_rate** | **str** | | [optional] +**description** | **str** | | [optional] +**device_group** | **str** | | [optional] +**gps_latitude** | **str** | | [optional] +**gps_longitude** | **str** | | [optional] +**host_name** | **str** | | [optional] +**location** | **str** | | [optional] +**on_demand_tunnel** | **str** | | [optional] +**on_demand_tunnel_idle_timeout** | **int** | | [optional] +**port_hopping** | **str** | | [optional] +**port_offset** | **int** | | [optional] +**site_id** | **str** | | [optional] +**system_ip** | **str** | | [optional] +**time_zone** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TagApi.md b/docs/TagApi.md new file mode 100644 index 0000000..e3d3fe7 --- /dev/null +++ b/docs/TagApi.md @@ -0,0 +1,708 @@ +# openapi_client.TagApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**check_for_conflicts_when_tagging**](TagApi.md#check_for_conflicts_when_tagging) | **POST** /tag/conflictCheck | +[**check_rules**](TagApi.md#check_rules) | **POST** /tag/checkRules | +[**create_tag**](TagApi.md#create_tag) | **POST** /tag | +[**create_tag_rule**](TagApi.md#create_tag_rule) | **POST** /tag/tagRules | +[**delete_tag**](TagApi.md#delete_tag) | **POST** /tag/remove | +[**delete_tag_rule**](TagApi.md#delete_tag_rule) | **DELETE** /tag/tagRules/{tagRuleId} | +[**edit_tag_rule**](TagApi.md#edit_tag_rule) | **PUT** /tag/tagRules | +[**get_tag**](TagApi.md#get_tag) | **GET** /tag | +[**get_tag_rules**](TagApi.md#get_tag_rules) | **GET** /tag/tagRules/{configGroupId} | +[**reindex_tag**](TagApi.md#reindex_tag) | **GET** /tag/reindex | + + +# **check_for_conflicts_when_tagging** +> str check_for_conflicts_when_tagging() + + + +Check for conflicts when tagging + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.check_for_conflicts_when_tagging(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->check_for_conflicts_when_tagging: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **check_rules** +> str check_rules() + + + +This API will check if a rule can be created or not + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.check_rules(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->check_rules: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tag** +> str create_tag() + + + +Create a tag + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tag(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->create_tag: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tag_rule** +> str create_tag_rule() + + + +Create a tag rule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tag_rule(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->create_tag_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tag** +> delete_tag() + + + +Deletes multiple tags + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + get_o365_preferred_path_from_v_analytics_request = GetO365PreferredPathFromVAnalyticsRequest( + key=GetO365PreferredPathFromVAnalyticsRequestValue( + value_type="ARRAY", + ), + ) # GetO365PreferredPathFromVAnalyticsRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_tag(get_o365_preferred_path_from_v_analytics_request=get_o365_preferred_path_from_v_analytics_request) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->delete_tag: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **get_o365_preferred_path_from_v_analytics_request** | [**GetO365PreferredPathFromVAnalyticsRequest**](GetO365PreferredPathFromVAnalyticsRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tag_rule** +> delete_tag_rule(tag_rule_id, config_group_id) + + + +Delete a tag rule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + tag_rule_id = "tagRuleId_example" # str | tagRule Id + config_group_id = "configGroupId_example" # str | ConfigGroup Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.delete_tag_rule(tag_rule_id, config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->delete_tag_rule: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_tag_rule(tag_rule_id, config_group_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->delete_tag_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tag_rule_id** | **str**| tagRule Id | + **config_group_id** | **str**| ConfigGroup Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **edit_tag_rule** +> edit_tag_rule() + + + +Edit a tag rule + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.edit_tag_rule(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->edit_tag_rule: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tag** +> [TagRestfulResource] get_tag() + + + +Get all tags + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from openapi_client.model.tag_restful_resource import TagRestfulResource +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tag() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->get_tag: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**[TagRestfulResource]**](TagRestfulResource.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tag_rules** +> get_tag_rules(config_group_id) + + + +Get tag rules + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + config_group_id = "configGroupId_example" # str | ConfigGroup Id + + # example passing only required values which don't have defaults set + try: + api_instance.get_tag_rules(config_group_id) + except openapi_client.ApiException as e: + print("Exception when calling TagApi->get_tag_rules: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **config_group_id** | **str**| ConfigGroup Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reindex_tag** +> reindex_tag() + + + +Re-index device tags for search. Only call this API very occasionally if tag search is not returning expected results. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tag_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tag_api.TagApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.reindex_tag() + except openapi_client.ApiException as e: + print("Exception when calling TagApi->reindex_tag: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TagRestfulResource.md b/docs/TagRestfulResource.md new file mode 100644 index 0000000..28bb90e --- /dev/null +++ b/docs/TagRestfulResource.md @@ -0,0 +1,12 @@ +# TagRestfulResource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**all_groups** | [**SoftwareUploadFileData**](SoftwareUploadFileData.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TenantBackupRestoreApi.md b/docs/TenantBackupRestoreApi.md new file mode 100644 index 0000000..210de9d --- /dev/null +++ b/docs/TenantBackupRestoreApi.md @@ -0,0 +1,341 @@ +# openapi_client.TenantBackupRestoreApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_tenant_backup**](TenantBackupRestoreApi.md#delete_tenant_backup) | **DELETE** /tenantbackup/delete | +[**download_existing_backup_file**](TenantBackupRestoreApi.md#download_existing_backup_file) | **GET** /tenantbackup/download/{path} | +[**export_tenant_backup**](TenantBackupRestoreApi.md#export_tenant_backup) | **GET** /tenantbackup/export | +[**import_tenant_backup**](TenantBackupRestoreApi.md#import_tenant_backup) | **POST** /tenantbackup/import | +[**list_tenant_backup**](TenantBackupRestoreApi.md#list_tenant_backup) | **GET** /tenantbackup/list | + + +# **delete_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_tenant_backup(file_name) + + + +Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_backup_restore_api.TenantBackupRestoreApi(api_client) + file_name = "fileName_example" # str | File name + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_tenant_backup(file_name) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantBackupRestoreApi->delete_tenant_backup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file_name** | **str**| File name | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_existing_backup_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download_existing_backup_file(path) + + + +Download a Backup File that is already stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_backup_restore_api.TenantBackupRestoreApi(api_client) + path = "path_example" # str | File path + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download_existing_backup_file(path) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantBackupRestoreApi->download_existing_backup_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| File path | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **export_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} export_tenant_backup() + + + +Trigger a backup of configuration database and store it in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_backup_restore_api.TenantBackupRestoreApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.export_tenant_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantBackupRestoreApi->export_tenant_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **import_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} import_tenant_backup() + + + +Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_backup_restore_api.TenantBackupRestoreApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.import_tenant_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantBackupRestoreApi->import_tenant_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_tenant_backup** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_tenant_backup() + + + +List all backup files of a tenant stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_backup_restore_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_backup_restore_api.TenantBackupRestoreApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_tenant_backup() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantBackupRestoreApi->list_tenant_backup: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TenantManagementApi.md b/docs/TenantManagementApi.md new file mode 100644 index 0000000..ed0efec --- /dev/null +++ b/docs/TenantManagementApi.md @@ -0,0 +1,1124 @@ +# openapi_client.TenantManagementApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_tenant**](TenantManagementApi.md#create_tenant) | **POST** /tenant | +[**create_tenant_async**](TenantManagementApi.md#create_tenant_async) | **POST** /tenant/async | +[**create_tenant_async_bulk**](TenantManagementApi.md#create_tenant_async_bulk) | **POST** /tenant/bulk/async | +[**delete_tenant**](TenantManagementApi.md#delete_tenant) | **POST** /tenant/{tenantId}/delete | +[**delete_tenant_async_bulk**](TenantManagementApi.md#delete_tenant_async_bulk) | **DELETE** /tenant/bulk/async | +[**force_status_collection**](TenantManagementApi.md#force_status_collection) | **POST** /tenantstatus/force | +[**get_all_tenant_statuses**](TenantManagementApi.md#get_all_tenant_statuses) | **GET** /tenantstatus | +[**get_all_tenants**](TenantManagementApi.md#get_all_tenants) | **GET** /tenant | +[**get_tenant**](TenantManagementApi.md#get_tenant) | **GET** /tenant/{tenantId} | +[**get_tenant_hosting_capacity_onv_smarts**](TenantManagementApi.md#get_tenant_hosting_capacity_onv_smarts) | **GET** /tenant/vsmart/capacity | +[**get_tenantv_smart_mapping**](TenantManagementApi.md#get_tenantv_smart_mapping) | **GET** /tenant/vsmart | +[**switch_tenant**](TenantManagementApi.md#switch_tenant) | **POST** /tenant/{tenantId}/switch | +[**tenantv_smart_mt_migrate**](TenantManagementApi.md#tenantv_smart_mt_migrate) | **POST** /tenant/vsmart-mt/migrate | +[**update_tenant**](TenantManagementApi.md#update_tenant) | **PUT** /tenant/{tenantId} | +[**update_tenantv_smart_placement**](TenantManagementApi.md#update_tenantv_smart_placement) | **PUT** /tenant/{tenantId}/vsmart | +[**v_session_id**](TenantManagementApi.md#v_session_id) | **POST** /tenant/{tenantId}/vsessionid | + + +# **create_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tenant() + + + +Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tenant(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->create_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tenant_async** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tenant_async() + + + +Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tenant_async(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->create_tenant_async: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_tenant_async_bulk** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_tenant_async_bulk() + + + +Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_tenant_async_bulk(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->create_tenant_async_bulk: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tenant** +> delete_tenant(tenant_id) + + + +Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.delete_tenant(tenant_id) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->delete_tenant: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_tenant(tenant_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->delete_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tenant_async_bulk** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_tenant_async_bulk() + + + +Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.delete_tenant_async_bulk(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->delete_tenant_async_bulk: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **force_status_collection** +> force_status_collection() + + + +Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.force_status_collection() + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->force_status_collection: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_tenant_statuses** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_tenant_statuses() + + + +List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_all_tenant_statuses() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->get_all_tenant_statuses: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_tenants** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_all_tenants() + + + +Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + device_id = "deviceId_example" # str | List all tenants associated with a vSmart (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_all_tenants(device_id=device_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->get_all_tenants: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_id** | **str**| List all tenants associated with a vSmart | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_tenant(tenant_id) + + + +Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_tenant(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->get_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenant_hosting_capacity_onv_smarts** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_tenant_hosting_capacity_onv_smarts() + + + +Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenant_hosting_capacity_onv_smarts() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->get_tenant_hosting_capacity_onv_smarts: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tenantv_smart_mapping** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_tenantv_smart_mapping() + + + +Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_tenantv_smart_mapping() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->get_tenantv_smart_mapping: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **switch_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} switch_tenant(tenant_id) + + + +Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.switch_tenant(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->switch_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tenantv_smart_mt_migrate** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] tenantv_smart_mt_migrate() + + + +Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.tenantv_smart_mt_migrate() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->tenantv_smart_mt_migrate: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_tenant** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_tenant(tenant_id) + + + +Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_tenant(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->update_tenant: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_tenant(tenant_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->update_tenant: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_tenantv_smart_placement** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] update_tenantv_smart_placement(tenant_id) + + + +Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Tenant model (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_tenantv_smart_placement(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->update_tenantv_smart_placement: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_tenantv_smart_placement(tenant_id, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->update_tenantv_smart_placement: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Tenant model | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **v_session_id** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} v_session_id(tenant_id) + + + +Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_management_api.TenantManagementApi(api_client) + tenant_id = "tenantId_example" # str | Tenant Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.v_session_id(tenant_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantManagementApi->v_session_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenant_id** | **str**| Tenant Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TenantMigrationApi.md b/docs/TenantMigrationApi.md new file mode 100644 index 0000000..c05650f --- /dev/null +++ b/docs/TenantMigrationApi.md @@ -0,0 +1,430 @@ +# openapi_client.TenantMigrationApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**download_tenant_data**](TenantMigrationApi.md#download_tenant_data) | **GET** /tenantmigration/download/{path} | +[**export_tenant_data**](TenantMigrationApi.md#export_tenant_data) | **POST** /tenantmigration/export | +[**get_migration_token**](TenantMigrationApi.md#get_migration_token) | **GET** /tenantmigration/migrationToken | +[**import_tenant_data**](TenantMigrationApi.md#import_tenant_data) | **POST** /tenantmigration/import | +[**migrate_network**](TenantMigrationApi.md#migrate_network) | **POST** /tenantmigration/networkMigration | +[**re_trigger_network_migration**](TenantMigrationApi.md#re_trigger_network_migration) | **GET** /tenantmigration/networkMigration | + + +# **download_tenant_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download_tenant_data(path) + + + +Download tenant data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_migration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_migration_api.TenantMigrationApi(api_client) + path = "path_example" # str | File path + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download_tenant_data(path) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantMigrationApi->download_tenant_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| File path | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **export_tenant_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} export_tenant_data() + + + +Export tenant data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_migration_api +from openapi_client.model.create_tenant_model import CreateTenantModel +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_migration_api.TenantMigrationApi(api_client) + create_tenant_model = CreateTenantModel( + desc="desc_example", + getv_bond_address="getv_bond_address_example", + getv_smarts=[ + "getv_smarts_example", + ], + idp_metadata="idp_metadata_example", + mode="mode_example", + name="name_example", + old_idp_metadata="old_idp_metadata_example", + org_name="org_name_example", + sp_metadata="sp_metadata_example", + sub_domain="sub_domain_example", + wan_edge_forecast="wan_edge_forecast_example", + ) # CreateTenantModel | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.export_tenant_data(create_tenant_model=create_tenant_model) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantMigrationApi->export_tenant_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_tenant_model** | [**CreateTenantModel**](CreateTenantModel.md)| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_migration_token** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_migration_token(migration_id) + + + +Get migration token + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_migration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_migration_api.TenantMigrationApi(api_client) + migration_id = "migrationId_example" # str | Migration Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_migration_token(migration_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantMigrationApi->get_migration_token: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **migration_id** | **str**| Migration Id | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **import_tenant_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} import_tenant_data() + + + +Import tenant data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_migration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_migration_api.TenantMigrationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.import_tenant_data() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantMigrationApi->import_tenant_data: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **migrate_network** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} migrate_network() + + + +Migrate network + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_migration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_migration_api.TenantMigrationApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Network migration (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.migrate_network(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TenantMigrationApi->migrate_network: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Network migration | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **re_trigger_network_migration** +> re_trigger_network_migration() + + + +Re-trigger network migration + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tenant_migration_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tenant_migration_api.TenantMigrationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.re_trigger_network_migration() + except openapi_client.ApiException as e: + print("Exception when calling TenantMigrationApi->re_trigger_network_migration: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TenantStatus.md b/docs/TenantStatus.md new file mode 100644 index 0000000..28589d2 --- /dev/null +++ b/docs/TenantStatus.md @@ -0,0 +1,17 @@ +# TenantStatus + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**control_status** | [**ControlStatus**](ControlStatus.md) | | [optional] +**getv_edge_health** | [**VEdgeHealth**](VEdgeHealth.md) | | [optional] +**getv_smart_status** | [**VSmartStatus**](VSmartStatus.md) | | [optional] +**site_health** | [**SiteHealth**](SiteHealth.md) | | [optional] +**tenant_id** | **str** | | [optional] +**tenant_name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TenantStatusListModel.md b/docs/TenantStatusListModel.md new file mode 100644 index 0000000..c367f49 --- /dev/null +++ b/docs/TenantStatusListModel.md @@ -0,0 +1,13 @@ +# TenantStatusListModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[TenantStatus]**](TenantStatus.md) | | [optional] +**header** | [**Header**](Header.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ThreadPoolDefinition.md b/docs/ThreadPoolDefinition.md new file mode 100644 index 0000000..54cd5fa --- /dev/null +++ b/docs/ThreadPoolDefinition.md @@ -0,0 +1,15 @@ +# ThreadPoolDefinition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**consumer_class** | **str** | | [optional] +**consumer_method** | **str** | | [optional] +**thread_pool_name** | **str** | | [optional] +**thread_pool_size** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ThreadPoolsDefinition.md b/docs/ThreadPoolsDefinition.md new file mode 100644 index 0000000..22a8223 --- /dev/null +++ b/docs/ThreadPoolsDefinition.md @@ -0,0 +1,13 @@ +# ThreadPoolsDefinition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**thread_pools** | [**[ThreadPoolDefinition]**](ThreadPoolDefinition.md) | | [optional] +**total_thread_count** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ToolsTACCasesApi.md b/docs/ToolsTACCasesApi.md new file mode 100644 index 0000000..2a5a3e3 --- /dev/null +++ b/docs/ToolsTACCasesApi.md @@ -0,0 +1,342 @@ +# openapi_client.ToolsTACCasesApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_call**](ToolsTACCasesApi.md#delete_call) | **DELETE** /opentaccase/scmwidget | +[**get_call**](ToolsTACCasesApi.md#get_call) | **GET** /opentaccase/scmwidget | +[**get_client_id**](ToolsTACCasesApi.md#get_client_id) | **GET** /opentaccase/getClientID | +[**oauth_access**](ToolsTACCasesApi.md#oauth_access) | **GET** /opentaccase/authcode | +[**post_call**](ToolsTACCasesApi.md#post_call) | **POST** /opentaccase/scmwidget | + + +# **delete_call** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_call() + + + +Proxy API for SCM Widget + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tools_tac_cases_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tools_tac_cases_api.ToolsTACCasesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.delete_call() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ToolsTACCasesApi->delete_call: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_call** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_call() + + + +Proxy API for SCM Widget + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tools_tac_cases_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tools_tac_cases_api.ToolsTACCasesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_call() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ToolsTACCasesApi->get_call: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_client_id** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_client_id() + + + +Gets vManage Client ID + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tools_tac_cases_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tools_tac_cases_api.ToolsTACCasesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_client_id() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ToolsTACCasesApi->get_client_id: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **oauth_access** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] oauth_access() + + + +Gets Access Token for SSO Logjn + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tools_tac_cases_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tools_tac_cases_api.ToolsTACCasesApi(api_client) + code = "code_example" # str | (optional) + redirect = "redirect_example" # str | (optional) + is_refresh_needed = True # bool | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.oauth_access(code=code, redirect=redirect, is_refresh_needed=is_refresh_needed) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ToolsTACCasesApi->oauth_access: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **code** | **str**| | [optional] + **redirect** | **str**| | [optional] + **is_refresh_needed** | **bool**| | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_call** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] post_call() + + + +Prxoy API for SCM Widget + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import tools_tac_cases_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = tools_tac_cases_api.ToolsTACCasesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_call() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling ToolsTACCasesApi->post_call: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TroubleshootingToolsDeviceConnectivityApi.md b/docs/TroubleshootingToolsDeviceConnectivityApi.md new file mode 100644 index 0000000..574b132 --- /dev/null +++ b/docs/TroubleshootingToolsDeviceConnectivityApi.md @@ -0,0 +1,1444 @@ +# openapi_client.TroubleshootingToolsDeviceConnectivityApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**copy_admin_tech_on_device**](TroubleshootingToolsDeviceConnectivityApi.md#copy_admin_tech_on_device) | **POST** /device/tools/admintech/copy | +[**create_admin_tech**](TroubleshootingToolsDeviceConnectivityApi.md#create_admin_tech) | **POST** /device/tools/admintech | +[**delete_admin_tech_file**](TroubleshootingToolsDeviceConnectivityApi.md#delete_admin_tech_file) | **DELETE** /device/tools/admintech/{requestID} | +[**delete_admin_tech_on_device**](TroubleshootingToolsDeviceConnectivityApi.md#delete_admin_tech_on_device) | **DELETE** /device/tools/admintech/delete | +[**download_admin_tech_file**](TroubleshootingToolsDeviceConnectivityApi.md#download_admin_tech_file) | **GET** /device/tools/admintech/download/{filename} | +[**factory_reset**](TroubleshootingToolsDeviceConnectivityApi.md#factory_reset) | **POST** /device/tools/factoryreset | +[**get_control_connections**](TroubleshootingToolsDeviceConnectivityApi.md#get_control_connections) | **GET** /troubleshooting/control/{uuid} | +[**get_device_configuration**](TroubleshootingToolsDeviceConnectivityApi.md#get_device_configuration) | **GET** /troubleshooting/devicebringup | +[**get_in_progress_count**](TroubleshootingToolsDeviceConnectivityApi.md#get_in_progress_count) | **GET** /device/tools/admintechs/inprogress | +[**list_admin_techs**](TroubleshootingToolsDeviceConnectivityApi.md#list_admin_techs) | **GET** /device/tools/admintechs | +[**list_admin_techs_on_device**](TroubleshootingToolsDeviceConnectivityApi.md#list_admin_techs_on_device) | **POST** /device/tools/admintechlist | +[**nping_device**](TroubleshootingToolsDeviceConnectivityApi.md#nping_device) | **POST** /device/tools/nping/{deviceIP} | +[**ping_device**](TroubleshootingToolsDeviceConnectivityApi.md#ping_device) | **POST** /device/tools/ping/{deviceIP} | +[**process_interface_reset**](TroubleshootingToolsDeviceConnectivityApi.md#process_interface_reset) | **POST** /device/tools/reset/interface/{deviceIP} | +[**process_port_hop_color**](TroubleshootingToolsDeviceConnectivityApi.md#process_port_hop_color) | **POST** /device/tools/porthopcolor/{deviceIP} | +[**process_reset_user**](TroubleshootingToolsDeviceConnectivityApi.md#process_reset_user) | **POST** /device/tools/resetuser/{deviceIP} | +[**service_path**](TroubleshootingToolsDeviceConnectivityApi.md#service_path) | **POST** /device/tools/servicepath/{deviceIP} | +[**traceroute_device**](TroubleshootingToolsDeviceConnectivityApi.md#traceroute_device) | **POST** /device/tools/traceroute/{deviceIP} | +[**tunnel_path**](TroubleshootingToolsDeviceConnectivityApi.md#tunnel_path) | **POST** /device/tools/tunnelpath/{deviceIP} | +[**upload_admin_tech**](TroubleshootingToolsDeviceConnectivityApi.md#upload_admin_tech) | **POST** /device/tools/admintechs/upload | + + +# **copy_admin_tech_on_device** +> copy_admin_tech_on_device() + + + +copy admin tech logs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Admin tech copy request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.copy_admin_tech_on_device(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->copy_admin_tech_on_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Admin tech copy request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_admin_tech** +> create_admin_tech() + + + +Generate admin tech logs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Admin tech generation request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.create_admin_tech(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->create_admin_tech: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Admin tech generation request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_admin_tech_file** +> delete_admin_tech_file(request_id) + + + +Delete admin tech logs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + request_id = "requestID_example" # str | Request Id of admin tech generation request + + # example passing only required values which don't have defaults set + try: + api_instance.delete_admin_tech_file(request_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->delete_admin_tech_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_id** | **str**| Request Id of admin tech generation request | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_admin_tech_on_device** +> delete_admin_tech_on_device() + + + +delete admin tech logs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Admin tech copy request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_admin_tech_on_device(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->delete_admin_tech_on_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Admin tech copy request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_admin_tech_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} download_admin_tech_file(filename) + + + +Download admin tech logs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + filename = "filename_example" # str | Admin tech file + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.download_admin_tech_file(filename) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->download_admin_tech_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filename** | **str**| Admin tech file | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **factory_reset** +> factory_reset() + + + +Device factory reset + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device factory reset (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.factory_reset(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->factory_reset: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device factory reset | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_control_connections** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_control_connections(uuid) + + + +Troubleshoot control connections + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_control_connections(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->get_control_connections: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_configuration** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_device_configuration(uuid) + + + +Debug device bring up + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_device_configuration(uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->get_device_configuration: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_in_progress_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_in_progress_count() + + + +Get device admin-tech InProgressCount + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_in_progress_count() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->get_in_progress_count: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_admin_techs** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_admin_techs() + + + +Get device admin-tech information + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_admin_techs() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->list_admin_techs: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_admin_techs_on_device** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_admin_techs_on_device() + + + +List admin tech logs + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Admin tech listing request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_admin_techs_on_device(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->list_admin_techs_on_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Admin tech listing request | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **nping_device** +> nping_device(device_ip) + + + +NPing device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | NPing parameter (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.nping_device(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->nping_device: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.nping_device(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->nping_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| NPing parameter | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ping_device** +> ping_device(device_ip) + + + +Ping device + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Ping parameter (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.ping_device(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->ping_device: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.ping_device(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->ping_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Ping parameter | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_interface_reset** +> process_interface_reset(device_ip) + + + +Reset device interface + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device interface (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.process_interface_reset(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->process_interface_reset: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_interface_reset(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->process_interface_reset: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device interface | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_port_hop_color** +> process_port_hop_color(device_ip) + + + +Request port hop color + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device port hop color (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.process_port_hop_color(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->process_port_hop_color: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_port_hop_color(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->process_port_hop_color: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device port hop color | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_reset_user** +> process_reset_user(device_ip) + + + +Request reset user + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device user reset (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.process_reset_user(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->process_reset_user: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_reset_user(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->process_reset_user: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device user reset | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **service_path** +> service_path(device_ip) + + + +Service path + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Service path parameter (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.service_path(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->service_path: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.service_path(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->service_path: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Service path parameter | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **traceroute_device** +> traceroute_device(device_ip) + + + +Traceroute + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Traceroute parameter (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.traceroute_device(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->traceroute_device: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.traceroute_device(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->traceroute_device: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Traceroute parameter | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tunnel_path** +> tunnel_path(device_ip) + + + +TunnelPath + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + device_ip = "deviceIP_example" # str | Device IP + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | TunnelPath parameter (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.tunnel_path(device_ip) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->tunnel_path: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.tunnel_path(device_ip, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->tunnel_path: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_ip** | **str**| Device IP | + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| TunnelPath parameter | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_admin_tech** +> upload_admin_tech() + + + +upload admin tech to SR + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_connectivity_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_connectivity_api.TroubleshootingToolsDeviceConnectivityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Admin tech upload request (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.upload_admin_tech(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceConnectivityApi->upload_admin_tech: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Admin tech upload request | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TroubleshootingToolsDeviceGroupApi.md b/docs/TroubleshootingToolsDeviceGroupApi.md new file mode 100644 index 0000000..b886fe9 --- /dev/null +++ b/docs/TroubleshootingToolsDeviceGroupApi.md @@ -0,0 +1,377 @@ +# openapi_client.TroubleshootingToolsDeviceGroupApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list_device_group_list**](TroubleshootingToolsDeviceGroupApi.md#list_device_group_list) | **GET** /group | +[**list_device_groups**](TroubleshootingToolsDeviceGroupApi.md#list_device_groups) | **GET** /group/device | +[**list_group_devices**](TroubleshootingToolsDeviceGroupApi.md#list_group_devices) | **GET** /group/devices | +[**list_group_devices_for_map**](TroubleshootingToolsDeviceGroupApi.md#list_group_devices_for_map) | **GET** /group/map/devices | +[**list_group_links_for_map**](TroubleshootingToolsDeviceGroupApi.md#list_group_links_for_map) | **GET** /group/map/devices/links | + + +# **list_device_group_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_device_group_list() + + + +Retrieve device group list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_group_api.TroubleshootingToolsDeviceGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_device_group_list() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_device_group_list: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_device_groups** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_device_groups() + + + +Retrieve device groups + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_group_api.TroubleshootingToolsDeviceGroupApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_device_groups() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_device_groups: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_group_devices** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_group_devices(group_id) + + + +Retrieve devices in group + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_group_api +from openapi_client.model.vpnid import VPNID +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_group_api.TroubleshootingToolsDeviceGroupApi(api_client) + group_id = "groupId_example" # str | Group Id + ssh = False # bool | SSH (optional) if omitted the server will use the default value of False + vpn_id = [ + VPNID( + vpn="vpn_example", + ), + ] # [VPNID] | VPN Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_group_devices(group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_group_devices: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_group_devices(group_id, ssh=ssh, vpn_id=vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_group_devices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group_id** | **str**| Group Id | + **ssh** | **bool**| SSH | [optional] if omitted the server will use the default value of False + **vpn_id** | [**[VPNID]**](VPNID.md)| VPN Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_group_devices_for_map** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_group_devices_for_map(group_id) + + + +Retrieve group devices for map + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_group_api +from openapi_client.model.vpnid import VPNID +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_group_api.TroubleshootingToolsDeviceGroupApi(api_client) + group_id = "groupId_example" # str | Group Id + vpn_id = [ + VPNID( + vpn="vpn_example", + ), + ] # [VPNID] | VPN Id (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_group_devices_for_map(group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_group_devices_for_map: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_group_devices_for_map(group_id, vpn_id=vpn_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_group_devices_for_map: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group_id** | **str**| Group Id | + **vpn_id** | [**[VPNID]**](VPNID.md)| VPN Id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_group_links_for_map** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_group_links_for_map(group_id) + + + +Retrieve devices in group for map + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_device_group_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_device_group_api.TroubleshootingToolsDeviceGroupApi(api_client) + group_id = "groupId_example" # str | Group Id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_group_links_for_map(group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDeviceGroupApi->list_group_links_for_map: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group_id** | **str**| Group Id | + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TroubleshootingToolsDiagnosticsApi.md b/docs/TroubleshootingToolsDiagnosticsApi.md new file mode 100644 index 0000000..a4e3d18 --- /dev/null +++ b/docs/TroubleshootingToolsDiagnosticsApi.md @@ -0,0 +1,6074 @@ +# openapi_client.TroubleshootingToolsDiagnosticsApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**clear_session**](TroubleshootingToolsDiagnosticsApi.md#clear_session) | **GET** /stream/device/log/sessions/clear/{sessionId} | +[**disable_device_log**](TroubleshootingToolsDiagnosticsApi.md#disable_device_log) | **GET** /stream/device/log/disable/{sessionId} | +[**disable_packet_capture_session**](TroubleshootingToolsDiagnosticsApi.md#disable_packet_capture_session) | **GET** /stream/device/capture/disable/{sessionId} | +[**disable_speed_test_session**](TroubleshootingToolsDiagnosticsApi.md#disable_speed_test_session) | **GET** /stream/device/speed/disable/{sessionId} | +[**download_debug_log**](TroubleshootingToolsDiagnosticsApi.md#download_debug_log) | **GET** /stream/device/log/download/{sessionId} | +[**download_file**](TroubleshootingToolsDiagnosticsApi.md#download_file) | **GET** /stream/device/capture/download/{sessionId} | +[**force_stop_pcap_session**](TroubleshootingToolsDiagnosticsApi.md#force_stop_pcap_session) | **GET** /stream/device/capture/forcedisbale/{sessionId} | +[**form_post_packet_capture**](TroubleshootingToolsDiagnosticsApi.md#form_post_packet_capture) | **POST** /stream/device/capture/{deviceUUID}/{sessionId} | +[**get_agg_flow**](TroubleshootingToolsDiagnosticsApi.md#get_agg_flow) | **GET** /stream/device/nwpi/aggFlow | +[**get_aggregation_data_by_query27**](TroubleshootingToolsDiagnosticsApi.md#get_aggregation_data_by_query27) | **GET** /stream/device/nwpi/aggregation | +[**get_aggregation_data_by_query28**](TroubleshootingToolsDiagnosticsApi.md#get_aggregation_data_by_query28) | **GET** /statistics/speedtest/aggregation | +[**get_app_qos_data**](TroubleshootingToolsDiagnosticsApi.md#get_app_qos_data) | **GET** /stream/device/nwpi/appQosData | +[**get_app_qos_state**](TroubleshootingToolsDiagnosticsApi.md#get_app_qos_state) | **GET** /stream/device/nwpi/appQosState | +[**get_concurrent_data**](TroubleshootingToolsDiagnosticsApi.md#get_concurrent_data) | **GET** /stream/device/nwpi/concurrentData | +[**get_concurrent_domain_data**](TroubleshootingToolsDiagnosticsApi.md#get_concurrent_domain_data) | **GET** /stream/device/nwpi/concurrentDomainData | +[**get_count29**](TroubleshootingToolsDiagnosticsApi.md#get_count29) | **GET** /stream/device/nwpi/doccount | +[**get_count30**](TroubleshootingToolsDiagnosticsApi.md#get_count30) | **GET** /statistics/speedtest/doccount | +[**get_count_post29**](TroubleshootingToolsDiagnosticsApi.md#get_count_post29) | **POST** /stream/device/nwpi/doccount | +[**get_count_post30**](TroubleshootingToolsDiagnosticsApi.md#get_count_post30) | **POST** /statistics/speedtest/doccount | +[**get_current_timestamp**](TroubleshootingToolsDiagnosticsApi.md#get_current_timestamp) | **GET** /stream/device/nwpi/currentTimestamp | +[**get_db_schema**](TroubleshootingToolsDiagnosticsApi.md#get_db_schema) | **GET** /diagnostics/dbschema | +[**get_device_log**](TroubleshootingToolsDiagnosticsApi.md#get_device_log) | **GET** /stream/device/log/{sessionId} | +[**get_domain_metric**](TroubleshootingToolsDiagnosticsApi.md#get_domain_metric) | **GET** /stream/device/nwpi/domainMetric | +[**get_event_app_hop_list**](TroubleshootingToolsDiagnosticsApi.md#get_event_app_hop_list) | **GET** /stream/device/nwpi/eventAppHopList | +[**get_event_app_score_bandwidth**](TroubleshootingToolsDiagnosticsApi.md#get_event_app_score_bandwidth) | **GET** /stream/device/nwpi/eventAppScoreBandwidth | +[**get_event_flow_from_app_hop**](TroubleshootingToolsDiagnosticsApi.md#get_event_flow_from_app_hop) | **GET** /stream/device/nwpi/eventFlowFromAppHop | +[**get_event_readout**](TroubleshootingToolsDiagnosticsApi.md#get_event_readout) | **GET** /stream/device/nwpi/eventReadout | +[**get_file_download_status**](TroubleshootingToolsDiagnosticsApi.md#get_file_download_status) | **GET** /stream/device/capture/status/{sessionId} | +[**get_fin_flow_time_range**](TroubleshootingToolsDiagnosticsApi.md#get_fin_flow_time_range) | **GET** /stream/device/nwpi/traceFinFlowTimeRange | +[**get_finalized_data**](TroubleshootingToolsDiagnosticsApi.md#get_finalized_data) | **GET** /stream/device/nwpi/finalizedData | +[**get_finalized_domain_data**](TroubleshootingToolsDiagnosticsApi.md#get_finalized_domain_data) | **GET** /stream/device/nwpi/finalizedDomainData | +[**get_finalized_flow_count**](TroubleshootingToolsDiagnosticsApi.md#get_finalized_flow_count) | **GET** /stream/device/nwpi/traceFinFlowCount | +[**get_flow_detail**](TroubleshootingToolsDiagnosticsApi.md#get_flow_detail) | **GET** /stream/device/nwpi/flowDetail | +[**get_flow_metric**](TroubleshootingToolsDiagnosticsApi.md#get_flow_metric) | **GET** /stream/device/nwpi/flowMetric | +[**get_interface_bandwidth**](TroubleshootingToolsDiagnosticsApi.md#get_interface_bandwidth) | **GET** /stream/device/speed/interface/bandwidth | +[**get_log_type**](TroubleshootingToolsDiagnosticsApi.md#get_log_type) | **GET** /stream/device/log/type | +[**get_monitor_state**](TroubleshootingToolsDiagnosticsApi.md#get_monitor_state) | **GET** /stream/device/nwpi/getMonitorState | +[**get_nwpi_dscp**](TroubleshootingToolsDiagnosticsApi.md#get_nwpi_dscp) | **GET** /stream/device/nwpi/nwpiDSCP | +[**get_nwpi_nbar_app_group**](TroubleshootingToolsDiagnosticsApi.md#get_nwpi_nbar_app_group) | **GET** /stream/device/nwpi/nwpiNbarAppGroup | +[**get_nwpi_protocol**](TroubleshootingToolsDiagnosticsApi.md#get_nwpi_protocol) | **GET** /stream/device/nwpi/nwpiProtocol | +[**get_packet_features**](TroubleshootingToolsDiagnosticsApi.md#get_packet_features) | **GET** /stream/device/nwpi/packetFeatures | +[**get_post_aggregation_app_data_by_query26**](TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_app_data_by_query26) | **POST** /stream/device/nwpi/app-agg/aggregation | +[**get_post_aggregation_app_data_by_query27**](TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_app_data_by_query27) | **POST** /statistics/speedtest/app-agg/aggregation | +[**get_post_aggregation_data_by_query27**](TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_data_by_query27) | **POST** /stream/device/nwpi/aggregation | +[**get_post_aggregation_data_by_query28**](TroubleshootingToolsDiagnosticsApi.md#get_post_aggregation_data_by_query28) | **POST** /statistics/speedtest/aggregation | +[**get_post_stat_bulk_raw_data27**](TroubleshootingToolsDiagnosticsApi.md#get_post_stat_bulk_raw_data27) | **POST** /stream/device/nwpi/page | +[**get_post_stat_bulk_raw_data28**](TroubleshootingToolsDiagnosticsApi.md#get_post_stat_bulk_raw_data28) | **POST** /statistics/speedtest/page | +[**get_preload_info**](TroubleshootingToolsDiagnosticsApi.md#get_preload_info) | **GET** /stream/device/nwpi/preloadinfo | +[**get_routing_detail_from_local**](TroubleshootingToolsDiagnosticsApi.md#get_routing_detail_from_local) | **GET** /stream/device/nwpi/routingDetail | +[**get_session**](TroubleshootingToolsDiagnosticsApi.md#get_session) | **POST** /stream/device/speed | +[**get_session_info_capture**](TroubleshootingToolsDiagnosticsApi.md#get_session_info_capture) | **POST** /stream/device/capture | +[**get_session_info_log**](TroubleshootingToolsDiagnosticsApi.md#get_session_info_log) | **POST** /stream/device/log | +[**get_sessions**](TroubleshootingToolsDiagnosticsApi.md#get_sessions) | **GET** /stream/device/log/sessions | +[**get_speed_test**](TroubleshootingToolsDiagnosticsApi.md#get_speed_test) | **GET** /stream/device/speed/{sessionId} | +[**get_speed_test_status**](TroubleshootingToolsDiagnosticsApi.md#get_speed_test_status) | **GET** /stream/device/speed/status/{sessionId} | +[**get_stat_bulk_raw_data27**](TroubleshootingToolsDiagnosticsApi.md#get_stat_bulk_raw_data27) | **GET** /stream/device/nwpi/page | +[**get_stat_bulk_raw_data28**](TroubleshootingToolsDiagnosticsApi.md#get_stat_bulk_raw_data28) | **GET** /statistics/speedtest/page | +[**get_stat_data_fields29**](TroubleshootingToolsDiagnosticsApi.md#get_stat_data_fields29) | **GET** /stream/device/nwpi/fields | +[**get_stat_data_fields30**](TroubleshootingToolsDiagnosticsApi.md#get_stat_data_fields30) | **GET** /statistics/speedtest/fields | +[**get_stat_data_raw_data26**](TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data26) | **GET** /stream/device/nwpi | +[**get_stat_data_raw_data27**](TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data27) | **GET** /statistics/speedtest | +[**get_stat_data_raw_data_as_csv27**](TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data_as_csv27) | **GET** /stream/device/nwpi/csv | +[**get_stat_data_raw_data_as_csv28**](TroubleshootingToolsDiagnosticsApi.md#get_stat_data_raw_data_as_csv28) | **GET** /statistics/speedtest/csv | +[**get_stat_query_fields29**](TroubleshootingToolsDiagnosticsApi.md#get_stat_query_fields29) | **GET** /stream/device/nwpi/query/fields | +[**get_stat_query_fields30**](TroubleshootingToolsDiagnosticsApi.md#get_stat_query_fields30) | **GET** /statistics/speedtest/query/fields | +[**get_stats_raw_data27**](TroubleshootingToolsDiagnosticsApi.md#get_stats_raw_data27) | **POST** /stream/device/nwpi | +[**get_stats_raw_data28**](TroubleshootingToolsDiagnosticsApi.md#get_stats_raw_data28) | **POST** /statistics/speedtest | +[**get_thread_pools**](TroubleshootingToolsDiagnosticsApi.md#get_thread_pools) | **GET** /diagnostics/threadpools | +[**get_trace_flow**](TroubleshootingToolsDiagnosticsApi.md#get_trace_flow) | **GET** /stream/device/nwpi/traceFlow | +[**get_trace_history**](TroubleshootingToolsDiagnosticsApi.md#get_trace_history) | **GET** /stream/device/nwpi/traceHistory | +[**get_vnic_info_by_vnf_id**](TroubleshootingToolsDiagnosticsApi.md#get_vnic_info_by_vnf_id) | **GET** /stream/device/capture/vnicsInfo/{vnfId} | +[**monitor_override_start**](TroubleshootingToolsDiagnosticsApi.md#monitor_override_start) | **POST** /stream/device/nwpi/monitor/overrideStart | +[**monitor_start**](TroubleshootingToolsDiagnosticsApi.md#monitor_start) | **POST** /stream/device/nwpi/monitor/start | +[**monitor_stop**](TroubleshootingToolsDiagnosticsApi.md#monitor_stop) | **POST** /stream/device/nwpi/monitor/stop | +[**nwpi_post_flow_data**](TroubleshootingToolsDiagnosticsApi.md#nwpi_post_flow_data) | **POST** /stream/device/nwpi/trace/record/{deviceUUID} | +[**process_device_status**](TroubleshootingToolsDiagnosticsApi.md#process_device_status) | **POST** /stream/device/status/{deviceUUID} | +[**renew_session_info**](TroubleshootingToolsDiagnosticsApi.md#renew_session_info) | **GET** /stream/device/log/renew/{sessionId} | +[**save_speed_test_results**](TroubleshootingToolsDiagnosticsApi.md#save_speed_test_results) | **POST** /stream/device/speed/{deviceUUID}/{sessionId} | +[**search_device_log**](TroubleshootingToolsDiagnosticsApi.md#search_device_log) | **POST** /stream/device/log/search/{sessionId} | +[**start_pcap_session**](TroubleshootingToolsDiagnosticsApi.md#start_pcap_session) | **GET** /stream/device/capture/start/{sessionId} | +[**start_speed_test**](TroubleshootingToolsDiagnosticsApi.md#start_speed_test) | **GET** /stream/device/speed/start/{sessionId} | +[**stop_pcap_session**](TroubleshootingToolsDiagnosticsApi.md#stop_pcap_session) | **GET** /stream/device/capture/stop/{sessionId} | +[**stop_speed_test**](TroubleshootingToolsDiagnosticsApi.md#stop_speed_test) | **GET** /stream/device/speed/stop/{sessionId} | +[**stream_log**](TroubleshootingToolsDiagnosticsApi.md#stream_log) | **POST** /stream/device/log/{logType}/{deviceUUID}/{sessionId} | +[**trace_delete**](TroubleshootingToolsDiagnosticsApi.md#trace_delete) | **DELETE** /stream/device/nwpi/trace/delete | +[**trace_fin_flow_with_query**](TroubleshootingToolsDiagnosticsApi.md#trace_fin_flow_with_query) | **GET** /stream/device/nwpi/traceFinFlowWithQuery | +[**trace_start**](TroubleshootingToolsDiagnosticsApi.md#trace_start) | **POST** /stream/device/nwpi/trace/start | +[**trace_stop**](TroubleshootingToolsDiagnosticsApi.md#trace_stop) | **POST** /stream/device/nwpi/trace/stop/{traceId} | + + +# **clear_session** +> clear_session(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = "sessionId_example" # str | Session Id + + # example passing only required values which don't have defaults set + try: + api_instance.clear_session(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->clear_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **str**| Session Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disable_device_log** +> disable_device_log(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.disable_device_log(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->disable_device_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disable_packet_capture_session** +> disable_packet_capture_session(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.disable_packet_capture_session(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->disable_packet_capture_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disable_speed_test_session** +> disable_speed_test_session(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.disable_speed_test_session(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->disable_speed_test_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_debug_log** +> download_debug_log(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = "sessionId_example" # str | Session Id + + # example passing only required values which don't have defaults set + try: + api_instance.download_debug_log(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->download_debug_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **str**| Session Id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **download_file** +> download_file(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.download_file(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->download_file: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **force_stop_pcap_session** +> force_stop_pcap_session(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.force_stop_pcap_session(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->force_stop_pcap_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **form_post_packet_capture** +> form_post_packet_capture(device_uuid, session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + device_uuid = "deviceUUID_example" # str | + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.form_post_packet_capture(device_uuid, session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->form_post_packet_capture: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_uuid** | **str**| | + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_agg_flow** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_agg_flow(trace_id, timestamp, trace_state) + + + +Get aggregated flow data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + trace_state = "traceState_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_agg_flow(trace_id, timestamp, trace_state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_agg_flow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **trace_state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query27() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query27(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_aggregation_data_by_query27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_aggregation_data_by_query28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query28() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_aggregation_data_by_query28(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_aggregation_data_by_query28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_qos_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_qos_data(trace_id, timestamp, received_timestamp) + + + +Get QoS Application data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + received_timestamp = 1 # int | received timestamp + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_qos_data(trace_id, timestamp, received_timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_app_qos_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **received_timestamp** | **int**| received timestamp | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_app_qos_state** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_app_qos_state(trace_id, timestamp, trace_state) + + + +Get QoS Application state to received timestamp mapping for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + trace_state = "traceState_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_app_qos_state(trace_id, timestamp, trace_state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_app_qos_state: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **trace_state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_concurrent_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_concurrent_data(trace_id, timestamp) + + + +Get concurrent data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_concurrent_data(trace_id, timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_concurrent_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_concurrent_domain_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_concurrent_domain_data(trace_id, timestamp) + + + +Get concurrent domain data for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_concurrent_domain_data(trace_id, timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_concurrent_domain_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count29(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count29(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_count29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count30(query) + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_count30(query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_count30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post29() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post29(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_count_post29: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_count_post30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post30() + + + +Get response count of a query + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_count_post30(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_count_post30: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Query | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_current_timestamp** +> get_current_timestamp() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_current_timestamp() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_current_timestamp: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_db_schema** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_db_schema() + + + +Get the current database schema + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_db_schema() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_db_schema: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_device_log** +> get_device_log(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + log_id = -1 # int | (optional) if omitted the server will use the default value of -1 + + # example passing only required values which don't have defaults set + try: + api_instance.get_device_log(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_device_log: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_device_log(session_id, log_id=log_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_device_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + **log_id** | **int**| | [optional] if omitted the server will use the default value of -1 + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_domain_metric** +> get_domain_metric(trace_id, timestamp, domain, first_timestamp, last_timestamp) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + domain = "domain_example" # str | domain name + first_timestamp = 1 # int | first timestamp of xAxis + last_timestamp = 1 # int | last timestamp of xAxis + + # example passing only required values which don't have defaults set + try: + api_instance.get_domain_metric(trace_id, timestamp, domain, first_timestamp, last_timestamp) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_domain_metric: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **domain** | **str**| domain name | + **first_timestamp** | **int**| first timestamp of xAxis | + **last_timestamp** | **int**| last timestamp of xAxis | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_app_hop_list** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_app_hop_list(trace_id, timestamp, state) + + + +Get Trace Application and HopList for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_app_hop_list(trace_id, timestamp, state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_event_app_hop_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_app_score_bandwidth** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_app_score_bandwidth(trace_id, timestamp, state, received_timestamp) + + + +Get Trace Event Application Performance Score and Bandwidth for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + received_timestamp = 1 # int | received timestamp + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_app_score_bandwidth(trace_id, timestamp, state, received_timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_event_app_score_bandwidth: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + **received_timestamp** | **int**| received timestamp | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_flow_from_app_hop** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_flow_from_app_hop(trace_id, timestamp, state, application, direction, _from, to, device_trace_id) + + + +Get Trace Event Flow From Application And Hop for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + application = "application_example" # str | app name + direction = "direction_example" # str | direction + _from = "from_example" # str | from + to = "to_example" # str | to + device_trace_id = 1 # int | deviceTraceId + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_flow_from_app_hop(trace_id, timestamp, state, application, direction, _from, to, device_trace_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_event_flow_from_app_hop: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + **application** | **str**| app name | + **direction** | **str**| direction | + **_from** | **str**| from | + **to** | **str**| to | + **device_trace_id** | **int**| deviceTraceId | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_event_readout** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_event_readout(trace_id, timestamp, state) + + + +Get Trace Event Readout for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_event_readout(trace_id, timestamp, state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_event_readout: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_file_download_status** +> get_file_download_status(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.get_file_download_status(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_file_download_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_fin_flow_time_range** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_fin_flow_time_range(trace_id, timestamp, state) + + + +Retrieve Fin Flow time range + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_fin_flow_time_range(trace_id, timestamp, state) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_fin_flow_time_range: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_finalized_data** +> get_finalized_data(trace_id, timestamp) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_instance.get_finalized_data(trace_id, timestamp) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_finalized_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_finalized_domain_data** +> get_finalized_domain_data(trace_id, timestamp) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_instance.get_finalized_domain_data(trace_id, timestamp) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_finalized_domain_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_finalized_flow_count** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_finalized_flow_count(trace_id, timestamp) + + + +Retrieve total Fin Flow counts + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_finalized_flow_count(trace_id, timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_finalized_flow_count: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_flow_detail** +> get_flow_detail(trace_id, timestamp, flow_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + flow_id = 1 # int | flow id + + # example passing only required values which don't have defaults set + try: + api_instance.get_flow_detail(trace_id, timestamp, flow_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_flow_detail: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **flow_id** | **int**| flow id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_flow_metric** +> get_flow_metric(trace_id, timestamp, flow_id, first_timestamp, last_timestamp) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + flow_id = 1 # int | flow id + first_timestamp = 1 # int | first timestamp of xAxis + last_timestamp = 1 # int | last timestamp of xAxis + + # example passing only required values which don't have defaults set + try: + api_instance.get_flow_metric(trace_id, timestamp, flow_id, first_timestamp, last_timestamp) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_flow_metric: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **flow_id** | **int**| flow id | + **first_timestamp** | **int**| first timestamp of xAxis | + **last_timestamp** | **int**| last timestamp of xAxis | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_interface_bandwidth** +> get_interface_bandwidth(circuit, device_uuid) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.device_uuid import DeviceUuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + circuit = "circuit_example" # str | + device_uuid = DeviceUuid( + device_uuid="device_uuid_example", + ) # DeviceUuid | + + # example passing only required values which don't have defaults set + try: + api_instance.get_interface_bandwidth(circuit, device_uuid) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_interface_bandwidth: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **circuit** | **str**| | + **device_uuid** | **DeviceUuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_log_type** +> get_log_type(uuid) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + uuid = "uuid_example" # str | Device uuid + + # example passing only required values which don't have defaults set + try: + api_instance.get_log_type(uuid) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_log_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **uuid** | **str**| Device uuid | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_monitor_state** +> get_monitor_state(trace_id, state) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_instance.get_monitor_state(trace_id, state) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_monitor_state: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **state** | **str**| trace state | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_nwpi_dscp** +> get_nwpi_dscp() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_nwpi_dscp() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_nwpi_dscp: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_nwpi_nbar_app_group** +> get_nwpi_nbar_app_group() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_nwpi_nbar_app_group() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_nwpi_nbar_app_group: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_nwpi_protocol** +> get_nwpi_protocol() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_nwpi_protocol() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_nwpi_protocol: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_packet_features** +> get_packet_features(trace_id, timestamp, flow_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + flow_id = 1 # int | flow id + + # example passing only required values which don't have defaults set + try: + api_instance.get_packet_features(trace_id, timestamp, flow_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_packet_features: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **flow_id** | **int**| flow id | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query26() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query26(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_post_aggregation_app_data_by_query26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_app_data_by_query27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query27() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_app_data_by_query27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_post_aggregation_app_data_by_query27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query27() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query27(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_post_aggregation_data_by_query27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_aggregation_data_by_query28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query28() + + + +Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_aggregation_data_by_query28(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_post_aggregation_data_by_query28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data27() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data27(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_post_stat_bulk_raw_data27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_post_stat_bulk_raw_data28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data28() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_post_stat_bulk_raw_data28(scroll_id=scroll_id, count=count, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_post_stat_bulk_raw_data28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_preload_info** +> get_preload_info() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_preload_info() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_preload_info: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_routing_detail_from_local** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_routing_detail_from_local(trace_id, timestamp, trace_state, route_prefixs) + + + +Get Routing Details for NWPI. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + trace_state = "traceState_example" # str | trace state + route_prefixs = "routePrefixs_example" # str | route prefixs + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_routing_detail_from_local(trace_id, timestamp, trace_state, route_prefixs) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_routing_detail_from_local: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **trace_state** | **str**| trace state | + **route_prefixs** | **str**| route prefixs | + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_session** +> get_session() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_session(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_session_info_capture** +> get_session_info_capture() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_session_info_capture(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_session_info_capture: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_session_info_log** +> get_session_info_log() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_session_info_log(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_session_info_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_sessions** +> get_sessions() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_sessions() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_sessions: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_speed_test** +> get_speed_test(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + log_id = 0 # int | (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + try: + api_instance.get_speed_test(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_speed_test: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.get_speed_test(session_id, log_id=log_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_speed_test: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + **log_id** | **int**| | [optional] if omitted the server will use the default value of 0 + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_speed_test_status** +> get_speed_test_status(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.get_speed_test_status(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_speed_test_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data27() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data27(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_bulk_raw_data27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_bulk_raw_data28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data28() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional) + scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional) + count = "10" # str | Result size (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_bulk_raw_data28(query=query, scroll_id=scroll_id, count=count) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_bulk_raw_data28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **scroll_id** | **str**| ES scroll Id | [optional] + **count** | **str**| Result size | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields29() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields29() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_data_fields29: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_fields30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields30() + + + +Get fields and type + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_data_fields30() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_data_fields30: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data26** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data26() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data26(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_data_raw_data26: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data27() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional) + sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data27(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_data_raw_data27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by(emp:entry_time) | [optional] + **sort_order** | **str**| sort order(emp:asc、ASC、Asc、desc、Desc、DESC) | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv27** +> str get_stat_data_raw_data_as_csv27() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv27(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_data_raw_data_as_csv27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_data_raw_data_as_csv28** +> str get_stat_data_raw_data_as_csv28() + + + +Get raw data with optional query as CSV + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stat_data_raw_data_as_csv28(query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_data_raw_data_as_csv28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| Query string | [optional] + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields29** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields29() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields29() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_query_fields29: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stat_query_fields30** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields30() + + + +Get query fields + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_stat_query_fields30() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stat_query_fields30: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data27** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data27() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data27(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stats_raw_data27: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stats_raw_data28** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data28() + + + +Get stats raw data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + page = 1 # int | page number (optional) + page_size = 1 # int | page size (optional) + sort_by = "sortBy_example" # str | sort by (optional) + sort_order = "sortOrder_example" # str | sort order (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_stats_raw_data28(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_stats_raw_data28: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page number | [optional] + **page_size** | **int**| page size | [optional] + **sort_by** | **str**| sort by | [optional] + **sort_order** | **str**| sort order | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Stats query string | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_thread_pools** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_thread_pools() + + + +Get information on the threadpools + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_thread_pools() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_thread_pools: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trace_flow** +> get_trace_flow(trace_id, timestamp, state) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + state = "state_example" # str | trace state + + # example passing only required values which don't have defaults set + try: + api_instance.get_trace_flow(trace_id, timestamp, state) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_trace_flow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **state** | **str**| trace state | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trace_history** +> get_trace_history() + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_trace_history() + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_trace_history: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vnic_info_by_vnf_id** +> get_vnic_info_by_vnf_id(vnf_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + vnf_id = "vnfId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.get_vnic_info_by_vnf_id(vnf_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->get_vnic_info_by_vnf_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vnf_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **monitor_override_start** +> monitor_override_start() + + + +CXP Monitor Action - Override Start + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.monitor_override_start(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->monitor_override_start: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **monitor_start** +> monitor_start() + + + +CXP Monitor Action - Start + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.monitor_start(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->monitor_start: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **monitor_stop** +> monitor_stop() + + + +CXP Monitor Action - Stop + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.monitor_stop(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->monitor_stop: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **nwpi_post_flow_data** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} nwpi_post_flow_data(device_uuid) + + + +post flow data + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + device_uuid = "deviceUUID_example" # str | + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.nwpi_post_flow_data(device_uuid) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->nwpi_post_flow_data: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.nwpi_post_flow_data(device_uuid, body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->nwpi_post_flow_data: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_uuid** | **str**| | + **body** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_device_status** +> process_device_status(device_uuid) + + + +Get device status stream + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + device_uuid = "deviceUUID_example" # str | Device uuid + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.process_device_status(device_uuid) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->process_device_status: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.process_device_status(device_uuid, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->process_device_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_uuid** | **str**| Device uuid | + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **renew_session_info** +> renew_session_info(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.renew_session_info(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->renew_session_info: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_speed_test_results** +> save_speed_test_results(device_uuid, session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + device_uuid = "deviceUUID_example" # str | + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.save_speed_test_results(device_uuid, session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->save_speed_test_results: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.save_speed_test_results(device_uuid, session_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->save_speed_test_results: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **device_uuid** | **str**| | + **session_id** | **Uuid**| | + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_device_log** +> search_device_log(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = "sessionId_example" # str | Session Id + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.search_device_log(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->search_device_log: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.search_device_log(session_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->search_device_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **str**| Session Id | + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **start_pcap_session** +> start_pcap_session(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.start_pcap_session(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->start_pcap_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **start_speed_test** +> start_speed_test(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.start_speed_test(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->start_speed_test: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stop_pcap_session** +> stop_pcap_session(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.stop_pcap_session(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->stop_pcap_session: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stop_speed_test** +> stop_speed_test(session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from openapi_client.model.uuid import Uuid +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + session_id = Uuid( + uuid="uuid_example", + ) # Uuid | + + # example passing only required values which don't have defaults set + try: + api_instance.stop_speed_test(session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->stop_speed_test: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **session_id** | **Uuid**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stream_log** +> stream_log(log_type, device_uuid, session_id) + + + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + log_type = "logType_example" # str | Log type + device_uuid = "deviceUUID_example" # str | Device uuid + session_id = "sessionId_example" # str | Session Id + body = "body_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.stream_log(log_type, device_uuid, session_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->stream_log: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.stream_log(log_type, device_uuid, session_id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->stream_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **log_type** | **str**| Log type | + **device_uuid** | **str**| Device uuid | + **session_id** | **str**| Session Id | + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trace_delete** +> trace_delete(trace_id, timestamp) + + + +Trace Action - Delete + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = "traceId_example" # str | trace id + timestamp = 1 # int | start time + + # example passing only required values which don't have defaults set + try: + api_instance.trace_delete(trace_id, timestamp) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->trace_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **str**| trace id | + **timestamp** | **int**| start time | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trace_fin_flow_with_query** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} trace_fin_flow_with_query(trace_id, timestamp) + + + +Retrieve Certain Fin Flows + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = 1 # int | trace id + timestamp = 1 # int | start time + query = "query_example" # str | Query filter (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.trace_fin_flow_with_query(trace_id, timestamp) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->trace_fin_flow_with_query: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.trace_fin_flow_with_query(trace_id, timestamp, query=query) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->trace_fin_flow_with_query: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **int**| trace id | + **timestamp** | **int**| start time | + **query** | **str**| Query filter | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trace_start** +> trace_start() + + + +Trace Action - Start + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.trace_start(body=body) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->trace_start: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **trace_stop** +> trace_stop(trace_id) + + + +Trace Action - Stop + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import troubleshooting_tools_diagnostics_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = troubleshooting_tools_diagnostics_api.TroubleshootingToolsDiagnosticsApi(api_client) + trace_id = "traceId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.trace_stop(trace_id) + except openapi_client.ApiException as e: + print("Exception when calling TroubleshootingToolsDiagnosticsApi->trace_stop: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trace_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UmbrellaApi.md b/docs/UmbrellaApi.md new file mode 100644 index 0000000..92bc0ae --- /dev/null +++ b/docs/UmbrellaApi.md @@ -0,0 +1,264 @@ +# openapi_client.UmbrellaApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_keys_from_umbrella**](UmbrellaApi.md#get_all_keys_from_umbrella) | **GET** /umbrella/getkeys | +[**get_management_keys_from_umbrella**](UmbrellaApi.md#get_management_keys_from_umbrella) | **GET** /umbrella/getkeys/management | +[**get_network_keys_from_umbrella**](UmbrellaApi.md#get_network_keys_from_umbrella) | **GET** /umbrella/getkeys/networkdevices | +[**get_reporting_keys_from_umbrella**](UmbrellaApi.md#get_reporting_keys_from_umbrella) | **GET** /umbrella/getkeys/reporting | + + +# **get_all_keys_from_umbrella** +> get_all_keys_from_umbrella() + + + +Get keys from Umbrella + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = umbrella_api.UmbrellaApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_all_keys_from_umbrella() + except openapi_client.ApiException as e: + print("Exception when calling UmbrellaApi->get_all_keys_from_umbrella: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_management_keys_from_umbrella** +> get_management_keys_from_umbrella() + + + +Get management keys from Umbrella + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = umbrella_api.UmbrellaApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_management_keys_from_umbrella() + except openapi_client.ApiException as e: + print("Exception when calling UmbrellaApi->get_management_keys_from_umbrella: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_network_keys_from_umbrella** +> get_network_keys_from_umbrella() + + + +Get network devices keys from Umbrella + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = umbrella_api.UmbrellaApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_network_keys_from_umbrella() + except openapi_client.ApiException as e: + print("Exception when calling UmbrellaApi->get_network_keys_from_umbrella: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reporting_keys_from_umbrella** +> get_reporting_keys_from_umbrella() + + + +Get reporting keys from Umbrella + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import umbrella_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = umbrella_api.UmbrellaApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_instance.get_reporting_keys_from_umbrella() + except openapi_client.ApiException as e: + print("Exception when calling UmbrellaApi->get_reporting_keys_from_umbrella: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UpdateTenantModel.md b/docs/UpdateTenantModel.md new file mode 100644 index 0000000..adc15b5 --- /dev/null +++ b/docs/UpdateTenantModel.md @@ -0,0 +1,21 @@ +# UpdateTenantModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**desc** | **str** | | [optional] +**getv_bond_address** | **str** | | [optional] +**getv_smarts** | **[str]** | | [optional] +**idp_metadata** | **str** | | [optional] +**mode** | **str** | | [optional] +**name** | **str** | | [optional] +**old_idp_metadata** | **str** | | [optional] +**sp_metadata** | **str** | | [optional] +**sub_domain** | **str** | | [optional] +**wan_edge_forecast** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateTenantvSmartModel.md b/docs/UpdateTenantvSmartModel.md new file mode 100644 index 0000000..73dc522 --- /dev/null +++ b/docs/UpdateTenantvSmartModel.md @@ -0,0 +1,13 @@ +# UpdateTenantvSmartModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**destv_smart_uuid** | **str** | | [optional] +**srcv_smart_uuid** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UtilityConfigurationDBApi.md b/docs/UtilityConfigurationDBApi.md new file mode 100644 index 0000000..8429109 --- /dev/null +++ b/docs/UtilityConfigurationDBApi.md @@ -0,0 +1,73 @@ +# openapi_client.UtilityConfigurationDBApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_db_size_on_file**](UtilityConfigurationDBApi.md#get_db_size_on_file) | **GET** /util/configdb/size | + + +# **get_db_size_on_file** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_db_size_on_file() + + + +Fetches the disk usage by configuration-db + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_configuration_db_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_configuration_db_api.UtilityConfigurationDBApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_db_size_on_file() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling UtilityConfigurationDBApi->get_db_size_on_file: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UtilityLoggingApi.md b/docs/UtilityLoggingApi.md new file mode 100644 index 0000000..79395ab --- /dev/null +++ b/docs/UtilityLoggingApi.md @@ -0,0 +1,348 @@ +# openapi_client.UtilityLoggingApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**debug_log**](UtilityLoggingApi.md#debug_log) | **POST** /util/logging/debuglog | +[**list_log_file_details**](UtilityLoggingApi.md#list_log_file_details) | **GET** /util/logfile/appserver | +[**list_loggers**](UtilityLoggingApi.md#list_loggers) | **GET** /util/logging/loggers | +[**list_v_manage_server_log_last_n_lines**](UtilityLoggingApi.md#list_v_manage_server_log_last_n_lines) | **GET** /util/logfile/appserver/lastnlines | +[**set_log_level**](UtilityLoggingApi.md#set_log_level) | **POST** /util/logging/level | + + +# **debug_log** +> debug_log(logger_name, log_message) + + + +Test whether logging works + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_logging_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_logging_api.UtilityLoggingApi(api_client) + logger_name = "logger_name_example" # str | + log_message = "log_message_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.debug_log(logger_name, log_message) + except openapi_client.ApiException as e: + print("Exception when calling UtilityLoggingApi->debug_log: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logger_name** | **str**| | + **log_message** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_log_file_details** +> str list_log_file_details() + + + +Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_logging_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_logging_api.UtilityLoggingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_log_file_details() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling UtilityLoggingApi->list_log_file_details: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_loggers** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] list_loggers() + + + +List loggers + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_logging_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_logging_api.UtilityLoggingApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.list_loggers() + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling UtilityLoggingApi->list_loggers: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_v_manage_server_log_last_n_lines** +> str list_v_manage_server_log_last_n_lines() + + + +List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response. + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_logging_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_logging_api.UtilityLoggingApi(api_client) + lines = 100 # int | Number of lines (optional) if omitted the server will use the default value of 100 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_v_manage_server_log_last_n_lines(lines=lines) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling UtilityLoggingApi->list_v_manage_server_log_last_n_lines: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **lines** | **int**| Number of lines | [optional] if omitted the server will use the default value of 100 + +### Return type + +**str** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_log_level** +> set_log_level(logger_name, log_level) + + + +Set log level for logger + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_logging_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_logging_api.UtilityLoggingApi(api_client) + logger_name = "logger_name_example" # str | + log_level = "log_level_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.set_log_level(logger_name, log_level) + except openapi_client.ApiException as e: + print("Exception when calling UtilityLoggingApi->set_log_level: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logger_name** | **str**| | + **log_level** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UtilitySecurityApi.md b/docs/UtilitySecurityApi.md new file mode 100644 index 0000000..256aac2 --- /dev/null +++ b/docs/UtilitySecurityApi.md @@ -0,0 +1,78 @@ +# openapi_client.UtilitySecurityApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**check_given_ip_list**](UtilitySecurityApi.md#check_given_ip_list) | **POST** /software/compliance/ip/origin/check | + + +# **check_given_ip_list** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] check_given_ip_list() + + + +Block IP based on list + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import utility_security_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = utility_security_api.UtilitySecurityApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Device detail (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.check_given_ip_list(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling UtilitySecurityApi->check_given_ip_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Device detail | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Uuid.md b/docs/Uuid.md new file mode 100644 index 0000000..920e41b --- /dev/null +++ b/docs/Uuid.md @@ -0,0 +1,13 @@ +# Uuid + +This is valid uuid + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UuidToDomainId.md b/docs/UuidToDomainId.md new file mode 100644 index 0000000..901ff9c --- /dev/null +++ b/docs/UuidToDomainId.md @@ -0,0 +1,13 @@ +# UuidToDomainId + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domain** | **str** | | [optional] +**mapping** | [**[UuidToDomainIdMapping]**](UuidToDomainIdMapping.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UuidToDomainIdMapping.md b/docs/UuidToDomainIdMapping.md new file mode 100644 index 0000000..e5f70e6 --- /dev/null +++ b/docs/UuidToDomainIdMapping.md @@ -0,0 +1,13 @@ +# UuidToDomainIdMapping + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domain_id** | **int** | | [optional] +**uuid** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VEdgeBootstrapConfig.md b/docs/VEdgeBootstrapConfig.md new file mode 100644 index 0000000..0851f73 --- /dev/null +++ b/docs/VEdgeBootstrapConfig.md @@ -0,0 +1,13 @@ +# VEdgeBootstrapConfig + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bootstrap_config_type** | **str** | | [optional] +**uuid** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VEdgeHealth.md b/docs/VEdgeHealth.md new file mode 100644 index 0000000..5c78e38 --- /dev/null +++ b/docs/VEdgeHealth.md @@ -0,0 +1,14 @@ +# VEdgeHealth + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **int** | | [optional] +**normal** | **int** | | [optional] +**warning** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VPNID.md b/docs/VPNID.md new file mode 100644 index 0000000..ce18e1a --- /dev/null +++ b/docs/VPNID.md @@ -0,0 +1,13 @@ +# VPNID + +This is the valid list of VPN-IDs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vpn** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VResourceGroupNameModel.md b/docs/VResourceGroupNameModel.md new file mode 100644 index 0000000..91471cd --- /dev/null +++ b/docs/VResourceGroupNameModel.md @@ -0,0 +1,12 @@ +# VResourceGroupNameModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**v_resource_group_name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VSmartStatus.md b/docs/VSmartStatus.md new file mode 100644 index 0000000..fe5c4c6 --- /dev/null +++ b/docs/VSmartStatus.md @@ -0,0 +1,13 @@ +# VSmartStatus + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**down** | **int** | | [optional] +**up** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Variable.md b/docs/Variable.md new file mode 100644 index 0000000..839bc74 --- /dev/null +++ b/docs/Variable.md @@ -0,0 +1,13 @@ +# Variable + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**json_path** | **str** | | +**var_name** | **str** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VertexDefinition.md b/docs/VertexDefinition.md new file mode 100644 index 0000000..11091ae --- /dev/null +++ b/docs/VertexDefinition.md @@ -0,0 +1,15 @@ +# VertexDefinition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**in_edges** | **[str]** | | [optional] +**name** | **str** | | [optional] +**out_edges** | **[str]** | | [optional] +**properties** | [**[PropertyDefinition]**](PropertyDefinition.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Vpn.md b/docs/Vpn.md new file mode 100644 index 0000000..3f99887 --- /dev/null +++ b/docs/Vpn.md @@ -0,0 +1,21 @@ +# Vpn + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**site_to_site_vpn** | [**SiteToSiteVpn**](SiteToSiteVpn.md) | | +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**ip_sec_policy** | [**IpSecPolicy**](IpSecPolicy.md) | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VpnAllOf.md b/docs/VpnAllOf.md new file mode 100644 index 0000000..69429f3 --- /dev/null +++ b/docs/VpnAllOf.md @@ -0,0 +1,13 @@ +# VpnAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**site_to_site_vpn** | [**SiteToSiteVpn**](SiteToSiteVpn.md) | | [optional] +**ip_sec_policy** | [**IpSecPolicy**](IpSecPolicy.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WanSpec.md b/docs/WanSpec.md new file mode 100644 index 0000000..269dfa3 --- /dev/null +++ b/docs/WanSpec.md @@ -0,0 +1,17 @@ +# WanSpec + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | | +**cloud_region** | **str** | | +**mapped_branches** | **str** | | +**resource_group** | **str** | | +**vpn** | **str** | | +**wan_id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Wifi.md b/docs/Wifi.md new file mode 100644 index 0000000..8861ad0 --- /dev/null +++ b/docs/Wifi.md @@ -0,0 +1,23 @@ +# Wifi + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Profile Parcel. Must be unique. | +**type** | **str** | type | +**ssid_config_list** | [**[SSIDConfig]**](SSIDConfig.md) | | [optional] +**guest_wifi** | [**GuestWifi**](GuestWifi.md) | | [optional] +**corporate_wifi** | [**CorporateWifi**](CorporateWifi.md) | | [optional] +**advanced_radio_setting** | [**AdvancedRadioSetting**](AdvancedRadioSetting.md) | | [optional] +**created_by** | **str** | User who last created this. | [optional] [readonly] +**created_on** | **int** | Timestamp of creation | [optional] [readonly] +**id** | **str** | System generated unique identifier of the Profile Parcel in UUID format. | [optional] +**last_updated_by** | **str** | User who last updated this. | [optional] [readonly] +**last_updated_on** | **int** | Timestamp of last update | [optional] [readonly] +**variables** | [**[Variable]**](Variable.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WifiAllOf.md b/docs/WifiAllOf.md new file mode 100644 index 0000000..5a6fc64 --- /dev/null +++ b/docs/WifiAllOf.md @@ -0,0 +1,15 @@ +# WifiAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ssid_config_list** | [**[SSIDConfig]**](SSIDConfig.md) | | [optional] +**guest_wifi** | [**GuestWifi**](GuestWifi.md) | | [optional] +**corporate_wifi** | [**CorporateWifi**](CorporateWifi.md) | | [optional] +**advanced_radio_setting** | [**AdvancedRadioSetting**](AdvancedRadioSetting.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WorkflowManagementApi.md b/docs/WorkflowManagementApi.md new file mode 100644 index 0000000..2a1031f --- /dev/null +++ b/docs/WorkflowManagementApi.md @@ -0,0 +1,294 @@ +# openapi_client.WorkflowManagementApi + +All URIs are relative to */dataservice* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_workflow**](WorkflowManagementApi.md#create_workflow) | **POST** /workflow | +[**delete_workflow**](WorkflowManagementApi.md#delete_workflow) | **DELETE** /workflow | +[**get_workflows**](WorkflowManagementApi.md#get_workflows) | **GET** /workflow | +[**save_workflow**](WorkflowManagementApi.md#save_workflow) | **PUT** /workflow | + + +# **create_workflow** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_workflow() + + + +Creates a workflow in the system + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import workflow_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workflow_management_api.WorkflowManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Request to create workflow with given user context (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.create_workflow(body=body) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling WorkflowManagementApi->create_workflow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Request to create workflow with given user context | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_workflow** +> delete_workflow() + + + +Deletes the workflow + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import workflow_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workflow_management_api.WorkflowManagementApi(api_client) + id = "id_example" # str | Workflow id (optional) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Request to delete the workflow (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_workflow(id=id, body=body) + except openapi_client.ApiException as e: + print("Exception when calling WorkflowManagementApi->delete_workflow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Workflow id | [optional] + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Request to delete the workflow | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_workflows** +> [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_workflows() + + + +List all workflows for the given tenant + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import workflow_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workflow_management_api.WorkflowManagementApi(api_client) + type = "type_example" # str | Workflow type (optional) + id = "id_example" # str | Workflow id (optional) + group_id = "group-id_example" # str | group id (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_workflows(type=type, id=id, group_id=group_id) + pprint(api_response) + except openapi_client.ApiException as e: + print("Exception when calling WorkflowManagementApi->get_workflows: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| Workflow type | [optional] + **id** | **str**| Workflow id | [optional] + **group_id** | **str**| group id | [optional] + +### Return type + +**[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **save_workflow** +> save_workflow() + + + +Saves the workflow + +### Example + + +```python +import time +import openapi_client +from openapi_client.api import workflow_management_api +from pprint import pprint +# Defining the host is optional and defaults to /dataservice +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "/dataservice" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = workflow_management_api.WorkflowManagementApi(api_client) + body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Request to save already created workflow with given user context (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.save_workflow(body=body) + except openapi_client.ApiException as e: + print("Exception when calling WorkflowManagementApi->save_workflow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**| Request to save already created workflow with given user context | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**500** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/git_push.sh b/git_push.sh new file mode 100644 index 0000000..f53a75d --- /dev/null +++ b/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/openapi-spec/vmanageapi_209.json b/openapi-spec/vmanageapi_209.json new file mode 100644 index 0000000..bac211b --- /dev/null +++ b/openapi-spec/vmanageapi_209.json @@ -0,0 +1,225708 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Cisco SD-WAN vManage API", + "description": "The vManage API exposes the functionality of operations maintaining devices and the overlay network", + "contact": { + "email": "vmanage@cisco.com" + }, + "license": { + "name": "Commercial License", + "url": "https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html" + }, + "version": "2.0.0" + }, + "servers": [ + { + "url": "/dataservice" + } + ], + "paths": { + "/admin/cologroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get COLO groups", + "operationId": "getColoGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Colocation groups": { + "description": "Colocation groups", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Add COLO group", + "operationId": "createColoGroup", + "requestBody": { + "description": "Colocation group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Colocation group": { + "description": "Colocation group", + "value": { + "rbacRequired": true, + "userGroupName": "usergrp1", + "name": "cologrp1", + "description": "Colocation Group One" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/cologroup/{id}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update COLO group", + "operationId": "editColoGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Colocation group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Colocation group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Colocation group": { + "description": "Colocation group", + "value": { + "rbacRequired": true, + "userGroupName": "usergrp1", + "name": "cologrp2", + "description": "Colocation Group Two", + "coloGroupId": "f02e27c3-b30b-4425-93a3-e0c0207f8c23" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete COLO group", + "operationId": "deleteColoGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Colocation group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/resourcegroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get all groups", + "operationId": "resourceGroup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceGroup" + } + }, + "examples": { + "Group": { + "description": "Group", + "value": "[ {\"name\": \"west\", \"desc\": \"US - West coast\", \"siteIds\": [100, 110, 120]}, {\"name\": \"east\", \"desc\": \"US - East coast\"}, \"siteIds\": [300, 310, 320] ]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Create a group", + "operationId": "resourceGroup_4", + "requestBody": { + "description": "Create a group", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceGroup" + }, + "examples": { + "Group": { + "description": "Group", + "value": { + "name": "west", + "desc": "US - West coast", + "siteIds": [ + 110, + 120, + 130 + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/resourcegroup/switch": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Global netadmin switches to a different resource group view", + "operationId": "resourceGroup_1", + "requestBody": { + "description": "Global netadmin switches to a different resource group view", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "switchGroupsDetails": { + "description": "switchGroupsDetails", + "value": { + "resourceGroupName": "west" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VResourceGroupName model": { + "description": "VResourceGroupName model", + "value": "{\n \u201cVResourceGroupName\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/resourcegroup/{groupId}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update a group", + "operationId": "resourceGroup_2", + "parameters": [ + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update group description", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceGroup" + }, + "examples": { + "Group": { + "description": "Group", + "value": { + "name": "west", + "desc": "US - West coast", + "siteIds": [ + 110, + 120, + 130 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete a group", + "operationId": "resourceGroup_3", + "parameters": [ + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get all users", + "operationId": "findUsers", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "User": { + "description": "User", + "value": [] + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Create a user", + "operationId": "createUser", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": "{\n \"group\":[\n \"demogrp\"\n ],\n \"description\":\"Demo User\",\n \"userName\":\"demouser\",\n \"password\":\"password\"\n \"locale\":\"en_US\"\n \"resGroupName\":\"global\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/activeSessions": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get active sessions", + "operationId": "getActiveSessions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "All active sessions for this tenant (except for the requesting session)": { + "description": "All active sessions for this tenant (except for the requesting session)", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read" + } + }, + "/admin/user/admin/password": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update admin default password", + "operationId": "updateAdminPassword", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/admin/user/password/validate": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Validate user password", + "operationId": "validatePassword", + "requestBody": { + "description": "User password", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User password": { + "description": "User password", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read" + } + }, + "/admin/user/password/{userName}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update user password", + "operationId": "updatePassword", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "User name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/profile/locale": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update profile locale", + "operationId": "updateProfileLocale", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/profile/password": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update profile password", + "operationId": "updateProfilePassword", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/removeSessions": { + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Remove sessions", + "operationId": "removeSessions", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of sessions": { + "description": "List of sessions", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/reset": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Unlock a user", + "operationId": "resetUser", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/resourceGroupName": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get the name of the resource group associated with the current logged in user", + "operationId": "resourceGroupName", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "resourceGroupDetails": { + "description": "resourceGroupDetails", + "value": { + "resourceGroupName": "global", + "effectiveResourceGroupName": "west" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/role": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Check whether a user has admin role", + "operationId": "findUserRole", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User has admin role": { + "description": "User has admin role", + "value": "{isAdmin: true}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write,Device Monitoring-read,Device Monitoring-write,System-read,System-write" + } + }, + "/admin/user/userAuthType": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Find user authentication type, whether it is SAML enabled", + "operationId": "findUserAuthType", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User authentication type": { + "description": "User authentication type", + "value": "{userAuthType: SAML}" + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/{userName}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update user", + "operationId": "updateUser", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "User name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": { + "userName": "demouser", + "password": "newpasswd" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete user", + "operationId": "deleteUser", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "User name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/usergroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get all user groups", + "operationId": "findUserGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "User groups": { + "description": "User groups", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Create user group", + "operationId": "createUserGroup", + "requestBody": { + "description": "User group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User group": { + "description": "User group", + "value": { + "groupName": "demogrp", + "tasks": [ + { + "feature": "Interface", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Routing", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Security", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "System", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Policy", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Alarms", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Audit Log", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Device Monitoring", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "RBAC VPN", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Certificates", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Device Inventory", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Template Configuration", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Template Deploy", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Policy Configuration", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Security Policy Configuration", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Policy Deploy", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Cloud OnRamp", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Software Upgrade", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Device Reboot", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Manage Users", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Tools", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Settings", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Cluster", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Colocation", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "vAnalytics", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Events", + "read": true, + "enabled": true, + "write": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/usergroup/definition": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get user groups in a grid table", + "operationId": "createGroupGridColumns", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User group in grid table": { + "description": "User group in grid table", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + } + }, + "/admin/usergroup/keyvalue": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get user groups as key value map", + "operationId": "findUserGroupsAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Map of user groups": { + "description": "Map of user groups", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + } + }, + "/admin/usergroup/{userGroupId}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update user group", + "operationId": "updateUserGroup", + "parameters": [ + { + "name": "userGroupId", + "in": "path", + "description": "User group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "User group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User group": { + "description": "User group", + "value": { + "groupName": "demogrp", + "tasks": [ + { + "feature": "Policy", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Routing", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Security", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Interface", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "System", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Alarms", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Audit Log", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Certificates", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Cloud OnRamp", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Cluster", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Colocation", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Device Inventory", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Device Monitoring", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Device Reboot", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Events", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Manage Users", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Policy Configuration", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Policy Deploy", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "RBAC VPN", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Security Policy Configuration", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Settings", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Software Upgrade", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Template Configuration", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Template Deploy", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Tools", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "vAnalytics", + "enabled": true, + "read": true, + "write": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete user group", + "operationId": "deleteUserGroup", + "parameters": [ + { + "name": "userGroupId", + "in": "path", + "description": "User group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/vpngroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get VPN groups", + "operationId": "getVpnGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN groups": { + "description": "VPN groups", + "value": { + "data": [ + { + "name": "VPNGroup", + "vpnGroupId": "34bb9532-60bd-464b-bb35-393f7bac5e56", + "description": "Sample", + "owner": "admin", + "lastUpdated": 1590190679126, + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb" + ], + "hasRbacGroup": true, + "userGroupName": "demo" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-read,RBAC VPN-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Add VPN group", + "operationId": "createVpnGroup", + "requestBody": { + "description": "VPN group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPN group": { + "description": "VPN group", + "value": { + "rbacRequired": true, + "userGroupName": "demo", + "name": "VPNGroup", + "description": "Sample", + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-write" + } + }, + "/admin/vpngroup/{id}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update VPN group", + "operationId": "editVpnGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "VPN group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "VPN group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPN group": { + "description": "VPN group", + "value": { + "rbacRequired": true, + "userGroupName": "demo", + "name": "VPNGroup", + "description": "Sample", + "vpnGroupId": "34bb9532-60bd-464b-bb35-393f7bac5e56", + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb", + "64b30b74-08e2-4b4b-81ca-d019c7e452d5" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete VPN group", + "operationId": "deleteVpnGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "VPN group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-write" + } + }, + "/alarms": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarms for last 30min if vManage query is not specified", + "operationId": "getAlarms", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "suppressed": false, + "devices": [ + { + "system-ip": "172.16.255.201" + } + ], + "eventname": "security-root-cert-chain-installed", + "type": "security-root-cert-chain-installed", + "rulename": "security-root-cert-chain-installed", + "component": "Security", + "entry_time": 1636914912376, + "statcycletime": 1636914906000, + "message": "Root cert chain installed", + "severity": "Critical", + "severity_number": 1, + "uuid": "b28d5637-d966-4898-a103-7e7e8d595b50", + "values": [ + { + "system-ip": "172.16.255.201", + "host-name": "vm201" + } + ], + "rule_name_display": "Root_Cert_Chain_Installed", + "receive_time": 1636914906044, + "values_short_display": [ + { + "host-name": "vm201", + "system-ip": "172.16.255.201" + } + ], + "system_ip": "172.16.255.201", + "acknowledged": false, + "active": true, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "id": "eS27H30BnC2wznhMXd52" + } + ], + "pageInfo": { + "startTime": "1636914912376", + "endTime": "1636656222308", + "count": 1 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets lists of alarms along with the raw alarm data of each.", + "operationId": "getRawAlarmData", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Alarm query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm query string": { + "description": "Alarm query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "suppressed": false, + "devices": [ + { + "system-ip": "172.16.255.201" + } + ], + "eventname": "security-root-cert-chain-installed", + "type": "security-root-cert-chain-installed", + "rulename": "security-root-cert-chain-installed", + "component": "Security", + "entry_time": 1636914912376, + "statcycletime": 1636914906000, + "message": "Root cert chain installed", + "severity": "Critical", + "severity_number": 1, + "uuid": "b28d5637-d966-4898-a103-7e7e8d595b50", + "values": [ + { + "system-ip": "172.16.255.201", + "host-name": "vm201" + } + ], + "rule_name_display": "Root_Cert_Chain_Installed", + "receive_time": 1636914906044, + "values_short_display": [ + { + "host-name": "vm201", + "system-ip": "172.16.255.201" + } + ], + "system_ip": "172.16.255.201", + "acknowledged": false, + "active": true, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "id": "eS27H30BnC2wznhMXd52" + } + ], + "pageInfo": { + "startTime": "1636914912376", + "endTime": "1636656222308", + "count": 1 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/aggregation": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets aggregated list of alarms along with the raw alarm data of each aggregation", + "operationId": "getAlarmAggregationData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "entry_time", + "type": "date", + "value": [ + "24" + ], + "operator": "last_n_hours" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "severity", + "order": "asc", + "sequence": 1 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + } + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated alarms with its raw data": { + "description": "Aggregated alarms with its raw data", + "value": { + "data": [ + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Critical" + }, + { + "entry_time": 1640655000000, + "count": 2, + "severity": "Major" + }, + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Medium" + }, + { + "entry_time": 1640655000000, + "count": 4, + "severity": "Minor" + }, + { + "entry_time": 1640656800000, + "count": 5, + "severity": "Critical" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets aggregated list of alarms along with the raw alarm data of each aggregation", + "operationId": "getPostAlarmAggregationData", + "requestBody": { + "description": "Input query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Input query": { + "description": "Input query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "entry_time", + "type": "date", + "value": [ + "24" + ], + "operator": "last_n_hours" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "severity", + "order": "asc", + "sequence": 1 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated alarms with its raw data": { + "description": "Aggregated alarms with its raw data", + "value": { + "data": [ + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Critical" + }, + { + "entry_time": 1640655000000, + "count": 2, + "severity": "Major" + }, + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Medium" + }, + { + "entry_time": 1640655000000, + "count": 4, + "severity": "Minor" + }, + { + "entry_time": 1640656800000, + "count": 5, + "severity": "Critical" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/clear": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Clears specific stale alarm", + "operationId": "clearStaleAlarm", + "requestBody": { + "description": "alarm_uuid", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "alarm_uuid": { + "description": "alarm_uuid", + "value": { + "alarm_uuid": "29f9bf31-0fbe-4114-b8f0-e6234699485c" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/count": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get count of the alarms which are active and acknowledged by the user", + "operationId": "getNonViewedActiveAlarmsCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm count": { + "description": "Alarm count", + "value": { + "header": { + "generatedOn": 1636687449660 + }, + "data": [ + { + "count": 86, + "cleared_count": 173 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/disabled": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "List all disabled alarms", + "operationId": "listDisabledAlarm", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Enable/Disable a specific alarm", + "operationId": "disableEnableAlarm", + "parameters": [ + { + "name": "eventName", + "in": "query", + "description": "Event name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "disable", + "in": "query", + "description": "Disable", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "time", + "in": "query", + "description": "time in hours [1, 72], -1 means infinite", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "alarm config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "alarms": { + "description": "alarms", + "value": "{\n \"eventName\":\"bfd\",\n \"disable\":true,\n \"time\":2,\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/doccount": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get response count of a query", + "operationId": "getCount_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_1", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/dump": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "dump correlation engine server data", + "operationId": "dumpCorrelationEngineData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "dump correlation engine server data": { + "description": "dump correlation engine server data", + "value": { + "Message": "Successfully dump data in log file" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/fields": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/link-state-alarm": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get configuration for link-state alarm", + "operationId": "getLinkStateAlarmConfig", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Enable/Disable a specific link-state alarm", + "operationId": "enableDisableLinkStateAlarm", + "parameters": [ + { + "name": "linkName", + "in": "query", + "description": "Link name (bgp, ospf)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enable", + "in": "query", + "description": "Enable", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "description": "alarm config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "alarms": { + "description": "alarms", + "value": "{\n \"linkName\":\"bgp\",\n \"enable\":true,\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/markallasviewed": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Mark all larms as acknowledged by the user", + "operationId": "markAllAlarmsAsViewed", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Query filter, possible value are \"active\" \"cleared\"", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/markviewed": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Mark alarms as acknowledged by the user", + "operationId": "markAlarmsAsViewed", + "requestBody": { + "description": "List of alarms", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of alarms": { + "description": "List of alarms", + "value": { + "uuid": [ + "29f9bf31-0fbe-4114-b8f0-e6234699485c" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "count": 73, + "cleared_count": 20 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/master": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get master manager state", + "operationId": "getMasterManagerState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "manager state": { + "description": "manager state", + "value": { + "master-ip": "10.105.0.202", + "AlarmEvent0": "10.105.0.202", + "AlarmEvent9": "10.105.0.200", + "AlarmEvent10": "10.105.0.201", + "AlarmEvent6": "10.105.0.201", + "AlarmEvent5": "10.105.0.202", + "AlarmEvent8": "10.105.0.200", + "AlarmEvent7": "10.105.0.202", + "AlarmEventGlobal": "10.105.0.201", + "AlarmEvent2": "10.105.0.200", + "AlarmEvent1": "10.105.0.200", + "AlarmEvent4": "10.105.0.202", + "AlarmEvent3": "10.105.0.201" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/notviewed": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarms which are active and acknowledged by the user", + "operationId": "getNonViewedAlarms", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "entry_time": 1636621017025, + "cleared_time": 1636621609835, + "severity": "Critical", + "rule_name_display": "Control_Node_Down", + "possible_causes": [ + "Trying to determine possible root causes" + ], + "suppressed": false, + "component": "Control", + "acknowledged": false, + "values_short_display": [ + { + "host-name": "vm1", + "system-ip": "172.16.255.11" + } + ], + "devices": [ + { + "system-ip": "172.16.255.11" + } + ], + "severity_number": 1, + "values": [ + { + "site-id": "100", + "host-name": "vm1", + "system-ip": "172.16.255.11" + } + ], + "active": false, + "message": "All Control connections for the node are down", + "type": "node_down", + "cleared_by": "d7041fe3-cb51-4f5c-9d51-26a6108a01a4", + "tenant": "default", + "uuid": "386dca30-101e-45a5-92f9-4f31f5a48a2e" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/page": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get paginated alarm raw data", + "operationId": "getStatBulkAlarmRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + } + }, + { + "name": "scrollId", + "in": "query", + "description": "Query offset", + "required": true, + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Query size", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "severity": "Critical", + "component": "Security", + "message": "Root cert chain installed", + "id": "B-FwAHIB_JLsavez9r7z" + }, + { + "severity": "Medium", + "component": "VPN", + "message": "The interface oper-state changed to up", + "id": "w-FLAHIB_JLsavezubKl" + } + ], + "pageInfo": { + "startTime": "", + "endTime": "", + "count": 2 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get paginated alarm raw data", + "operationId": "getPostStatBulkAlarmRawData", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "Query offset", + "required": true, + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Query size", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Alarm query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm query string": { + "description": "Alarm query string", + "value": { + "query": { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "severity": "Critical", + "component": "Security", + "message": "Root cert chain installed", + "id": "B-FwAHIB_JLsavez9r7z" + }, + { + "severity": "Medium", + "component": "VPN", + "message": "The interface oper-state changed to up", + "id": "w-FLAHIB_JLsavezubKl" + } + ], + "pageInfo": { + "startTime": "", + "endTime": "", + "count": 2 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/purgefrequency": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Set alarm purge timer", + "operationId": "setPeriodicPurgeTimer", + "parameters": [ + { + "name": "interval", + "in": "query", + "description": "Purge interval", + "schema": { + "type": "string" + } + }, + { + "name": "activeTime", + "in": "query", + "description": "Purge activeTime", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm purge setting": { + "description": "Alarm purge setting", + "value": { + "interval": 60000, + "activeTime": 60000 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/query/fields": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/query/input": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get query configuration", + "operationId": "createAlarmQueryConfig", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm query configuration": { + "description": "Alarm query configuration", + "value": { + "timeOptions": [ + { + "enableDateFields": false, + "value": "Last 24 hours", + "key": "last_24_hours" + }, + { + "enableDateFields": true, + "value": "Custom", + "key": "custom" + } + ], + "component": [ + { + "value": "System", + "key": "system" + }, + { + "value": "Control", + "key": "control" + }, + { + "value": "Interface", + "key": "interface" + } + ], + "severityOptions": [ + { + "value": "Critical", + "key": "critical" + }, + { + "value": "Major", + "key": "major" + }, + { + "value": "Minor", + "key": "minor" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/reset": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Reset correlation engine data", + "operationId": "correlAntiEntropy", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": { + "Message": "Successfully reset correlation engine data" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/restart": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Restart correlation engine", + "operationId": "restartCorrelationEngine", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": { + "Message": "Successfully restarted correlation engine" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/rulenamedisplay/keyvalue": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets alarm type as key value pair", + "operationId": "getAlarmTypesAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm types": { + "description": "Alarm types", + "value": { + "header": { + "generatedOn": 1637230423454 + }, + "data": [ + { + "value": "BFD Node Up", + "key": "BFD_Node_Up" + }, + { + "value": "BFD Between Sites Down", + "key": "BFD_Between_Sites_Down" + }, + { + "value": "Disk Write Speed", + "key": "Disk_Write_Speed" + }, + { + "value": "System-IP Change", + "key": "System-IP_Change" + }, + { + "value": "ZBFW Session Maximum", + "key": "ZBFW_Session_Maximum" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/severity": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm by severity", + "operationId": "getAlarmsBySeverity", + "parameters": [ + { + "name": "severity-level", + "in": "query", + "description": "Alarm severity", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "major", + "minor", + "medium", + "critical" + ] + }, + "enum": [ + "major", + "minor", + "medium", + "critical" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm": { + "description": "Alarm", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/severity/summary": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm severity histogram", + "operationId": "getAlarmSeverityCustomHistogram", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm histogram query string", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm histogram": { + "description": "Alarm histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/severitymappings": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets alarm severity mappings", + "operationId": "getAlarmSeverityMappings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm severity map": { + "description": "Alarm severity map", + "value": [ + { + "associatedAlarms": [ + { + "value": "System IP Reuse", + "key": "System_IP_Reuse" + }, + { + "value": "OMP All Vsmarts Down", + "key": "OMP_All_Vsmarts_Down" + }, + { + "value": "ZBFW Session Maximum", + "key": "ZBFW_Session_Maximum" + } + ], + "value": "Minor", + "key": "Minor" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/starttracking/{testName}": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Start tracking events", + "operationId": "startTracking", + "parameters": [ + { + "name": "testName", + "in": "path", + "description": "test name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/stats": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm statistics", + "operationId": "getStats", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm statistics": { + "description": "Alarm statistics", + "value": { + "Correlation Engine": { + "Added Events": 16819 + }, + "Correlation DB Manipulator": { + "Link Update Events": { + "Discarded Events": 0, + "Total": 0, + "Processed Events": 0 + }, + "Other Events": { + "Discarded Events": 0, + "Total": 16817, + "Processed Events": 16817 + } + }, + "Link Update Correlator": {} + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/stoptracking/{testName}": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Stop tracking events", + "operationId": "stopTracking", + "parameters": [ + { + "name": "testName", + "in": "path", + "description": "test name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/topic": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get device topic state", + "operationId": "getDeviceTopic", + "parameters": [ + { + "name": "ip", + "in": "query", + "description": "Query topic", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + }, + "example": "172.16.255.14" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "device topic state": { + "description": "device topic state", + "value": [ + { + "model_sk": "None", + "state_description": "All daemons up", + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.22", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "0", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vmanage", + "uuid": "c36658b0-71cc-48ba-a806-6e6e476ebf22", + "lastupdated": 1636958286777, + "platform": "x86_64", + "state": "green", + "host-name": "vm12", + "uptime-date": 1635906180000, + "latitude": "37.666684", + "system-ip": "172.16.255.22", + "personality": "vmanage", + "status": "normal", + "board-serial": "12345963", + "validity": "valid", + "certificate-validity": "Valid", + "max-controllers": "0", + "device-model": "vmanage", + "deviceId": "172.16.255.22", + "layoutLevel": 1, + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + }, + { + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.20", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "1", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vsmart", + "uuid": "fbafb4a5-5a98-4587-8e6e-b34debb8f9e8", + "lastupdated": 1636958307799, + "platform": "x86_64", + "host-name": "vm10", + "uptime-date": 1635855000000, + "latitude": "37.666684", + "system-ip": "172.16.255.20", + "personality": "vsmart", + "status": "normal", + "board-serial": "12345961", + "validity": "valid", + "certificate-validity": "Valid", + "device-model": "vsmart", + "deviceId": "172.16.255.20", + "layoutLevel": 2, + "ompPeers": "6", + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/uuid/{alarm_uuid}": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm detail", + "operationId": "getAlarmDetails", + "parameters": [ + { + "name": "alarm_uuid", + "in": "path", + "description": "Alarm Id", + "required": true, + "schema": { + "type": "string", + "default": "b28d5637-d966-4898-a103-7e7e8d595b50" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm detail": { + "description": "Alarm detail", + "value": [ + { + "model_sk": "None", + "state_description": "All daemons up", + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.22", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "0", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vmanage", + "uuid": "c36658b0-71cc-48ba-a806-6e6e476ebf22", + "lastupdated": 1637137519265, + "platform": "x86_64", + "state": "green", + "host-name": "vm12", + "uptime-date": 1635906180000, + "latitude": "37.666684", + "system-ip": "172.16.255.22", + "personality": "vmanage", + "status": "normal", + "board-serial": "12345963", + "validity": "valid", + "certificate-validity": "Valid", + "max-controllers": "0", + "device-model": "vmanage", + "deviceId": "172.16.255.22", + "layoutLevel": 1, + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get stat raw data", + "operationId": "getStatDataRawAuditLogData", + "parameters": [ + { + "name": "inputQuery", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data with post action", + "operationId": "getRawPropertyData", + "requestBody": { + "description": "Query filter for getting stat raw data", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/aggregation": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data aggregated", + "operationId": "getPropertyAggregationData", + "parameters": [ + { + "name": "inputQuery", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data aggregated with post action", + "operationId": "getPostPropertyAggregationData", + "requestBody": { + "description": "Query filter for getting stat raw data", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/doccount": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get response count of a query", + "operationId": "getCount", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get response count of a query", + "operationId": "getCountPost", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog/fields": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog/page": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data in bulk", + "operationId": "getStatBulkRawPropertyData", + "parameters": [ + { + "name": "inputQuery", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "scrollId", + "in": "query", + "description": "Offset of the query result", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "size of the query result", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data in bulk with post action", + "operationId": "getPostStatBulkRawPropertyData", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "Offset of the query result", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "Size of the query result", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Query filter for getting stat raw data", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/query/fields": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog/severity": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get audit logs for last 3 hours", + "operationId": "generateAuditLog", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Audit log": { + "description": "Audit log", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/severity/summary": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get audit log severity histogram", + "operationId": "getAuditSeverityCustomHistogram", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Audit log severity histogram": { + "description": "Audit log severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/backup/backupinfo": { + "delete": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Delete all or a specific backup file stored in vManage", + "operationId": "deleteSchduledBackup", + "parameters": [ + { + "name": "taskId", + "in": "query", + "description": "task id", + "schema": { + "type": "string" + } + }, + { + "name": "backupInfoId", + "in": "query", + "description": "Local Backup Info Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Deleted file list": { + "description": "Deleted file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/backupinfo/{localBackupInfoId}": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Get a localBackupInfo record by localBackupInfoId", + "operationId": "getLocalBackupInfo", + "parameters": [ + { + "name": "localBackupInfoId", + "in": "path", + "description": "localBackupInfo Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get LocalBackupInfo ": { + "description": "Get LocalBackupInfo ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/download/{path}": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Download a Backup File that is already stored in vManage", + "operationId": "downloadBackupFile", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "File path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file stream": { + "description": "Backup file stream" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/export": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Trigger a backup of configuration database and statstics database and store it in vManage", + "operationId": "exportBackup", + "requestBody": { + "description": "backup request information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/list": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "List all backup files of a tenant stored in vManage", + "operationId": "listBackup", + "parameters": [ + { + "name": "size", + "in": "query", + "description": "size", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file list": { + "description": "Backup file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/certificate/certdetails": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get cert details", + "operationId": "getCertDetails", + "requestBody": { + "description": "parse cert", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate": { + "description": "Certificate", + "value": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE---- " + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read" + } + }, + "/certificate/csr/details": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get CSR detail view", + "operationId": "getCSRViewRightMenus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR detail": { + "description": "CSR detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/device/details": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get device detail view", + "operationId": "getDeviceViewRightMenus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device detail": { + "description": "Device detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/device/invalidate": { + "post": { + "tags": [ + "Configuration - Device Connectivity" + ], + "description": "invalidate the device", + "operationId": "invalidateDevice", + "requestBody": { + "description": "vEdge device info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device info": { + "description": "vEdge device info", + "value": { + "chassisNumber": "C8K-979f05bd-7568-470e-ab16-fd9957809e13", + "deviceIp": "172.16.255.16" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/device/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vEdge list", + "operationId": "getDevicesList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge list": { + "description": "vEdge list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/device/stage": { + "post": { + "tags": [ + "Configuration - Device Connectivity" + ], + "description": "Stop data traffic to device", + "operationId": "stageDevice", + "requestBody": { + "description": "vEdge device info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device info": { + "description": "vEdge device info", + "value": { + "chassisNumber": "C8K-979f05bd-7568-470e-ab16-fd9957809e13", + "deviceIp": "172.16.255.16" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/forcesync/rootCert": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Force sync root certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "forceSyncRootCert", + "requestBody": { + "description": "Singed certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Singed certificate": { + "description": "Singed certificate" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/generate/csr": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "generateCSR", + "requestBody": { + "description": "CSR request for device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/generate/enterprise/csr/vedge": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "generateEnterpriseCSR", + "requestBody": { + "description": "CSR request for hardware device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request", + "value": { + "deviceUUID": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": { + "id": "0a8db9bd-790e-44d2-ad84-6ceabf63c1c5" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/generate/wanedge/csr": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "generateEdgeDeviceCSR", + "requestBody": { + "description": "CSR request for device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request", + "value": { + "deviceUUID": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/install/signedCert": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Install singed certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "installCertificate", + "requestBody": { + "description": "Singed certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Singed certificate": { + "description": "Singed certificate" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/jks": { + "put": { + "tags": [ + "Certificate Management - Device" + ], + "description": "update JKS


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "updateJks", + "requestBody": { + "description": "Update JKS", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "JKS": { + "description": "JKS", + "value": "binary format of JKS" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/list/status": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "get certificate", + "operationId": "getListStatus", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/mthub/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vSmart list", + "operationId": "setvSmartList_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/record": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate chain", + "operationId": "getCertificateData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate chain": { + "description": "Certificate chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write,dca" + } + }, + "/certificate/reset/rsa": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Register CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "resetRSA", + "requestBody": { + "description": "CSR request for vEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR for vEdge": { + "description": "CSR for vEdge", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/revoke/enterprise/certificate": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Revoking enterprise CSR for hardware vEdge


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "decommissionEnterpriseCSRForVedge", + "requestBody": { + "description": "Revoking CSR for hardware vEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoking CSR request": { + "description": "Revoking CSR request", + "value": { + "uuid": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": {} + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/rootcertchains": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get root cert chain", + "operationId": "getRootCertChains", + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Action", + "required": true, + "schema": { + "type": "string", + "enum": [ + "get", + "verify" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read" + }, + "put": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save root cert chain


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "saveRootCertChain", + "requestBody": { + "description": "Save root cert chain", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Save root cert chain": { + "description": "Save root cert chain", + "value": { + "RootCertChain": [ + { + "Certificate": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----\n" + }, + { + "Certificate": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----\n" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/rootcertificate": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get device root certificate detail view", + "operationId": "getRootCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device root certificate detail": { + "description": "Device root certificate detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/certificate/save/vedge/list": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vEdge device list", + "operationId": "saveVEdgeList", + "requestBody": { + "description": "vEdge device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device list": { + "description": "vEdge device list", + "value": [ + { + "chasisNumber": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18", + "serialNumber": "f0b1985ba82e4c4889c225c59ca9a878", + "validity": "staging" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": { + "id": "0a8db9bd-790e-44d2-ad84-6ceabf63c1c5" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/stats/detail": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate detail", + "operationId": "getCertificateDetail", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate stats detail": { + "description": "Certificate stats detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/stats/summary": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate expiration status", + "operationId": "getCertificateStats", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate status view": { + "description": "Certificate status view", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/certificate/syncvbond": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "sync vManage UUID to all vBond", + "operationId": "syncvBond", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device root certificate detail": { + "description": "Device root certificate detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/certificate/tokengeneratedlist": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get cEdge list with tokengenerated list", + "operationId": "getcEdgeList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge list": { + "description": "vEdge list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vedge": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get Installed Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getInstalledCert", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vedge/csr": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vEdge CSR Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getvEdgeCSR", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vedge/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vEdge list", + "operationId": "getvEdgeList", + "parameters": [ + { + "name": "model", + "in": "query", + "description": "Device model", + "schema": { + "type": "string", + "enum": [ + "vedge-cloud", + "vedge-1000", + "vedge-2000", + "vedge-100", + "vedge-ISR1100-4G", + "vedge-ISR1100-4GLTE", + "vedge-ISR1100X-4G", + "vedge-ISR1100-6G", + "vedge-ISR1100X-6G", + "vedge-100-B", + "vedge-100-WM", + "vedge-100-M", + "vEdge-5000", + "vedge-CSR-1000v", + "vedge-IR-1101", + "vedge-IR-1821", + "vedge-IR-1831", + "vedge-IR-1833", + "vedge-IR-1835", + "vedge-IR-8140H", + "vedge-IR-8140H-P", + "vedge-IR-8340", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-IR-1101", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-ISR-4221X", + "vedge-ISR-4431", + "vedge-ISR-4451-X", + "vedge-ASR-1001-HX", + "vedge-ASR-1002-X", + "vedge-ASR-1002-HX", + "vedge-ASR-1006-X", + "vedge-C1111-8P", + "vedge-C1121X-8P", + "vedge-C1111X-8P", + "vedge-C1111-8PLTELAW", + "vedge-C1111-8PLTEEA", + "vedge-C1121-8PLTEPW", + "vedge-C1111-8PLTELA", + "vedge-C1117-4PLTEEA", + "vedge-C1126X-8PLTEP", + "vedge-C1127X-8PLTEP", + "vedge-C1127X-8PMLTEP", + "vedge-C1127-8PMLTEP", + "vedge-C1117-4PLTELA", + "vedge-ISRv", + "vedge-C8000V", + "vedge-ASR-1001-X", + "vedge-C1111-4P", + "vedge-C1101-4P", + "vedge-C1101-4PLTEP", + "vedge-C8500-12X4QC", + "vedge-C8500-20X6C", + "vedge-C8500-12X", + "vedge-C8500L-8S4X", + "vedge-C1111-8PW", + "vedge-C1111-8PLTEEAW", + "vedge-C1111-4PLTEEA", + "vedge-C1101-4PLTEPW", + "vedge-C1109-4PLTE2PW", + "vedge-C1109-4PLTE2P", + "vedge-C1121X-8PLTEP", + "vedge-C1161X-8PLTEP", + "vedge-C1113-8PMLTEEA", + "vedge-C1111-4PLTELA,vedge-C1116-4P", + "vedge-C1116-4PLTEEA", + "vedge-C1117-4P", + "vedge-C1117-4PM", + "vedge-C1117-4PMLTEEA", + "vsmart", + "vmanage", + "vbond", + "vedge-ISR-4461", + "vedge-C8300-1N1S-4T2X", + "vedge-C8300-1N1S-6T", + "vedge-C1161X-8P", + "vedge-C8300-2N2S-4T2X", + "vedge-C8300-2N2S-6T", + "vedge-C8200-1N-4T", + "vedge-C8200L-1N-4T", + "vedge-C1161-8P", + "vedge-C1126-8PLTEP", + "vedge-C1127-8PLTEP", + "vedge-C1121-4P", + "vedge-C1121-4PLTEP", + "vedge-C1128-8PLTEP", + "vedge-C1121X-8PLTEPW", + "vedge-C1121-8PLTEP", + "vedge-C1121-8P", + "vedge-C1161-8PLTEP", + "vedge-C1113-8PLTEEA", + "vedge-C1113-8PLTEW", + "vedge-C1111-4PW", + "vedge-C1112-8P", + "vedge-C1112-8PLTEEA", + "vedge-C1112-8PLTEEAWE", + "vedge-C1112-8PWE", + "vedge-C1113-8P", + "vedge-C1113-8PLTEEAW", + "vedge-C1113-8PLTELA", + "vedge-C1113-8PLTELAWZ", + "vedge-C1113-8PM", + "vedge-C1113-8PMWE", + "vedge-C1113-8PW", + "vedge-C1116-4PLTEEAWE", + "vedge-C1131-8PW", + "vedge-C1131X-8PW", + "vedge-C1131-8PLTEPW", + "vedge-C1131X-8PLTEPW", + "vedge-C1116-4PWE", + "vedge-C1117-4PLTEEAW", + "vedge-C1117-4PLTELAWZ", + "vedge-C1117-4PMLTEEAWE", + "vedge-C1117-4PMWE", + "vedge-C1117-4PW", + "vedge-C1118-8P", + "vedge-C1109-2PLTEGB", + "vedge-C1109-2PLTEUS", + "vedge-C1109-2PLTEVZ" + ] + } + }, + { + "name": "state", + "in": "query", + "description": "Device state", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge list": { + "description": "vEdge list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vEdge list", + "operationId": "setvEdgeList", + "requestBody": { + "description": "vEdge device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device list": { + "description": "vEdge device list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/view": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate UI view", + "operationId": "getView", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device certificate view": { + "description": "Device certificate view", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vmanage/selfsignedcert": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "get self signed certificate", + "operationId": "getSelfSignedCert", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Self signed certificate": { + "description": "Self signed certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read" + } + }, + "/certificate/vsmart/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vSmart list


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getvSmartList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vSmart list": { + "description": "vSmart list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vSmart list", + "operationId": "setvSmartList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/{uuid}": { + "delete": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Invalidate device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "deleteConfiguration", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "replaceController", + "in": "query", + "description": "Replace a vSmart in Multi-tenant setup with a new vSmart", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "deviceId", + "in": "query", + "description": "uuid of new vSmart", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/cloudservices/accesstoken": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "operationId": "getAccessTokenforDevice", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/cloudservices/app/webex": { + "put": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Day N- Update Webex App", + "operationId": "enableWebex_1", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Add Webex App", + "operationId": "enableWebex", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + }, + "delete": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "deleteWebexPrefixLists", + "operationId": "deleteWebexPrefixLists", + "requestBody": { + "description": "TMP-Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/cloudservices/authtoken": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get Azure token", + "operationId": "getAzureToken", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry state": { + "description": "Telemetry state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/connect": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Telemetry Opt In", + "operationId": "connect", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry Opt In": { + "description": "Telemetry Opt In", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/credentials": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service credentials", + "operationId": "getCloudCredentials", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service credentials": { + "description": "Cloud service credentials", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + }, + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service settings", + "operationId": "addCloudCredentials", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service setting": { + "description": "Cloud service setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca,CXP-write,default" + } + }, + "/cloudservices/devicecode": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get Azure device code", + "operationId": "getDeviceCode", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry state": { + "description": "Telemetry state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/m365/preferredpath": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getO365PreferredPathFromVAnalytics", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/cloudservices/staging": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Check if testbed or production", + "operationId": "isStaging", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Environment": { + "description": "Environment", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/cloudservices/telemetry": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get Telemetry state", + "operationId": "getTelemetryState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry state": { + "description": "Telemetry state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/telemetry/optin": { + "put": { + "tags": [ + "System - Cloud Service" + ], + "description": "Telemetry Opt In", + "operationId": "optIn", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry Opt In": { + "description": "Telemetry Opt In", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/telemetry/optout": { + "delete": { + "tags": [ + "System - Cloud Service" + ], + "description": "Telemetry Opt Out", + "operationId": "optOut", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry Opt Out": { + "description": "Telemetry Opt Out", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,CXP-read,CXP-write,default," + } + }, + "/clusterManagement/clusterLocked": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Check whether cluster is locked


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "checkIfClusterLocked", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster lock": { + "description": "Cluster lock", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/clusterworkflow/version": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getClusterWorkflowVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "clusterV2Enabled": { + "description": "clusterV2Enabled", + "value": "True" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/configure": { + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Configure vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "configureVmanage", + "requestBody": { + "description": "vManage server config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage server config": { + "description": "vManage server config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/connectedDevices/{vmanageIP}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get connected device for vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getConnectedDevices", + "parameters": [ + { + "name": "vmanageIP", + "in": "path", + "description": "vManage IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/health/details": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "healthDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster health check detail": { + "description": "Cluster health check detail", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/health/status": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "healthStatusInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster health status info": { + "description": "Cluster health status info", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/health/summary": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get cluster health check summary


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "healthSummary", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Flag to enable cached result", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster health check summary": { + "description": "Cluster health check summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/iplist/{vmanageID}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get configured IP addresses


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getConfiguredIPList", + "parameters": [ + { + "name": "vmanageID", + "in": "path", + "description": "vManage Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vManage IP list": { + "description": "vManage IP list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/isready": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Is cluster ready


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "isClusterReady", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster state": { + "description": "Cluster state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/list": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "listVmanages", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vManage server": { + "description": "vManage server", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/nodeProperties": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get properties of vManage being added to cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "nodeProperties", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage cluster properties": { + "description": "vManage cluster properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/remove": { + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Remove vManage from cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "removeVmanage", + "requestBody": { + "description": "vManage server info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage server info": { + "description": "vManage server info", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/replicateAndRebalance": { + "put": { + "tags": [ + "Cluster Management" + ], + "description": "Initiate replication and rebalance of kafka topics


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "performReplicationAndRebalanceOfKafkaPartitions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Kafka topics rebalance status": { + "description": "Kafka topics rebalance status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/setup": { + "put": { + "tags": [ + "Cluster Management" + ], + "description": "Update vManage cluster info


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editVmanage", + "requestBody": { + "description": "vManage cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage cluster config": { + "description": "vManage cluster config", + "value": "{\n \"vmanageID\":\"0\",\n \"deviceIP\u201d:\u201d10.0.1.38\u201d,\n \"username\":\"admin\",\n \"password\u201d:\u201dpassword\u201d,\n \"persona\":\"COMPUTE_AND_DATA\",\n \"services\":{\n \"container-manager\":{\n \"server\":false\n }\n }\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Add vManage to cluster", + "operationId": "addVmanage", + "requestBody": { + "description": "vManage cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage cluster config": { + "description": "vManage cluster config", + "value": { + "deviceIP": "10.0.1.200", + "username": "admin", + "password": "password", + "genCSR": false, + "persona": "COMPUTE_AND_DATA", + "services": { + "container-manager": { + "server": false + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/tenancy/mode": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get vManage tenancy mode


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenancyMode", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage tenancy mode": { + "description": "vManage tenancy mode", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Update vManage tenancy mode", + "operationId": "setTenancyMode", + "requestBody": { + "description": "Tenancy mode setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenancy mode": { + "description": "Tenancy mode", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/tenantList": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get tenant list


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantsList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Tenant": { + "description": "Tenant", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/userCreds": { + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Add or update user credentials for cluster operations


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "addOrUpdateUserCredentials", + "requestBody": { + "description": "User credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User credential": { + "description": "User credential", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/vManage/details/{vmanageIP}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get vManage detail


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getVManageDetails", + "parameters": [ + { + "name": "vmanageIP", + "in": "path", + "description": "vManage IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage detail": { + "description": "vManage detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/{tenantId}/connectedDevices/{vmanageIP}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get connected device for vManage for a tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getConnectedDevicesPerTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vmanageIP", + "in": "path", + "description": "vManage IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/colocation/cluster": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get details of all existing Clusters", + "operationId": "getCloudDockClusterDetail", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Clouddock cluster": { + "description": "Clouddock cluster", + "value": { + "data": [ + { + "managementMask": "31", + "ccmIpAddress": "1.1.1.1/31", + "ccmdeviceName": "ccm-Cluster1", + "activeState": "INCOMPLETE", + "maxHaNetNumber": 1, + "description": "Description for Cluster1", + "serviceChainVlanPool": "100", + "clusterId": "b1201e77-3987-480e-b0d3-a2c972e59a33", + "ipPoolName": "Cluster1_ResourcePool", + "lastUpdated": 1590354925245, + "@rid": 3268, + "systemIpPool": "1.1.1.1", + "vnfNetworkPool": "1.1.1.1", + "clusterName": "Cluster1", + "clusterState": "INACTIVE", + "updatedBy": "admin", + "IpPoolDescription": "Description for Cluster1_ResourcePool", + "activeStateInternal": "INCOMPLETE", + "ccmdeviceTemplateId": "037a8893-3f35-4305-90a1-da9a30159586", + "vnfMgmtPool": "1.1.1.1", + "subnetMask": "255.255.255.254", + "managementGateway": "1.1.1.1", + "serviceChainCount": "0", + "designStatus": "IN_PROGRESS", + "siteId": "100", + "cspQueue": ",,", + "location": "us-west-1", + "csp": [ + { + "name": "CSP_Cluster13", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster11", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster12", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + } + ], + "switch": [ + { + "name": "Switch1", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + }, + { + "name": "Switch2", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + } + ], + "template": [ + { + "templateType": "clouddock_aaa", + "templateMinVersion": "15.0.0", + "deviceType": [ + "vedge-nfvis-CSP2100" + ], + "lastUpdatedBy": "admin", + "editedTemplateDefinition": "{\"authentication\":{\"users\":{\"user\":{\"vipType\":\"constant\",\"vipValue\":[{\"name\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"admin\"},\"password\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81\"},\"password-scrypt\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c\"},\"role\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"administrators\"}}],\"vipObjectType\":\"tree\",\"vipPrimaryKey\":[\"name\"]}}}}", + "templateDefinition": "{\"authentication\":{\"users\":{\"user\":{\"vipType\":\"constant\",\"vipValue\":[{\"name\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"admin\"},\"password\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81\"},\"password-scrypt\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c\"},\"role\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"administrators\"}}],\"vipObjectType\":\"tree\",\"vipPrimaryKey\":[\"name\"]}}}}", + "attachedMastersCount": 0, + "templateId": "30be9f2a-6188-4657-9286-fa993eb87cf2", + "configType": "xml", + "createdOn": 1590354925752, + "feature": "cloud-dock", + "factoryDefault": false, + "templateName": "Cluster1_Credentials", + "createdBy": "admin", + "devicesAttached": 0, + "templateDescription": "Description for Cluster1_Credentials", + "lastUpdatedOn": 1590354925752 + } + ], + "device_up": "0", + "device_down": "0", + "vnf_up": "0", + "vnf_down": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + }, + "put": { + "tags": [ + "Colocation" + ], + "description": "Update a existing cluster", + "operationId": "updateCloudDockCluster", + "requestBody": { + "description": "Cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster config": { + "description": "Cluster config", + "value": { + "cloudDockCluster": { + "clusterName": "Cluster1", + "ccmIpAddress": "1.1.1.1/31", + "siteId": "100", + "description": "Description for Cluster1", + "location": "us-west-1", + "isActiveCSPAdd": false, + "csp": [ + { + "name": "CSP_Cluster13", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster11", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster12", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + } + ], + "switch": [ + { + "name": "Switch1", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + }, + { + "name": "Switch2", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + } + ], + "setting": [ + { + "templateName": "Cluster1_Credentials", + "templateDescription": "Description for Cluster1_Credentials", + "templateType": "clouddock_aaa", + "templateMinVersion": "15.0.0", + "templateDefinition": { + "authentication": { + "users": { + "user": { + "vipType": "constant", + "vipValue": [ + { + "name": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "admin" + }, + "password": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81" + }, + "password-scrypt": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c" + }, + "role": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "administrators" + } + } + ], + "vipObjectType": "tree", + "vipPrimaryKey": [ + "name" + ] + } + } + } + }, + "transitionInProgress": false, + "deviceType": [ + "vedge-nfvis-CSP2100" + ], + "deviceModels": [ + { + "name": "vedge-nfvis-CSP2100", + "displayName": "vedge-nfvis-CSP2100-X1", + "deviceType": "vedge", + "isCliSupported": false, + "isCiscoDeviceModel": true + } + ], + "feature": "cloud-dock", + "lastUpdatedBy": "admin", + "editedTemplateDefinition": { + "authentication": { + "users": { + "user": { + "vipType": "constant", + "vipValue": [ + { + "name": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "admin" + }, + "password": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81" + }, + "password-scrypt": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c" + }, + "role": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "administrators" + } + } + ], + "vipObjectType": "tree", + "vipPrimaryKey": [ + "name" + ] + } + } + } + }, + "attachedMastersCount": 0, + "templateId": "30be9f2a-6188-4657-9286-fa993eb87cf2", + "configType": "xml", + "createdOn": 1590354925752, + "factoryDefault": false, + "createdBy": "admin", + "devicesAttached": 0, + "lastUpdatedOn": 1590354925752 + } + ], + "resourcePool": { + "ipPoolName": "Cluster1_ResourcePool", + "IpPoolDescription": "Description for Cluster1_ResourcePool", + "serviceChainVlanPool": "200", + "vnfMgmtPool": "1.1.1.1", + "vnfNetworkPool": "1.1.1.1", + "managementGateway": "1.1.1.1", + "managementMask": "31", + "systemIpPool": "1.1.1.1", + "ccmIpAddress": "1.1.1.1/31" + }, + "clusterId": "b1201e77-3987-480e-b0d3-a2c972e59a33" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + }, + "post": { + "tags": [ + "Colocation" + ], + "description": "Add a new cluster", + "operationId": "createCloudDockCluster", + "requestBody": { + "description": "Cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster config": { + "description": "Cluster config", + "value": { + "cloudDockCluster": { + "clusterName": "Cluster1", + "siteId": "100", + "description": "Description for Cluster1", + "location": "us-west-1", + "isActiveCSPAdd": false, + "csp": [ + { + "name": "CSP_Cluster11", + "uuid": "" + }, + { + "name": "CSP_Cluster12", + "uuid": "" + }, + { + "name": "CSP_Cluster13", + "uuid": "" + } + ], + "switch": [ + { + "name": "Switch1", + "uuid": "" + }, + { + "name": "Switch2", + "uuid": "" + } + ], + "setting": [ + { + "templateName": "Cluster1_Credentials", + "templateDescription": "Description for Cluster1_Credentials", + "templateType": "clouddock_aaa", + "templateMinVersion": "15.0.0", + "templateDefinition": { + "authentication": { + "users": { + "user": { + "vipType": "constant", + "vipValue": [ + { + "name": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "admin" + }, + "password": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81" + }, + "password-scrypt": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c" + }, + "role": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "administrators" + } + } + ], + "vipObjectType": "tree", + "vipPrimaryKey": [ + "name" + ] + } + } + } + }, + "transitionInProgress": true, + "deviceType": [ + "vedge-nfvis-CSP2100" + ], + "deviceModels": [ + { + "name": "vedge-nfvis-CSP2100", + "displayName": "vedge-nfvis-CSP2100-X1", + "deviceType": "vedge", + "isCliSupported": false, + "isCiscoDeviceModel": true + } + ], + "feature": "cloudDock", + "factoryDefault": false + } + ], + "resourcePool": { + "ipPoolName": "Cluster1_ResourcePool", + "IpPoolDescription": "Description for Cluster1_ResourcePool", + "serviceChainVlanPool": "100", + "vnfMgmtPool": "1.1.1.1", + "vnfNetworkPool": "1.1.1.1", + "managementGateway": "1.1.1.1", + "managementMask": "31", + "systemIpPool": "1.1.1.1", + "ccmIpAddress": "1.1.1.1/31" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/activate": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Activate a cluster", + "operationId": "acitvateCloudDockCluster", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster detail": { + "description": "Cluster detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/activateClusterDummy": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Activate dummp cluster", + "operationId": "dummyccm", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/cluster/activateClusterDummyState": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Activate cluster in a state", + "operationId": "dummycspState", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "Cluster state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/cluster/attached/csp": { + "put": { + "tags": [ + "Colocation" + ], + "description": "Update attached csp to cluster", + "operationId": "updateCspToCluster", + "requestBody": { + "description": "CSP config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSP config": { + "description": "CSP config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/config": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Clouddock cluster preview", + "operationId": "CloudDockClusterPreview", + "parameters": [ + { + "name": "serialNumber", + "in": "query", + "description": "Serial number", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Cluster detail": { + "description": "Cluster detail" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/deactivate": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Deactivate clouddock cluster", + "operationId": "deAcitvateCloudDockCluster", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/id": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get cluster by Id", + "operationId": "getCloudDockClusterDetailById", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Clouddock cluster detail": { + "description": "Clouddock cluster detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/cluster/rma": { + "post": { + "tags": [ + "Colocation" + ], + "description": "RMA operation for CSP device", + "operationId": "rmaCloudDockCsp", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSP info": { + "description": "CSP info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/{clustername}": { + "delete": { + "tags": [ + "Colocation" + ], + "description": "Delete cluster by name", + "operationId": "deleteCloudDockClusterByName", + "parameters": [ + { + "name": "clustername", + "in": "path", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/monitor/cluster": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of ids of existing clusters", + "operationId": "getClusterDetailsByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster detail": { + "description": "Cluster detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/cluster/config": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of devices of clusters", + "operationId": "getClusterConfigByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cluster details": { + "description": "Cluster details", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/cluster/portView": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of port mappings in the cluster", + "operationId": "getClusterPortMappingByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cluster port mapping": { + "description": "Cluster port mapping", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/device": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List details for Device", + "operationId": "getDeviceDetailByDeviceId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device detail": { + "description": "Device detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/device/system": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all connected VNF to a device", + "operationId": "getSystemStatusByDeviceId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/device/vnf": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all VNF attached with Device", + "operationId": "getvnfByDeviceId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/networkfunction/listmap": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Retrieve network function listing", + "operationId": "listNetworkFunctionMap", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Network functions": { + "description": "Network functions", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,Colocation User Service Group-read" + } + }, + "/colocation/monitor/pnf": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all PNF by cluster Id", + "operationId": "getpnfDetails", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/pnf/configuration": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List configuration of PNF", + "operationId": "getPNFConfig", + "parameters": [ + { + "name": "pnfSerialNumber", + "in": "query", + "description": "PNF serial number", + "schema": { + "type": "string" + } + }, + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF detail": { + "description": "VNF detail", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/servicechain": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all service chain or service chains by Id", + "operationId": "getServiceChainDetails", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + }, + { + "name": "userGroupName", + "in": "query", + "description": "UserGroup Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/servicegroup": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all attached serviceGroups to cluster", + "operationId": "getServiceGroupByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Service group": { + "description": "Service group", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/vnf": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of all existing VNF", + "operationId": "getvnfDetails", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + }, + { + "name": "userGroupName", + "in": "query", + "description": "UserGroup Name", + "schema": { + "type": "string" + } + }, + { + "name": "vnfName", + "in": "query", + "description": "VNF Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VNF details": { + "description": "VNF details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/action": { + "post": { + "tags": [ + "Colocation" + ], + "description": "VNF action", + "operationId": "vnfActions", + "parameters": [ + { + "name": "vmName", + "in": "query", + "description": "VM Name", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + }, + { + "name": "action", + "in": "query", + "description": "Action", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/alarms": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get event detail of VNF", + "operationId": "getVNFEventsCountDetail", + "parameters": [ + { + "name": "user_group", + "in": "query", + "description": "user group name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/alarms/count": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get event detail of VNF", + "operationId": "getVNFAlarmCount", + "parameters": [ + { + "name": "user_group", + "in": "query", + "description": "user group name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/events": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get event detail of VNF", + "operationId": "getVNFEventsDetail", + "parameters": [ + { + "name": "vnfName", + "in": "query", + "description": "VNF name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/interface": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get interface detail of VNF", + "operationId": "getVNFInterfaceDetail", + "parameters": [ + { + "name": "vnfName", + "in": "query", + "description": "VNF name", + "schema": { + "type": "string" + } + }, + { + "name": "deviceIp", + "in": "query", + "description": "Device IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceClass", + "in": "query", + "description": "Device class", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/servicechain/attach": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Attach service chain to cluster", + "operationId": "attachServiceChain", + "requestBody": { + "description": "Attach service chain request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attach service chain request": { + "description": "Attach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/autoattach": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Attach service chain to cluster", + "operationId": "attachServiceChain_1", + "requestBody": { + "description": "Attach service chain request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attach service chain request": { + "description": "Attach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/cancel": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Cancel button to cancel configuring devices", + "operationId": "cancelButton", + "requestBody": { + "description": "Cancel configuring devices", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attach service chain request": { + "description": "Attach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/detach": { + "put": { + "tags": [ + "Colocation" + ], + "description": "Detach service chain", + "operationId": "detachServiceChain", + "requestBody": { + "description": "Detach service chain request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detach service chain request": { + "description": "Detach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/edge/devices": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get edge devices", + "operationId": "getEdgeDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices list": { + "description": "Devices list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write,default" + } + }, + "/colocation/servicechain/edge/pnfdevices": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get PNF edge devices", + "operationId": "getpnfDevices", + "parameters": [ + { + "name": "pnfDeviceType", + "in": "query", + "description": "PNF device type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PNF devices list": { + "description": "PNF devices list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write,default" + } + }, + "/colocation/servicegroup": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get service chain by name", + "operationId": "getServiceChain", + "parameters": [ + { + "name": "serviceGroupName", + "in": "query", + "description": "Service group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + }, + "put": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Update service group", + "operationId": "updateServiceGroupCluster", + "requestBody": { + "description": "Service group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service group": { + "description": "Service group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + }, + "post": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Add new service group", + "operationId": "createServiceGroupCluster", + "requestBody": { + "description": "Service group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service group": { + "description": "Service group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicegroup/attached": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get service chains in cluster", + "operationId": "getServiceGroupInCluster", + "parameters": [ + { + "name": "ClusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + }, + { + "name": "UserGroupName", + "in": "query", + "description": "UserGroup Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/servicegroup/servicechain/default": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get default service chains", + "operationId": "getDefaultChain", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/servicegroup/servicechains": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get all service chains", + "operationId": "getAvailableChains", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Service chains": { + "description": "Service chains", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/servicegroup/{name}": { + "delete": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Delete service group", + "operationId": "deleteServiceGroupCluster", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Service group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,Colocation-write" + } + }, + "/container-manager/activate/{containerName}": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Activate container on remote host", + "operationId": "activateContainerOnRemoteHost", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "url", + "in": "query", + "description": "Container image URL", + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + }, + { + "name": "checksum", + "in": "query", + "description": "Container image checksum", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/container-manager/deactivate/{containerName}": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Deactivate container on remote host", + "operationId": "deActivateContainer", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/container-manager/doesValidImageExist/{containerName}": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Get container image checksum", + "operationId": "doesValidImageExist", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Container image checksum": { + "description": "Container image checksum", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "admin" + } + }, + "/container-manager/inspect/{containerName}": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Get container inspect data", + "operationId": "getContainerInspectData", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Container inspect data": { + "description": "Container inspect data" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/container-manager/settings/{containerName}": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Get container settings", + "operationId": "getContainerSettings", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Container settings": { + "description": "Container settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/data/device/state/{state_data_type}": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device state data", + "operationId": "generateDeviceStateData", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startId", + "in": "query", + "description": "Start Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "Count", + "schema": { + "type": "string", + "default": "1000" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "State data": { + "description": "State data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/state/{state_data_type}/fields": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device state data fileds", + "operationId": "generateDeviceStateDataFields", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "State data fileds": { + "description": "State data fileds", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/state/{state_data_type}/query": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device state data fileds", + "operationId": "generateDeviceStateDataWithQueryString", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "State data": { + "description": "State data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/statistics": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get statistics types", + "operationId": "getStatisticsType", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics type": { + "description": "Statistics type", + "value": [ + "interfacestatistics", + "eioltestatistics", + "sulstatistics", + "qosstatistics", + "devicesystemstatusstatistics", + "bridgemacstatistics", + "dpistatistics", + "approutestatsstatistics", + "wlanclientinfostatistics", + "flowlogstatistics", + "urlf", + "fwall", + "vnfstatistics", + "umbrella", + "apphostingstatistics", + "utddaqioxstatistics", + "ipsalert", + "aggregatedappsdpistatistics", + "bridgeinterfacestatistics", + "artstatistics", + "trackerstatistics", + "cloudxstatistics", + "deviceevents", + "sleofflinereport", + "alarm", + "auditlog", + "deviceconfiguration", + "nwpi", + "nwpiflowraw", + "speedtest" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/statistics/alarm/active": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get active alarms", + "operationId": "getActiveAlarms", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "SrollId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startDate", + "in": "query", + "description": "Start date", + "schema": { + "type": "string" + } + }, + { + "name": "endDate", + "in": "query", + "description": "End date", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "count", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "timeZone", + "in": "query", + "description": "Time zone", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Active alarms": { + "description": "Active alarms", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/data/device/statistics/{state_data_type}": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get device statistics data", + "operationId": "generateDeviceStatisticsData", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scrollId", + "in": "query", + "description": "Scroll Id", + "schema": { + "type": "string" + } + }, + { + "name": "startDate", + "in": "query", + "description": "Start date", + "schema": { + "type": "string" + } + }, + { + "name": "endDate", + "in": "query", + "description": "End date", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timeZone", + "in": "query", + "description": "Time zone", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics data": { + "description": "Statistics data", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/statistics/{state_data_type}/doccount": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get response count of a query", + "operationId": "getCountWithStateDataType", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type(example:object)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startDate", + "in": "query", + "description": "Start date (example:2021-1-1T00:00:00)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "endDate", + "in": "query", + "description": "End date (example:2021-12-1T00:00:00)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "timeZone", + "in": "query", + "description": "Time zone (example:UTC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Response count": { + "description": "Response count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/data/device/statistics/{state_data_type}/fields": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get statistics fields and types", + "operationId": "getStatDataFieldsByStateDataType", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics field and type": { + "description": "Statistics field and type", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/dca/analytics": { + "put": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get statistics data", + "operationId": "createStats", + "requestBody": { + "description": "Stats query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query": { + "description": "Stats query", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats data": { + "description": "Stats data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/analytics/all": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get all statistics setting data", + "operationId": "getAllStatsDataDCA", + "requestBody": { + "description": "Stats setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats index status": { + "description": "Stats index status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service settings", + "operationId": "getCloudSettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service setting": { + "description": "Cloud service setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + } + }, + "/dca/cloudservices/accesstoken": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA access token", + "operationId": "getAccessToken", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA access token": { + "description": "DCA access token", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Set DCA access token", + "operationId": "storeAccessToken", + "requestBody": { + "description": "DCA access token", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA access token": { + "description": "DCA access token", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/alarm": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Generate DCA alarms", + "operationId": "generateAlarm", + "requestBody": { + "description": "DCA alarm message", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA alarm message": { + "description": "DCA alarm message", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/idtoken": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA Id token", + "operationId": "getIdToken", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA Id token": { + "description": "DCA Id token", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Set DCA Id token", + "operationId": "storeIdToken", + "requestBody": { + "description": "DCA Id token", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA Id token": { + "description": "DCA Id token", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/otp": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service OTP value", + "operationId": "getOTP", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service OTP value": { + "description": "Cloud service OTP value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + }, + "put": { + "tags": [ + "System - Cloud Service" + ], + "description": "Update cloud service OTP value", + "operationId": "updatetOTP", + "requestBody": { + "description": "Cloud service OTP value", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service OTP value": { + "description": "Cloud service OTP value", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + } + }, + "/dca/cloudservices/telemetry": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA telemetry settings", + "operationId": "getTelemetrySettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA telemetry settings": { + "description": "DCA telemetry settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/vanalytics": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get session from DCS for vAnalytics", + "operationId": "getvAnalytics", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service OTP value": { + "description": "Cloud service OTP value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + } + }, + "/dca/data/device/state/{state_data_type}": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device state data", + "operationId": "generateDCADeviceStateData", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "Device state data", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device state": { + "description": "Device state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/data/device/statistics/{stats_data_type}": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device statistics data", + "operationId": "generateDCADeviceStatisticsData", + "parameters": [ + { + "name": "stats_data_type", + "in": "path", + "description": "Device statistics data", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device statistics": { + "description": "Device statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/dcatenantowners": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA tenant owners", + "operationId": "getDCATenantOwners", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA service owner": { + "description": "DCA service owner", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/device": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get all devices", + "operationId": "listAllDevicesDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device lists": { + "description": "Device lists", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/device/crashlog/details": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get crash log", + "operationId": "getCrashLogs", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crash logs": { + "description": "Crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/device/crashlog/synced": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device crash log", + "operationId": "getCrashLogsSynced", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crash logs": { + "description": "Crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/settings/configuration/cloudservices/dca": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA cloud service configuration", + "operationId": "getCloudServicesConfigurationDCA", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA cloud service configuration": { + "description": "DCA cloud service configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/settings/configuration/{type}/dca": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Create analytics config data", + "operationId": "createDCAAnalyticsDataFile", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Data type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "analytics", + "callHome" + ] + } + } + ], + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Analytics config data": { + "description": "Analytics config data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/statistics/settings/status": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get statistics setting status", + "operationId": "getStatsDBIndexStatus", + "requestBody": { + "description": "Stats setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats index status": { + "description": "Stats index status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/system/device": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device details", + "operationId": "getDevicesDetailsDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device details": { + "description": "Device details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/device/config/attachedconfig": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get attached config to device", + "operationId": "getDCAAttachedConfigToDevice", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attached config to device": { + "description": "Attached config to device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/definition/approute": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get template policy definitions", + "operationId": "getTemplatePolicyDefinitionsDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template policy definition": { + "description": "Template policy definition", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/list/vpn": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get VPN details", + "operationId": "getVPNListsDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN": { + "description": "VPN", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/vedge": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get vEdge template list", + "operationId": "getVedgeTemplateListDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vEdge template": { + "description": "vEdge template", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/vsmart": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get vSmart template list", + "operationId": "getVsmartTemplateListDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart template": { + "description": "vSmart template", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "List all devices", + "operationId": "listAllDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of devices": { + "description": "List of devices", + "value": { + "header": { + "generatedOn": 1635153515143, + "viewKeys": { + "uniqueKey": [ + "system-ip" + ], + "preferenceKey": "grid-DeviceMultitenant" + }, + "columns": [ + { + "title": "Hostname", + "property": "host-name", + "display": "iconAndText", + "iconProperty": "device-type", + "hideable": false, + "icon": [ + { + "key": "vmanage", + "value": "images/vmanage_table.png" + }, + { + "key": "vedge", + "value": "images/vedge_table.png" + }, + { + "key": "vedge-vbond", + "value": "images/vedge-vbond_table.png" + }, + { + "key": "vsmart", + "value": "images/vsmart_table.png" + }, + { + "key": "vbond", + "value": "images/vbond_table.png" + } + ], + "width": 150, + "dataType": "string" + }, + { + "title": "Connected vManage", + "property": "connectedVManages", + "visible": true, + "width": 500, + "dataType": "array" + } + ], + "fields": [ + { + "property": "host-name", + "dataType": "string", + "display": "iconAndText" + }, + { + "property": "state", + "dataType": "string", + "display": "iconAndToolTip" + } + ] + }, + "data": [ + { + "deviceId": "169.254.10.1", + "system-ip": "169.254.10.1", + "host-name": "vm200", + "reachability": "reachable", + "status": "normal", + "personality": "vmanage", + "device-type": "vmanage", + "timezone": "UTC", + "device-groups": [ + "No groups" + ], + "lastupdated": 1634627015139, + "domain-id": "0", + "board-serial": "12345704", + "certificate-validity": "Valid", + "max-controllers": "0", + "uuid": "96af574a-eadd-4b6a-97bf-d5c1e98f40f2", + "controlConnections": "9", + "device-model": "vmanage", + "version": "20.8.999-1397", + "connectedVManages": [ + "169.254.10.1" + ], + "site-id": "200", + "latitude": "37.666684", + "longitude": "-122.777023", + "isDeviceGeoData": false, + "platform": "x86_64", + "uptime-date": 1634626320000, + "statusOrder": 4, + "device-os": "next", + "validity": "valid", + "state": "green", + "state_description": "All daemons up", + "model_sku": "None", + "local-system-ip": "172.16.255.200", + "total_cpu_count": "8", + "testbed_mode": true, + "layoutLevel": 1 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/aaa/servers": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get AAA servers from device (Real Time)", + "operationId": "getAAAservers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AAA servers": { + "description": "AAA servers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/aaa/users": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get AAA users from device (Real Time)", + "operationId": "getAAAUsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AAA users": { + "description": "AAA users" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/acl/matchcounter": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get ACL match counters from device (Real Time)", + "operationId": "getACLMatchCounterUsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL match counters": { + "description": "ACL match counters", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/action/cancel": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Cancel tasks", + "operationId": "processCancelTask", + "requestBody": { + "description": "Cancel task payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cancel task request": { + "description": "Cancel task request", + "value": "{ \n \"action\":\"cancel\",\n \"devices\":[ \n { \n \"deviceIP\":\"172.16.255.11\",\n \"deviceId\":\"6ace13f8-fded-4669-994a-a100b84b14dd\",\n \"transactionId\":\"image_download-9ebdbd1d-68ea-4238-90e5-29788f09fa75%b2c48cd3-f464-48cd-990c-d122134941d6%3600000\",\n },\n { \n \"deviceIP\":\"172.16.255.21\",\n \"deviceId\":\"bedf3db0-c9c9-439d-b5fe-0edf09c2f33f\",\n \"transactionId\":\"image_download-9ebdbd1d-68ea-4238-90e5-29788f09fa75%b2c48cd3-f464-48cd-990c-d122134941d6%3600000\",\n }\n ],\n \"deviceType\":\"vedge\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/changepartition": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get change partition information", + "operationId": "generateChangePartitionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process change partition operation", + "operationId": "processChangePartition", + "requestBody": { + "description": "Device change partition request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device change partition request": { + "description": "Device change partition request", + "value": { + "action": "changepartition", + "devices": [ + { + "version": "20.3.0", + "deviceIP": "172.16.51.1", + "deviceId": "52fe5cd3-ec3d-4141-92e4-0c31d0e0347a" + }, + { + "version": "20.3.0", + "deviceIP": "172.16.51.2", + "deviceId": "4d4507df-29b4-4f68-9129-36cfa4528847" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "change_partition-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/deactivate": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get deactivate partition information", + "operationId": "generateDeactivateInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process deactivate operation for smu image", + "operationId": "processDeactivateSmu", + "requestBody": { + "description": "Device smu image deactivate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device deactivate request": { + "description": "Device deactivate request", + "value": { + "action": "deactivate", + "devices": [ + { + "version": "20.3.0", + "deviceIP": "172.16.51.1", + "deviceId": "52fe5cd3-ec3d-4141-92e4-0c31d0e0347a" + }, + { + "version": "20.3.0", + "deviceIP": "172.16.51.2", + "deviceId": "4d4507df-29b4-4f68-9129-36cfa4528847" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "deactivate-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/defaultpartition": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process marking default partition operation", + "operationId": "processDefaultPartition", + "requestBody": { + "description": "Marking default partition request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Marking default partition request": { + "description": "Marking default partition request", + "value": { + "action": "defaultpartition", + "devices": [ + { + "version": "99.99.999-2499", + "deviceIP": "172.16.255.16", + "deviceId": "13cf949c-9192-4c5d-8096-12c41fbd366d" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "default_partition-01112017T159951140" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/filter/vpn": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get filter VPN list", + "operationId": "createFilterVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Filter VPN list": { + "description": "Filter VPN list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,RBAC VPN-read" + } + }, + "/device/action/firmware": { + "get": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Get list of firmware images in the repository", + "operationId": "getFirmwareImages", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Upload firmware image package", + "operationId": "processFirmwareImage", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/activate": { + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Activate firmware on device", + "operationId": "activateFirmwareImage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/devices": { + "get": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Get list of devices that support firmware upgrade", + "operationId": "getDevicesFWUpgrade", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + } + }, + "/device/action/firmware/install": { + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Install firmware on device", + "operationId": "installFirmwareImage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/remove": { + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Remove firmware on device", + "operationId": "removeFirmwareImage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/{versionId}": { + "get": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Get firmware image details for a given version", + "operationId": "getFirmwareImageDetails", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Firmware image version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "delete": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Delete firmware image package", + "operationId": "deleteFirmwareImage", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Firmware image version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/image-download": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Intitate image download on the given device.", + "operationId": "initiateImageDownload", + "requestBody": { + "description": "Image download request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Image download request": { + "description": "Image download request", + "value": "{ \n \"action\":\"image-download\",\n \"input\": { \n \"data\": [,\n { \n \"family\":\"c8000v\",\n \"remoteServerId\":\"59ced1b4-cc8d-4d2d-b5e2-da00ba1e5a72\",\n \"version\":\"9dc17146-3c25-407c-8da7-4635e0e451f1\",\n }\n ]\n },\n \"devices\":[\n { \n \"deviceIP\":\"172.16.255.14\",\n \"deviceId\":\"2f876a33-9944-450a-91ee-f1f80eb68348\"\n \"version\":\"13cf949c-9192-4c5d-8096-12c41fbd366d\",\n }\n ],\n \"deviceType\":\"vedge\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "default_partition-01112017T159951140" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/image-remove": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process remove software image operation", + "operationId": "processRemoveSoftwareImage", + "requestBody": { + "description": "Device remove software image request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device remove software image request": { + "description": "Device remove software image request", + "value": { + "action": "image-remove", + "devices": [ + { + "deviceIP": "172.16.255.11", + "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd", + "image": [ + "viptela-20.4.2-x86_64.tar.gz", + "viptela-20.6.1-x86_64.tar.gz" + ] + }, + { + "deviceIP": "172.16.255.21", + "deviceId": "bedf3db0-c9c9-439d-b5fe-0edf09c2f33f", + "image": [ + "isr4300-ucmk9.17.03.02.SPA.bin" + ] + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/install": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Generate install info", + "operationId": "generateInstallInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device install list": { + "description": "Device install list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an installation operation", + "operationId": "processInstall", + "requestBody": { + "description": "Installation payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Installation Operation": { + "description": "Installation Operation", + "value": { + "action": "install", + "input": { + "vEdgeVPN": 0, + "vSmartVPN": 0, + "version": "16.2.0", + "versionType": "vmanage", + "reboot": false, + "sync": true + }, + "devices": [ + { + "deviceIP": "172.16.255.14", + "deviceId": "2f876a33-9944-450a-91ee-f1f80eb68348" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "software_install-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/install/devices/{deviceType}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get list of installed devices", + "operationId": "generateDeviceList", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceType" + } + }, + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/GroupId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,vmanage-http-stream" + } + }, + "/device/action/list": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get device action list", + "operationId": "generateDeviceActionList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device action list": { + "description": "Device action list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/lxcactivate": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an activation operation", + "operationId": "processLxcActivate", + "requestBody": { + "description": "Activation request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Activation Operation": { + "description": "Activation Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcdelete": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a delete operation", + "operationId": "processLxcDelete", + "requestBody": { + "description": "Delete request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete Operation": { + "description": "Delete Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcinstall": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an installation operation", + "operationId": "processLxcInstall", + "requestBody": { + "description": "Installation request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Installation Operation": { + "description": "Installation Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcreload": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a reload operation", + "operationId": "processLxcReload", + "requestBody": { + "description": "Reload request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reload Operation": { + "description": "Reload Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcreset": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a reset operation", + "operationId": "processLxcReset", + "requestBody": { + "description": "Reset request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reset Operation": { + "description": "Reset Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcupgrade": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an upgrade operation", + "operationId": "processLxcUpgrade", + "requestBody": { + "description": "Upgrade request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Upgrade Operation": { + "description": "Upgrade Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/reboot": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get device reboot information", + "operationId": "generateRebootInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Reboot-read,Device Reboot-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a reboot operation", + "operationId": "processReboot", + "requestBody": { + "description": "Device reboot request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reboot request": { + "description": "Device reboot request", + "value": { + "action": "reboot", + "deviceType": "vedge", + "devices": [ + { + "deviceIP": "172.16.255.11", + "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "reboot-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Reboot-write" + } + }, + "/device/action/reboot/devices/{deviceType}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get list of rebooted devices", + "operationId": "generateRebootDeviceList", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceType" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/GroupId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Reboot-read,Device Reboot-write" + } + }, + "/device/action/rediscover": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get rediscover operation information", + "operationId": "generateRediscoverInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-read,Tools-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Rediscover device", + "operationId": "reDiscoverDevices", + "requestBody": { + "description": "Rediscover device request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Rediscover device request": { + "description": "Rediscover device request", + "value": { + "action": "rediscover", + "devices": [ + { + "deviceId": "CSR-940ad679-a16a-48ea-9920-16278597d98e", + "deviceIP": "10.3.0.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-write,Tools-write" + } + }, + "/device/action/rediscoverall": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Rediscover all devices", + "operationId": "reDiscoverAllDevice", + "requestBody": { + "description": "Rediscover device request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Rediscover device request": { + "description": "Rediscover device request", + "value": { + "action": "rediscover", + "devices": [ + { + "deviceId": "CSR-940ad679-a16a-48ea-9920-16278597d98e", + "deviceIP": "10.3.0.1" + }, + { + "deviceId": "CSR-04ed104b-86bb-4cb3-bd2b-a0d0991f6872", + "deviceIP": "10.3.0.2" + }, + { + "deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de", + "deviceIP": "10.1.0.1" + }, + { + "deviceId": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35", + "deviceIP": "10.1.0.2" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-write,Tools-write" + } + }, + "/device/action/remote-server": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get list of remote servers", + "operationId": "getRemoteServerList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote Server List": { + "description": "Remote Server List", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "post": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Add a new remote server entry.", + "operationId": "addRemoteServer", + "requestBody": { + "description": "Request payload for a new remote server entry.", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add a new remote server entry.": { + "description": "Add a new remote server entry.", + "value": "{ \n \"remoteServerName\":\"Server1\", \n \"remoteServerUrl\":\"1.1.1.1\"\n \"remoteServerProtocol\":\"FTP\"\n \"remoteServerPort\":21\n \"remoteServerVPN\":0\n \"remoteServerUser\":\"admin\"\n \"remoteServerPassword\":\"admin\"\n \"imageLocationPrefix\":\"/home/admin/\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/remote-server/{id}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get remote server for the specified ID", + "operationId": "getRemoteServerById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Remote Server ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote Server": { + "description": "Remote Server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "put": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Update remote server for the specified ID", + "operationId": "updateRemoteServer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Remote Server ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Update an existing new remote server entry.": { + "description": "Update an existing new remote server entry.", + "value": "{ \n \"remoteServerName\":\"Server1\", \n \"remoteServerLocation\":\"1.1.1.1\"\n \"remoteServerProtocol\":\"FTP\"\n \"remoteServerPort\":21\n \"remoteServerVPN\":0\n \"remoteServerUser\":\"admin\"\n \"remoteServerPassword\":\"admin\"\n \"imageLocationPrefix\":\"/home/admin/\"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + }, + "delete": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Delete remote server for the specified ID", + "operationId": "deleteRemoteServer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Remote Server ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote Server": { + "description": "Remote Server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/removepartition": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get remove partition information", + "operationId": "generateRemovePartitionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process remove partition operation", + "operationId": "processRemovePartition", + "requestBody": { + "description": "Device remove partition request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device remove partition request": { + "description": "Device remove partition request", + "value": { + "action": "removepartition", + "devices": [ + { + "deviceIP": "172.16.255.11", + "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd", + "version": [ + "20.1.1", + "20.3.1" + ] + }, + { + "deviceIP": "172.16.255.21", + "deviceId": "bedf3db0-c9c9-439d-b5fe-0edf09c2f33f", + "version": [ + "20.1.1" + ] + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/security/amp/apikey/{uuid}": { + "delete": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process amp api key deletion operation", + "operationId": "processDeleteAmpApiKey", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Uuid", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AMP API key deletion request": { + "description": "AMP API key deletion request", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/security/amp/rekey": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process amp api re-key operation", + "operationId": "processAmpApiReKey", + "requestBody": { + "description": "AMP API re-key request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AMP API re-key request": { + "description": "AMP API re-key request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/security/apikey/{uuid}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get API key from device", + "operationId": "testApiKey", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "API key": { + "description": "API key", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read" + } + }, + "/device/action/security/devices/{policyType}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get list of devices by security policy type", + "operationId": "generateSecurityDevicesList", + "parameters": [ + { + "name": "policyType", + "in": "path", + "description": "Policy type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "zoneBasedFW", + "intrusionPrevention", + "urlFiltering", + "advancedMalwareProtection", + "dnsSecurity", + "sslDecryption" + ] + } + }, + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/GroupId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,Security-read,Security-read,Security-write" + } + }, + "/device/action/software": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get software images", + "operationId": "findSoftwareImages", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software image URL": { + "description": "Software image URL", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Create software image URL", + "operationId": "createImageURL", + "requestBody": { + "description": "Create software image request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Create software image request": { + "description": "Create software image request", + "value": { + "versionName": "16.1.2", + "versionURL": "ftp://1.1.1.1/builds/16.1/" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/imageProperties/{versionId}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get Image Properties", + "operationId": "getImageProperties", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Image properties": { + "description": "Image properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/images": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get software images", + "operationId": "findSoftwareImagesWithFilters", + "parameters": [ + { + "name": "imageType", + "in": "query", + "description": "Image type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vnfType", + "in": "query", + "description": "VNF type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software image URL": { + "description": "Software image URL", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/package": { + "post": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Install software package", + "operationId": "installPkg", + "requestBody": { + "description": "File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/SoftwareUploadFile" + }, + "examples": { + "File": { + "description": "File" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "415": { + "description": "Unsupported Media Type" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/custom/file/{uuid}": { + "get": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Get bootstrap file contents", + "operationId": "getFileContents", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "File uuid", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "File content": { + "description": "File content", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + }, + "put": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Edit bootstrap file", + "operationId": "editConfigFile", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "File uuid", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Bootstrap file", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Bootstrap file": { + "description": "Bootstrap file", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Bootstrap file": { + "description": "Bootstrap file", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/custom/uploads/{type}": { + "post": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Upload virtual image/bootstrap file", + "operationId": "uploadImageFile", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Upload file type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "image", + "file" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "File content": { + "description": "File content", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/custom/vnfPackage": { + "post": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Create VNF custom package", + "operationId": "createVnfPackage", + "requestBody": { + "description": "Custom package", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Custom package": { + "description": "Custom package", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "File content": { + "description": "File content", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/imageCount": { + "get": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Number of software image presented in vManage repository", + "operationId": "getUploadImagesCount", + "parameters": [ + { + "name": "imageType", + "in": "query", + "description": "Image type", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "default": "software" + } + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/package/{fileName}": { + "get": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Download software package file", + "operationId": "downloadPackageFile", + "parameters": [ + { + "name": "fileName", + "in": "path", + "description": "Pakcage file name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "imageType", + "in": "query", + "description": "Image type", + "required": true, + "schema": { + "type": "string", + "default": "software" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/package/{imageType}": { + "post": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Install software image package", + "operationId": "processSoftwareImage", + "parameters": [ + { + "name": "imageType", + "in": "path", + "description": "Image type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/SoftwareUploadFile" + }, + "examples": { + "File": { + "description": "File" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "415": { + "description": "Unsupported Media Type" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/{versionId}/metadata": { + "get": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Update Package Metadata", + "operationId": "getImageMetadata", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Image ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Update Package Metadata", + "operationId": "editImageMetadata", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Image ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/action/software/pnfproperties/{pnfType}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get PNF Properties", + "operationId": "getPnfProperties", + "parameters": [ + { + "name": "pnfType", + "in": "path", + "description": "PNF type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PNF properties": { + "description": "PNF properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/remoteserver/{versionId}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get Image Remote Server Details", + "operationId": "getImageRemoteServer", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Remote Server Details": { + "description": "Remote Server Details", + "value": { + "remoteServers": [ + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e03", + "ImageRelativePath": "/images" + }, + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e14", + "ImageRelativePath": "/images/virtualImages" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "put": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Update Image Remote Server Details", + "operationId": "editImageRemoteServer", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Image ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update image remote server details", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update image remote server details": { + "description": "Update image remote server details", + "value": { + "remoteServers": [ + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e03", + "ImageRelativePath": "/images" + }, + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e14", + "ImageRelativePath": "/images/virtualImages" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/vedge/version": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get vEdge software version", + "operationId": "findVEdgeSoftwareVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge software version": { + "description": "vEdge software version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/version": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get software version", + "operationId": "findSoftwareVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Software version": { + "description": "Software version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/vnfproperties/{versionId}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get VNF Properties", + "operationId": "getVnfProperties", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VNF properties": { + "description": "VNF properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/ztp/version": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get ZTP software version", + "operationId": "findZtpSoftwareVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP software version": { + "description": "ZTP software version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/{versionId}": { + "put": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Update software image URL", + "operationId": "updateImageURL", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update software image request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update software image request": { + "description": "Update software image request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + }, + "delete": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Delete software image URL", + "operationId": "deleteImageURL", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/startmonitor": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Triggers global monitoring thread", + "operationId": "triggerPendingTasksMonitoring", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status": { + "put": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Update device action status.", + "operationId": "updateDeviceActionStatus", + "requestBody": { + "description": "Update device action status", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update device action status": { + "description": "Update device action status", + "value": "{ \n \"transactionId\":\"software_install-2dfee040-d927-4d32-8a74-242a6d6d7916%C8K-30c039e8-415d-4e4f-8f70-a537aa71708a\",\n \"status\":\"in_progress\",\n \"statusMessage\": [ \n { \n \"type\":\"download-complete\",\n \"detail\":\"Image download complete.\"\n }\n }" + } + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/device/action/status/cancel/{processId}": { + "post": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Bulk cancel task status", + "operationId": "cancelPendingTasks", + "parameters": [ + { + "name": "processId", + "in": "path", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/clean": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Delete task and status vertex", + "operationId": "cleanStatus", + "parameters": [ + { + "name": "cleanStatus", + "in": "query", + "description": "Clear status flag", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "admin" + } + }, + "/device/action/status/clear": { + "delete": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Delete status of action", + "operationId": "deleteStatus", + "parameters": [ + { + "name": "processId", + "in": "query", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/preupgrade/check": { + "put": { + "tags": [ + "Configuration - Pre upgrade check status" + ], + "description": "Update pre upgrade check status", + "operationId": "updatePreUpgradeCheckStatus", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/tasks": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Find running tasks", + "operationId": "findRunningTasks", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Running tasks": { + "description": "Running tasks", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/tasks/activeCount": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Get active task count", + "operationId": "getActiveTaskCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Active task count": { + "description": "Active task count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,default" + } + }, + "/device/action/status/tasks/clean": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Delete task and status vertex", + "operationId": "getCleanStatus", + "parameters": [ + { + "name": "processId", + "in": "query", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/device/action/status/{actionName}": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Find status of action", + "operationId": "findStatus", + "parameters": [ + { + "name": "actionName", + "in": "path", + "description": "Action name", + "required": true, + "schema": { + "type": "string" + }, + "example": "push_feature_template_configuration-01232017T154359940" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action status": { + "description": "Action status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/test/ioxconfig/{deviceIP}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "testIoxConfig", + "operationId": "testIoxConfig", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/uniquevpnlist": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Create unique VPN list", + "operationId": "createUniqueVPNList", + "requestBody": { + "description": "Device IPs", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device IPs": { + "description": "Device IPs", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Unique VPN list": { + "description": "Unique VPN list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + } + }, + "/device/action/vnfinstall": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an installation operation", + "operationId": "processVnfInstall", + "requestBody": { + "description": "Installation request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Installation Operation": { + "description": "Installation Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/vpn": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Create VPN list", + "operationId": "createVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN list": { + "description": "VPN list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/action/ztp/upgrade": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get ZTP upgrade configuration", + "operationId": "getZTPUpgradeConfig", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade config": { + "description": "ZTP upgrade config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process ZTP upgrade configuration", + "operationId": "processZTPUpgradeConfig", + "requestBody": { + "description": "ZTP upgrade config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade config": { + "description": "ZTP upgrade config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/device/action/ztp/upgrade/setting": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get ZTP upgrade configuration setting", + "operationId": "getZTPUpgradeConfigSetting", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade config setting": { + "description": "ZTP upgrade config setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process ZTP upgrade configuration setting", + "operationId": "processZTPUpgradeConfigSetting", + "requestBody": { + "description": "ZTP upgrade setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade setting": { + "description": "ZTP upgrade setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/device/app-hosting/attached-devices": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting attached device from device", + "operationId": "getAppHostingAttachedDevices", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting attached device": { + "description": "App hosting attached device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/details": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting details from device", + "operationId": "getAppHostingDetails", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting details": { + "description": "App hosting details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/guest-routes": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting guest routes from device", + "operationId": "getAppHostingGuestRoutes", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting guest routes": { + "description": "App hosting guest routes", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/network-interfaces": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting network interface from device", + "operationId": "getAppHostingNetworkDevices", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting network interface": { + "description": "App hosting network interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/network-utilization": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting network utilization from device", + "operationId": "getAppHostingNetworkUtils", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting network utilization": { + "description": "App hosting network utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/processes": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting processes from device", + "operationId": "getAppHostingProcesses", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting processes utilization": { + "description": "App hosting processes utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/storage-utilization": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting storage utilization from device", + "operationId": "getAppHostingStorageUtils", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting storage utilization": { + "description": "App hosting storage utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/utilization": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting utilization from device", + "operationId": "getAppHostingUtilization", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting utilization": { + "description": "App hosting utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-route/sla-class": { + "get": { + "tags": [ + "Real-Time Monitoring - Application-Aware Route" + ], + "description": "Get SLA class list from device (Real Time)", + "operationId": "createAppRouteSlaClassList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SLA class": { + "description": "SLA class", + "value": { + "data": [ + { + "app-probe-class": "None", + "loss": 0, + "fallback-best-tunnel": "None", + "jitter": 0, + "vdevice-dataKey": "169.254.10.10-0", + "vdevice-name": "169.254.10.10", + "latency": 0, + "name": "__all_tunnels__", + "index": 0, + "lastupdated": 1642576726463, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/app-route/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Application-Aware Route" + ], + "description": "Get application-aware routing statistics from device (Real Time)", + "operationId": "createAppRouteStatisticsList", + "parameters": [ + { + "name": "remote-system-ip", + "in": "query", + "description": "Remote system IP", + "schema": { + "type": "string" + } + }, + { + "name": "local-color", + "in": "query", + "description": "Local color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "remote-color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application-aware routing statistics": { + "description": "Application-aware routing statistics", + "value": { + "data": [ + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.2.2", + "tx-data-pkts": "0", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "dst-port": "12426", + "remote-color": "default", + "remote-system-ip": "172.16.254.1", + "fallback-sla-class-index": "None", + "mean-latency": 0, + "total-packets": "600", + "loss": "0", + "mean-jitter": 0, + "average-latency": "0", + "index": "3", + "sla-class-index": "0", + "vdevice-host-name": "vm3", + "local-color": "default", + "app-probe-class": "None", + "mean-loss": 0, + "vdevice-dataKey": "169.254.10.10-3", + "proto": "ipsec", + "lastupdated": 1642577794383, + "average-jitter": "0", + "rx-data-pkts": "0" + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.2.2", + "tx-data-pkts": "0", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "dst-port": "12426", + "remote-color": "default", + "remote-system-ip": "172.16.254.1", + "fallback-sla-class-index": "None", + "mean-latency": 0, + "total-packets": "600", + "loss": "0", + "mean-jitter": 0, + "average-latency": "0", + "index": "4", + "sla-class-index": "0", + "vdevice-host-name": "vm3", + "local-color": "default", + "app-probe-class": "None", + "mean-loss": 0, + "vdevice-dataKey": "169.254.10.10-4", + "proto": "ipsec", + "lastupdated": 1642577794385, + "average-jitter": "0", + "rx-data-pkts": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/app/log/flow-count": { + "get": { + "tags": [ + "Real-Time Monitoring - App Logs" + ], + "description": "Get App log flows count from device (Real Time)", + "operationId": "getAppLogFlowCount", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App log flows count": { + "description": "App log flows count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/app/log/flows": { + "get": { + "tags": [ + "Real-Time Monitoring - App Logs" + ], + "description": "Get App log flows from device (Real Time)", + "operationId": "getAppLogFlows", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App log flows": { + "description": "App log flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/appqoe/active-flow-id": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Active flow Id details from device", + "operationId": "createAppqoeActiveFlowIdDetails", + "parameters": [ + { + "name": "flow-id", + "in": "query", + "description": "Flow Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Active FlowId details": { + "description": "Appqoe Flow Active FlowId details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/appqoe/appqoe-hput-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Hput Statistics from device", + "operationId": "getAppqoeHputStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Hput Statistics": { + "description": "Appqoe Hput Statistics", + "value": { + "data": [ + { + "hs-sch-delay20us": "2569563", + "hs-time-node-dealloc": "10730115", + "uhs-callout-drain": "0", + "uhs-stop-cancel": "0", + "hs-exp-list-process": "237791", + "hs-curr-node-null": "0", + "hs-sch-delay200us": "4110", + "hs-sch-delay10000us": "6741", + "uhs-callout-unlock": "0", + "uhs-add": "1624643", + "uhs-rst-sbt-drain": "0", + "hs-timer-deleted": "0", + "hs-sch-delay300us": "1809", + "uhs-stop-del-cancel": "0", + "hs-sch-delay400us": "1541", + "uhs-add-fail": "0", + "hs-sch-delay1000000us": "0", + "hs-sch-delay1000us": "1069", + "uhs-stop-no-pending": "4", + "hs-timer-del-failed": "0", + "hs-expired-send-sig": "224059", + "uhs-stop-nodrain": "0", + "hs-sch-delay500us": "1444", + "hs-sch-delay30us": "198079", + "hs-timer-alloc": "10730124", + "hs-time-node-added": "10713486", + "uhs-stop": "4", + "uhs-callout-lock": "0", + "uhs-raw-add": "9105481", + "hs-ktimer-start": "17812503", + "hs-sch-delay600us": "1463", + "hs-ktimer-cb": "10475629", + "uhs-rst-sbt-del": "0", + "hs-expired-list-alloc": "237791", + "hs-sch-delay700us": "1417", + "hs-timer-cb": "10730115", + "uhs-callout": "1624635", + "uhs-raw-cb": "9105480", + "hs-timer-add-req": "10730124", + "vdevice-name": "169.254.10.12", + "uhs-rst-sbt-req": "1624643", + "hs-sch-delay40us": "27818", + "hs-timer-dealloc": "10730115", + "uhs-callout-done": "1624635", + "hs-time-node-deleted": "10713477", + "hs-sch-delay100000us": "2", + "uhs-callout-not-pending": "0", + "uhs-raw-add-failed": "0", + "hs-timer-del-req": "0", + "hs-pending-list-process": "224059", + "uhs-rst-sbt-add": "1624643", + "uhs-callout-cancel": "0", + "hs-sch-delay800us": "1334", + "hs-sch-delay10us": "7627736", + "hs-expired-list-dealloc": "237791", + "hs-min-sch-delay": "4330", + "uhs-callout-call": "1624635", + "uhs-callout-del": "0", + "uhs-rst-sbt-cancel": "0", + "vdevice-host-name": "vm5", + "hs-sch-delay900us": "1186", + "hs-time-node-alloc": "10730124", + "hs-time-node-exist": "0", + "hs-sch-delay50us": "13812", + "uhs-stop-drain": "0", + "uhs-stop-del": "0", + "hs-time-node-expired": "1642", + "vdevice-dataKey": "169.254.10.12", + "hs-curr-node-ts-not-valid": "0", + "hs-timer-added": "10493918", + "hs-sch-delay100us": "16505", + "uihs-nr-hpts-cpu": "0", + "hs-timer-add-expired": "236206", + "hs-max-sch-delay": "36715506", + "lastupdated": 1644996827424, + "hs-ktimer-stop": "17812503" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-nat-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Nat Statistics from device", + "operationId": "getAppqoeNatStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Nat Statistics": { + "description": "Appqoe Nat Statistics", + "value": { + "data": [ + { + "port-alloc-fail": "0", + "port-free-succ": "0", + "port-free-fail": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "alloc-fail": "0", + "lastupdated": 1644997117219, + "dup-entries": "0", + "vdevice-host-name": "vm5", + "port-alloc-succ": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-rm-resource": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Resource Manager resources from device", + "operationId": "getAppqoeRmResources", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Resource Manager resources": { + "description": "Appqoe Resource Manager resources", + "value": { + "data": [ + { + "ssl-max-sess": "40000", + "avail-sys-mem": "2411556", + "dre-mem-per-sess": "0", + "ssl-used-sess": "0", + "vdevice-name": "169.254.10.12", + "rm-global-health-flag": "status-green", + "rm-tcp-sess-flag": "status-green", + "dre-used-sess": "0", + "tcp-max-sess": "40000", + "http-mem-per-sess": "0", + "vdevice-host-name": "vm5", + "rm-svc-mem-flag": "status-green", + "vdevice-dataKey": "169.254.10.12", + "per-used-serv-mem": "0", + "used-serv-mem": "0", + "http-max-sess": "0", + "tcp-used-sess": "0", + "ssl-mem-per-sess": "50", + "tcp-mem-per-sess": "64", + "lastupdated": 1644997246553, + "http-used-sess": "0", + "max-serv-mem": "1205778", + "dre-max-sess": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-rm-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe RM Statistics from device", + "operationId": "getAppqoeRMStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe RM Statistics": { + "description": "Appqoe RM Statistics", + "value": { + "data": [ + { + "port-alloc-fail": "0", + "port-free-succ": "0", + "port-free-fail": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "alloc-fail": "0", + "lastupdated": 1644997491529, + "dup-entries": "0", + "vdevice-host-name": "vm5", + "port-alloc-succ": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-services-status": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Services Status from device", + "operationId": "getAppqoeServicesStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Services Status": { + "description": "Appqoe Services Status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "service": "appqoe-service-tcpopt", + "load-percentage": "0", + "lastupdated": 1644998907908, + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "service": "appqoe-service-ssl", + "load-percentage": "0", + "lastupdated": 1644998907908, + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "load-status": "appqoe-service-status-red", + "vdevice-name": "169.254.10.12", + "service": "appqoe-service-dreopt", + "lastupdated": 1644998907908, + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-sppi-pipe-resource": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Sppi Pipe Stats from device", + "operationId": "getAppqoeSppiPipeStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Sppi Pipe Statistics": { + "description": "Appqoe Sppi Pipe Statistics", + "value": { + "data": [ + { + "p-invalid-mtu": "0", + "p-disconnect": "0", + "p-in-use": "0", + "p-invalid-queue-id": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "channel-num": "0", + "lastupdated": 1644997573992, + "p-ifindex-error": "0", + "vdevice-host-name": "vm5", + "p-sock-error": "0" + }, + { + "p-invalid-mtu": "0", + "p-disconnect": "0", + "p-in-use": "0", + "p-invalid-queue-id": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "channel-num": "1", + "lastupdated": 1644997573993, + "p-ifindex-error": "0", + "vdevice-host-name": "vm5", + "p-sock-error": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-sppi-queue-resource": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Sppi Queue Stats from device", + "operationId": "getAppqoeSppiQueueStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Sppi Queue Statistics": { + "description": "Appqoe Sppi Queue Statistics", + "value": { + "data": [ + { + "pkt-send-failed": "0", + "vdevice-name": "169.254.10.12", + "poll-error": "0", + "tpkt-version-error": "0", + "mmap-error": "0", + "truncated": "0", + "no-pkt-buf": "0", + "pkt-available": "0", + "invalid-ring": "0", + "vdevice-host-name": "vm5", + "in-use": "0", + "no-dev": "0", + "pkt-read-failed": "0", + "invalid-mode": "0", + "vdevice-dataKey": "169.254.10.12", + "nomem": "0", + "no-iov-buf": "0", + "not-init": "0", + "sock-error": "0", + "pkt": "8", + "channel-num": "0", + "lastupdated": 1644998764198, + "invalid-size": "0", + "pkt-losing": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/cluster-summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Cluster Summary from device", + "operationId": "getAppqoeClusterSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Cluster Summary": { + "description": "Appqoe Cluster Summary", + "value": { + "data": [ + { + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "load-percentage": "0", + "system-ip": "172.16.254.4", + "sng-name": "SNG-APPQOE", + "site-id": "5", + "vdevice-host-name": "vm5", + "lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.2", + "error-message": "-", + "service": "appqoe-service-tcpopt", + "lastupdated": 1644995623537, + "device-mode": "device-mode-integrated-service-node", + "status": "sn-status-green" + }, + { + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "load-percentage": "0", + "system-ip": "172.16.254.4", + "sng-name": "SNG-APPQOE", + "site-id": "5", + "vdevice-host-name": "vm5", + "lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.2", + "error-message": "-", + "service": "appqoe-service-ssl", + "lastupdated": 1644995623537, + "device-mode": "device-mode-integrated-service-node", + "status": "sn-status-green" + }, + { + "load-status": "appqoe-service-status-red", + "vdevice-name": "169.254.10.12", + "system-ip": "172.16.254.4", + "sng-name": "SNG-APPQOE", + "site-id": "5", + "vdevice-host-name": "vm5", + "lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.2", + "error-message": "-", + "service": "appqoe-service-dreopt", + "lastupdated": 1644995623537, + "device-mode": "device-mode-integrated-service-node", + "status": "sn-status-green" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/error-recent": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe error recent from device", + "operationId": "getAppqoeErrorRecent", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Error Recent": { + "description": "Appqoe Error Recent", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-res-tcp-used-sess", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-res-ssl-used-sess", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-health-yellow", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-health-green", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-tcp-sess-alloc", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-tcp-sess-free", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-ssl-sess-alloc", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-ssl-sess-free", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-tcp-tot-conn", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-tcp-tot-flow-create", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/expired-flow-id": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Expired flow Id details from device", + "operationId": "createAppqoeFlowIdExpiredDetails", + "parameters": [ + { + "name": "flow-id", + "in": "query", + "description": "Flow Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Expired flow Id details": { + "description": "Appqoe Expired flow Id details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/appqoe/flow-closed-error": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe flow closed error from device", + "operationId": "getAppqoeFlowClosedError", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Closed Error": { + "description": "Appqoe Flow Closed Error", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/flow-expired": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe expired from device", + "operationId": "getAppqoeExpired", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Expired List": { + "description": "Appqoe Flow Expired List", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/appqoe/service-controllers": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe service controllers from device", + "operationId": "getAppqoeServiceControllers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Service Controllers": { + "description": "Appqoe Service Controllers", + "value": { + "data": [ + { + "sn-lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.1", + "vdevice-name": "169.254.10.12", + "sc-lan-ip": "192.168.2.1", + "system-ip": "172.16.254.4", + "lastupdated": 1644996521181, + "site-id": "5", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe status from device", + "operationId": "getAppqoeStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Status": { + "description": "Appqoe Status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-sslproxy", + "err-tag": "appqoe-err-ca-tp-cfg", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-yellow" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-tcpproxy", + "err-tag": "appqoe-err-undef", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-green" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-sc", + "err-tag": "appqoe-err-undef", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-green" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-rm", + "err-tag": "appqoe-err-undef", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-green" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/vpn-id": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Active vpn Id details from device", + "operationId": "createAppqoeVpnIdList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "client-ip", + "in": "query", + "description": "Client Ip", + "schema": { + "type": "string" + } + }, + { + "name": "server-ip", + "in": "query", + "description": "Server Ip", + "schema": { + "type": "string" + } + }, + { + "name": "server-port", + "in": "query", + "description": "Server-Port", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Active VpnId List": { + "description": "Appqoe Flow Active VpnId List", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/arp": { + "get": { + "tags": [ + "Real-Time Monitoring - ARP" + ], + "description": "Get ARP interfaces from device (Real Time)", + "operationId": "getARPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ARP interface": { + "description": "ARP interface", + "value": { + "data": [ + { + "if-name": "ge0/1", + "idle-timer": "0:00:10:36", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "10.101.254.254", + "lastupdated": 1642578468257, + "state": "dynamic", + "vpn-id": "0", + "uptime-date": 1642160280000, + "vdevice-host-name": "vm3", + "mac": "52:54:00:7a:da:f8", + "uptime": "4:20:09:23" + }, + { + "if-name": "eth0", + "vdevice-dataKey": "169.254.10.10-512-eth0", + "vdevice-name": "169.254.10.10", + "ip": "10.0.1.3", + "lastupdated": 1642578468257, + "state": "static", + "vpn-id": "512", + "uptime-date": 1642154760000, + "vdevice-host-name": "vm3", + "mac": "00:50:56:00:01:03", + "uptime": "4:21:41:16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/bfd/history": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get BFD session history from device (Real Time)", + "operationId": "createBFDHistoryList", + "parameters": [ + { + "name": "system-ip", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD session history": { + "description": "BFD session history", + "value": { + "data": [ + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "default", + "tx-pkts": 3856, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187218000, + "system-ip": "172.16.254.1", + "index": 8, + "dst-port": 12386, + "del": 0, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-8-2022-01-14T19:06:58+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:58+0000", + "state": "down", + "rx-pkts": 3855 + }, + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "default", + "tx-pkts": 6, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187218000, + "system-ip": "172.16.254.1", + "index": 9, + "dst-port": 12386, + "del": 1, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-9-2022-01-14T19:06:58+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:58+0000", + "state": "down", + "rx-pkts": 6 + }, + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "biz-internet", + "tx-pkts": 0, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187219000, + "system-ip": "172.16.254.1", + "index": 6, + "dst-port": 12406, + "del": 0, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-6-2022-01-14T19:06:59+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:59+0000", + "state": "down", + "rx-pkts": 0 + }, + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "biz-internet", + "tx-pkts": 6, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187219000, + "system-ip": "172.16.254.1", + "index": 7, + "dst-port": 12406, + "del": 0, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-7-2022-01-14T19:06:59+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:59+0000", + "state": "up", + "rx-pkts": 6 + }, + { + "dst-ip": "10.102.5.5", + "src-ip": "10.101.3.3", + "color": "default", + "tx-pkts": 95431, + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "time-date": 1642577832000, + "system-ip": "172.16.254.4", + "index": 8, + "dst-port": 12386, + "del": 0, + "site-id": 5, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-8-2022-01-19T07:37:12+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-19T07:37:12+0000", + "state": "down", + "rx-pkts": 95426 + }, + { + "dst-ip": "10.102.16.16", + "src-ip": "10.102.3.3", + "color": "lte", + "tx-pkts": 0, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642163442000, + "system-ip": "172.16.254.16", + "index": 6, + "dst-port": 12366, + "del": 0, + "site-id": 16, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-6-2022-01-14T12:30:42+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T12:30:42+0000", + "state": "down", + "rx-pkts": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/links": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get list of BFD connections", + "operationId": "createBFDLinkList", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Device state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD connections": { + "description": "BFD connections", + "value": { + "data": [ + { + "linkKey": "172.16.255.14:lte - 172.16.255.16:lte", + "linkKeyDisplay": "172.16.255.14 (lte) - 172.16.255.16 (lte)", + "asystem-ip": "172.16.255.16", + "bhost-name": "vm4", + "lastupdated": "1642494861369", + "bsite-id": "400", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.14", + "ahost-name": "vm6", + "adeviceId": "172.16.255.16", + "asite-id": "600", + "bsystem-ip": "172.16.255.14" + }, + { + "linkKey": "172.16.255.11:lte - 172.16.255.16:lte", + "linkKeyDisplay": "172.16.255.11 (lte) - 172.16.255.16 (lte)", + "asystem-ip": "172.16.255.16", + "bhost-name": "vm1", + "lastupdated": "1642663041881", + "bsite-id": "100", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.11", + "ahost-name": "vm6", + "adeviceId": "172.16.255.16", + "asite-id": "600", + "bsystem-ip": "172.16.255.11" + }, + { + "linkKey": "172.16.255.16:lte - 172.16.255.21:lte", + "linkKeyDisplay": "172.16.255.16 (lte) - 172.16.255.21 (lte)", + "asystem-ip": "172.16.255.16", + "bhost-name": "vm11", + "lastupdated": "1642494861369", + "bsite-id": "100", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.21", + "ahost-name": "vm6", + "adeviceId": "172.16.255.16", + "asite-id": "600", + "bsystem-ip": "172.16.255.21" + }, + { + "linkKey": "172.16.255.15:lte - 172.16.255.16:lte", + "linkKeyDisplay": "172.16.255.15 (lte) - 172.16.255.16 (lte)", + "asystem-ip": "172.16.255.15", + "bhost-name": "vm6", + "lastupdated": "1642975004139", + "bsite-id": "600", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.16", + "ahost-name": "vm5", + "adeviceId": "172.16.255.15", + "asite-id": "500", + "bsystem-ip": "172.16.255.16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/bfd/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get list of BFD sessions from vManage (Real Time)", + "operationId": "createBFDSessions", + "parameters": [ + { + "name": "system-ip", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-color", + "in": "query", + "description": "Source color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "region-type", + "in": "query", + "description": "Region type", + "schema": { + "type": "string", + "enum": [ + "core", + "access" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD sessions": { + "description": "BFD sessions", + "value": { + "data": [ + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.2.2", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.1", + "dst-port": 12426, + "site-id": 2, + "transitions": 1, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:14:04:10", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.1-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642532640000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.4.4", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.3", + "dst-port": 12386, + "site-id": 4, + "transitions": 1, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:14:04:10", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.3-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642532640000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.102.5.5", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.4", + "dst-port": 12386, + "site-id": 5, + "transitions": 3, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:01:31:46", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.4-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642577820000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.102.6.6", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.5", + "dst-port": 12386, + "site-id": 6, + "transitions": 2, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:01:36:07", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.5-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642577520000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.102.16.16", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.16", + "dst-port": 12386, + "site-id": 16, + "transitions": 1, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:14:04:10", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.16-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642532640000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/sites/detail": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get detailed BFD site details", + "operationId": "getBFDSiteStateDetail", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD site detail: state=siteup": { + "description": "BFD site detail: state=siteup", + "value": { + "data": [ + { + "bfdSessions": "5", + "site-id": "4", + "device-type": "vedge", + "uuid": "4125a7b2-65cd-43c5-a393-cba53ebcdc00", + "lastupdated": 1648413952287, + "reachability": "reachable", + "device-model": "vedge-cloud", + "version": "20.3.4-542", + "system-ip": "169.254.10.11", + "uptime-date": 1646298000000, + "controlConnections": "3", + "host-name": "vm4", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.3", + "board-serial": "12345709" + }, + { + "bfdSessions": "5", + "site-id": "16", + "device-type": "vedge", + "uuid": "CSR-aec2123c-f20b-4876-b9ac-ae1dba561fb5", + "lastupdated": 1648416356665, + "reachability": "reachable", + "device-model": "vedge-CSR-1000v", + "version": "17.03.06.0.6691", + "system-ip": "169.254.10.14", + "uptime-date": 1647300780000, + "controlConnections": "3", + "host-name": "vm16", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.16", + "board-serial": "1234570F" + }, + { + "bfdSessions": "5", + "site-id": "5", + "device-type": "vedge", + "uuid": "C8K-d721a892-1cc1-4a30-9d17-98387348e2d4", + "lastupdated": 1648418760239, + "reachability": "reachable", + "device-model": "vedge-C8000V", + "version": "17.06.03.0.3496", + "system-ip": "169.254.10.12", + "uptime-date": 1646298240000, + "controlConnections": "3", + "host-name": "vm5", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.4", + "board-serial": "1234570A" + }, + { + "bfdSessions": "5", + "site-id": "2", + "device-type": "vedge", + "uuid": "f713e867-4376-45f1-8ecf-7c5fbe2be2f8", + "lastupdated": 1648453581214, + "reachability": "reachable", + "device-model": "vedge-cloud", + "version": "20.8.0-218", + "system-ip": "169.254.10.9", + "uptime-date": 1648060560000, + "controlConnections": "3", + "host-name": "vm2", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.1", + "board-serial": "12345707" + }, + { + "bfdSessions": "5", + "site-id": "6", + "device-type": "vedge", + "uuid": "C8K-47924f4e-0029-4693-a3df-986cb132437f", + "lastupdated": 1648413353813, + "reachability": "reachable", + "device-model": "vedge-C8000V", + "version": "17.08.01.0.1034", + "system-ip": "169.254.10.13", + "uptime-date": 1646298240000, + "controlConnections": "3", + "host-name": "vm6", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.5", + "board-serial": "1234570B" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-read,RBAC VPN-write" + } + }, + "/device/bfd/sites/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get BFD site summary", + "operationId": "getBFDSitesSummary", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Flag for caching", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "Filter VPN", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD site summary": { + "description": "BFD site summary", + "value": { + "data": [ + { + "count": 6, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "Full WAN Connectivity", + "status": "up", + "message": "6 Full WAN Connectivity", + "detailsURL": "/dataservice/device/bfd/sites/detail?state=siteup", + "count": 6 + }, + { + "name": "Partial WAN Connectivity", + "status": "warning", + "message": "0 Partial WAN Connectivity", + "detailsURL": "/dataservice/device/bfd/sites/detail?state=sitepartial", + "count": 0 + }, + { + "name": "No WAN Connectivity", + "status": "down", + "message": "0 No WAN Connectivity", + "detailsURL": "/dataservice/device/bfd/sites/detail?state=sitedown", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,System-read,System-write" + } + }, + "/device/bfd/state/device": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD state summary", + "operationId": "getDeviceBFDStateSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD state summary": { + "description": "BFD state summary", + "value": { + "data": [ + { + "site-id": 400, + "color": "lte", + "vmanage-system-ip": "172.16.255.11", + "local-color": "lte", + "local-if-desc": "", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.14-lte-ipsec", + "tx-interval": 1000, + "vdevice-host-name": "vm1", + "transitions": 0, + "proto": "ipsec", + "lastupdated": 1642663028239, + "state": "up", + "uptime-date": 1642663020000, + "dst-port": 12366, + "system-ip": "172.16.255.14", + "dst-ip": "10.1.14.14", + "remote-if-desc": "", + "createTimeStamp": 1642494963368, + "src-port": 12347, + "vdevice-name": "172.16.255.11", + "@rid": 936, + "detect-multiplier": "7", + "src-ip": "10.0.5.11", + "local-remote-ifname": "ge0/2-ge0/4" + }, + { + "site-id": 600, + "color": "lte", + "vmanage-system-ip": "172.16.255.11", + "local-color": "lte", + "local-if-desc": "", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.16-lte-ipsec", + "tx-interval": 1000, + "vdevice-host-name": "vm1", + "transitions": 0, + "proto": "ipsec", + "lastupdated": 1642663028239, + "state": "up", + "uptime-date": 1642663020000, + "dst-port": 12366, + "system-ip": "172.16.255.16", + "dst-ip": "10.1.16.16", + "remote-if-desc": "", + "createTimeStamp": 1642494971424, + "src-port": 12347, + "vdevice-name": "172.16.255.11", + "@rid": 947, + "detect-multiplier": "7", + "src-ip": "10.0.5.11", + "local-remote-ifname": "ge0/2-GigabitEthernet1" + }, + { + "site-id": 500, + "color": "lte", + "vmanage-system-ip": "172.16.255.11", + "local-color": "lte", + "local-if-desc": "", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.15-lte-ipsec", + "tx-interval": 1000, + "vdevice-host-name": "vm1", + "transitions": 0, + "proto": "ipsec", + "lastupdated": 1642663028239, + "state": "up", + "uptime-date": 1642663020000, + "dst-port": 12346, + "system-ip": "172.16.255.15", + "dst-ip": "10.1.15.15", + "remote-if-desc": "", + "createTimeStamp": 1642657637570, + "src-port": 12347, + "vdevice-name": "172.16.255.11", + "@rid": 1004, + "detect-multiplier": "7", + "src-ip": "10.0.5.11", + "local-remote-ifname": "ge0/2-GigabitEthernet1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,System-read,System-write" + } + }, + "/device/bfd/state/device/tloc": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD state summary with tloc color", + "operationId": "getDeviceBFDStateSummaryTloc", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD state summary with tloc": { + "description": "BFD state summary with tloc", + "value": { + "data": [ + { + "local-color": [ + "lte", + "dia" + ], + "color": [ + "lte", + "dia" + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/device/bfd/state/device/tlocInterfaceMap": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device tloc color to Intf Mapping Relationship", + "operationId": "getDeviceTlocToIntfList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device tloc to intf mapping relationships": { + "description": "Device tloc to intf mapping relationships", + "value": { + "intfList": { + "private1": "GigabitEthernet1", + "mpls": "GigabitEthernet2" + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/device/bfd/status": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD status", + "operationId": "getDeviceBFDStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD status": { + "description": "BFD status", + "value": { + "data": [ + { + "count": 0, + "statusList": [ + { + "status": "up", + "count": 0, + "name": "up", + "color": "b0e276", + "detailsURL": "/dataservice/device/bfd/links?state=up", + "detailView": "dialog", + "icon": "images/connection/connection-network-up.png" + }, + { + "status": "down", + "count": 0, + "name": "down", + "color": "fa7c7d", + "detailsURL": "/dataservice/device/bfd/links?state=down", + "detailView": "dialog", + "icon": "images/connection/connection-network-down.png" + } + ], + "name": "BFD", + "image": "images/bfd.png", + "detailsURL": "/dataservice/device/bfd/links", + "type": "bfd", + "detailView": "dialog" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/bfd/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get BFD summary from device (Real Time)", + "operationId": "createBFDSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD summary": { + "description": "BFD summary", + "value": { + "data": [ + { + "bfd-sessions-max": "22", + "vdevice-dataKey": "169.254.10.10", + "bfd-sessions-flap": "111", + "vdevice-name": "169.254.10.10", + "bfd-sessions-up": "5", + "lastupdated": 1642641879344, + "bfd-sessions-total": "5", + "poll-interval": "600000", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/summary/device": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD status summary", + "operationId": "getDeviceBFDStatusSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD status summary": { + "description": "BFD status summary", + "value": { + "header": { + "generatedOn": 1646894919672, + "title": "DataConnections" + }, + "data": [ + { + "name": "DataConnection", + "count": 3, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "up", + "message": "3up", + "detailsURL": "/dataservice/device/bfd/sessions?deviceId=172.16.255.11&state=up", + "count": 3 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/bfd/synced/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get list of BFD sessions from vManage synchronously", + "operationId": "createSyncedBFDSession", + "parameters": [ + { + "name": "system-ip", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-color", + "in": "query", + "description": "Source color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD sessions": { + "description": "BFD sessions", + "value": { + "data": [ + { + "src-ip": "10.0.5.11", + "dst-ip": "10.1.14.14", + "color": "lte", + "vdevice-name": "172.16.255.11", + "src-port": 12347, + "createTimeStamp": 1646804370042, + "system-ip": "172.16.255.14", + "dst-port": 12366, + "site-id": 400, + "transitions": 0, + "vdevice-host-name": "vm1", + "local-color": "lte", + "detect-multiplier": "7", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.14-lte-ipsec", + "@rid": 1050, + "vmanage-system-ip": "172.16.255.11", + "proto": "ipsec", + "lastupdated": 1646893777827, + "tx-interval": 1000, + "state": "up", + "uptime-date": 1646893680000 + }, + { + "src-ip": "10.0.5.11", + "dst-ip": "10.1.15.15", + "color": "lte", + "vdevice-name": "172.16.255.11", + "src-port": 12347, + "createTimeStamp": 1646804372038, + "system-ip": "172.16.255.15", + "dst-port": 12366, + "site-id": 500, + "transitions": 0, + "vdevice-host-name": "vm1", + "local-color": "lte", + "detect-multiplier": "7", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.15-lte-ipsec", + "@rid": 1057, + "vmanage-system-ip": "172.16.255.11", + "proto": "ipsec", + "lastupdated": 1646893777827, + "tx-interval": 1000, + "state": "up", + "uptime-date": 1646893680000 + }, + { + "src-ip": "10.0.5.11", + "dst-ip": "10.1.16.16", + "color": "lte", + "vdevice-name": "172.16.255.11", + "src-port": 12347, + "createTimeStamp": 1646804374521, + "system-ip": "172.16.255.16", + "dst-port": 12366, + "site-id": 600, + "transitions": 0, + "vdevice-host-name": "vm1", + "local-color": "lte", + "detect-multiplier": "7", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.16-lte-ipsec", + "@rid": 1060, + "vmanage-system-ip": "172.16.255.11", + "proto": "ipsec", + "lastupdated": 1646893777827, + "tx-interval": 1000, + "state": "up", + "uptime-date": 1646893680000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/tloc": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get TLOC summary from device (Real Time)", + "operationId": "createTLOCSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TLOC summary": { + "description": "TLOC summary", + "value": { + "data": [ + { + "sessions-flap": 90, + "if-name": "ge0/1", + "sessions-total": 5, + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642641739756, + "encap": "ipsec", + "sessions-up": 5, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bgp/neighbors": { + "get": { + "tags": [ + "Real-Time Monitoring - BGP" + ], + "description": "Get BGP neighbors list (Real Time)", + "operationId": "createBGPNeighborsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "peer-addr", + "in": "query", + "description": "Peer address", + "schema": { + "type": "string" + } + }, + { + "name": "as", + "in": "query", + "description": "AS number", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BGP neighbors list": { + "description": "BGP neighbors list", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "afi": "ipv4-unicast", + "vpn-id": 10, + "vdevice-host-name": "vm3", + "peer-addr": "20.20.20.20", + "as": 200, + "vdevice-dataKey": "169.254.10.10-10-20.20.20.20", + "msg-rcvd": 0, + "outQ": 0, + "afi-id": 0, + "lastupdated": 1642657118366, + "msg-sent": 0, + "state": "active" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/bgp/routes": { + "get": { + "tags": [ + "Real-Time Monitoring - BGP" + ], + "description": "Get BGP routes list (Real Time)", + "operationId": "createBGPRoutesList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "nexthop", + "in": "query", + "description": "Next hop", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BGP routes list": { + "description": "BGP routes list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.15", + "prefix": "10.20.24.0/24", + "origin": "origin-incomplete", + "as-path": "10007", + "weight": "0", + "vpn-id": "1", + "vdevice-host-name": "vm5", + "nexthop": "10.20.24.17", + "afi-safi": "vpnv4-unicast", + "path-id": "0", + "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-10.20.24.0/24", + "metric": "0", + "local-pref": "100", + "lastupdated": 1646989331657, + "path-status": "valid" + }, + { + "vdevice-name": "172.16.255.15", + "prefix": "10.20.24.0/24", + "origin": "origin-incomplete", + "weight": "32768", + "vpn-id": "1", + "vdevice-host-name": "vm5", + "nexthop": "0.0.0.0", + "afi-safi": "vpnv4-unicast", + "path-id": "0", + "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-10.20.24.0/24", + "metric": "0", + "local-pref": "100", + "lastupdated": 1646989331694, + "path-status": "bestpathvalid" + }, + { + "vdevice-name": "172.16.255.15", + "prefix": "172.16.255.117/32", + "origin": "origin-incomplete", + "as-path": "10007", + "weight": "0", + "vpn-id": "1", + "vdevice-host-name": "vm5", + "nexthop": "10.20.24.17", + "afi-safi": "vpnv4-unicast", + "path-id": "0", + "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-172.16.255.117/32", + "metric": "0", + "local-pref": "100", + "lastupdated": 1646989331735, + "path-status": "bestpathvalid" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/bgp/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - BGP" + ], + "description": "Get BGP summary (Real Time)", + "operationId": "createBGPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BGP summary": { + "description": "BGP summary", + "value": { + "data": [ + { + "local-site-of-origin": "SoO:0:3", + "vdevice-dataKey": "169.254.10.10-10", + "bgp-router-identifier": "172.16.254.2", + "peer-memory": "4816", + "vdevice-name": "169.254.10.10", + "rib-memory": "0", + "lastupdated": 1642657523957, + "total-peers": "1", + "vpn-id": 10, + "vdevice-host-name": "vm3", + "rib-entries": "0", + "local-as": "100" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/blockSync": { + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Set collection manager block set flag", + "operationId": "setBlockSync", + "parameters": [ + { + "name": "blockSync", + "in": "query", + "description": "Block sync flag", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/bridge/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - Bridge" + ], + "description": "Get device bridge interface list (Real Time)", + "operationId": "getBridgeInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bridge interface": { + "description": "Device bridge interface", + "value": { + "data": [ + { + "ifindex": "13", + "vdevice-name": "10.0.0.121", + "oper-status": "up", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/0", + "admin-status": "up", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/0", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "14", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/1", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/1", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "15", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/2", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/2", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "16", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/3", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/3", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "17", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/4", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/4", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/bridge/mac": { + "get": { + "tags": [ + "Real-Time Monitoring - Bridge" + ], + "description": "Get device bridge interface MAC (Real Time)", + "operationId": "getBridgeInterfaceMac", + "parameters": [ + { + "name": "bridge-id", + "in": "query", + "description": "Bridge ID", + "schema": { + "type": "string" + } + }, + { + "name": "if-name", + "in": "query", + "description": "Interface name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "mac-address", + "in": "query", + "description": "MAC address", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bridge interface MAC": { + "description": "Device bridge interface MAC", + "value": { + "data": [ + { + "if-name": "Ethernet-Internal2/0/0", + "mac-address": "58:bc:27:6d:c3:09", + "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-58:bc:27:6d:c3:09", + "vlan": "1", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1", + "interface": "GigabitEthernet0/3/0", + "type": "bridge-mac-type-dynamic", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "mac-address": "a4:4c:11:9e:03:d7", + "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:03:d7", + "vlan": "1", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1", + "interface": "GigabitEthernet0/3/0", + "type": "bridge-mac-type-dynamic", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "mac-address": "a4:4c:11:9e:1d:cc", + "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:1d:cc", + "vlan": "1", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1", + "type": "bridge-mac-type-static", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "vdevice-dataKey": "10.0.0.121-1002-Ethernet-Internal2/0/0-", + "vlan": "1002", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1002", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "vdevice-dataKey": "10.0.0.121-1003-Ethernet-Internal2/0/0-", + "vlan": "1003", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1003", + "vdevice-host-name": "ISR4451-X" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/bridge/table": { + "get": { + "tags": [ + "Real-Time Monitoring - Bridge" + ], + "description": "Get device bridge interface table (Real Time)", + "operationId": "getBridgeInterfaceTable", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bridge interface": { + "description": "Device bridge interface", + "value": { + "data": [ + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 4, + "routing-interface": "Vlan1", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1", + "vlan": "1", + "tx-octets": "0", + "tx-packets": "0", + "name": "default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1002", + "vlan": "1002", + "tx-octets": "0", + "tx-packets": "0", + "name": "fddi-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1002", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1003", + "vlan": "1003", + "tx-octets": "0", + "tx-packets": "0", + "name": "token-ring-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1003", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1004", + "vlan": "1004", + "tx-octets": "0", + "tx-packets": "0", + "name": "fddinet-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1004", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1005", + "vlan": "1005", + "tx-octets": "0", + "tx-packets": "0", + "name": "trnet-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1005", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/connection": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular connection list from device", + "operationId": "createCellularConnectionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular connection list": { + "description": "Cellular connection list", + "value": [ + { + "lastupdated": 1649242617635, + "cellular-interface": "Cellular0/1/0", + "active-profile": "1", + "cellular-packet-status": "packet-session-status-active", + "rx-packets": "20905", + "rx-bytes": "10301", + "tx-packets": "20905", + "tx-bytes": "10301", + "ipv4-addr": "29.29.29.105", + "ipv4-dns-pri": "8.0.0.8", + "ipv4-dns-sec": "4.4.4.4", + "ipv6-addr": "2001:a0:c::1a", + "ipv6-dns-pri": "2400:da00::6666", + "ipv6-dns-sec": "2400:da00::6666", + "scope": "scope", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/hardware": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular hardware list from device", + "operationId": "createHardwareList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular hardware list": { + "description": "Cellular hardware list", + "value": [ + { + "lastupdated": 1649242617635, + "cellular-interface": "Cellular0/1/0", + "cellular-firmware-build-time": "1649242617635", + "cellular-firmware-version": "1.0", + "cellular-hardware-version": "1.0", + "cellular-device-model": "HMOD1", + "cellular-imsi": "HUID1", + "cellular-imei": "imei", + "cellular-iccid": "iccid", + "cellular-msisdn": "msisdn", + "cellular-fsn": "fsn", + "cellular-modem-status": "active", + "cellular-modem-temperature": "16c", + "cellular-pri-skuid": "skuid", + "cellular-pri-version": "2.0", + "cellular-carrier": "carrier", + "cellular-oem-pri-version": "2.0", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/modem": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular modem list from device", + "operationId": "createModemList", + "parameters": [ + { + "name": "policyId", + "in": "query", + "description": "Policy IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular modem list": { + "description": "Cellular modem list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "model": "model", + "fw-version": "1.0", + "fw-date": "2022-04-18", + "fw-time": "1649242617635", + "fw-pkg-ver": "1.2", + "fw-pkg-carrier": "carrier", + "fw-pkg-pri": "pri", + "fw-pkg-subver": "subver", + "hw-version": "1.5", + "modem-status": "active", + "temperature": "16c", + "imsi": "imsi", + "imei": "imei", + "iccid": "iccid", + "msisdn": "msisdn", + "esn": "esn", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/network": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular network list from device", + "operationId": "createNetworkList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular network list": { + "description": "Cellular network list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "reg-status": "status", + "roam-status": "status", + "domain-status": "status", + "mcc": "mcc", + "mnc": "mnc", + "nw-name": "name", + "emm-state": "state", + "emm-substate": "good", + "emm-connstate": "good", + "cellid": "cellid", + "tac": "tac", + "sid": "sid", + "nid": "nid", + "bid": "bid", + "lac": "lac", + "psc": "psc", + "bsic": "bsic", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/profiles": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular profile list from device", + "operationId": "createProfileList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular profile list": { + "description": "Cellular profile list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "profile-id": "123", + "pdn-type": "type", + "apn": "apn", + "name": "name", + "auth": "auth", + "ip-addr": "172.16.255.15", + "primary-dns": "8.8.8.8", + "secondary-dns": "4.4.4.4", + "user-name": "uname", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/radio": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular radio list from device", + "operationId": "createRadioList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular radio list": { + "description": "Cellular radio list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "band": 123, + "bandwidth": 1000.2, + "tx-channel": 1, + "rx-channel": 2, + "rssi": 1, + "rsrp": 2, + "rsrp-comment": "comment", + "rsrq": 4, + "rsrq-comment": "comment", + "snr": 3.4, + "snr-comment": "comment", + "ecio": "ecio", + "sinr": "sinr", + "io": "io", + "mode": "mode", + "band-class": "band class", + "channel": "unam123e", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular session list from device", + "operationId": "createSessionsList", + "parameters": [ + { + "name": "if-name", + "in": "query", + "description": "Interface name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "ipv4-dns-pri", + "in": "query", + "description": "DNS primary IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular session list": { + "description": "Cellular session list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "session-id": "123", + "data-bearer": "bearer", + "dormancy-state": "state", + "active-profile": 1, + "rx-packets": 18, + "rx-drops": 15, + "rx-errors": 888, + "rx-overflows": 444, + "rx-octets": 235, + "tx-packets": 234, + "tx-drops": 234, + "tx-errors": 123, + "tx-overflows": 123, + "tx-octets": 123, + "ipv4-addr": "172.16.255.15", + "ipv4-mask": "255.255.255.0", + "ipv4-gw": "192.168.0.1", + "ipv4-dns-pri": "8.8.8.8", + "ipv4-dns-sec": "4.4.4.4", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular status list from device", + "operationId": "getCellularStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular status list": { + "description": "Cellular status list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "modem-status": "status", + "sim-status": "status", + "signal-strength": "12", + "network-status": "health", + "last-seen-error": "last error", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellularEiolte/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Connection Service" + ], + "description": "Get cellular connection info from device", + "operationId": "getEiolteConnectionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular connection info": { + "description": "cellular connection info", + "value": [ + { + "vdevice-name": "172.16.255.111", + "rx-errors": 0, + "cellular-interface-name": "Cellular 1/0", + "tx-errors": 0, + "sec-dns-ipv4-addr": "0.0.0.0", + "pri-dns-ipv4-addr": "8.8.8.8", + "tx-ofl": 0, + "connectivity": "Attach and Data", + "ipv4-address": "192.168.3.2", + "rx-ofl": 0, + "rx-pkts": 42067, + "apn": "internet", + "ipv6-prefix-length": "0", + "tx-pkts": 36604, + "ipv4-gateway-addr": "192.168.3.1", + "session-status": "Connected", + "pri-dns-ipv6-addr": "::", + "sec-dns-ipv6-addr": "::", + "vdevice-host-name": "CellularGateway", + "tx-drops": 0, + "rx-drops": 0, + "vdevice-dataKey": "172.16.255.111-1-1-", + "profile-id": 1, + "modem-index": "1", + "tx-bytes": 10145490, + "lastupdated": 1649249750021, + "ipv6-gw-prefix-length": "0", + "ipv6-gw-prefix": "::", + "rx-bytes": 8887213, + "ipv6-prefix": "::" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/hardware": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Hardware Service " + ], + "description": "Get cellular hardware info from device", + "operationId": "getEiolteHardwareInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular hardware info": { + "description": "cellular hardware info", + "value": [ + { + "ICCID": "8952530306500032705", + "FSN": "4H0222009903AG", + "host-manufacturer": "Cisco Systems, Inc.", + "vdevice-name": "172.16.255.111", + "PRI-SKU-ID": "1104567", + "Modem-Status": "MODEM_STATE_DNS_ACQUIRED", + "cellular-interface-name": "Cellular 1/0", + "Firmware-Version": "SWIX55C_03.07.00.00 fef145 jenkins", + "host-software-version": "N/A", + "IMEI": "351735110100118", + "Model-ID": "EM9190", + "vdevice-host-name": "CellularGateway", + "vdevice-dataKey": "172.16.255.111-1-", + "Modem-Temperature": 33, + "PRI-Version": "030.018_000", + "IMSI": "001010123456063", + "OEM-PRI-Version": "001.021", + "modem-index": "1", + "Host-Firmware-Version": "SWIX55C_03.07.00.00 fef145 jenkins", + "lastupdated": 1649250029516, + "Carrier": "GENERIC", + "host-id": "N/A", + "host-model": "N/A" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/ipsec/interface/counters": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular AON Ipsec Interface " + ], + "description": "Get cellular ipsec interface info from device", + "operationId": "getAONIpsecInterfaceCountersInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular info": { + "description": "cellular info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/ipsec/interface/session": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular AON Ipsec Interface " + ], + "description": "Get cellular ipsec interface info from device", + "operationId": "getAONIpsecInterfaceSessionnfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular info": { + "description": "cellular info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/network": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Network Service" + ], + "description": "Get cellular network info from device", + "operationId": "getEiolteNetworkInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular network info": { + "description": "cellular network info", + "value": [ + { + "Network-Selection-Mode": "Automatic", + "MNC": 1, + "vdevice-name": "172.16.255.111", + "cellular-interface-name": "Cellular 1/0", + "MCC": 1, + "vdevice-host-name": "CellularGateway", + "MTU": 1500, + "System-Time": "Thu Mar 24 3:6:0 2022", + "PS-State": "Attached", + "Roaming-Status": "Home", + "RRC-Connection-State": "RRC Connected", + "vdevice-dataKey": "172.16.255.111-1-", + "Network": "Test PLMN 1-1", + "EMM-State": "Registered", + "TAC": 1, + "Cell-ID": 27447297, + "modem-index": "1", + "lastupdated": 1649250149676, + "Current-Service": "Packet switched", + "Current-Service-status": "Normal", + "EMM-Sub-State": "Normal-Service" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/radio": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Connection Service" + ], + "description": "Get cellular radio info from device", + "operationId": "getEiolteRadioInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular radio info": { + "description": "cellular radio info", + "value": [ + { + "Current-ENDC-RSRQ": "-11 dB", + "Current-ENDC-RSRP": "-71 dBm", + "vdevice-name": "172.16.255.111", + "LTE-Bandwidth": "20 MHz", + "cellular-interface-name": "Cellular 1/0", + "Offline-Reason": "Unknown", + "LTE-Rx-Channel-Number": 18300, + "Measured-ENDC-SINR": "36.0 dB", + "ENDC-active-downlink-channel": "632628", + "Low-Power-Reason": "Unknown", + "ENDC-active-band": "78", + "SNR": "30.0 dB", + "ENDC-Physical-CellId": "500", + "LTE-Band": 1, + "RSRP": "-60 dBm", + "Radio-Status": "online", + "ENDC-active-uplink-channel": "632628", + "RSRQ": "-7 dB", + "LTE-Tx-Channel-Number": 300, + "vdevice-host-name": "CellularGateway", + "RSSI": "-33 dBm", + "vdevice-dataKey": "172.16.255.111-1-", + "PCI": 1, + "ENDC-bandwidth": "50 MHz", + "modem-index": "1", + "lastupdated": 1649250251234, + "RAT-Selected": "LTE" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/sim": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Sim Service" + ], + "description": "Get cellular sim info from device", + "operationId": "getEiolteSimInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular sim info": { + "description": "cellular sim info", + "value": [ + { + "active-sim": 0, + "vdevice-dataKey": "172.16.255.111-1-", + "vdevice-name": "172.16.255.111", + "cellular-interface-name": "Cellular 1/0", + "sim-status-slot-0": "Present", + "modem-index": "1", + "sim-status-slot-1": "Not Present", + "lastupdated": 1649250373414, + "vdevice-host-name": "CellularGateway" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cflowd/application/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get Cflowd DPI query field JSON", + "operationId": "getCflowdDPIDeviceFieldJSON", + "parameters": [ + { + "name": "isDeviceDashBoard", + "in": "query", + "description": "Flag whether it is device dashboard request", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI query field in JSON": { + "description": "DPI query field in JSON", + "value": { + "header": {}, + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + } + ] + }, + { + "property": "vpn_id", + "name": "VPN", + "isRequired": true, + "multiSelect": false, + "dataType": "int", + "fieldData": { + "type": "url", + "url": "dataservice/device/action/vpn" + } + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "isHidden": true, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/collector": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd collector list from device", + "operationId": "createCflowdCollectorList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cflowd collector list": { + "description": "Cflowd collector list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/device/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get CflowdvDPI query field JSON", + "operationId": "getCflowdDPIFieldJSON", + "parameters": [ + { + "name": "isDeviceDashBoard", + "in": "query", + "description": "Flag whether it is device dashboard request", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI query field in JSON": { + "description": "DPI query field in JSON", + "value": [ + { + "name": "Event Time", + "dataType": "date", + "isRequired": true, + "property": "entry_time", + "options": [ + { + "enableDateFields": false, + "value": "Last 24 hours", + "key": "last_24_hours", + "number": "24" + }, + { + "enableDateFields": false, + "value": "Last 12 hours", + "key": "last_12_hours", + "number": "12" + }, + { + "enableDateFields": false, + "value": "Last 6 hours", + "key": "last_6_hours", + "number": "6" + }, + { + "enableDateFields": false, + "value": "Last 3 hours", + "key": "last_3_hours", + "number": "3" + }, + { + "enableDateFields": false, + "value": "Last 1 hour", + "key": "last_1_hour", + "number": "1" + }, + { + "enableDateFields": false, + "value": "Last 7 days", + "key": "last_168_hours", + "number": "168" + } + ], + "fieldData": { + "type": "dateList" + } + }, + { + "dataType": "string", + "isRequired": true, + "property": "dest_ip", + "multiSelect": false, + "name": "Destination Ip" + }, + { + "dataType": "long", + "isRequired": true, + "property": "dest_port", + "multiSelect": false, + "name": "Destination port" + }, + { + "name": "Device name", + "dataType": "string", + "isRequired": true, + "multiSelect": false, + "property": "vdevice_name", + "isHidden": true + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/flows": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get list of cflowd flows from device", + "operationId": "createCflowCollectorList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "src-ip", + "in": "query", + "description": "Source IP", + "schema": { + "type": "string" + } + }, + { + "name": "dest-ip", + "in": "query", + "description": "Destination IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cflowd flows list": { + "description": "Cflowd flows list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/flows-count": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd flow count from device", + "operationId": "createCflowdFlowsCountList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "src-ip", + "in": "query", + "description": "Source IP", + "schema": { + "type": "string" + } + }, + { + "name": "dest-ip", + "in": "query", + "description": "Destination IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cflowd flow count": { + "description": "Cflowd flow count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/cache-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF cache stats from device", + "operationId": "getFnFCacheStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF cache stats": { + "description": "FnF cache stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/export-client-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF export client stats from device", + "operationId": "getFnFExportClientStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF export client stats": { + "description": "FnF export client stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/export-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF export stats from device", + "operationId": "getFnFExportStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF export stats": { + "description": "FnF export stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/flow-monitor": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF from device", + "operationId": "getFnf", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF": { + "description": "FnF", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/monitor-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF monitor stats from device", + "operationId": "getFnFMonitorStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF monitor stats": { + "description": "FnF monitor stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/statistics": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd statistics from device", + "operationId": "createCflowdStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cflowd statistics": { + "description": "Cflowd statistics", + "value": [ + { + "model_sk": "None", + "state_description": "All daemons up", + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.22", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "0", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vmanage", + "uuid": "b9944bb0-b10b-427a-8fb4-5d3b51eec679", + "lastupdated": 1639105319291, + "platform": "x86_64", + "state": "green", + "host-name": "vm12", + "uptime-date": 1638953400000, + "latitude": "37.666684", + "system-ip": "172.16.255.22", + "personality": "vmanage", + "status": "normal", + "board-serial": "12345963", + "validity": "valid", + "certificate-validity": "Valid", + "max-controllers": "0", + "device-model": "vmanage", + "deviceId": "172.16.255.22", + "layoutLevel": 1, + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/template": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd template from device", + "operationId": "createCflowdTemplate", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cflowd template": { + "description": "Cflowd template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cfm/mp/database": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp database from device", + "operationId": "getMpDatabase", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp database": { + "description": "Mp database", + "value": { + "data": [ + { + "defect": "defect-none", + "flag": "rmep-flag-none", + "vdevice-dataKey": "172.16.255.11", + "vdevice-name": "172.16.255.11", + "level": "7", + "service": "UNINET_VERLEANDROVALLE-17_5005", + "domain": "UNINET", + "local-mep-id": "1562", + "lastupdated": 1648692601592, + "remote-mep-id": "1561", + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cfm/mp/local/mep": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp local mep from device", + "operationId": "getMpLocalMep", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "Domain Name", + "schema": { + "type": "string" + } + }, + { + "name": "service", + "in": "query", + "description": "Service Name", + "schema": { + "type": "string" + } + }, + { + "name": "mep-id", + "in": "query", + "description": "MEP ID", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp local mep": { + "description": "Mp local mep", + "value": { + "data": [ + { + "svc-type": "cfm-svc-bd-vlan", + "offload-success": "false", + "vdevice-name": "172.16.255.11", + "level": "7", + "offload": "false", + "ccm-mode": "ccm-mode-multicast", + "dir": "mep-direction-down", + "vdevice-host-name": "vm1", + "svc-inst": "0", + "mep-id": "1562", + "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562", + "vlan": "112", + "port": "GigabitEthernet3", + "evc-name": "UNINET_VERLEANDROVALLE-17_5005", + "service": "UNINET_VERLEANDROVALLE-17_5005", + "ccm-state": "ccm-enabled", + "domain": "UNINET", + "lastupdated": 1648692897652, + "mac-addr": "52:54:00:fb:57:42" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cfm/mp/local/mip": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp local mip from device", + "operationId": "getMpLocalMip", + "parameters": [ + { + "name": "level", + "in": "query", + "description": "Level", + "schema": { + "type": "number" + } + }, + { + "name": "port", + "in": "query", + "description": "Port", + "schema": { + "type": "string" + } + }, + { + "name": "svc-inst", + "in": "query", + "description": "Service Instance", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp local mip": { + "description": "Mp local mip", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cfm/mp/remotemep": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp remote mep from device", + "operationId": "getMpRemoteMep", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "Domain Name", + "schema": { + "type": "string" + } + }, + { + "name": "service", + "in": "query", + "description": "Service Name", + "schema": { + "type": "string" + } + }, + { + "name": "local-mep-id", + "in": "query", + "description": "Local MEP ID", + "schema": { + "type": "number" + } + }, + { + "name": "remote-mep-id", + "in": "query", + "description": "Remote MEP ID", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp remote mep": { + "description": "Mp remote mep", + "value": { + "data": [ + { + "svc-type": "cfm-svc-bd-vlan", + "vdevice-name": "172.16.255.11", + "level": "7", + "remote-mep-id": "1561", + "if-status": "if-status-up", + "vdevice-host-name": "vm1", + "port-status": "port-status-up", + "svc-inst": "0", + "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562-1561", + "vlan": "112", + "evc-name": "UNINET_VERLEANDROVALLE-17_5005", + "service": "UNINET_VERLEANDROVALLE-17_5005", + "rdi": "false", + "domain": "UNINET", + "up-time": "2022-03-31T02:24:16.459+00:00", + "local-mep-id": "1562", + "lastupdated": 1648693001718, + "mac-addr": "52:54:00:aa:65:ba", + "ingress-if": "GigabitEthernet3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cloudx/application/detail": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress applications from device (Real Time)", + "operationId": "createApplicationsDetailList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress applications detail": { + "description": "Cloudexpress applications detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress applications from device (Real Time)", + "operationId": "createApplicationsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress applications": { + "description": "Cloudexpress applications", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/gatewayexits": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress gateway exits from device (Real Time)", + "operationId": "createGatewayExitsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress gateway exits": { + "description": "Cloudexpress gateway exits", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/loadbalance": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress load balance applications from device (Real Time)", + "operationId": "createLbApplicationsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress load-balance applications-lb": { + "description": "Cloudexpress load-balance applications-lb", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/localexits": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress local exits from device (Real Time)", + "operationId": "createLocalExitsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress local exits": { + "description": "Cloudexpress local exits", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/config": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device running configuration", + "operationId": "getDeviceRunningConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Device running configuration": { + "description": "Device running configuration" + } + } + }, + "text/xml": { + "schema": { + "type": "string" + }, + "examples": { + "Device running configuration": { + "description": "Device running configuration" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/config/html": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device running configuration in HTML format", + "operationId": "getDeviceRunningConfigHTML", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/html": { + "schema": { + "type": "string" + }, + "examples": { + "Device running configuration": { + "description": "Device running configuration" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true + } + }, + "/device/configuration/commit-list": { + "get": { + "tags": [ + "Real-Time Monitoring - Commit List" + ], + "description": "Get device commit list", + "operationId": "getDeviceConfigurationCommitList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device commit list": { + "description": "Device commit list", + "value": { + "data": [ + { + "time-stamp": "2022-03-1006:53:10", + "vdevice-dataKey": "172.16.255.11-0-10032", + "vdevice-name": "172.16.255.11", + "client": "system", + "lastupdated": 1646900329409, + "sn": "0", + "id": "10032", + "user": "system-vdaemon", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:48:02", + "vdevice-dataKey": "172.16.255.11-1-10031", + "vdevice-name": "172.16.255.11", + "client": "netconf", + "lastupdated": 1646900329409, + "sn": "1", + "id": "10031", + "user": "vmanage-admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:47:42", + "vdevice-dataKey": "172.16.255.11-2-10030", + "vdevice-name": "172.16.255.11", + "client": "cli", + "lastupdated": 1646900329409, + "sn": "2", + "id": "10030", + "user": "admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:28:31", + "vdevice-dataKey": "172.16.255.11-3-10026", + "vdevice-name": "172.16.255.11", + "client": "system", + "lastupdated": 1646900329409, + "sn": "3", + "id": "10026", + "user": "system-vdaemon", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:23:22", + "vdevice-dataKey": "172.16.255.11-4-10025", + "vdevice-name": "172.16.255.11", + "client": "netconf", + "lastupdated": 1646900329409, + "sn": "4", + "id": "10025", + "user": "vmanage-admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:02:22", + "vdevice-dataKey": "172.16.255.11-5-10024", + "vdevice-name": "172.16.255.11", + "client": "netconf", + "lastupdated": 1646900329409, + "sn": "5", + "id": "10024", + "user": "vmanage-admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1005:56:46", + "vdevice-dataKey": "172.16.255.11-6-10023", + "vdevice-name": "172.16.255.11", + "client": "system", + "lastupdated": 1646900329409, + "sn": "6", + "id": "10023", + "user": "system-vdaemon", + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/control/affinity/config": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get affinity config from device (Real Time)", + "operationId": "getAffinityConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Affinity config": { + "description": "Affinity config", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10--0", + "vdevice-name": "169.254.10.10", + "affc-ccl": "0(2)Y", + "affc-equil": "Yes", + "affc-ecl": "0(2)", + "affc-index": "0", + "lastupdated": 1642746599493, + "affc-interface": "ge0/1", + "affc-last-resort": "No", + "vdevice-host-name": "vm3", + "affc-ervc": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/affinity/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get affinity status from device (Real Time)", + "operationId": "getAffinityStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Affinity status": { + "description": "Affinity status", + "value": { + "data": [ + { + "affs-acc": "172.16.253.129(0),172.16.255.130(0)", + "vdevice-dataKey": "169.254.10.10--0", + "vdevice-name": "169.254.10.10", + "affs-index": "0", + "lastupdated": 1642746754330, + "vdevice-host-name": "vm3", + "affs-interface": "ge0/1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list from device (Real Time)", + "operationId": "createRealTimeConnectionList", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "domain-id": 1, + "instance": 0, + "vdevice-name": "169.254.10.10", + "behind-proxy": "No", + "system-ip": "172.16.253.129", + "remote-color": "default", + "site-id": 129, + "private-port": 12346, + "controller-group-id": 0, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:05:55:35", + "peer-type": "vsmart", + "v-org-name": "vIPtela Inc Regression", + "protocol": "dtls", + "vdevice-dataKey": "169.254.10.10-0-default-172.16.253.129-default", + "public-ip": "10.103.129.129", + "public-port": 12346, + "lastupdated": 1642727162594, + "state": "up", + "private-ip": "10.103.129.129", + "uptime-date": 1642705800000 + }, + { + "domain-id": 1, + "instance": 0, + "vdevice-name": "169.254.10.10", + "behind-proxy": "No", + "system-ip": "172.16.255.130", + "remote-color": "default", + "site-id": 130, + "private-port": 12346, + "controller-group-id": 0, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:05:55:35", + "peer-type": "vsmart", + "v-org-name": "vIPtela Inc Regression", + "protocol": "dtls", + "vdevice-dataKey": "169.254.10.10-0-default-172.16.255.130-default", + "public-ip": "10.103.130.130", + "public-port": 12346, + "lastupdated": 1642727162594, + "state": "up", + "private-ip": "10.103.130.130", + "uptime-date": 1642705800000 + }, + { + "domain-id": 0, + "instance": 0, + "vdevice-name": "169.254.10.10", + "behind-proxy": "No", + "system-ip": "169.254.10.3", + "remote-color": "default", + "site-id": 202, + "private-port": 12346, + "controller-group-id": 0, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:05:55:35", + "peer-type": "vmanage", + "v-org-name": "vIPtela Inc Regression", + "protocol": "dtls", + "vdevice-dataKey": "169.254.10.10-0-default-169.254.10.3-default", + "public-ip": "10.103.202.202", + "public-port": 12346, + "lastupdated": 1642727162594, + "state": "up", + "private-ip": "10.103.202.202", + "uptime-date": 1642705800000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/control/connectionshistory": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections history list from device (Real Time)", + "operationId": "createConnectionHistoryListRealTime", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "0.0.0.0", + "remote-color": "default", + "site-id": 0, + "uuid": "d7e88eac-250c-4189-bc66-747615452ad9", + "peer-type": "vbond", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.135.135", + "local_enum-desc": "Disconnect vBond after register reply.", + "domain-id": 0, + "rep-count": 0, + "index": 0, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "default", + "downtime": "2022-01-20T19:10:43+0000", + "vdevice-dataKey": "169.254.10.10-0-0-2022-01-20T19:10:43+0000", + "public-ip": "10.103.135.135", + "downtime-date": 1642705843000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISCVBD" + }, + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "169.254.10.3", + "remote-color": "default", + "site-id": 202, + "uuid": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", + "peer-type": "vmanage", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.202.202", + "local_enum-desc": "TLOC Disabled.", + "domain-id": 0, + "rep-count": 0, + "index": 1, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "biz-internet", + "downtime": "2022-01-20T19:10:24+0000", + "vdevice-dataKey": "169.254.10.10-0-1-2022-01-20T19:10:24+0000", + "public-ip": "10.103.202.202", + "downtime-date": 1642705824000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISTLOC" + }, + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "172.16.255.130", + "remote-color": "default", + "site-id": 130, + "uuid": "fca7532b-9366-466a-a8f9-79922392917b", + "peer-type": "vsmart", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.130.130", + "local_enum-desc": "TLOC Disabled.", + "domain-id": 1, + "rep-count": 0, + "index": 2, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "biz-internet", + "downtime": "2022-01-20T19:10:24+0000", + "vdevice-dataKey": "169.254.10.10-0-2-2022-01-20T19:10:24+0000", + "public-ip": "10.103.130.130", + "downtime-date": 1642705824000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISTLOC" + }, + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "169.254.10.3", + "remote-color": "default", + "site-id": 202, + "uuid": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", + "peer-type": "vmanage", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.202.202", + "local_enum-desc": "TLOC Disabled.", + "domain-id": 0, + "rep-count": 0, + "index": 5, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "default", + "downtime": "2022-01-20T19:09:22+0000", + "vdevice-dataKey": "169.254.10.10-0-5-2022-01-20T19:09:22+0000", + "public-ip": "10.103.202.202", + "downtime-date": 1642705762000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISTLOC" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/connectionsinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list from device (Real Time)", + "operationId": "createRealTimeConnectionList_1", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11---", + "vdevice-name": "172.16.255.11", + "rate": "Per-Control Connection Rate: 300 pps", + "lastupdated": 1646962973344, + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/control/count": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get number of vedges and vsmart device in different control states", + "operationId": "getTotalCountForDeviceStates", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Device State cached", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device state count": { + "description": "Device state count", + "value": { + "data": [ + { + "name": "ControlStatus", + "count": 7, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "Controlup", + "status": "up", + "message": "devicesup", + "detailsURL": "/dataservice/device/control/networksummary?state=up", + "count": 7 + }, + { + "name": "Partial", + "status": "warning", + "message": "devicesdown", + "detailsURL": "/dataservice/device/control/networksummary?state=partial", + "count": 0 + }, + { + "name": "Controldown", + "status": "error", + "message": "devicesdown", + "detailsURL": "/dataservice/device/control/networksummary?state=down", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/links": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list", + "operationId": "createLinkList", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Device State", + "required": true, + "schema": { + "type": "string", + "example": "up" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "state": "up", + "color1": "default", + "color2": "default", + "lastupdated": "1646912547015", + "linkKey": "172.16.255.19:default-172.16.255.26:default", + "linkKeyDisplay": "172.16.255.19(default)-172.16.255.26(default)", + "adeviceId": "172.16.255.26", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.26", + "bsystem-ip": "172.16.255.19", + "asite-id": "--", + "bsite-id": "100", + "ahost-name": "vm16", + "bhost-name": "vm9", + "apersonality": "vbond", + "bpersonality": "vsmart" + }, + { + "state": "up", + "color1": "default", + "color2": "default", + "lastupdated": "1646912512113", + "linkKey": "172.16.255.20:default-172.16.255.26:default", + "linkKeyDisplay": "172.16.255.20(default)-172.16.255.26(default)", + "adeviceId": "172.16.255.26", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.26", + "bsystem-ip": "172.16.255.20", + "asite-id": "--", + "bsite-id": "200", + "ahost-name": "vm16", + "bhost-name": "vm10", + "apersonality": "vbond", + "bpersonality": "vsmart" + }, + { + "state": "up", + "color1": "default", + "color2": "default", + "lastupdated": "1646912347752", + "linkKey": "172.16.255.22:default-172.16.255.26:default", + "linkKeyDisplay": "172.16.255.22(default)-172.16.255.26(default)", + "adeviceId": "172.16.255.26", + "bdeviceId": "172.16.255.22", + "asystem-ip": "172.16.255.26", + "bsystem-ip": "172.16.255.22", + "asite-id": "--", + "bsite-id": "200", + "ahost-name": "vm16", + "bhost-name": "vm12", + "apersonality": "vbond", + "bpersonality": "vmanage" + }, + { + "state": "up", + "color1": "lte", + "color2": "default", + "lastupdated": "1646912547013", + "linkKey": "172.16.255.14:lte-172.16.255.19:default", + "linkKeyDisplay": "172.16.255.14(lte)-172.16.255.19(default)", + "adeviceId": "172.16.255.14", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.14", + "bsystem-ip": "172.16.255.19", + "asite-id": "400", + "bsite-id": "100", + "ahost-name": "vm4", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "color1": "lte", + "color2": "default", + "lastupdated": "1646912512112", + "linkKey": "172.16.255.14:lte-172.16.255.20:default", + "linkKeyDisplay": "172.16.255.14(lte)-172.16.255.20(default)", + "adeviceId": "172.16.255.14", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.14", + "bsystem-ip": "172.16.255.20", + "asite-id": "400", + "bsite-id": "200", + "ahost-name": "vm4", + "bhost-name": "vm10", + "apersonality": "vedge", + "bpersonality": "vsmart" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/localproperties": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get local properties list (Real Time)", + "operationId": "createLocalPropertiesListListRealTIme", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Local properties list": { + "description": "Local properties list", + "value": { + "data": [ + { + "certificate-not-valid-before": "Jan 26 07:37:47 2022 GMT", + "site-id": "100", + "protocol": "dtls", + "root-ca-chain-status": "Installed", + "certificate-not-valid-after": "Jan 26 07:37:47 2023 GMT", + "dns-name": "vbond", + "vdevice-host-name": "vm1", + "port-hopped": "TRUE", + "device-role": "edge-router", + "certificate-status": "Installed", + "device-type": "vedge", + "uuid": "a555e577-d513-4768-a695-93574a15f5cc", + "sp-organization-name": "vIPtela Inc Regression", + "lastupdated": 1643348428058, + "region-id-set": "N/A", + "keygen-interval": "1:00:00:00", + "domain-id": "1", + "time-since-port-hop": "1:21:43:52", + "system-ip": "172.16.255.11", + "board-serial": "12346580", + "certificate-validity": "Valid", + "max-controllers": "0", + "tls-port": "0", + "organization-name": "vIPtela Inc Regression", + "vdevice-name": "172.16.255.11", + "vsmart-list-version": "0", + "number-vbond-peers": "0", + "vdevice-dataKey": "172.16.255.11", + "token": "Invalid", + "number-active-wan-interfaces": "1", + "register-interval": "0:00:00:30", + "retry-interval": "0:00:00:15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/networksummary": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get list of unreachable devices", + "operationId": "networkSummary", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Device State", + "schema": { + "type": "string", + "example": "up" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "list of unreachable devices": { + "description": "list of unreachable devices", + "value": { + "data": [ + { + "device-model": "vedge-cloud", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.21", + "system-ip": "172.16.255.21", + "host-name": "vm11", + "site-id": "100", + "version": "20.9.999-1766", + "uuid": "2b57ef1a-5eb2-4d8d-8676-cce19b56b26b", + "board-serial": "12345962", + "bfdSessions": "3", + "device-type": "vedge", + "lastupdated": 1646917368708, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646908860000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vedge-cloud", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.11", + "system-ip": "172.16.255.11", + "host-name": "vm1", + "site-id": "100", + "version": "20.9.999-1766", + "uuid": "84d1ab4e-0cbf-4369-a290-08fafeb80f95", + "board-serial": "12345974", + "bfdSessions": "3", + "device-type": "vedge", + "lastupdated": 1646967284462, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646909100000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vsmart", + "ompPeers": "6", + "number-vsmart-peers": 1, + "local-system-ip": "172.16.255.19", + "system-ip": "172.16.255.19", + "host-name": "vm9", + "site-id": "100", + "version": "20.9.999-1766", + "uuid": "9abd3af9-9087-497d-8b99-8fd0a7baa3f2", + "board-serial": "12345967", + "device-type": "vsmart", + "lastupdated": 1646967277159, + "reachability": "reachable", + "controlConnections": "9", + "uptime-date": 1646908920000, + "controlConnectionsToVsmarts": "1" + }, + { + "device-model": "vsmart", + "ompPeers": "6", + "number-vsmart-peers": 1, + "local-system-ip": "172.16.255.20", + "system-ip": "172.16.255.20", + "host-name": "vm10", + "site-id": "200", + "version": "20.9.999-1766", + "uuid": "43ba3223-9df7-4cc9-a059-a12e5382d79d", + "board-serial": "12345961", + "device-type": "vsmart", + "lastupdated": 1646967275863, + "reachability": "reachable", + "controlConnections": "9", + "uptime-date": 1646908860000, + "controlConnectionsToVsmarts": "1" + }, + { + "device-model": "vedge-cloud", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.14", + "system-ip": "172.16.255.14", + "host-name": "vm4", + "site-id": "400", + "version": "20.9.999-1766", + "uuid": "a66335c5-451f-4b93-a752-4116d688f347", + "board-serial": "12345970", + "bfdSessions": "4", + "device-type": "vedge", + "lastupdated": 1646967282559, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646908980000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vedge-C8000V", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.15", + "system-ip": "172.16.255.15", + "host-name": "vm5", + "site-id": "500", + "version": "17.09.01.0.154453", + "uuid": "C8K-8bda7a5d-6b75-47ec-a658-b30ca54e30eb", + "board-serial": "12345703", + "bfdSessions": "4", + "device-type": "vedge", + "lastupdated": 1646967275462, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646909400000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vedge-C8000V", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.16", + "system-ip": "172.16.255.16", + "host-name": "vm6", + "site-id": "600", + "version": "17.09.01.0.154453", + "uuid": "C8K-46aa4ddc-7468-45c2-9144-2d60c2f553f3", + "board-serial": "12345702", + "bfdSessions": "4", + "device-type": "vedge", + "lastupdated": 1646967277103, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646909400000, + "controlConnectionsToVsmarts": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connection statistics from device (Real Time)", + "operationId": "getConnectionStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection statistics": { + "description": "Connection statistics", + "value": { + "data": [ + { + "rx_challenge": "14", + "challenge_failures": "0", + "vdevice-name": "169.254.10.10", + "tx_dtls_handshake": "21", + "tx_register_replies": "0", + "rx_challenge_ack": "14", + "tx_octets": "24918292", + "rx_registers": "0", + "tx_dtls_handshake_failures": "7", + "tx_vmanage_to_peer": "0", + "tx_pkts": "330231", + "tx_blocked": "0", + "tx_dtls_handshake_done": "14", + "rx_octets": "50924456", + "tx_error": "0", + "bid_failures_needing_reset": "0", + "rx_error": "0", + "rx_dtls_handshake_done": "0", + "tx_challenge_ack_error": "0", + "rx_challenge_resp": "0", + "tx_challenge_error": "0", + "tx_challenge_resp_error": "0", + "tx_register_to_vmanage": "4", + "tx_challenge": "0", + "rx_connects": "0", + "tx_registers": "15", + "rx_pkts": "347847", + "tx_connects": "0", + "tx_challenge_gen_error": "0", + "rx_register_to_vmanage": "0", + "vdevice-host-name": "vm3", + "tx_hello": "212412", + "tx_challenge_ack": "0", + "rx_hello": "212399", + "tx_challenge_resp": "14", + "rx_dtls_handshake": "0", + "vdevice-dataKey": "169.254.10.10", + "lastupdated": 1642730071268, + "rx_dtls_handshake_failures": "0", + "rx_register_replies": "15", + "rx_vmanage_to_peer": "4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get local device status", + "operationId": "getLocalDeviceStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Local device status": { + "description": "Local device status", + "value": { + "data": [ + { + "type": "control", + "name": "Control", + "image": "images/control.png", + "count": 0, + "detailView": "dialog", + "detailsURL": "/dataservice/device/control/links", + "statusList": [ + { + "status": "up", + "icon": "images/connection/connection-network-up.png", + "color": "b0e276", + "name": "up", + "detailView": "dialog", + "detailsURL": "/dataservice/device/control/links?state=up", + "count": 0 + }, + { + "status": "down", + "icon": "images/connection/connection-network-down.png", + "color": "fa7c7d", + "name": "down", + "detailView": "dialog", + "detailsURL": "/dataservice/device/control/links?state=down", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections summary from device (Real Time)", + "operationId": "createConnectionsSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections summary": { + "description": "Connections summary", + "value": { + "data": [ + { + "instance": 0, + "vdevice-dataKey": "172.16.255.14-0", + "vdevice-name": "172.16.255.14", + "vmanage_counts": 1, + "lastupdated": 1588603863504, + "vsmart_counts": 2, + "vbond_counts": 0, + "vdevice-host-name": "vm4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/summary/device": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get device control status summary", + "operationId": "getDeviceControlStatusSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device control status summary": { + "description": "Device control status summary", + "value": { + "data": [ + { + "name": "ControlConnection", + "count": 3, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "up", + "message": "3up", + "detailsURL": "/dataservice/device/control/connection?deviceId=172.16.255.11&state=up", + "count": 3 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/synced/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list from vManage", + "operationId": "createSyncedConnectionList", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "instance": 0, + "vdevice-name": "172.16.255.11", + "system-ip": "172.16.255.19", + "remote-color": "default", + "site-id": 100, + "controller-group-id": 0, + "peer-type": "vsmart", + "shared-region-id-set": "N/A", + "protocol": "dtls", + "@rid": 1060, + "state": "up", + "private-ip": "10.0.5.19", + "domain-id": 1, + "behind-proxy": "No", + "createTimeStamp": 1646912557634, + "private-port": 12455, + "vdevice-host-name": "vm1", + "local-color": "lte", + "v-org-name": "vIPtelaIncRegression", + "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.19-default", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.5.19", + "public-port": 12455, + "lastupdated": 1646967283468, + "uptime-date": 1646967180000 + }, + { + "instance": 0, + "vdevice-name": "172.16.255.11", + "system-ip": "172.16.255.20", + "remote-color": "default", + "site-id": 200, + "controller-group-id": 0, + "peer-type": "vsmart", + "shared-region-id-set": "N/A", + "protocol": "dtls", + "@rid": 1063, + "state": "up", + "private-ip": "10.0.12.20", + "domain-id": 1, + "behind-proxy": "No", + "createTimeStamp": 1646912560801, + "private-port": 12456, + "vdevice-host-name": "vm1", + "local-color": "lte", + "v-org-name": "vIPtelaIncRegression", + "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.20-default", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.12.20", + "public-port": 12456, + "lastupdated": 1646967283468, + "uptime-date": 1646967180000 + }, + { + "instance": 0, + "vdevice-name": "172.16.255.11", + "system-ip": "172.16.255.22", + "remote-color": "default", + "site-id": 200, + "controller-group-id": 0, + "peer-type": "vmanage", + "protocol": "dtls", + "@rid": 1068, + "state": "up", + "private-ip": "10.0.12.22", + "domain-id": 0, + "behind-proxy": "No", + "createTimeStamp": 1646912562214, + "private-port": 12446, + "vdevice-host-name": "vm1", + "local-color": "lte", + "v-org-name": "vIPtelaIncRegression", + "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.22-default", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.12.22", + "public-port": 12446, + "lastupdated": 1646967283468, + "uptime-date": 1646967180000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/control/synced/localproperties": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get local properties list", + "operationId": "createLocalPropertiesSyncedList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Local properties list": { + "description": "Local properties list", + "value": { + "data": [ + { + "retry-interval": "0:00:00:16", + "vdevice-name": "172.16.255.11", + "device-role": "edge-router", + "tls-port": "0", + "max-controllers": "0", + "system-ip": "172.16.255.11", + "certificate-not-valid-before": "Mar1011:16:192022GMT", + "site-id": "100", + "certificate-not-valid-after": "Mar1011:16:192023GMT", + "uuid": "84d1ab4e-0cbf-4369-a290-08fafeb80f95", + "number-active-wan-interfaces": "1", + "protocol": "dtls", + "board-serial": "12345974", + "vsmart-list-version": "0", + "@rid": 1071, + "certificate-status": "Installed", + "device-type": "vedge", + "port-hopped": "TRUE", + "organization-name": "vIPtelaIncRegression", + "domain-id": "1", + "root-ca-chain-status": "Installed", + "dns-name": "vbond", + "createTimeStamp": 1646912563392, + "sp-organization-name": "vIPtelaIncRegression", + "vdevice-host-name": "vm1", + "register-interval": "0:00:00:30", + "token": "Invalid", + "keygen-interval": "1:00:00:00", + "vdevice-dataKey": "172.16.255.11", + "certificate-validity": "Valid", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1646963388706, + "number-vbond-peers": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/synced/waninterface": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get WAN interface list", + "operationId": "createWanInterfaceSyncedList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "WAN interface list": { + "description": "WAN interface list", + "value": { + "data": [ + { + "instance": 0, + "low-bandwidth-link": "No", + "color": "lte", + "vdevice-name": "172.16.255.11", + "nat-type": "N", + "admin-state": "up", + "interface": "ge0/2", + "restrict-str": "no", + "@rid": 1077, + "private-ipv6": "::", + "private-ip": "10.0.5.11", + "per-wan-max-controllers": 2, + "num-vsmarts": 2, + "num-vmanages": 1, + "preference": "0", + "createTimeStamp": 1646912567192, + "weight": 1, + "index": 0, + "private-port": 12407, + "vdevice-host-name": "vm1", + "vbond-as-stun-server": "no", + "control-str": "yes", + "carrier": "default", + "last-resort": "No", + "vdevice-dataKey": "172.16.255.11-0-0", + "vmanage-connection-preference": "5", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.5.11", + "operation-state": "up", + "public-port": 12407, + "region-id": "Default", + "lastupdated": 1646967283812, + "wan-port-hopped": "TRUE" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/validdevices": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get vmanage valid device list (Real Time)", + "operationId": "createValidDevicesListRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "data": [ + { + "chassis-number": "00D132A6-F3D2-40BA-862B-A6D1A83EFAEA", + "vdevice-dataKey": "172.16.255.22-00D132A6-F3D2-40BA-862B-A6D1A83EFAEA-12346574", + "vdevice-name": "172.16.255.22", + "serial-number": "12346574", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F", + "vdevice-dataKey": "172.16.255.22-C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F-12345703", + "vdevice-name": "172.16.255.22", + "serial-number": "12345703", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7", + "vdevice-dataKey": "172.16.255.22-C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7-12345705", + "vdevice-name": "172.16.255.22", + "serial-number": "12345705", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-A9DF16AA-14C2-4B60-8D65-05957111879E", + "vdevice-dataKey": "172.16.255.22-C8K-A9DF16AA-14C2-4B60-8D65-05957111879E-12345967", + "vdevice-name": "172.16.255.22", + "serial-number": "12345967", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A", + "vdevice-dataKey": "172.16.255.22-C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A-12345707", + "vdevice-name": "172.16.255.22", + "serial-number": "12345707", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/validvmanageid": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get valid vManage from device (Real Time)", + "operationId": "getValidVManageIdRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage": { + "description": "vManage", + "value": { + "data": [ + { + "chassis-number": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642746085123, + "vdevice-host-name": "vm3" + }, + { + "chassis-number": "59ddeeef-24ad-4bd3-9e55-f9760b640970", + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642746085123, + "vdevice-host-name": "vm3" + }, + { + "chassis-number": "c0fd955c-7e0d-4b90-9626-55684f69a899", + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642746085123, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/validvsmarts": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get valid vSmart list from device (Real Time)", + "operationId": "createValidVSmartsListRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart list": { + "description": "vSmart list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-12345701", + "vdevice-name": "169.254.10.10", + "serial-number": "12345701", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345702", + "vdevice-name": "169.254.10.10", + "serial-number": "12345702", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345703", + "vdevice-name": "169.254.10.10", + "serial-number": "12345703", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345704", + "vdevice-name": "169.254.10.10", + "serial-number": "12345704", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345705", + "vdevice-name": "169.254.10.10", + "serial-number": "12345705", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345706", + "vdevice-name": "169.254.10.10", + "serial-number": "12345706", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/waninterface": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get WAN interface list (Real Time)", + "operationId": "createWanInterfaceListList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "WAN interface list": { + "description": "WAN interface list", + "value": { + "data": [ + { + "instance": 0, + "low-bandwidth-link": "No", + "color": "default", + "vdevice-name": "169.254.10.10", + "nat-type": "N", + "admin-state": "up", + "interface": "ge0/1", + "restrict-str": "no", + "private-ipv6": "::", + "private-ip": "10.101.3.3", + "per-wan-max-controllers": 2, + "num-vsmarts": 2, + "num-vmanages": 1, + "preference": "0", + "wan-time-since-port-hop": "0:11:14:02", + "spi-change": "0:00:45:59", + "index": 0, + "weight": 1, + "private-port": 12386, + "last-conn-time": "0:11:13:42", + "vbond-as-stun-server": "no", + "vdevice-host-name": "vm3", + "control-str": "yes", + "carrier": "default", + "vmanage-connection-preference": "5", + "last-resort": "No", + "vdevice-dataKey": "169.254.10.10-0-0", + "public-ip": "10.101.3.3", + "operation-state": "up", + "public-port": 12386, + "lastupdated": 1642746267569, + "last-conn-time-date": 1642705800000, + "wan-port-hopped": "TRUE" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/waninterface/color": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get port hop colors", + "operationId": "getPortHopColor", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device port hop colors": { + "description": "Device port hop colors", + "value": { + "data": [ + { + "color": "lte" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/counters": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device counters", + "operationId": "getDeviceCounters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device counters": { + "description": "Device counters", + "value": { + "header": { + "generatedOn": 1635392499184 + }, + "data": [ + { + "system-ip": "169.254.10.1", + "number-vsmart-control-connections": 3, + "expectedControlConnections": 3, + "rebootCount": 3, + "crashCount": 0 + }, + { + "system-ip": "169.254.10.2", + "number-vsmart-control-connections": 3, + "expectedControlConnections": 3, + "rebootCount": 0, + "crashCount": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/crashlog": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash logs from device", + "operationId": "getDeviceCrashLogs", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device crash logs": { + "description": "Device crash logs", + "value": { + "data": [ + { + "core-time": "Tue Feb 15 04:14:38 UTC 2022", + "vdevice-dataKey": "169.254.10.12-0", + "vdevice-name": "169.254.10.12", + "index": 0, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_19219_20220215-041430-UTC.core.gz", + "core-time-date": 1644898478000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 04:15:24 UTC 2022", + "vdevice-dataKey": "169.254.10.12-1", + "vdevice-name": "169.254.10.12", + "index": 1, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_19539_20220215-041515-UTC.core.gz", + "core-time-date": 1644898524000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 05:55:04 UTC 2022", + "vdevice-dataKey": "169.254.10.12-2", + "vdevice-name": "169.254.10.12", + "index": 2, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_30530_20220215-055452-UTC.core.gz", + "core-time-date": 1644904504000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 05:55:50 UTC 2022", + "vdevice-dataKey": "169.254.10.12-3", + "vdevice-name": "169.254.10.12", + "index": 3, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_31380_20220215-055542-UTC.core.gz", + "core-time-date": 1644904550000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 06:21:52 UTC 2022", + "vdevice-dataKey": "169.254.10.12-4", + "vdevice-name": "169.254.10.12", + "index": 4, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_26426_20220215-062140-UTC.core.gz", + "core-time-date": 1644906112000, + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/crashlog/details": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash logs for all device", + "operationId": "getAllDeviceCrashLogs", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device crash logs": { + "description": "Device crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/crashlog/log": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash info from device", + "operationId": "getDeviceCrashInformation", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "filename", + "in": "query", + "description": "Crash file name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Device crash info": { + "description": "Device crash info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/crashlog/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash logs synchronously from device", + "operationId": "getDeviceCrashLogsSynced", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device crash logs": { + "description": "Device crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/csp/containers/container": { + "get": { + "tags": [ + "Real-Time Monitoring - Container Lifecycle" + ], + "description": "Get device container from device (Real Time)", + "operationId": "createDeviceContainersInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "device container": { + "description": "device container", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/pnic": { + "get": { + "tags": [ + "Real-Time Monitoring - RBAC" + ], + "description": "Get pnic interfaces from device", + "operationId": "getPnicStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PNIC interfaces": { + "description": "PNIC interfaces", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/csp/pnic/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - RBAC" + ], + "description": "Get pnic stats from device", + "operationId": "getPNICStatsFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PNIC stats": { + "description": "PNIC stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/csp/rbac": { + "get": { + "tags": [ + "Real-Time Monitoring - RBAC" + ], + "description": "Get RBAC interfaces from device", + "operationId": "getRBACInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device RBAC interface": { + "description": "Device RBAC interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/csp/resources/cpu-info/allocation": { + "get": { + "tags": [ + "Real-Time Monitoring - NetworkHub Resources" + ], + "description": "Get NetworkHub CPU allocation info from device", + "operationId": "getAllocationInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NetworkHub CPU allocation info": { + "description": "NetworkHub CPU allocation info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/csp/resources/cpu-info/cpus": { + "get": { + "tags": [ + "Real-Time Monitoring - NetworkHub Resources" + ], + "description": "Get NetworkHub CPU info from device", + "operationId": "getCPUInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NetworkHub CPU info": { + "description": "NetworkHub CPU info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/csp/resources/cpu-info/vnfs": { + "get": { + "tags": [ + "Real-Time Monitoring - NetworkHub Resources" + ], + "description": "Get NetworkHub CPU VNF info from device", + "operationId": "getVNFInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NetworkHub CPU VNF info": { + "description": "NetworkHub CPU VNF info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/csp/system/native": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system native settings from device", + "operationId": "createDeviceSystemSettingNativeInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system native settings": { + "description": "Device system native settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/system/processlist": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system process list from device", + "operationId": "createDeviceSystemProcessList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system process list": { + "description": "Device system process list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/system/settings": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system settings from device", + "operationId": "createDeviceSystemSetting", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system settings": { + "description": "Device system settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/system/status": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system status from device", + "operationId": "createDeviceSystemStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system status": { + "description": "Device system status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/ctsPac": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec PAC information from device", + "operationId": "getCtsPac", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec PAC information": { + "description": "TrustSec PAC information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/devicestatus": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get devices status per type", + "operationId": "getDeviceOnlyStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device status per type list": { + "description": "Device status per type list", + "value": { + "header": { + "generatedOn": 1635296479960 + }, + "data": [ + { + "type": "vSmart", + "name": "vSmart", + "image": "images/vsmart.png", + "count": 3, + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart", + "statusList": [ + { + "status": "error", + "name": "Error", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=error", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "warning", + "name": "Warning", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=warning", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + }, + { + "status": "normal", + "name": "Normal", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=normal", + "color": "b0e276", + "icon": "images/device/device-normal.png", + "count": 3 + }, + { + "status": "new", + "name": "Discovered device", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=new", + "color": "7c8afa", + "icon": "images/device/device-new.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/dhcp/client": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCP client from device (Real Time)", + "operationId": "getDHCPClient", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DHCP client": { + "description": "DHCP client", + "value": { + "data": [ + { + "lease-server-addr": "10.0.1.1", + "state": "dhcp-client-state-bound", + "if-name": "GigabitEthernet1", + "dns-address-secondary": "0.0.0.0", + "subnet-mask": "255.255.255.0", + "client-addr": "10.0.1.5", + "lease-remaining": "3143", + "gateway-addr": "0.0.0.0", + "dns-address": "10.0.1.1", + "vdevice-dataKey": "169.254.10.12-Mgmt-intf-GigabitEthernet1", + "vrf-name": "Mgmt-intf", + "lastupdated": 1643101911868, + "vdevice-host-name": "vm5", + "vdevice-name": "169.254.10.12", + "lease-time": "3600" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dhcp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCP interfaces from device (Real Time)", + "operationId": "getDHCPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DHCP interfaces": { + "description": "DHCP interfaces", + "value": { + "data": [ + { + "server": "10.0.1.1", + "vdevice-dataKey": "169.254.10.10-512-eth0", + "lease-time": "0:01:00:00", + "vdevice-name": "169.254.10.10", + "ifname": "eth0", + "acquired-ip": "10.0.1.3/24", + "dns": "10.0.1.1", + "lastupdated": 1643013783968, + "time-remaining": "0:00:31:25", + "state": "bound", + "vpn-id": "512", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dhcp/server": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCP server from device (Real Time)", + "operationId": "getDHCPServer", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DHCP server": { + "description": "DHCP server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dhcpv6/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCPv6 interfaces from device", + "operationId": "getDHCPv6Interface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device DHCP v6 interface": { + "description": "Device DHCP v6 interface", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-512-eth0", + "vdevice-name": "169.254.10.10", + "ifname": "eth0", + "lastupdated": 1646099652315, + "state": "init", + "vpn-id": "512", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dot1x/clients": { + "get": { + "tags": [ + "Real-Time Monitoring - DOT1x" + ], + "description": "Get DOT1x client from device (Real Time)", + "operationId": "getWLANDOT1xClients", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DOT1x client": { + "description": "DOT1x client", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dot1x/interfaces": { + "get": { + "tags": [ + "Real-Time Monitoring - DOT1x" + ], + "description": "Get DOT1x interface from device (Real Time)", + "operationId": "getWLANDOT1xInterfaces", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DOT1x interface": { + "description": "DOT1x interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dot1x/radius": { + "get": { + "tags": [ + "Real-Time Monitoring - DOT1x" + ], + "description": "Get DOT1x Radius from device (Real Time)", + "operationId": "getDOT1xRadius", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DOT1x Radius": { + "description": "DOT1x Radius", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/downloadedImages": { + "get": { + "tags": [ + "Configuration - Downloaded Images" + ], + "description": "Get images list from device", + "operationId": "createSoftwareList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1644801887912, + "downloadedImages": "[]", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dpi/application-mapping": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI supported application list from device", + "operationId": "getSupportedApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI supported application list": { + "description": "DPI supported application list", + "value": { + "data": [ + { + "name": "an", + "family": "network-service", + "familyShort": "network_service", + "longname": "ActiveNetworks", + "appId": "861" + }, + { + "name": "bb", + "family": "network-management", + "familyShort": "network_management", + "longname": "Systemsandnetworkmonitoringtool", + "appId": "50333632" + }, + { + "name": "fc", + "family": "network-service", + "familyShort": "network_service", + "longname": "FibreChannel", + "appId": "16777349" + }, + { + "name": "il", + "family": "network-service", + "familyShort": "network_service", + "longname": "InternalLinkTransportProtocol", + "appId": "16777256" + }, + { + "name": "ns", + "family": "network-service", + "familyShort": "network_service", + "longname": "NetworkSystems", + "appId": "50332408" + }, + { + "name": "sm", + "family": "network-service", + "familyShort": "network_service", + "longname": "SM", + "appId": "16777338" + }, + { + "name": "st", + "family": "network-service", + "familyShort": "network_service", + "longname": "Stream", + "appId": "16777221" + }, + { + "name": "3pc", + "family": "network-service", + "familyShort": "network_service", + "longname": "ThirdPartyConnectProtocol", + "appId": "16777250" + }, + { + "name": "acp", + "family": "network-service", + "familyShort": "network_service", + "longname": "AeolonCoreProtocol", + "appId": "50332247" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/application/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI query field from device", + "operationId": "getDPIDeviceFieldJSON", + "parameters": [ + { + "name": "isDeviceDashBoard", + "in": "query", + "description": "Flag whether is device dashboard request", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI query field": { + "description": "DPI query field", + "value": { + "data": [ + { + "isRequired": true, + "fieldData": { + "type": "dateList" + }, + "dataType": "date", + "property": "entry_time", + "name": "EventTime", + "options": [ + { + "enableDateFields": false, + "number": "24", + "value": "Last24hours", + "key": "last_24_hours" + }, + { + "enableDateFields": false, + "number": "12", + "value": "Last12hours", + "key": "last_12_hours" + }, + { + "enableDateFields": false, + "number": "6", + "value": "Last6hours", + "key": "last_6_hours" + }, + { + "enableDateFields": false, + "number": "3", + "value": "Last3hours", + "key": "last_3_hours" + }, + { + "enableDateFields": false, + "number": "1", + "value": "Last1hour", + "key": "last_1_hour" + }, + { + "enableDateFields": false, + "number": "168", + "value": "Last7days", + "key": "last_168_hours" + } + ] + }, + { + "isRequired": true, + "fieldData": { + "type": "url", + "url": "dataservice/device/action/vpn" + }, + "dataType": "int", + "property": "vpn_id", + "name": "VPN", + "multiSelect": false + }, + { + "isRequired": true, + "dataType": "string", + "property": "vdevice_name", + "name": "Devicename", + "multiSelect": false, + "isHidden": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI applications from device (Real Time)", + "operationId": "createDPICollectorList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dpi/common/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI common application list from device", + "operationId": "getCommonApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI common application list": { + "description": "DPI common application list", + "value": { + "data": [ + { + "name": "3com-amp3", + "familyShort": "network-service", + "longname": "3ComAMP3", + "family": "NetworkService", + "qosmosName": "3com-amp3", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "3com-tsmux", + "familyShort": "network-service", + "longname": "3ComTSMUX", + "family": "NetworkService", + "qosmosName": "3com-tsmux", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "3pc", + "familyShort": "network-service", + "longname": "ThirdPartyConnect", + "family": "NetworkService", + "qosmosName": "3pc", + "qosmosFamily": "network_service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "4chan", + "familyShort": "web", + "longname": "4CHAN", + "family": "Web", + "qosmosName": "4chan", + "qosmosFamily": "web", + "trafficClass": "transactional-data", + "businessRelevance": "business-irrelevant" + }, + { + "name": "58-city", + "familyShort": "web", + "longname": "58City", + "family": "Web", + "qosmosName": "58com", + "qosmosFamily": "web", + "trafficClass": "transactional-data", + "businessRelevance": "business-irrelevant" + }, + { + "name": "914c/g", + "familyShort": "terminal", + "longname": "TexasInstruments914Terminal", + "family": "Terminal", + "qosmosName": "914c/g", + "qosmosFamily": "terminal", + "trafficClass": "ops-admin-mgmt", + "businessRelevance": "business-relevant" + }, + { + "name": "9pfs", + "familyShort": "network-service", + "longname": "9P", + "family": "NetworkService", + "qosmosName": "9p", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "abc-news", + "familyShort": "web", + "longname": "ABCNews", + "family": "Web", + "qosmosName": "abcnews", + "qosmosFamily": "web", + "trafficClass": "transactional-data", + "businessRelevance": "business-irrelevant" + }, + { + "name": "acap", + "familyShort": "network-management", + "longname": "ApplicationConfigurationAccessProtocol", + "family": "NetworkManagement", + "qosmosName": "acap", + "qosmosFamily": "network-management", + "trafficClass": "ops-admin-mgmt", + "businessRelevance": "business-relevant" + }, + { + "name": "acas", + "familyShort": "network-service", + "longname": "ACAServices", + "family": "NetworkService", + "qosmosName": "acas", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/device/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI field from device", + "operationId": "getDPIFieldJSON", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI field": { + "description": "DPI field", + "value": { + "data": [ + { + "property": "entry_time", + "name": "EventTime", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_24_hours", + "value": "Last24hours", + "number": "24", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last12hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last6hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last3hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_1_hour", + "value": "Last1hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_168_hours", + "value": "Last7days", + "number": "168", + "enableDateFields": false + } + ] + }, + { + "property": "application", + "name": "Application", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/devicedetails/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI detailed field from device", + "operationId": "getDPIDeviceDetailsFieldJSON", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI detailed field": { + "description": "DPI detailed field", + "value": { + "data": [ + { + "property": "entry_time", + "name": "EventTime", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_24_hours", + "value": "Last24hours", + "number": "24", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last12hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last6hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last3hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_1_hour", + "value": "Last1hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_168_hours", + "value": "Last7days", + "number": "168", + "enableDateFields": false + } + ] + }, + { + "property": "application", + "name": "Application", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + }, + { + "property": "vdevice_name", + "name": "Devicename", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/flows": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI flow list from device (Real Time)", + "operationId": "createDPIFlowsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "src-ip", + "in": "query", + "description": "Source IP", + "schema": { + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI flows": { + "description": "DPI flows", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dpi/qosmos-static/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI QoSMos static application list", + "operationId": "getQosmosStaticApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI QoSMos static application list": { + "description": "DPI QoSMos static application list", + "value": { + "data": [ + { + "name": "9p", + "family": "FileServer", + "familyShort": "file_server", + "longname": "Plan9FilesystemProtocol", + "appId": "3430" + }, + { + "name": "ah", + "family": "NetworkService", + "familyShort": "network_service", + "longname": "AuthenticationHeader", + "appId": "720" + }, + { + "name": "dr", + "family": "Web", + "familyShort": "web", + "longname": "Dr.dk", + "appId": "2043" + }, + { + "name": "dv", + "family": "Web", + "familyShort": "web", + "longname": "DV.is", + "appId": "1861" + }, + { + "name": "hs", + "family": "Web", + "familyShort": "web", + "longname": "Hs.fi(HelsinginSanomat)", + "appId": "2097" + }, + { + "name": "il", + "family": "NetworkService", + "familyShort": "network_service", + "longname": "InternetLink(Transportprotocol)", + "appId": "637" + }, + { + "name": "ip", + "family": "NetworkService", + "familyShort": "network_service", + "longname": "InternetProtocol", + "appId": "81" + }, + { + "name": "ja", + "family": "Web", + "familyShort": "web", + "longname": "Ja.is", + "appId": "1897" + }, + { + "name": "mk", + "family": "Web", + "familyShort": "web", + "longname": "Mk.co.kr", + "appId": "1213" + }, + { + "name": "mq", + "family": "ApplicationService", + "familyShort": "application_service", + "longname": "IBMWebsphereMQ", + "appId": "312" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/qosmos/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI QoSMos application list from device", + "operationId": "getQosmosApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI QoSMos application list": { + "description": "DPI QoSMos application list", + "value": { + "data": [ + { + "name": "an", + "family": "network-service", + "familyShort": "network_service", + "longname": "ActiveNetworks", + "appId": "861" + }, + { + "name": "bna", + "family": "network-service", + "familyShort": "network_service", + "longname": "BNA", + "appId": "803" + }, + { + "name": "box", + "family": "web", + "familyShort": "web", + "longname": "Box", + "appId": "1074" + }, + { + "name": "dls", + "family": "network-service", + "familyShort": "network_service", + "longname": "DirectoryLocationService", + "appId": "1078" + }, + { + "name": "dmp", + "family": "audio-video", + "familyShort": "audio_video", + "longname": "CiscoDigitalMediaPlayer", + "appId": "1422" + }, + { + "name": "apple-location-services", + "family": "application-service", + "familyShort": "application_service", + "longname": "AppleLocationServices", + "appId": "294" + }, + { + "name": "apple-push-notification", + "family": "application-service", + "familyShort": "application_service", + "longname": "ApplePushNotificationService", + "appId": "1169" + }, + { + "name": "sixtofour-ipv6-tunneled", + "family": "network-service", + "familyShort": "network_service", + "longname": "SixtofourIPv6Tunneled", + "appId": "1223" + }, + { + "name": "internet-audio-streaming", + "family": "instant-messaging", + "familyShort": "instant_messaging", + "longname": "InternetAudioStreamingWebApps", + "appId": "1514" + }, + { + "name": "internet-video-streaming", + "family": "web", + "familyShort": "web", + "longname": "InternetVideoStreamingWebApps", + "appId": "1513" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/device/dpi/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI summary from device (Real Time)", + "operationId": "createDPISummaryRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": { + "data": [ + { + "flows-expired": "0", + "vdevice-dataKey": "169.254.10.10", + "flows-created": "0", + "vdevice-name": "169.254.10.10", + "current-flows": "0", + "peak-rate": "0", + "current-rate": "0", + "lastupdated": 1643014386555, + "vdevice-host-name": "vm3", + "status": "disable", + "peak-flows": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dpi/supported-applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get supported applications from device (Real Time)", + "operationId": "createDPIStatistics", + "parameters": [ + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": { + "data": [ + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-an", + "application": "an", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Active Networks", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-management", + "vdevice-dataKey": "169.254.10.10-bb", + "application": "bb", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_management", + "application-long-name": "Systems and network monitoring tool", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-fc", + "application": "fc", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Fibre Channel", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-il", + "application": "il", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Internal Link Transport Protocol", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-ns", + "application": "ns", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Network Systems", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-sm", + "application": "sm", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "SM", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-st", + "application": "st", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Stream", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-3pc", + "application": "3pc", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Third Party Connect Protocol", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-acp", + "application": "acp", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Aeolon Core Protocol", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "erp", + "vdevice-dataKey": "169.254.10.10-adp", + "application": "adp", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "erp", + "application-long-name": "Automatic Data Processing", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dre/auto-bypass-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE auto-bypass statistics", + "operationId": "getDreAutoBypassStats", + "parameters": [ + { + "name": "appqoe-dre-auto-bypass-server-ip", + "in": "query", + "description": "Server IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "appqoe-dre-auto-bypass-port", + "in": "query", + "description": "Port", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Auto-Bypass Stats": { + "description": "DRE Auto-Bypass Stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dre/dre-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE statistics", + "operationId": "getDreStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Stats": { + "description": "DRE Stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dre/dre-status": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE status", + "operationId": "getDreStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Status": { + "description": "DRE Status", + "value": { + "data": [ + { + "lastupdated": 1645775163290, + "appqoe-dre-status-health-status": "dre-status-disabled", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dre/peer-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE peer statistics", + "operationId": "getDrePeerStats", + "parameters": [ + { + "name": "appqoe-dre-stats-peer-system-ip", + "in": "query", + "description": "System IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "appqoe-dre-stats-peer-peer-no", + "in": "query", + "description": "Peer Number", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Peer Stats": { + "description": "DRE Peer Stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dualStaticRouteTracker": { + "get": { + "tags": [ + "Real-Time Monitoring - Dual Static Route Tracker Service" + ], + "description": "Get dual static route tracker info from device", + "operationId": "getDualStaticRouteTrackerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Dual static route tracker info": { + "description": "Dual static route tracker info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/eigrp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - EIGRP" + ], + "description": "Get EIGRP interface list from device (Real Time)", + "operationId": "createEIGRPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "EIGRP interface list": { + "description": "EIGRP interface list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/eigrp/route": { + "get": { + "tags": [ + "Real-Time Monitoring - EIGRP" + ], + "description": "Get EIGRP route from device (Real Time)", + "operationId": "createEIGRPRoute", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "EIGRP route": { + "description": "EIGRP route", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/eigrp/topology": { + "get": { + "tags": [ + "Real-Time Monitoring - EIGRP" + ], + "description": "Get EIGRP topology info from device (Real Time)", + "operationId": "createEIGRPTopology", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "EIGRP topology info": { + "description": "EIGRP topology info", + "value": { + "data": [ + { + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15-0----", + "vdevice-name": "172.16.255.15", + "topo-id": "0", + "lastupdated": 1649307997571 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/enableSDAVC/{deviceIP}/{enable}": { + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Enable/Disable SDAVC on device", + "operationId": "enableSDAVCOnDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enable", + "in": "path", + "description": "Enable/Disable flag", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/endpointTracker": { + "get": { + "tags": [ + "Real-Time Monitoring - Endpoint Tracker Service" + ], + "description": "Get endpoint tracker info from device", + "operationId": "getEndpointTrackerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Endpoint tracker info": { + "description": "Endpoint tracker info", + "value": { + "data": [ + { + "record-name": "test", + "if-name": "GigabitEthernet1", + "lastupdated": 1650794336441, + "actual-delay": "4294967295", + "vdevice-dataKey": "172.16.255.15-vm5-GigabitEthernet1", + "state": "tracker-if-state-down", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/endpointTrackerGroup": { + "get": { + "tags": [ + "Real-Time Monitoring - Endpoint Tracker Group Service" + ], + "description": "Get endpoint tracker group info from device", + "operationId": "getEndpointTrackerGroupInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Endpoint tracker group info": { + "description": "Endpoint tracker group info", + "value": { + "data": [ + { + "oper": "tracker-group-oper-and", + "name": "tracker1", + "vdevice-dataKey": "172.16.255.15-vm5-tracker3_tracker-group", + "elem-state": "tracker-if-state-down", + "lastupdated": 1650866884165, + "actual-delay": "4294967295", + "group-name": "tracker3", + "group-state": "tracker-if-state-down", + "attach-point-name": "tracker3_tracker-group", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "oper": "tracker-group-oper-and", + "name": "tracker2", + "vdevice-dataKey": "172.16.255.15-vm5-tracker3_tracker-group", + "elem-state": "tracker-if-state-down", + "lastupdated": 1650866884165, + "actual-delay": "4294967295", + "group-name": "tracker3", + "group-state": "tracker-if-state-down", + "attach-point-name": "tracker3_tracker-group", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/environmentData": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Environment Data information from device", + "operationId": "getEnvironmentData", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec environment data information": { + "description": "TrustSec environment data information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/environmentData/radiusServer": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Environment Data Radius Server list from device", + "operationId": "getRadiusServer", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec environment data radius server list information": { + "description": "TrustSec environment data radius server list information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/featurelist": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Feature List" + ], + "description": "Get feature lists from device (Real Time)", + "operationId": "getFeatureList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature lists": { + "description": "Feature lists", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11-statistics-collection-1.0", + "vdevice-name": "172.16.255.11", + "name": "statistics-collection", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-confirm-1.0", + "vdevice-name": "172.16.255.11", + "name": "upgrade-confirm", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-vmanage-mode-2.0", + "vdevice-name": "172.16.255.11", + "name": "vmanage-mode", + "lastupdated": 1647222469375, + "version": "2.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-dpi-statistics-2.0", + "vdevice-name": "172.16.255.11", + "name": "dpi-statistics", + "lastupdated": 1647222469375, + "version": "2.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-cert-serial-hashing-1.0", + "vdevice-name": "172.16.255.11", + "name": "cert-serial-hashing", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-1.0", + "vdevice-name": "172.16.255.11", + "name": "upgrade", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-cert-serial-version-1.0", + "vdevice-name": "172.16.255.11", + "name": "cert-serial-version", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-vbond-standalone-1.0", + "vdevice-name": "172.16.255.11", + "name": "vbond-standalone", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-tools-2.0", + "vdevice-name": "172.16.255.11", + "name": "tools", + "lastupdated": 1647222469375, + "version": "2.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-admin-tech-options-1.0", + "vdevice-name": "172.16.255.11", + "name": "admin-tech-options", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/featurelist/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Feature List" + ], + "description": "Get feature lists synchronously from device", + "operationId": "getSyncedFeatureList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature lists": { + "description": "Feature lists", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11-statistics-collection-1.0", + "@rid": 632, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912241600, + "name": "statistics-collection", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-confirm-1.0", + "@rid": 639, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912243273, + "name": "upgrade-confirm", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + }, + { + "vdevice-dataKey": "172.16.255.11-vmanage-mode-2.0", + "@rid": 646, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912247190, + "name": "vmanage-mode", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "2.0" + }, + { + "vdevice-dataKey": "172.16.255.11-dpi-statistics-2.0", + "@rid": 654, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912250128, + "name": "dpi-statistics", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "2.0" + }, + { + "vdevice-dataKey": "172.16.255.11-cert-serial-hashing-1.0", + "@rid": 662, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912255235, + "name": "cert-serial-hashing", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-1.0", + "@rid": 669, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912260609, + "name": "upgrade", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/geofence/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Geo-fencing" + ], + "description": "Get Geo-fencing Status from device", + "operationId": "getGeofenceStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Geo-fencing Status": { + "description": "Geo-fencing Status", + "value": { + "data": [ + { + "geofence-config-status": "Geofencing-Disabled", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "lastupdated": 1645089720394, + "current-location-status": "Location-Invalid", + "current-device-location-timestamp": "2022-02-15T06:39:22+00:00", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/alarms": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware alarm list from device", + "operationId": "createAlarmList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware alarm list": { + "description": "Hardware alarm list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/environment": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware environment list from device", + "operationId": "createEnvironmentList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware environment list": { + "description": "Hardware environment list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-Interface module-0", + "vdevice-name": "169.254.10.10", + "hw-class": "PIM", + "hw-item": "Interface module", + "hw-dev-index": 0, + "lastupdated": 1643076101789, + "vdevice-host-name": "vm3", + "measurement": "Present: yes; Powered On: no; Fault: no", + "status": "Down" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/errors": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware error list from device", + "operationId": "createErrorAlarmList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware error list": { + "description": "Hardware error list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/inventory": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware inventory list from device", + "operationId": "createInventoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware inventory list": { + "description": "Hardware inventory list", + "value": { + "data": [ + { + "hw-type": "Chassis", + "vdevice-dataKey": "169.254.10.10-Chassis-0", + "vdevice-name": "169.254.10.10", + "hw-dev-index": 0, + "serial-number": "sim", + "part-number": "vEdge-Cloud", + "lastupdated": 1643076350328, + "version": "1.0", + "vdevice-host-name": "vm3", + "hw-description": "vEdge-Cloud" + }, + { + "hw-type": "PIM", + "vdevice-dataKey": "169.254.10.10-PIM-0", + "vdevice-name": "169.254.10.10", + "hw-dev-index": 0, + "serial-number": "None", + "part-number": "ge-8", + "lastupdated": 1643076350328, + "version": "None", + "vdevice-host-name": "vm3", + "hw-description": "Max 8 x 1GE VM ports" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/status/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware status summary from device", + "operationId": "createStatusSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware status summary": { + "description": "Hardware status summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/synced/alarms": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware alarm list synchronously from device", + "operationId": "createSyncedAlarmList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware alarm list": { + "description": "Hardware alarm list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/synced/environment": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware environment list synchronously from device", + "operationId": "createSyncedEnvironmentList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware environment list": { + "description": "Hardware environment list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "hw-dev-index": 0, + "createTimeStamp": 1647316012518, + "vdevice-host-name": "vm1", + "measurement": "Present:yes;PoweredOn:no;Fault:no", + "vdevice-dataKey": "172.16.255.11-Interfacemodule-0", + "@rid": 1156, + "hw-item": "Interfacemodule", + "hw-class": "PIM", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647316012314, + "status": "Down" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/synced/inventory": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware inventory list synchronously from device", + "operationId": "createSyncedInventoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware inventory list": { + "description": "Hardware inventory list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "serial-number": "sim", + "hw-dev-index": 0, + "createTimeStamp": 1647316018898, + "version": "1.0", + "vdevice-host-name": "vm1", + "hw-description": "vEdge-Cloud", + "hw-type": "Chassis", + "vdevice-dataKey": "172.16.255.11-Chassis-0", + "@rid": 1163, + "vmanage-system-ip": "172.16.255.11", + "part-number": "vEdge-Cloud", + "lastupdated": 1647316017498 + }, + { + "vdevice-name": "172.16.255.11", + "serial-number": "None", + "hw-dev-index": 0, + "createTimeStamp": 1647316036497, + "version": "None", + "vdevice-host-name": "vm1", + "hw-description": "Max8x1GEVMports", + "hw-type": "PIM", + "vdevice-dataKey": "172.16.255.11-PIM-0", + "@rid": 1169, + "vmanage-system-ip": "172.16.255.11", + "part-number": "ge-8", + "lastupdated": 1647316017498 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/system": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware system data list from device", + "operationId": "createSystemList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware system data list": { + "description": "Hardware system data list", + "value": [ + { + "last-reboot-reason": "reload", + "software-version": "Cisco IOS Software [Cupertino], Virtual XE Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Experimental Version 17.8.20211216:090342 [BLD_POLARIS_DEV_LATEST_20211216_061759:/nobackup/mcpre/s2c-build-ws 101]\nCopyright (c) 1986-2021 by Cisco Systems, Inc.\nCompiled Thu 16-Dec-21 01:03 by mcpre", + "lastupdated": 1643186341301, + "vdevice-dataKey": "172.16.255.15-2022-01-26T08:40:53.165+00:00-2022-01-26T08:37:03+00:00", + "boot-time": "2022-01-26T08:37:03+00:00", + "rommon-version": "IOS-XE ROMMON", + "current-time": "2022-01-26T08:40:53.165+00:00", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/threshold": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware temperature list from device", + "operationId": "createTempThresholdList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware temperature list": { + "description": "Hardware temperature list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardwarehealth/detail": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get hardware health details for device", + "operationId": "getHardwareHealthDetails", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "Device state", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device hardware health details": { + "description": "Device hardware health details", + "value": { + "data": [ + { + "bfdSessions": "3", + "memUsageDisplay": "52.0", + "site-id": "100", + "device-type": "vedge", + "version": "20.7.999-1133", + "hardwareState": "normal", + "uptime-date": 1635324240000, + "uuid": "63e8518c-e76f-4d5f-a4c7-28ffb669526b", + "lastupdated": 1635371851165, + "reachability": "reachable", + "device-model": "vedge-cloud", + "host-name": "vm11", + "local-system-ip": "172.16.255.21", + "cpuLoadDisplay": "39.27", + "controlConnections": "3", + "board-serial": "12346568", + "number-vsmart-peers": 2, + "system-ip": "172.16.255.21", + "ompPeers": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/hardwarehealth/summary": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get hardware health summary for device", + "operationId": "getHardwareHealthSummary", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Status cached", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device hardware health": { + "description": "Device hardware health", + "value": { + "data": [ + { + "count": 5, + "status": "error", + "statusList": [ + { + "status": "up", + "count": 5, + "message": "5 {normal=5, warning=0, error=0}", + "name": "normal", + "detailsURL": "/dataservice/device/hardwarehealth/detail?state=normal" + }, + { + "status": "warning", + "count": 0, + "message": "0 {normal=5, warning=0, error=0}", + "name": "warning", + "detailsURL": "/dataservice/device/hardwarehealth/detail?state=warning" + }, + { + "status": "down", + "count": 0, + "message": "0 {normal=5, warning=0, error=0}", + "name": "error", + "detailsURL": "/dataservice/device/hardwarehealth/detail?state=error" + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/history": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_20", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/aggregation": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_19", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/device/history/app-agg/aggregation": { + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_19", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/device/history/config": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get device config history", + "operationId": "getLastThousandConfigList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config history": { + "description": "Device config history", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/config/diff/list": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get diff of two configs", + "operationId": "getConfigDiff", + "parameters": [ + { + "name": "config_id1", + "in": "query", + "description": "Config Id one", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "config_id2", + "in": "query", + "description": "Config Id two", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/config/{config_id}": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get device config", + "operationId": "getDeviceConfig", + "parameters": [ + { + "name": "config_id", + "in": "path", + "description": "Config Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/csv": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/doccount": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get response count of a query", + "operationId": "getCount_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_22", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/history/fields": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/history/page": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_20", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/query/fields": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/igmp/groups": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP neighbor list from device", + "operationId": "createIGMPGroupsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IGMP neighbor": { + "description": "IGMP neighbor", + "value": { + "data": [ + { + "if-name": "ge0/0", + "v1-members-present": "false", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643076514019, + "state": "members-present", + "vpn-id": "10", + "event": "init-event", + "vdevice-host-name": "vm3", + "group": "225.225.0.1", + "uptime": "0:06:38:43" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/igmp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP interface list from device", + "operationId": "createIGMPInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IGMP interface": { + "description": "IGMP interface", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "if-addr": "100.100.3.101/24", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "querier": "true", + "querier-ip": "100.100.3.101", + "if-name": "ge0/0", + "vdevice-dataKey": "169.254.10.10-10-ge0/0", + "group-count": 1, + "query-interval": "0:00:00:51", + "lastupdated": 1643076670382, + "state": "querier", + "event": "init-event" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/igmp/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP statistics list from device", + "operationId": "createIGMPStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IGMP statistics": { + "description": "IGMP statistics", + "value": { + "data": [ + { + "rx_group_query": 0, + "vdevice-name": "169.254.10.10", + "tx_group_query": 0, + "vpn-id": "10", + "rx_v2_report": 0, + "rx_unknown": 0, + "vdevice-host-name": "vm3", + "rx_v1_report": 0, + "rx_leave": 0, + "tx_general_query": 194, + "vdevice-dataKey": "169.254.10.10", + "rx_general_query": 0, + "tx_error": 0, + "lastupdated": 1643076824172, + "rx_error": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/igmp/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP summary from device", + "operationId": "createIGMPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IGMP summary": { + "description": "IGMP summary", + "value": { + "data": [ + { + "last-member-query-response-time": "3", + "querier-timeout": "255", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "query-interval": "125", + "query-response-time": "10", + "lastupdated": 1643076984762, + "version": "2", + "last-member-query-count": "2", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get device interfaces", + "operationId": "getDeviceInterface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 18, + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 13, + "ifname": "ge0/1", + "rx-pps": 14, + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 2, + "allow-service": "dhcp dns icmp https", + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 6544375, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 48131, + "tx-drops": 2, + "uptime": "4:20:14:13", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.101.3.3/16", + "hwaddr": "52:54:00:a1:4f:47", + "speed-mbps": "1000", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "tx-octets": 1238809794, + "tx-packets": 6404951, + "rx-octets": 1209186254, + "rx-kbps": 19, + "lastupdated": 1643077714908, + "port-type": "transport", + "uptime-date": 1642659240000, + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/1", + "rx-pps": 0, + "af-type": "ipv6", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ipv6-admin-status": "Up", + "ifindex": 2, + "allow-service": "dhcp dns icmp https", + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 3644, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "uptime": "4:20:14:13", + "ipv6-address": "-", + "hwaddr": "52:54:00:a1:4f:47", + "speed-mbps": "1000", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "tx-octets": 9140, + "tx-packets": 128, + "rx-octets": 405455, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "transport", + "uptime-date": 1642659240000, + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Down", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/2", + "rx-pps": 0, + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Down", + "ifindex": 3, + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 0, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "ipv6-address": "-", + "hwaddr": "52:54:00:39:5a:01", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "tx-octets": 0, + "tx-packets": 0, + "rx-octets": 0, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "service", + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Down", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/2", + "rx-pps": 0, + "af-type": "ipv6", + "shaping-rate": 0, + "if-oper-status": "Down", + "ipv6-admin-status": "Up", + "ifindex": 3, + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 0, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "ipv6-address": "-", + "hwaddr": "52:54:00:39:5a:01", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "tx-octets": 0, + "tx-packets": 0, + "rx-octets": 0, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "service", + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Down", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/3", + "rx-pps": 0, + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Down", + "ifindex": 4, + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 0, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "ipv6-address": "-", + "hwaddr": "52:54:00:2d:a0:f5", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "tx-octets": 0, + "tx-packets": 0, + "rx-octets": 0, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "service", + "encap-type": "null" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/arp_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface ARP statistics", + "operationId": "getDeviceInterfaceARPStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ARP statistics": { + "description": "ARP statistics", + "value": { + "data": [ + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "45746", + "rx-arp-requests": "296", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "12281", + "ip-address": "-", + "tx-arp-replies": "304", + "tx-no-arp-drops": "2", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "rx-arp-replies": "12281", + "ifname": "ge0/1", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "lastupdated": 1643077098782, + "arp-add-fails": "1" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "1", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "rx-arp-replies": "0", + "ifname": "ge0/1", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "0", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "rx-arp-replies": "0", + "ifname": "ge0/2", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "0", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "rx-arp-replies": "0", + "ifname": "ge0/2", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "0", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "rx-arp-replies": "0", + "ifname": "ge0/3", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/error_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface error stats", + "operationId": "getDeviceInterfaceErrorStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Error stats": { + "description": "Error stats", + "value": { + "data": [ + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "2078", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "2", + "ifname": "ge0/1", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "arp-add-fails": "1", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "46027", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/1", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/2", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/2", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/3", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/ipv6Stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface IPv6 stats", + "operationId": "getDeviceInterfaceIpv6Stats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface IPv6 stats": { + "description": "Interface IPv6 stats", + "value": { + "data": [ + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet1", + "lastupdated": 1645602691945, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet2", + "lastupdated": 1645602691945, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet3", + "lastupdated": 1645602691946, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet4", + "lastupdated": 1645602691946, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet5", + "lastupdated": 1645602691946, + "out-error-pkts": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/pkt_size": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface packet size", + "operationId": "getDeviceInterfacePktSizes", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface packet size": { + "description": "Interface packet size", + "value": { + "data": [ + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "num-flaps": "0", + "af-type": "ipv4", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "num-flaps": "0", + "af-type": "ipv6", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "num-flaps": "0", + "af-type": "ipv4", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "num-flaps": "0", + "af-type": "ipv6", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/3", + "num-flaps": "0", + "af-type": "ipv4", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/port_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface port stats", + "operationId": "getDeviceInterfacePortStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface port stats": { + "description": "Interface port stats", + "value": { + "data": [ + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "af-type": "ipv4", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "af-type": "ipv6", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "af-type": "ipv4", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "af-type": "ipv6", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/qosStats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface QOS stats", + "operationId": "getDeviceInterfaceQosStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface QOS stats": { + "description": "Interface QOS stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/queue_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface queue stats", + "operationId": "getDeviceInterfaceQueueStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface queue stats": { + "description": "Interface queue stats", + "value": { + "data": [ + { + "qnum": "0", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "vpn-id": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-0", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "af-type": "ipv4", + "tx-bytes": "0", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "2", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-2", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "3", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-3", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "4", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-4", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "5", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-5", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/serial": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get serial interface", + "operationId": "getDeviceSerialInterface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface stats", + "operationId": "getDeviceInterfaceStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface stats": { + "description": "Interface stats", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "rx-packets": "6634251", + "rx-errors": "0", + "tx-kbps": "18", + "tx-errors": "0", + "tx-pps": "13", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "48776", + "tx-drops": "2", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "ifname": "ge0/1", + "rx-pps": "13", + "tx-octets": "1255701145", + "tx-packets": "6493413", + "af-type": "ipv4", + "rx-octets": "1225652937", + "rx-kbps": "19", + "lastupdated": 1643083561267 + }, + { + "vdevice-name": "169.254.10.10", + "rx-packets": "3694", + "rx-errors": "0", + "tx-kbps": "0", + "tx-errors": "0", + "tx-pps": "0", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "0", + "tx-drops": "0", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "ifname": "ge0/1", + "rx-pps": "0", + "tx-octets": "9280", + "tx-packets": "130", + "af-type": "ipv6", + "rx-octets": "411008", + "rx-kbps": "0", + "lastupdated": 1643083561267 + }, + { + "vdevice-name": "169.254.10.10", + "rx-packets": "0", + "rx-errors": "0", + "tx-kbps": "0", + "tx-errors": "0", + "tx-pps": "0", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "0", + "tx-drops": "0", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "ifname": "ge0/2", + "rx-pps": "0", + "tx-octets": "0", + "tx-packets": "0", + "af-type": "ipv4", + "rx-octets": "0", + "rx-kbps": "0", + "lastupdated": 1643083561267 + }, + { + "vdevice-name": "169.254.10.10", + "rx-packets": "0", + "rx-errors": "0", + "tx-kbps": "0", + "tx-errors": "0", + "tx-pps": "0", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "0", + "tx-drops": "0", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "ifname": "ge0/2", + "rx-pps": "0", + "tx-octets": "0", + "tx-packets": "0", + "af-type": "ipv6", + "rx-octets": "0", + "rx-kbps": "0", + "lastupdated": 1643083561267 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get device interfaces synchronously", + "operationId": "getSyncedDeviceInterface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "@rid": 855, + "ifname": "ge0/1", + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 2, + "if-tracker-status": "NA", + "createTimeStamp": 1647315879734, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.0.26.11/24", + "hwaddr": "52:54:00:db:d9:1b", + "speed-mbps": "1000", + "vdevice-dataKey": "172.16.255.11-0-ge0/1-ipv4", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315879722, + "port-type": "service", + "encap-type": "null" + }, + { + "vdevice-name": "172.16.255.11", + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "@rid": 869, + "ifname": "ge0/2", + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 3, + "allow-service": "dhcpdnsicmphttps", + "if-tracker-status": "NA", + "createTimeStamp": 1647315880679, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.0.5.11/24", + "hwaddr": "52:54:00:5b:92:ab", + "speed-mbps": "1000", + "vdevice-dataKey": "172.16.255.11-0-ge0/2-ipv4", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315879722, + "port-type": "transport", + "encap-type": "null" + }, + { + "ifindex": 4, + "vdevice-name": "172.16.255.11", + "if-tracker-status": "NA", + "if-admin-status": "Down", + "createTimeStamp": 1647315881312, + "tcp-mss-adjust": "1416", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "hwaddr": "52:54:00:36:5b:37", + "ip-address": "-", + "vdevice-dataKey": "172.16.255.11-0-ge0/3-ipv4", + "@rid": 883, + "ifname": "ge0/3", + "vmanage-system-ip": "172.16.255.11", + "af-type": "ipv4", + "lastupdated": 1647315879722, + "shaping-rate": 0, + "port-type": "service", + "if-oper-status": "Down", + "encap-type": "null" + }, + { + "vdevice-name": "172.16.255.11", + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "@rid": 897, + "ifname": "ge0/4", + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 5, + "if-tracker-status": "NA", + "createTimeStamp": 1647315882880, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.0.7.11/24", + "hwaddr": "52:54:00:67:74:f1", + "speed-mbps": "1000", + "vdevice-dataKey": "172.16.255.11-0-ge0/4-ipv4", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315879722, + "port-type": "service", + "encap-type": "null" + }, + { + "ifindex": 6, + "vdevice-name": "172.16.255.11", + "if-tracker-status": "NA", + "if-admin-status": "Down", + "createTimeStamp": 1647315883461, + "tcp-mss-adjust": "1416", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "hwaddr": "52:54:00:0f:c2:a7", + "ip-address": "-", + "vdevice-dataKey": "172.16.255.11-0-ge0/5-ipv4", + "@rid": 908, + "ifname": "ge0/5", + "vmanage-system-ip": "172.16.255.11", + "af-type": "ipv4", + "lastupdated": 1647315879722, + "shaping-rate": 0, + "port-type": "service", + "if-oper-status": "Down", + "encap-type": "null" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/trustsec": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get policy filter memory usage from device", + "operationId": "trustsec", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy filter memory usage": { + "description": "Policy filter memory usage", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/interface/vpn": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get device interfaces per VPN", + "operationId": "generateDeviceInterfaceVPN", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "data": [ + { + "index": 0, + "vpnId": "0", + "ifname": "ge0/1" + }, + { + "index": 1, + "vpnId": "0", + "ifname": "ge0/2" + }, + { + "index": 2, + "vpnId": "0", + "ifname": "ge0/3" + }, + { + "index": 3, + "vpnId": "0", + "ifname": "ge0/4" + }, + { + "index": 4, + "vpnId": "0", + "ifname": "ge0/5" + }, + { + "index": 5, + "vpnId": "0", + "ifname": "ge0/6" + }, + { + "index": 6, + "vpnId": "0", + "ifname": "ge0/7" + }, + { + "index": 7, + "vpnId": "0", + "ifname": "system" + }, + { + "index": 8, + "vpnId": "1", + "ifname": "ge0/0" + }, + { + "index": 9, + "vpnId": "512", + "ifname": "eth0" + }, + { + "index": 10, + "vpnId": "65528", + "ifname": "loopback65528" + }, + { + "index": 11, + "vpnId": "65530", + "ifname": "loopback65530" + }, + { + "index": 12, + "vpnId": "65530", + "ifname": "loopback65531" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/ip/fib": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get FIB list from device (Real Time)", + "operationId": "createFibList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "address-family", + "in": "query", + "description": "Address family", + "schema": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "tloc", + "in": "query", + "description": "tloc IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FIB list": { + "description": "FIB list", + "value": { + "data": [ + { + "nexthop-address": "10.0.5.13", + "vdevice-dataKey": "172.16.255.21-0-0.0.0.0/0", + "vdevice-name": "172.16.255.21", + "prefix": "0.0.0.0/0", + "lastupdated": 1649641392351, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.5.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.5.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.5.21/32", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.5.21/32", + "lastupdated": 1649641392351, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.100.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.100.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/7", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.100.21/32", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.100.21/32", + "lastupdated": 1649641392351, + "out-ifname": "ge0/7", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-100.0.0.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "100.0.0.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/6", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-100.0.0.11/32", + "vdevice-name": "172.16.255.21", + "prefix": "100.0.0.11/32", + "lastupdated": 1649641392351, + "out-ifname": "ge0/6", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "nexthop-address": "100.0.0.1", + "vdevice-dataKey": "172.16.255.21-0-100.2.0.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "100.2.0.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/6", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/ipRoutes": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get ietf routing list from device", + "operationId": "createIetfRoutingList", + "parameters": [ + { + "name": "routing-instance-name", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "address-family", + "in": "query", + "description": "Address family", + "schema": { + "type": "string" + } + }, + { + "name": "outgoing-interface", + "in": "query", + "description": "Outgoing Interface", + "schema": { + "type": "string" + } + }, + { + "name": "source-protocol", + "in": "query", + "description": "Source Protocol", + "schema": { + "type": "string" + } + }, + { + "name": "next-hop-address", + "in": "query", + "description": "Next Hop Address", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ietf routing list": { + "description": "ietf routing list", + "value": { + "data": [ + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "0.0.0.0/0", + "route-source-protocol": "static", + "next-hop-next-hop-address": "10.102.254.254", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "1", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "route-metric": "0", + "lastupdated": 1645080304580 + }, + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "10.101.0.0/16", + "route-source-protocol": "direct", + "next-hop-next-hop-address": "0.0.0.0", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "0", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "next-hop-outgoing-interface": "GigabitEthernet3", + "route-metric": "0", + "lastupdated": 1645080304580 + }, + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "10.101.5.5/32", + "route-source-protocol": "direct", + "next-hop-next-hop-address": "0.0.0.0", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "0", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "next-hop-outgoing-interface": "GigabitEthernet3", + "route-metric": "0", + "lastupdated": 1645080304580 + }, + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "10.102.0.0/16", + "route-source-protocol": "direct", + "next-hop-next-hop-address": "0.0.0.0", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "0", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "next-hop-outgoing-interface": "GigabitEthernet5", + "route-metric": "0", + "lastupdated": 1645080304580 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/mfiboil": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get IP MFIB OIL list from device (Real Time)", + "operationId": "createIPMfibOilList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP MFIB OIL list": { + "description": "IP MFIB OIL list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/mfibstats": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get IP MFIB statistics list from device (Real Time)", + "operationId": "createIPMfibStatsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP MFIB statistics list": { + "description": "IP MFIB statistics list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/mfibsummary": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get IP MFIB summary list from device (Real Time)", + "operationId": "createIPMfibSummaryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP MFIB summary list": { + "description": "IP MFIB summary list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/filter": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT filter list from device", + "operationId": "createNatFilterList", + "parameters": [ + { + "name": "nat-vpn-id", + "in": "query", + "description": "NAT VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "nat-ifname", + "in": "query", + "description": "NAT interface name", + "schema": { + "type": "string" + } + }, + { + "name": "private-source-address", + "in": "query", + "description": "Private source address", + "schema": { + "type": "string" + } + }, + { + "name": "proto", + "in": "query", + "description": "Protocol", + "schema": { + "type": "string", + "enum": [ + "icm", + "tcp", + "udp" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT filter list": { + "description": "NAT filter list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT interface list from device (Real Time)", + "operationId": "createNatInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT interface list": { + "description": "NAT interface list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/interfacestatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT interface statistics list from device", + "operationId": "createNatInterfaceStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT interface statistics list": { + "description": "NAT interface statistics list", + "value": [ + { + "out2in-drops": 0, + "in2out-drops": 0, + "vdevice-dataKey": "172.16.255.15-0-0", + "vdevice-host-name": "vm5", + "initialized": 9223372036854775807, + "entry-timeouts": 0, + "pool-stats-drop": "0", + "limit-entry-add-fail": "0", + "outsides": 0, + "packets-punted": "0", + "lastupdated": 1645079319277, + "mapping-stats-drop": "0", + "misses": 0, + "interrupt-switched": 0, + "frag-pak-count": "0", + "statics": 0, + "flows": 0, + "entries": "0", + "vdevice-name": "172.16.255.15", + "hits": 0, + "portlist-req-fail": "0", + "ipalias-add-fail": 0, + "insides": 0, + "statics-sorted": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/translation": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT translation list from device (Real Time)", + "operationId": "createNatTranslationList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT translation list": { + "description": "NAT translation list", + "value": { + "data": [ + { + "inside-local-addr": "10.1.15.15", + "outside-local-port": "50", + "vdevice-name": "172.16.255.15", + "inside-global-port": "50", + "flags": "0", + "outside-global-port": "50", + "vdevice-host-name": "vm5", + "vrfid": "0", + "protocol": "1", + "outside-local-addr": "10.1.16.16", + "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-50", + "outside-global-addr": "10.1.16.16", + "inside-local-port": "50", + "lastupdated": 1651038839092, + "application-type": "0", + "inside-global-addr": "10.1.15.15" + }, + { + "inside-local-addr": "10.1.15.15", + "outside-local-port": "51", + "vdevice-name": "172.16.255.15", + "inside-global-port": "51", + "flags": "0", + "outside-global-port": "51", + "vdevice-host-name": "vm5", + "vrfid": "0", + "protocol": "1", + "outside-local-addr": "10.1.16.16", + "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-51", + "outside-global-addr": "10.1.16.16", + "inside-local-port": "51", + "lastupdated": 1651038839092, + "application-type": "0", + "inside-global-addr": "10.1.15.15" + }, + { + "inside-local-addr": "10.1.15.15", + "outside-local-port": "49", + "vdevice-name": "172.16.255.15", + "inside-global-port": "49", + "flags": "0", + "outside-global-port": "49", + "vdevice-host-name": "vm5", + "vrfid": "0", + "protocol": "1", + "outside-local-addr": "10.1.16.16", + "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-49", + "outside-global-addr": "10.1.16.16", + "inside-local-port": "49", + "lastupdated": 1651038839092, + "application-type": "0", + "inside-global-addr": "10.1.15.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat64/translation": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT64 interface list from device", + "operationId": "createNat64TranslationList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT64 interface list": { + "description": "NAT64 interface list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/routetable": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get route table list from device (Real Time)", + "operationId": "createRouteTableList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "address-family", + "in": "query", + "description": "Address family", + "schema": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "protocol", + "in": "query", + "description": "IP protocol", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Route table list": { + "description": "Route table list", + "value": { + "data": [ + { + "rstatus": "F S", + "protocol": "static", + "vdevice-dataKey": "169.254.10.10-0-0.0.0.0/0", + "vdevice-name": "169.254.10.10", + "prefix": "0.0.0.0/0", + "lastupdated": 1643160579908, + "nexthop-addr": "10.101.254.254", + "vpn-id": 0, + "nexthop-type": "ipv4", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "nexthop-ifname": "ge0/1" + }, + { + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.5.0/24", + "ip": "172.16.254.4", + "encap": "ipsec", + "vpn-id": 10, + "nexthop-label": "1047", + "nexthop-type": "ipv4-indirect", + "vdevice-host-name": "vm3", + "rstatus": "F S", + "protocol": "omp", + "vdevice-dataKey": "169.254.10.10-10-10.0.5.0/24", + "lastupdated": 1643160579908, + "address-family": "ipv4" + }, + { + "rstatus": "F S", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-512-fcff::/120", + "vdevice-name": "169.254.10.10", + "prefix": "fcff::/120", + "lastupdated": 1643160579908, + "vpn-id": 512, + "nexthop-type": "ipv6", + "vdevice-host-name": "vm3", + "address-family": "ipv6", + "nexthop-ifname": "loop0.2" + }, + { + "rstatus": "F S", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-65528-192.168.0.0/24", + "vdevice-name": "169.254.10.10", + "prefix": "192.168.0.0/24", + "lastupdated": 1643160579908, + "vpn-id": 65528, + "nexthop-type": "ipv4", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "nexthop-ifname": "loopback65528" + }, + { + "rstatus": "F S", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-65530-192.168.0.0/24", + "vdevice-name": "169.254.10.10", + "prefix": "192.168.0.0/24", + "lastupdated": 1643160579908, + "vpn-id": 65530, + "nexthop-type": "ipv4", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "nexthop-ifname": "loopback65530" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/v4fib": { + "get": { + "tags": [ + "Real-Time Monitoring - IPv4 FIB" + ], + "description": "Get IPv4 FIB list from device (Real Time)", + "operationId": "createIPv4FibList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "tloc", + "in": "query", + "description": "tloc IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FIB list": { + "description": "FIB list", + "value": { + "data": [ + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-512-10.0.1.0/24", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.1.0/24", + "lastupdated": 1643096072514, + "out-ifname": "eth0", + "vpn-id": 512, + "vdevice-host-name": "vm3" + }, + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-512-10.0.1.3/32", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.1.3/32", + "lastupdated": 1643096072514, + "out-ifname": "eth0", + "vpn-id": 512, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/v6fib": { + "get": { + "tags": [ + "Real-Time Monitoring - IPv6 FIB" + ], + "description": "Get IPv6 FIB list from device (Real Time)", + "operationId": "createIPv6FibList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "tloc", + "in": "query", + "description": "tloc IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FIB list": { + "description": "FIB list", + "value": { + "data": [ + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-0-fe80::3274:7d86:eb7f:4a3c/128", + "vdevice-name": "169.254.10.10", + "prefix": "fe80::3274:7d86:eb7f:4a3c/128", + "lastupdated": 1643096311251, + "out-ifname": "vmanage_system", + "vpn-id": 0, + "vdevice-host-name": "vm3" + }, + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-0-fe80::40b8:4592:c183:592c/128", + "vdevice-name": "169.254.10.10", + "prefix": "fe80::40b8:4592:c183:592c/128", + "lastupdated": 1643096311251, + "out-ifname": "system", + "vpn-id": 0, + "vdevice-host-name": "vm3" + }, + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-0-fe80::5054:ff:fea1:4f47/128", + "vdevice-name": "169.254.10.10", + "prefix": "fe80::5054:ff:fea1:4f47/128", + "lastupdated": 1643096311251, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ipsec/identity": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get Crypto IPSEC identity entry from device", + "operationId": "createCryptoIpsecIdentity", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crypto IPSEC identity entry": { + "description": "Crypto IPSEC identity entry", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.12", + "local-ident-addr": "10.102.5.5", + "local-endpt-addr": "10.102.5.5", + "remote-ident-protocol": "0", + "interface": "Tunnel5", + "vpn-id": "0", + "vdevice-host-name": "vm5", + "local-ident-mask": "255.255.255.255", + "local-ident-protocol": "0", + "vdevice-dataKey": "169.254.10.12", + "plaintext-mtu": "1438", + "lastupdated": 1644890148156, + "remote-ident-addr": "10.101.3.3", + "remote-endpt-addr": "10.101.3.3", + "remote-ident-mask": "255.255.255.255", + "dh-group": "crypto-dh-grouptype-none" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ike/inbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec IKE inbound connection list from device", + "operationId": "createIkeInboundList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec IKE local inbound connection list": { + "description": "IPsec IKE local inbound connection list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ike/outbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec IKE outbound connection list from device", + "operationId": "createIkeOutboundList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec IKE outbound connection list": { + "description": "IPsec IKE outbound connection list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ike/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec IKE sessions from device", + "operationId": "createIkeSessions", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec IKE sessions": { + "description": "IPsec IKE sessions", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ikev1": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get Crypto IKEv1 SA entry from device", + "operationId": "createCryptov1LocalSAList", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crypto IKEv1 SA entry": { + "description": "Crypto IKEv1 SA entry", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ikev2": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get Crypto IKEv2 SA entry from device", + "operationId": "createCryptov2LocalSAList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crypto IKEv2 SA entry": { + "description": "Crypto IKEv2 SA entry", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/inbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec inbound connection list from device (Real Time)", + "operationId": "createInBoundList", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec inbound connection list": { + "description": "IPsec inbound connection list", + "value": { + "data": [ + { + "dest-ip": "10.101.3.3", + "source-port": 12386, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.1", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.101.2.2", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.3", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.101.4.4", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.4", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.102.5.5", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.5", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.102.6.6", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.16", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.102.16.16", + "remote-tloc-color": "default", + "local-tloc-color": "default" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/localsa": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec local SA list from device", + "operationId": "createLocalSAList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec local SA list": { + "description": "IPsec local SA list", + "value": { + "data": [ + { + "tloc-color": "default", + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "vdevice-name": "169.254.10.10", + "port": 12406, + "tloc-address": "172.16.254.2", + "ipv6": "::", + "ip": "10.101.3.3", + "lastupdated": 1643166514716, + "encrypt-key-hash": "*****386b", + "spi": "286", + "auth-key-hash": "*****386b", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/outbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec outbound connection list from device (Real Time)", + "operationId": "createOutBoundList", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec outbound connection list": { + "description": "IPsec outbound connection list", + "value": { + "data": [ + { + "dest-ip": "10.101.2.2", + "integrity-used": "ip-udp-esp", + "source-port": 12426, + "vdevice-name": "169.254.10.10", + "spi": 262, + "auth-key-hash": "*****2450", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.1", + "dest-port": 12386, + "vdevice-dataKey": "169.254.10.10-10.101.3.3", + "tunnel-mtu": 1441, + "lastupdated": 1643334538276, + "source-ip": "10.101.3.3", + "remote-tloc-color": "default", + "encrypt-key-hash": "*****2450" + }, + { + "dest-ip": "10.101.4.4", + "integrity-used": "ip-udp-esp", + "source-port": 12426, + "vdevice-name": "169.254.10.10", + "spi": 289, + "auth-key-hash": "*****3b7e", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.3", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-10.101.3.3", + "tunnel-mtu": 1441, + "lastupdated": 1643334538276, + "source-ip": "10.101.3.3", + "remote-tloc-color": "default", + "encrypt-key-hash": "*****3b7e" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/pwk/inbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPSEC pairwise key inbound entry from device", + "operationId": "createIPsecPWKInboundConnections", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPSEC pairwise key inbound entry": { + "description": "IPSEC pairwise key inbound entry", + "value": { + "data": [ + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.1", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066644, + "remote-tloc-color": "lte", + "source-ip": "10.102.2.2", + "local-tloc-color": "default", + "sa-index": "7", + "remote-tloc-index": "32775" + }, + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.1", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066644, + "remote-tloc-color": "3g", + "source-ip": "10.101.2.2", + "local-tloc-color": "default", + "sa-index": "19", + "remote-tloc-index": "32781" + }, + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.2", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066644, + "remote-tloc-color": "lte", + "source-ip": "10.102.3.3", + "local-tloc-color": "default", + "sa-index": "11", + "remote-tloc-index": "32777" + }, + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.2", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066645, + "remote-tloc-color": "3g", + "source-ip": "10.101.3.3", + "local-tloc-color": "default", + "sa-index": "9", + "remote-tloc-index": "32776" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/pwk/localsa": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPSEC pairwise key local SA entry from device", + "operationId": "createIPsecPWKLocalSA", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPSEC pairwise key local SA entry": { + "description": "IPSEC pairwise key local SA entry", + "value": { + "data": [ + { + "tloc-color": "default", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32770", + "ip": "10.101.5.5", + "spi": "262", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "9" + }, + { + "tloc-color": "default", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32770", + "ip": "10.101.5.5", + "spi": "263", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "11" + }, + { + "tloc-color": "3g", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32771", + "ip": "10.102.5.5", + "spi": "262", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "10" + }, + { + "tloc-color": "3g", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32771", + "ip": "10.102.5.5", + "spi": "263", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "12" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/pwk/outbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPSEC pairwise key outbound entry from device", + "operationId": "createIPsecPWKOutboundConnections", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPSEC pairwise key outbound entry": { + "description": "IPSEC pairwise key outbound entry", + "value": { + "data": [ + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "a600", + "local-tloc-color": "lte", + "dest-ip": "10.0.5.11", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32772", + "lastupdated": 1645156239932, + "sa-index": "183", + "remote-tloc-address": "172.16.255.11", + "tloc-index": "32772", + "dest-port": "12367", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + }, + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "b13e", + "local-tloc-color": "lte", + "dest-ip": "10.0.5.21", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32771", + "lastupdated": 1645156239933, + "sa-index": "182", + "remote-tloc-address": "172.16.255.21", + "tloc-index": "32771", + "dest-port": "12377", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + }, + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "59f1", + "local-tloc-color": "lte", + "dest-ip": "10.1.14.14", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32774", + "lastupdated": 1645156239933, + "sa-index": "184", + "remote-tloc-address": "172.16.255.14", + "tloc-index": "32774", + "dest-port": "12366", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + }, + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "61b6", + "local-tloc-color": "lte", + "dest-ip": "10.1.16.16", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32773", + "lastupdated": 1645156239933, + "sa-index": "181", + "remote-tloc-address": "172.16.255.16", + "tloc-index": "32773", + "dest-port": "12366", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipv6/nd6": { + "get": { + "tags": [ + "Real-Time Monitoring - Device" + ], + "description": "Get ipv6 data from device", + "operationId": "getIpv6Data", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP v6 data": { + "description": "IP v6 data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/keyvalue": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get vEdge inventory as key value (key as systemIp value as hostName)", + "operationId": "getDeviceListAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge inventory": { + "description": "vEdge inventory", + "value": { + "header": { + "generatedOn": 1635297986225 + }, + "data": [ + { + "key": "172.16.255.128", + "value": "vm128 (172.16.255.128)" + }, + { + "key": "172.16.253.129", + "value": "vm129 (172.16.253.129)" + }, + { + "key": "172.16.255.130", + "value": "vm130 (172.16.255.130)" + }, + { + "key": "172.16.253.131", + "value": "vm131 (172.16.253.131)" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/license/evaluation": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license evaluation info from device", + "operationId": "getLicenseEvalInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License evaluation info": { + "description": "License evaluation info", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.14", + "vdevice-name": "169.254.10.14", + "lastupdated": 1646031617468, + "eval-expired": "false", + "eval-in-use": "false", + "time-left": "0", + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/pak": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license pak info from device", + "operationId": "getLicensePAKInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License pak info": { + "description": "License pak info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/privacy": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license privacy info from device", + "operationId": "getLicensePrivacyInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License privacy info": { + "description": "License privacy info", + "value": { + "data": [ + {}, + { + "lastupdated": 1646030987293, + "hostname": "false", + "vdevice-dataKey": "169.254.10.14", + "vdevice-name": "169.254.10.14", + "version": "false", + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/registration": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license registration info from device", + "operationId": "getLicenseRegInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License info": { + "description": "License info", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "always-enabled": "true", + "lastupdated": 1645754331129, + "vdevice-host-name": "vm5", + "smart-enabled": "false" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/udi": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license UDI info from device", + "operationId": "getLicenseUDIInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License UDI info": { + "description": "License UDI info", + "value": { + "data": [ + { + "mac-address": "00:00:00:00:00:00", + "vdevice-dataKey": "169.254.10.14", + "vdevice-name": "169.254.10.14", + "lastupdated": 1646030100474, + "pid": "CSR1000V", + "sn": "9PBHZUBMD18", + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/usage": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license usage info from device", + "operationId": "getLicenseUsageInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License usage info": { + "description": "License usage info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/logging": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get logging from device (Real Time)", + "operationId": "getLoggingFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Logging": { + "description": "Logging", + "value": { + "data": [ + { + "disk_priority": "info", + "disk_filerotate": 10, + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "host_priority": "emerg", + "lastupdated": 1643178776334, + "disk_status": "enabled", + "disk_filename": "vsyslog", + "disk_filesize": 10, + "host_status": "disabled", + "host_vpn_id": 0, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/models": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get all device models supported by the vManage", + "operationId": "listAllDeviceModels", + "parameters": [ + { + "name": "list", + "in": "query", + "description": "List type of device", + "required": true, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device model": { + "description": "Device model", + "value": { + "header": { + "generatedOn": 1635224742597 + }, + "data": [ + { + "name": "vedge-ISR-4461", + "templateClass": "cedge", + "displayName": "ISR4461", + "deviceType": "vedge", + "isCliSupported": true, + "templateSupported": true, + "deviceClass": "cisco-router", + "cpuCountAttribute": { + "enable": true, + "attributeField": "total_cpu_count" + }, + "interfaces": { + "wan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "lan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "mgmt": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "day0": [ + "GigabitEthernet0/0/0" + ] + }, + "onboardCert": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/models/{uuid}": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device model for the device", + "operationId": "getDeviceModels", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device model": { + "description": "Device model", + "value": { + "name": "vedge-cloud", + "displayName": "vEdge Cloud", + "deviceType": "vedge", + "isCliSupported": true, + "templateSupported": true, + "deviceClass": "viptela-router", + "cpuCountAttribute": { + "enable": true, + "attributeField": "linux_cpu_count" + }, + "onboardCert": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/monitor": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get all monitoring details of the devices", + "operationId": "listAllMonitorDetailsDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitor device details": { + "description": "Monitor device details", + "value": { + "header": { + "generatedOn": 1635227574211, + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-MonitorDeviceDetails" + }, + "columns": [ + { + "title": "Status", + "property": "status", + "display": "icon", + "iconProperty": "status-icon", + "colorProperty": "status-color", + "hideable": false, + "dataType": "string" + }, + { + "title": "Device Type", + "property": "device-type", + "display": "keyvalue", + "keyvalueProperty": "device-type", + "keyvalue": [ + { + "key": "vsmart", + "value": "vSmart" + }, + { + "key": "vbond", + "value": "vBond" + }, + { + "key": "vmanage", + "value": "vManage" + }, + { + "key": "vedge", + "value": "WAN Edge" + } + ], + "dataType": "string" + } + ], + "fields": [ + { + "property": "status", + "dataType": "string", + "display": "icon" + }, + { + "property": "host-name", + "dataType": "string", + "display": "iconAndText" + } + ] + }, + "data": [ + { + "device-model": "vmanage", + "device-type": "vmanage", + "system-ip": "169.254.10.1", + "host-name": "vm200", + "site-id": "200", + "layoutLevel": 1, + "status": "normal" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/multicast/replicator": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get replicator list from device", + "operationId": "createReplicatorList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Replicator list": { + "description": "Replicator list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/multicast/rpf": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get RPF list from device", + "operationId": "createRpfList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "RPF list": { + "description": "RPF list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/multicast/topology": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get topology list from device", + "operationId": "createTopologyList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Topology list": { + "description": "Topology list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/multicast/tunnel": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get PIM tunnel from device", + "operationId": "createPimTunnelList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PIM tunnel": { + "description": "PIM tunnel", + "value": { + "data": [ + { + "tunnel-status": "UP", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "replicator": "no", + "lastupdated": 1643179140806, + "vpn-id": "10", + "vdevice-host-name": "vm3", + "tunnel-address": "172.16.254.1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ndv6": { + "get": { + "tags": [ + "Real-Time Monitoring - IPv6 Neighbours" + ], + "description": "Get IPv6 Neighbors from device (Real Time)", + "operationId": "getIpv6Interface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "if-name", + "in": "query", + "description": "Interface name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "mac", + "in": "query", + "description": "Mac address", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPv6 Neighbors": { + "description": "IPv6 Neighbors", + "value": { + "data": [ + { + "if-name": "ge0/1", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "fe80::5054:ff:fea1:4f47", + "lastupdated": 1643172402186, + "state": "static", + "vpn-id": "0", + "uptime-date": 1642659240000, + "vdevice-host-name": "vm3", + "mac": "52:54:00:a1:4f:47", + "uptime": "5:22:32:19" + }, + { + "if-name": "ge0/1", + "idle-timer": "0:00:00:00", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "fe80::5054:ff:fecf:dad8", + "lastupdated": 1643172402186, + "state": "dynamic", + "vpn-id": "0", + "uptime-date": 1643048160000, + "vdevice-host-name": "vm3", + "mac": "52:54:00:cf:da:d8", + "uptime": "1:10:30:01" + }, + { + "if-name": "ge0/1", + "idle-timer": "0:00:00:00", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "fe80::fc54:ff:fea1:4f47", + "lastupdated": 1643172402186, + "state": "dynamic", + "vpn-id": "0", + "uptime-date": 1642670640000, + "vdevice-host-name": "vm3", + "mac": "fe:54:00:a1:4f:47", + "uptime": "5:19:21:53" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/nms/running": { + "get": { + "tags": [ + "Real-Time Monitoring - NMS" + ], + "description": "Get nms running state from device", + "operationId": "getRunning", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Nms running": { + "description": "Nms running", + "value": { + "data": [ + { + "vdevice-host-name": "vm12", + "vdevice-dataKey": "172.16.255.22-true", + "running": "true", + "vdevice-name": "172.16.255.22", + "lastupdated": 1642648535452 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/ntp/associations": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get NTP peer associations list from device (Real Time)", + "operationId": "createAssociationsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "NTP peer associations list": { + "description": "NTP peer associations list", + "value": { + "data": [ + { + "count": 1, + "status": "8011", + "idx": 1, + "last_event": "mobilize", + "vdevice-name": "172.16.255.11", + "associd": "51657", + "auth": "none", + "reachability": "no", + "lastupdated": 1647428253985, + "conf": "yes", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11-1-51657", + "condition": "reject" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/ntp/peer": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get NTP peer list from device (Real Time)", + "operationId": "createPeerList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "NTP peer associations list": { + "description": "NTP peer associations list", + "value": { + "data": [ + { + "index": 1, + "remote": "10.10.10.10", + "reach": "0", + "when": "-", + "lastupdated": 1647576150422, + "st": "16", + "delay": "0.000", + "vdevice-dataKey": "172.16.255.11-1", + "offset": "+0.000", + "vdevice-host-name": "vm1", + "jitter": "0.000", + "poll": "512", + "type": "u", + "refid": ".INIT.", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/ntp/status": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get NTP status list from device (Real Time)", + "operationId": "createNTPStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "NTP peer associations list": { + "description": "NTP peer associations list", + "value": { + "data": [ + { + "sys-poll": "3", + "stratum": "16", + "lastupdated": 1647483667971, + "root-delay": "0.0", + "vdevice-dataKey": "172.16.255.15-3", + "reftime": "1970-01-01T00:00:00+00:00", + "offset": "0.0", + "kod-type": "ntp-ref-init", + "root-disp": "38.5", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/omp/cloudx": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get CloudExpress routes received list", + "operationId": "createOMPCloudXRecv", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudExpress routes received list": { + "description": "CloudExpress routes received list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/links": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP connection list", + "operationId": "createOMPLinkList", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Connection state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OMP connection list": { + "description": "OMP connection list", + "value": { + "data": [ + { + "state": "up", + "lastupdated": "1646804216515", + "linkKey": "172.16.255.16-172.16.255.20", + "adeviceId": "172.16.255.16", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.16", + "bsystem-ip": "172.16.255.20", + "asite-id": "600", + "bsite-id": "200", + "ahost-name": "vm6", + "bhost-name": "vm10", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804204258", + "linkKey": "172.16.255.16-172.16.255.19", + "adeviceId": "172.16.255.16", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.16", + "bsystem-ip": "172.16.255.19", + "asite-id": "600", + "bsite-id": "100", + "ahost-name": "vm6", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804204257", + "linkKey": "172.16.255.15-172.16.255.19", + "adeviceId": "172.16.255.15", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.15", + "bsystem-ip": "172.16.255.19", + "asite-id": "500", + "bsite-id": "100", + "ahost-name": "vm5", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804216515", + "linkKey": "172.16.255.15-172.16.255.20", + "adeviceId": "172.16.255.15", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.15", + "bsystem-ip": "172.16.255.20", + "asite-id": "500", + "bsite-id": "200", + "ahost-name": "vm5", + "bhost-name": "vm10", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804204257", + "linkKey": "172.16.255.14-172.16.255.19", + "adeviceId": "172.16.255.14", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.14", + "bsystem-ip": "172.16.255.19", + "asite-id": "400", + "bsite-id": "100", + "ahost-name": "vm4", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/omp/mcastautodiscoveradvt": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast autodiscover advertised list", + "operationId": "createOMPMcastAutoDiscoverAdvt", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast autodiscover advertised list": { + "description": "OMP multicast autodiscover advertised list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643180905996, + "source-originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.253.129" + }, + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643180905996, + "source-originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/mcastautodiscoverrecv": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast autodiscover received list", + "operationId": "createOMPMcastAutoDiscoverRecv", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast autodiscover received list": { + "description": "OMP multicast autodiscover received list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "from-peer": "172.16.253.129", + "lastupdated": 1643181632850, + "source-originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C I R" + }, + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "from-peer": "172.16.255.130", + "lastupdated": 1643181632851, + "source-originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C I R" + }, + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "from-peer": "0.0.0.0", + "lastupdated": 1643181632852, + "source-originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C Red R" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/mcastroutesadvt": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast routes advertised list", + "operationId": "createOMPMcastRoutesAdvt", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast routes advertised list": { + "description": "OMP multicast routes advertised list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/mcastroutesrecv": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast routes received list", + "operationId": "createOMPMcastRoutesRecv", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast routes received list": { + "description": "OMP multicast routes received list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/peers": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP session list (Real Time)", + "operationId": "createOMPSessionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OP session list": { + "description": "OP session list", + "value": { + "data": [ + { + "domain-id": 1, + "vdevice-name": "169.254.10.10", + "refresh": "supported", + "site-id": 129, + "type": "vsmart", + "vdevice-host-name": "vm3", + "up-time-date": 1643135160000, + "vdevice-dataKey": "169.254.10.10-172.16.253.129-vsmart", + "peer": "172.16.253.129", + "up-time": "0:12:57:30", + "legit": "yes", + "lastupdated": 1643181828115, + "state": "up" + }, + { + "domain-id": 1, + "vdevice-name": "169.254.10.10", + "refresh": "supported", + "site-id": 130, + "type": "vsmart", + "vdevice-host-name": "vm3", + "up-time-date": 1643135160000, + "vdevice-dataKey": "169.254.10.10-172.16.255.130-vsmart", + "peer": "172.16.255.130", + "up-time": "0:12:57:30", + "legit": "yes", + "lastupdated": 1643181828115, + "state": "up" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/routes/advertised": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP advertised routes list (Real Time)", + "operationId": "createAdvertisedRoutesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP advertised routes list": { + "description": "OMP advertised routes list", + "value": { + "data": [ + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.3.0/24", + "ip": "172.16.254.2", + "label": "1069", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "65", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643179668956, + "to-peer": "172.16.253.129" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.3.0/24", + "ip": "172.16.254.2", + "label": "1069", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "65", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643179668956, + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/routes/advertised/ompIpv6": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP advertised routes list (Real Time)", + "operationId": "createAdvertisedRoutesListIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP advertised routes list": { + "description": "OMP advertised routes list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/omp/routes/received": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP received routes list (Real Time)", + "operationId": "createReceivedRoutesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP received routes list": { + "description": "OMP received routes list", + "value": { + "data": [ + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.5.0/24", + "ip": "172.16.254.4", + "from-peer": "172.16.253.129", + "label": "1047", + "encap": "ipsec", + "site-id": "5", + "originator": "172.16.254.4", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "42", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C I R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.5.0/24", + "ip": "172.16.254.4", + "from-peer": "172.16.255.130", + "label": "1047", + "encap": "ipsec", + "site-id": "5", + "originator": "172.16.254.4", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "42", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.16.0/24", + "ip": "172.16.254.16", + "from-peer": "172.16.253.129", + "label": "1014", + "encap": "ipsec", + "site-id": "16", + "originator": "172.16.254.16", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "38", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C I R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.16.0/24", + "ip": "172.16.254.16", + "from-peer": "172.16.255.130", + "label": "1014", + "encap": "ipsec", + "site-id": "16", + "originator": "172.16.254.16", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "38", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.2.0/24", + "ip": "172.16.254.1", + "from-peer": "172.16.253.129", + "label": "1018", + "encap": "ipsec", + "site-id": "2", + "originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "29", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C I R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.2.0/24", + "ip": "172.16.254.1", + "from-peer": "172.16.255.130", + "label": "1018", + "encap": "ipsec", + "site-id": "2", + "originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "29", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.3.0/24", + "ip": "172.16.254.2", + "from-peer": "0.0.0.0", + "label": "1069", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "65", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041520, + "attribute-type": "installed", + "status": "C Red R" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/routes/received/ompIpv6": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP received routes list (Real Time)", + "operationId": "createReceivedRoutesListIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP received routes list": { + "description": "OMP received routes list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/omp/services": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP services list", + "operationId": "createOMPServices", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP services list": { + "description": "OMP services list", + "value": { + "data": [ + { + "path-id": "65", + "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", + "vdevice-name": "169.254.10.10", + "service": "VPN", + "from-peer": "0.0.0.0", + "lastupdated": 1643250832867, + "originator": "172.16.254.2", + "label": "1077", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C Red R" + }, + { + "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", + "vdevice-name": "169.254.10.10", + "service": "VPN", + "lastupdated": 1643250832868, + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.253.129" + }, + { + "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", + "vdevice-name": "169.254.10.10", + "service": "VPN", + "lastupdated": 1643250832869, + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/status": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get device OMP status", + "operationId": "getDeviceOMPStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device OMP status": { + "description": "Device OMP status", + "value": { + "data": [ + { + "type": "omp", + "name": "OMP", + "image": "images/omp.png", + "count": 0, + "detailView": "dialog", + "detailsURL": "/dataservice/device/omp/links", + "statusList": [ + { + "status": "up", + "icon": "images/connection/connection-network-up.png", + "color": "b0e276", + "name": "up", + "detailView": "dialog", + "detailsURL": "/dataservice/device/omp/links?state=up", + "count": 0 + }, + { + "status": "down", + "icon": "images/connection/connection-network-down.png", + "color": "fa7c7d", + "name": "down", + "detailView": "dialog", + "detailsURL": "/dataservice/device/omp/links?state=down", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/omp/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP summary", + "operationId": "createOMPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OMP summary": { + "description": "OMP summary", + "value": { + "data": [ + { + "tlocs-sent": 4, + "policy-sent": 0, + "mcast-routes-sent": 0, + "packets-sent": 81579, + "vdevice-name": "169.254.10.10", + "inform-sent": 14, + "packets-received": 81956, + "routes-received": 18, + "tlocs-received": 22, + "mcast-routes-installed": 0, + "update-sent": 84, + "devicetype": "vedge", + "mcast-routes-received": 0, + "hello-received": 81472, + "alert-sent": 0, + "update-received": 468, + "vsmart-peers": 2, + "operstate": "UP", + "policy-received": 0, + "handshake-received": 2, + "handshake-sent": 2, + "alert-received": 0, + "services-sent": 4, + "vdevice-host-name": "vm3", + "inform-received": 14, + "vdevice-dataKey": "169.254.10.10--", + "tlocs-installed": 10, + "services-installed": 0, + "ompuptime": "9:11:16:34", + "services-received": 2, + "lastupdated": 1645494228477, + "routes-sent": 4, + "hello-sent": 81479, + "routes-installed": 8, + "adminstate": "UP" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/synced/peers": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OP session list", + "operationId": "createSyncedOMPSessionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OP session list": { + "description": "OP session list", + "value": { + "data": [ + { + "domain-id": 1, + "vdevice-name": "172.16.255.11", + "createTimeStamp": 1646804055895, + "refresh": "supported", + "site-id": 100, + "type": "vsmart", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11-172.16.255.19-vsmart", + "@rid": 568, + "vmanage-system-ip": "172.16.255.11", + "peer": "172.16.255.19", + "legit": "yes", + "lastupdated": 1646804055844, + "region-id": "None", + "state": "up" + }, + { + "domain-id": 1, + "vdevice-name": "172.16.255.11", + "createTimeStamp": 1646804061584, + "refresh": "supported", + "site-id": 200, + "type": "vsmart", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11-172.16.255.20-vsmart", + "@rid": 574, + "vmanage-system-ip": "172.16.255.11", + "peer": "172.16.255.20", + "legit": "yes", + "lastupdated": 1646804055844, + "region-id": "None", + "state": "up" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/tlocs/advertised": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get advertised TLOCs list (Real Time)", + "operationId": "createAdvertisedTlocsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Advertised TLOCs list": { + "description": "Advertised TLOCs list", + "value": { + "data": [ + { + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.2", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "weight": "1", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.3.3", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.3.3", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", + "tloc-private-port": "12406", + "tloc-spi": "286", + "lastupdated": 1643179953349, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4", + "to-peer": "172.16.253.129" + }, + { + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.2", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "weight": "1", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.3.3", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.3.3", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", + "tloc-private-port": "12406", + "tloc-spi": "286", + "lastupdated": 1643179953351, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4", + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/tlocs/received": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get received TLOCs list (Real Time)", + "operationId": "createReceivedTlocsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Received TLOCs list": { + "description": "Received TLOCs list", + "value": { + "data": [ + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.1", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.253.129", + "weight": "1", + "encap": "ipsec", + "site-id": "2", + "originator": "172.16.254.1", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.2.2", + "tloc-public-port": "12386", + "tloc-private-ip": "10.101.2.2", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.1", + "tloc-private-port": "12386", + "tloc-spi": "263", + "lastupdated": 1643185163270, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.2", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "0.0.0.0", + "weight": "1", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.3.3", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.3.3", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", + "tloc-private-port": "12406", + "tloc-spi": "287", + "lastupdated": 1643185163276, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.3", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.255.130", + "weight": "1", + "encap": "ipsec", + "site-id": "4", + "originator": "172.16.254.3", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.4.4", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.4.4", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.3", + "tloc-private-port": "12406", + "tloc-spi": "284", + "lastupdated": 1643185163281, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.4", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.255.130", + "weight": "1", + "encap": "ipsec", + "site-id": "5", + "originator": "172.16.254.4", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.102.5.5", + "tloc-public-port": "12406", + "tloc-private-ip": "10.102.5.5", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.4", + "tloc-private-port": "12406", + "tloc-spi": "288", + "lastupdated": 1643185163286, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.5", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.253.129", + "weight": "1", + "encap": "ipsec", + "site-id": "6", + "originator": "172.16.254.5", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.102.6.6", + "tloc-public-port": "12406", + "tloc-private-ip": "10.102.6.6", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.5", + "tloc-private-port": "12406", + "tloc-spi": "292", + "lastupdated": 1643185163290, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.16", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.253.129", + "weight": "1", + "encap": "ipsec", + "site-id": "16", + "originator": "172.16.254.16", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.102.16.16", + "tloc-public-port": "12406", + "tloc-private-ip": "10.102.16.16", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.16", + "tloc-private-port": "12406", + "tloc-spi": "287", + "lastupdated": 1643185163295, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/ondemand/local": { + "get": { + "tags": [ + "Real-Time Monitoring - Show On Demand Local" + ], + "description": "Get on-demand local (Real Time)", + "operationId": "getOnDemandLocal", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "On Demand Local list": { + "description": "On Demand Local list", + "value": { + "data": [ + { + "status": "-", + "site-id": "5", + "on-demand": "no", + "lastupdated": 1642667823842, + "idle-timeout-expiry": "10", + "vdevice-dataKey": "169.254.10.12-", + "vdevice-host-name": "vm5", + "vdevice-name": "169.254.10.12", + "system-ip": "172.16.254.4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ondemand/remote": { + "get": { + "tags": [ + "Real-Time Monitoring - Show On Demand Remote" + ], + "description": "Get on-demand remote (Real Time)", + "operationId": "getOnDemandRemote", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "On Demand Remote list": { + "description": "On Demand Remote list", + "value": { + "data": [ + { + "status": "-", + "site-id": "3", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.2" + }, + { + "status": "-", + "site-id": "4", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.3" + }, + { + "status": "-", + "site-id": "5", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.4" + }, + { + "status": "-", + "site-id": "6", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.5" + }, + { + "status": "-", + "site-id": "16", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/orchestrator/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get connection list from device", + "operationId": "createConnectionListFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection list": { + "description": "Connection list", + "value": { + "data": [ + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 100, + "local-color": "default", + "uptime": "1:23:51:47", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.19", + "state": "up", + "private-port": 12355, + "public-port": 12355, + "public-ip": "10.0.5.19", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.19", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.19" + }, + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 100, + "local-color": "default", + "uptime": "1:23:51:46", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.19", + "state": "up", + "private-port": 12455, + "public-port": 12455, + "public-ip": "10.0.5.19", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.19", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.19" + }, + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 200, + "local-color": "default", + "uptime": "1:23:51:47", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.20", + "state": "up", + "private-port": 12356, + "public-port": 12356, + "public-ip": "10.0.12.20", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.12.20", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.20" + }, + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 200, + "local-color": "default", + "uptime": "1:23:51:46", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.20", + "state": "up", + "private-port": 12456, + "public-port": 12456, + "public-ip": "10.0.12.20", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.12.20", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.20" + }, + { + "domain-id": 0, + "site-id": 200, + "local-color": "default", + "uptime": "1:23:51:45", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vmanage-172.16.255.22", + "state": "up", + "private-port": 12346, + "public-port": 12346, + "public-ip": "10.0.12.22", + "uptime-date": 1649589180000, + "peer-type": "vmanage", + "vdevice-host-name": "vm16", + "private-ip": "10.0.12.22", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.22" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/connectionshistory": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get connection history list from device", + "operationId": "createConnectionHistoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection history list": { + "description": "Connection history list", + "value": { + "data": [ + { + "remote-color": "default", + "index": 0, + "site-id": 500, + "public-port": 12386, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "default", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-0-2022-04-10T12:23:23+0000", + "state": "up", + "domain-id": 1, + "private-port": 12386, + "public-ip": "10.1.15.15", + "downtime": "2022-04-10T12:23:23+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.1.15.15", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "default", + "index": 1, + "site-id": 100, + "public-port": 12386, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "default", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-1-2022-04-10T11:48:32+0000", + "state": "up", + "domain-id": 1, + "private-port": 12386, + "public-ip": "10.0.5.11", + "downtime": "2022-04-10T11:48:32+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.11", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "default", + "index": 2, + "site-id": 0, + "public-port": 12387, + "peer-type": "unknown", + "local_enum": "DHSTMO", + "rep-count": 0, + "local-color": "default", + "remote_enum": "NOERR", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-2-2022-04-10T11:48:21+0000", + "state": "connect", + "domain-id": 0, + "private-port": 0, + "public-ip": "10.0.5.11", + "downtime": "2022-04-10T11:48:21+0000", + "vdevice-host-name": "vm16", + "private-ip": "::", + "remote_enum-desc": "NoError.", + "local_enum-desc": "DTLSHandShakeTimeout.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "lte", + "index": 3, + "site-id": 600, + "public-port": 12366, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "lte", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-3-2022-04-10T11:13:44+0000", + "state": "up", + "domain-id": 1, + "private-port": 12366, + "public-ip": "10.1.16.16", + "downtime": "2022-04-10T11:13:44+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.1.16.16", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "lte", + "index": 4, + "site-id": 100, + "public-port": 12377, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "lte", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-4-2022-04-10T11:13:41+0000", + "state": "up", + "domain-id": 1, + "private-port": 12377, + "public-ip": "10.0.5.21", + "downtime": "2022-04-10T11:13:41+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.21", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/localproperties": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get local properties list from device", + "operationId": "createLocalPropertiesListList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Local properties list": { + "description": "Local properties list", + "value": { + "data": [ + { + "certificate-not-valid-before": "Apr1010:34:032022GMT", + "certificate-status": "Installed", + "protocol": "dtls", + "uuid": "0a3c20df-82d6-43d4-b27f-a67864d35950", + "root-ca-chain-status": "Installed", + "certificate-not-valid-after": "Apr1010:34:032023GMT", + "sp-organization-name": "vIPtelaIncRegression", + "lastupdated": 1649766458903, + "certificate-validity": "Valid", + "vdevice-dataKey": "172.16.255.26", + "vedge-list-version": "0", + "number-active-wan-interfaces": "1", + "system-ip": "172.16.255.26", + "organization-name": "vIPtelaIncRegression", + "vdevice-host-name": "vm16", + "device-type": "vbond", + "vdevice-name": "172.16.255.26", + "vsmart-list-version": "0", + "board-serial": "12346571" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/proxymapping": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get reverse proxy mapping from vbond", + "operationId": "createReverseProxyMappingList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reverse proxy mapping": { + "description": "Reverse proxy mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/orchestrator/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get statistics from device", + "operationId": "getStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics": { + "description": "Statistics", + "value": { + "data": [ + { + "tx_challenge_ack": 13, + "tx_registers": 0, + "rx_pkts": 168816, + "tx_error": 0, + "vdevice-dataKey": "172.16.255.26", + "tx_challenge": 15, + "rx_challenge_ack": 0, + "tx_dtls_handshake_done": 0, + "vdevice-host-name": "vm16", + "tx_dtls_handshake_failures": 0, + "tx_challenge_gen_error": 0, + "rx_connects": 0, + "rx_octets": 42608317, + "rx_registers": 64644, + "lastupdated": 1649768154244, + "rx_challenge_resp": 15, + "tx_register_replies": 64644, + "tx_challenge_ack_error": 0, + "rx_challenge": 0, + "tx_dtls_handshake": 0, + "rx_dtls_handshake_done": 15, + "rx_dtls_handshake_failures": 0, + "rx_error": 0, + "challenge_failures": 2, + "tx_challenge_resp_error": 0, + "vdevice-name": "172.16.255.26", + "tx_blocked": 0, + "tx_connects": 64671, + "tx_octets": 63147501, + "tx_challenge_error": 0, + "rx_register_replies": 0, + "tx_challenge_resp": 0, + "tx_pkts": 242150, + "rx_dtls_handshake": 70 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get connection summary from device", + "operationId": "createConnectionSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection summary": { + "description": "Connection summary", + "value": { + "data": [ + { + "protocol": "dtls", + "listening_port": 12346, + "listening_ip": "0.0.0.0", + "vsmart_counts": 4, + "vmanage_counts": 2, + "lastupdated": 1649816906161, + "instance": 0, + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-0", + "listening_ipv6": "::", + "vedge_counts": 0, + "vdevice-name": "172.16.255.26" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/validvedges": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get valid device list from device", + "operationId": "createValidDevicesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Valid device list": { + "description": "Valid device list", + "value": { + "data": [ + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-1BFB0237-AFCA-4583-BF0C-BECD124565D6-12346572", + "serial-number": "12346572", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "1BFB0237-AFCA-4583-BF0C-BECD124565D6", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-33418D3F-286E-4256-A7CB-7BF3A70E1ED8-12346570", + "serial-number": "12346570", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "33418D3F-286E-4256-A7CB-7BF3A70E1ED8", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-4D0318BF-472E-4114-B72D-A5E99C5AFAD7-12346580", + "serial-number": "12346580", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "4D0318BF-472E-4114-B72D-A5E99C5AFAD7", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-ADC329CC-701C-42D6-84C6-245F09C25583-12346578", + "serial-number": "12346578", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "ADC329CC-701C-42D6-84C6-245F09C25583", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E-12346575", + "serial-number": "12346575", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E", + "vdevice-name": "172.16.255.26" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/validvmanageid": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get valid vManage Id from device", + "operationId": "getValidVManageId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Valid vManage Id": { + "description": "Valid vManage Id", + "value": { + "data": [ + { + "chassis-number": "a52d3492-755a-4a02-9a3d-8bdf2dc1d241", + "vdevice-dataKey": "172.16.255.26-", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649823209136, + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/validvsmarts": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get valid vSmart list from device", + "operationId": "createValidVSmartsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Valid vSmart list": { + "description": "Valid vSmart list", + "value": { + "data": [ + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-12346567", + "serial-number": "12346567", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649824251432 + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-12346569", + "serial-number": "12346569", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649824251432 + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-12346573", + "serial-number": "12346573", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649824251432 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/ospf/database": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF database list from device (Real Time)", + "operationId": "createOSPFDatabaseList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF database list": { + "description": "OSPF database list", + "value": { + "data": [ + { + "area": 0, + "link-id": "172.16.255.11", + "data": "10.2.2.11", + "vdevice-name": "172.16.255.11", + "link-count": "1", + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.11", + "lsa-type": "router", + "router-link-id": "10.2.2.12", + "router-link-type": "transit", + "sequence": "2147483652", + "vdevice-dataKey": "172.16.255.11-1-0", + "checksum": "50110", + "lastupdated": 1646791144576, + "tos-metric": "10", + "age": "153" + }, + { + "area": 0, + "link-id": "172.16.255.12", + "data": "10.2.2.12", + "vdevice-name": "172.16.255.11", + "link-count": "2", + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.12", + "lsa-type": "router", + "router-link-id": "10.2.2.12", + "router-link-type": "transit", + "sequence": "2147483655", + "vdevice-dataKey": "172.16.255.11-1-0", + "checksum": "52821", + "lastupdated": 1646791144576, + "tos-metric": "10", + "age": "153" + }, + { + "area": 0, + "link-id": "172.16.255.21", + "data": "10.2.3.21", + "vdevice-name": "172.16.255.11", + "link-count": "1", + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.21", + "lsa-type": "router", + "router-link-id": "10.2.3.21", + "router-link-type": "transit", + "sequence": "2147483651", + "vdevice-dataKey": "172.16.255.11-1-0", + "checksum": "8760", + "lastupdated": 1646791144576, + "tos-metric": "10", + "age": "154" + }, + { + "area": 0, + "sequence": "2147483649", + "link-id": "10.2.2.12", + "vdevice-dataKey": "172.16.255.11-1-0", + "vdevice-name": "172.16.255.11", + "checksum": "63980", + "lastupdated": 1646791144576, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.12", + "age": "154", + "lsa-type": "network" + }, + { + "area": 0, + "sequence": "2147483649", + "link-id": "10.2.3.21", + "vdevice-dataKey": "172.16.255.11-1-0", + "vdevice-name": "172.16.255.11", + "checksum": "59106", + "lastupdated": 1646791144576, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.21", + "age": "155", + "lsa-type": "network" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/databaseexternal": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF external database list from device (Real Time)", + "operationId": "createOSPFDatabaseExternal", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF external database list": { + "description": "OSPF external database list", + "value": { + "data": [ + { + "link-id": "10.20.25.0", + "options-flags": "EDN", + "vdevice-name": "172.16.255.11", + "prefix": "10.20.25.0/24", + "metric-type": "type2", + "length": 36, + "flags": 11, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.11", + "forwarding-addr": "0.0.0.0", + "sequence": 2147483650, + "vdevice-dataKey": "172.16.255.11-1-10.20.25.0", + "metric": "16777214", + "checksum": 62048, + "options": 130, + "lastupdated": 1646791949860, + "tag": 0, + "age": 958 + }, + { + "link-id": "10.20.25.0", + "options-flags": "EDN", + "vdevice-name": "172.16.255.11", + "prefix": "10.20.25.0/24", + "metric-type": "type2", + "length": 36, + "flags": 6, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.21", + "forwarding-addr": "0.0.0.0", + "sequence": 2147483650, + "vdevice-dataKey": "172.16.255.11-1-10.20.25.0", + "metric": "16777214", + "checksum": 46738, + "options": 130, + "lastupdated": 1646791949860, + "tag": 0, + "age": 959 + }, + { + "link-id": "172.16.255.112", + "options-flags": "E", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.112/32", + "metric-type": "type2", + "length": 36, + "flags": 6, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.12", + "forwarding-addr": "0.0.0.0", + "sequence": 2147483651, + "vdevice-dataKey": "172.16.255.11-1-172.16.255.112", + "metric": "20", + "checksum": 58083, + "options": 2, + "lastupdated": 1646791949860, + "tag": 0, + "age": 958 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/databasesummary": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF database summary list from device (Real Time)", + "operationId": "createOSPFDatabaseSummaryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF database summary list": { + "description": "OSPF database summary list", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11-1-0", + "router-lsa": 3, + "total-lsa": 5, + "vdevice-name": "172.16.255.11", + "summary-lsa": 0, + "nssa-lsa": 0, + "network-lsa": 2, + "lastupdated": 1646792331519, + "area-id": 0, + "vpn-id": 1, + "asbr-summary-lsa": 0, + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF interface list from device (Real Time)", + "operationId": "createOSPFInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF interface list": { + "description": "OSPF interface list", + "value": { + "data": [ + { + "lastupdated": 1646026461327, + "vdevice-dataKey": "169.254.10.14-0-1--", + "vdevice-name": "169.254.10.14", + "router-id": "0", + "vdevice-host-name": "vm16", + "instance-id": "1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/neighbor": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF neighbor list from device (Real Time)", + "operationId": "createOSPFNeighbors", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF neighbor list": { + "description": "OSPF neighbor list", + "value": { + "data": [ + { + "lastupdated": 1646027273671, + "vdevice-dataKey": "169.254.10.14-0-1---", + "vdevice-name": "169.254.10.14", + "router-id": "0", + "vdevice-host-name": "vm16", + "instance-id": "1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/process": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF process list from device (Real Time)", + "operationId": "createOSPFProcess", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF process list": { + "description": "OSPF process list", + "value": { + "data": [ + { + "ls-ack-sent": "5", + "summary-lsa-checksum": "0", + "vdevice-name": "172.16.255.11", + "spf-max-holdtime": "10000", + "spf-holdtime": "1000", + "number-areas": "1", + "rfc1583-compatible": "true", + "lsa-count": "5", + "external-lsa-checksum": "166869", + "router-id": "172.16.255.11", + "hello-received": "172", + "ignore-down-bit": "false", + "area-id": "0", + "dbd-received": "2", + "network-lsa-checksum": "123086", + "summary-lsa-count": "0", + "router-lsa-count": "3", + "router-lsa-checksum": "111691", + "spf-delay": "200", + "spf-hold-multiplier": "1", + "external-lsa-count": "3", + "ls-ack-received": "5", + "asbr-lsa-count": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "spf-last-exec-time": "1663", + "backbone-area": "true", + "network-lsa-count": "2", + "ls-req-sent": "1", + "asbr-lsa-checksum": "0", + "dbd-sent": "3", + "vdevice-dataKey": "172.16.255.11-1-", + "lsa-refresh-interval": "10", + "ls-upd-received": "12", + "nssa-lsa-count": "0", + "ls-req-received": "1", + "num-full-adj-routers": "1", + "spf-exec-count": "3", + "lastupdated": 1646792665279, + "ls-upd-sent": "8", + "nssa-lsa-checksum": "0", + "hello-sent": "172", + "num-interfaces": "1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/routes": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF route list from device (Real Time)", + "operationId": "createOSPFRoutesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF route list": { + "description": "OSPF route list", + "value": { + "data": [ + { + "cost": "10", + "dest-type": "router", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.12/32", + "flags": "2", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-router-172.16.255.12/32-0", + "route-type": "router", + "lastupdated": 1646793742274, + "area-id": "0", + "next-hop": "10.2.2.12", + "path-type": "intra-area" + }, + { + "cost": "20", + "dest-type": "router", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.21/32", + "flags": "2", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-router-172.16.255.21/32-0", + "route-type": "router", + "lastupdated": 1646793742276, + "area-id": "0", + "next-hop": "10.2.2.12", + "path-type": "intra-area" + }, + { + "cost": "10", + "dest-type": "network", + "vdevice-name": "172.16.255.11", + "prefix": "10.2.2.0/24", + "flags": "0", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-network-10.2.2.0/24-0", + "route-type": "network", + "lastupdated": 1646793742276, + "area-id": "0", + "next-hop": "0.0.0.0", + "path-type": "intra-area" + }, + { + "cost": "20", + "dest-type": "network", + "vdevice-name": "172.16.255.11", + "prefix": "10.2.3.0/24", + "flags": "0", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-network-10.2.3.0/24-0", + "route-type": "network", + "lastupdated": 1646793742276, + "area-id": "0", + "next-hop": "10.2.2.12", + "path-type": "intra-area" + }, + { + "dest-type": "network", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.112/32", + "flags": "78", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "type2-cost": "20", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-external-172.16.255.112/32-0", + "route-type": "external", + "lastupdated": 1646793742276, + "tag": "0", + "next-hop": "10.2.2.12", + "path-type": "external2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/v3interface": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF v3 interface list from device (Real Time)", + "operationId": "createOSPFv3Interface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF v3 interface list": { + "description": "OSPF v3 interface list", + "value": { + "data": [ + { + "router-id": "90.90.90.90", + "af": "ospfv3-address-family-ipv4", + "area-id": "300", + "lastupdated": 1649681917917, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300-", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "router-id": "100.100.5.101", + "af": "ospfv3-address-family-ipv6", + "area-id": "300", + "lastupdated": 1649681917917, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300-", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/v3neighbor": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF v3 neighbor list from device (Real Time)", + "operationId": "createOSPFv3Neighbors", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF v3 neighbor list": { + "description": "OSPF v3 neighbor list", + "value": { + "data": [ + { + "router-id": "90.90.90.90", + "af": "ospfv3-address-family-ipv4", + "area-id": "300", + "lastupdated": 1649682289885, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300--", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "router-id": "100.100.5.101", + "af": "ospfv3-address-family-ipv6", + "area-id": "300", + "lastupdated": 1649682289885, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300--", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM interface list from device", + "operationId": "createPIMInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM interface list": { + "description": "PIM interface list", + "value": { + "data": [ + { + "if-name": "ge0/0", + "dr-address": "100.100.3.101", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "if-addr": "100.100.3.101/24", + "neighbor-count": 0, + "hello-interval": 30, + "lastupdated": 1643258686605, + "join-prune-interval": 60, + "vpn-id": "10", + "priority": 1, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/neighbor": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM neighbor list from device", + "operationId": "createPIMNeighborList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM neighbor list": { + "description": "PIM neighbor list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/rp-mapping": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM Rp-mapping list from device", + "operationId": "createPIMRpMappingList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM Rp-mapping list": { + "description": "PIM Rp-mapping list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM statistics list from device", + "operationId": "createPIMStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM statistics list": { + "description": "PIM statistics list", + "value": { + "data": [ + { + "hello-rx": 0, + "unknown-rx": 0, + "vdevice-name": "169.254.10.10", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "bad-rx": 0, + "join-prune-tx": 0, + "vdevice-dataKey": "169.254.10.10", + "join-prune-rx": 0, + "auto-rp-mapping-rx": 0, + "unsupported-rx": 0, + "lastupdated": 1643259067333, + "assert-rx": 0, + "auto-rp-announce-rx": 0, + "assert-tx": 0, + "hello-tx": 1090 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policer": { + "get": { + "tags": [ + "Real-Time Monitoring - Policer" + ], + "description": "Get policed interface list from device", + "operationId": "getPolicedInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policed interface": { + "description": "Policed interface", + "value": { + "data": [ + { + "oos-bytes": "0", + "oos-action": "drop", + "vdevice-dataKey": "169.254.10.10-10", + "vdevice-name": "169.254.10.10", + "rate": 81920, + "oos-pkts": "0", + "name": "TCPOPT_SYN_POLICER", + "index": 10, + "lastupdated": 1643264577448, + "burst": 10240, + "vdevice-host-name": "vm3", + "direction": "in" + }, + { + "oos-bytes": "0", + "oos-action": "drop", + "vdevice-dataKey": "169.254.10.10-11", + "vdevice-name": "169.254.10.10", + "rate": 100000000, + "oos-pkts": "0", + "name": "TCPOPT_DATA_POLICER", + "index": 11, + "lastupdated": 1643264577448, + "burst": 12500000, + "vdevice-host-name": "vm3", + "direction": "in" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistassociations": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list associations from device", + "operationId": "createPolicyAccessListAssociations", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistcounters": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list counter from device", + "operationId": "createPolicyAccessListCounters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list counter": { + "description": "Access list counter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistnames": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list names from device", + "operationId": "createPolicyAccessListNames", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list names": { + "description": "Access list names", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistpolicers": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list policers from device", + "operationId": "createPolicyAccessListPolicers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list policers": { + "description": "Access list policers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/approutepolicyfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get approute policy filter from device", + "operationId": "createPolicyAppRoutePolicyFilter", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Approute policy filter": { + "description": "Approute policy filter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/datapolicyfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get data policy filters from device", + "operationId": "createPolicDataPolicyFilter", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Data policy filter": { + "description": "Data policy filter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/filtermemoryusage": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get data policy filter memory usage from device", + "operationId": "createPolicyFilterMemoryUsage", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Data policy filter memory usage": { + "description": "Data policy filter memory usage", + "value": { + "data": [ + { + "filter-max": "512", + "vdevice-dataKey": "169.254.10.10-0", + "vdevice-name": "169.254.10.10", + "blocks-used": "0", + "blocks-max": "1048576", + "filter-used": "0", + "lastupdated": 1643266183894, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/iptouserbindings": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show ip to user binding from Vsmart", + "operationId": "showVsmartIptoUserBinding", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistassociations": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list associations from device", + "operationId": "createPolicyAccessListAssociationsIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistcounters": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list counters from device", + "operationId": "createPolicyAccessListCountersIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list counters": { + "description": "Access list counters", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistnames": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list names from device", + "operationId": "createPolicyAccessListNamesIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list names": { + "description": "Access list names", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistpolicers": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list policers from device", + "operationId": "createPolicyAccessListPolicersIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list policers": { + "description": "Access list policers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/pxgridstatus": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show Pxgrid status From Vsmart", + "operationId": "showVsmartPxGridStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/pxgridusersessions": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show Pxgrid sessions From Vsmart", + "operationId": "showVsmartPxGridUserSessions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/qosmapinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get QoS map information from device", + "operationId": "createPolicQosMapInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "QoS map information": { + "description": "QoS map information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/qosschedulerinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get QoS scheduler information from device", + "operationId": "createPolicQosSchedulerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "QoS scheduler information": { + "description": "QoS scheduler information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/rewriteassociations": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get rewrite associations information from device", + "operationId": "createPolicyRewriteAssociationsInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Rewrite associations information": { + "description": "Rewrite associations information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/userusergroupbindings": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Show User-Usergroup bindings from Vsmart", + "operationId": "showVsmartUserUsergroupBindings", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": [ + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:Employee", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser0" + }, + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:TestUserGroup-1", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser0" + }, + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:Employee", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser1" + }, + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:TestUserGroup-1", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser1" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/vsmart": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show Sdwan Policy From Vsmart", + "operationId": "showSdwanPolicyFromVsmart", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zbfwdropstatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone drop statistics from device", + "operationId": "getZoneDropStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone drop statistics": { + "description": "Zone drop statistics", + "value": { + "data": [ + { + "l4-tcp-l7-ooo-seg": "0", + "l4-icmp-err-l4-invalid-seq": "0", + "policy-action-drop": "0", + "l4-icmp-err-no-ip-no-icmp": "0", + "l7-type-drop": "0", + "l4-scb-close": "0", + "l4-tcp-invalid-seg-synsent-state": "0", + "l4-tcp-syn-flood-drop": "0", + "l4-icmp-internal-err-no-nat": "0", + "l4-tcp-invalid-seq": "0", + "l7-no-seg": "0", + "no-new-session": "0", + "l4-icmp-internal-err-get-stat-blk-fail": "0", + "syncookie-max-dst": "0", + "insp-internal-err-get-stat-blk-fail": "0", + "l4-invalid-hdr": "0", + "l4-icmp-internal-err-alloc-fail": "0", + "l4-tcp-invalid-seg-pkt-win-overflow": "0", + "no-forwarding-zone": "0", + "l4-icmp-too-many-err-pkts": "0", + "fdb-err": "0", + "no-session": "0", + "insp-dstaddr-lookup-fail": "0", + "l4-session-limit": "0", + "insp-class-action-drop": "0", + "l4-tcp-rst-to-resp": "0", + "l4-tcp-stray-seg": "0", + "not-initiator": "0", + "backpressure": "0", + "l4-tcp-invalid-tcp-initiator": "0", + "l4-icmp-pkt-too-short": "0", + "zone-mismatch": "0", + "l4-tcp-unexpect-tcp-payload": "0", + "l7-no-frag": "0", + "l4-tcp-invalid-seg-pyld-after-fin-send": "0", + "l4-icmp-err-policy-not-present": "0", + "l7-alg-ret-drop": "0", + "l4-tcp-internal-err-synflood-alloc-hostdb-fail": "0", + "insp-classification-fail": "0", + "l4-tcp-invalid-win-scale-option": "0", + "l4-tcp-syn-in-win": "0", + "policy-icmp-action-drop": "0", + "vdevice-name": "169.254.10.12", + "lisp-inner-ipv6-insane": "0", + "l4-tcp-rst-in-win": "0", + "l4-tcp-retrans-invalid-flags": "0", + "catch-all": "0", + "l4-icmp-err-l4-invalid-ack": "0", + "syncookie-trigger": "0", + "l7-unknown-proto": "0", + "l4-tcp-syn-with-data": "0", + "l4-tcp-invalid-seg-pkt-too-old": "0", + "l4-icmp-err-classification-fail": "0", + "l4-icmp-internal-err-dir-not-identified": "0", + "l4-internal-err-undefined-dir": "0", + "insp-policy-not-present": "0", + "syncookie-internal-err-alloc-fail": "0", + "lisp-header-restore-fail": "0", + "l4-tcp-synflood-blackout-drop": "0", + "l4-tcp-invalid-ack-flag": "0", + "insp-pam-lookup-fail": "0", + "l4-icmp-scb-close": "0", + "invalid-zone": "0", + "ha-ar-standby": "0", + "vdevice-host-name": "vm5", + "l4-tcp-invalid-seg-synrcvd-state": "0", + "l4-tcp-invalid-ack-num": "0", + "l7-promote-fail-no-policy": "0", + "l4-too-many-pkts": "0", + "l4-icmp-err-pkts-burst": "0", + "l7-promote-fail-no-zone-pair": "0", + "vdevice-dataKey": "169.254.10.12-0", + "l4-icmp-err-multiple-unreach": "0", + "policy-fragment-drop": "0", + "l4-tcp-invalid-flags": "0", + "lisp-inner-ipv4-insane": "0", + "lastupdated": 1645666649064, + "l4-max-halfsession": "0", + "insp-sess-miss-policy-not-present": "0", + "l4-icmp-pkt-no-ip-hdr": "0", + "insp-policy-misconfigure": "0", + "lisp-inner-pkt-insane": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zbfwstatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone based firewall statistics from device", + "operationId": "getZbfwStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone based firewall statistics": { + "description": "Zone based firewall statistics", + "value": { + "data": [ + { + "no-pair-diff-zone-dropped": "0", + "tcp-retrans-seg": "0", + "flow-add-fail": "0", + "vdevice-name": "169.254.10.10", + "tcp-drop-stray-seg": "0", + "tcp-drop-invalid-seg-pkt-too-old": "0", + "zbf-pkts": "0", + "state-check-fail": "0", + "unsupported-proto": "0", + "no-pair-same-zone-allowed": "0", + "zone-no-zone-inet-denied": "0", + "tcp-drop-invalid-seg-synsent-state": "0", + "max-halfopen-exceeded": "0", + "tcp-drop-invalid-flags": "0", + "tcp-drop-unexpect-tcp-pyld": "0", + "num-flow-entries": "0", + "tcp-ooo-seg": "0", + "tcp-drop-invalid-seg-synrcvd-state": "0", + "tcp-drop-no-syn-in-listen-state": "0", + "tcp-drop-invalid-ack-flag": "0", + "fragments": "0", + "zone-no-zone-dropped": "0", + "no-zone-no-zone-allowed": "0", + "tcp-drop-invalid-ack-num": "0", + "policy-change-dropped": "0", + "tcp-drop-rst-to-resp": "0", + "tcp-drop-syn-with-data": "0", + "tcp-drop-syn-in-win": "0", + "tcp-drop-invalid-dir": "0", + "tcp-drop-invalid-win-scale-option": "0", + "frag-fail": "0", + "tcp-drop-retrans-invalid-flags": "0", + "tcp-drop-internal-invalid-tcp-state": "0", + "tcp-drop-rst-in-win": "0", + "tcp-drop-invalid-seg-pkt-win-overflow": "0", + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-", + "lastupdated": 1643271305369, + "tcp-drop-invalid-seq": "0", + "zone-no-zone-inet-allowed": "0", + "tcp-drop-invalid-seg-pyld-after-fin-send": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zonepairsessions": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone pair sessions from device", + "operationId": "getZonePairSessions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone pair session": { + "description": "Zone pair session", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zonepairstatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone pair statistics from device", + "operationId": "getZonePairs", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone pair statistics": { + "description": "Zone pair statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zonepolicyfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone policy filter from device", + "operationId": "getZonePolicyFilters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone policy filter": { + "description": "Zone policy filter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ppp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PPP interface list from device (Real Time)", + "operationId": "createPPPInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PPP interface list": { + "description": "PPP interface list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/pppoe/session": { + "get": { + "tags": [ + "Real-Time Monitoring - PPPoE" + ], + "description": "Get PPPoE session list from device", + "operationId": "createPPPoEInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PPPoE session list": { + "description": "PPPoE session list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/pppoe/statistic": { + "get": { + "tags": [ + "Real-Time Monitoring - PPPoE" + ], + "description": "Get PPPoE statistics from device", + "operationId": "createPPPoENeighborList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PPPoE statistics": { + "description": "PPPoE statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/queues": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get synchronized queue information, returns information about syncing, queued and stuck devices", + "operationId": "getSyncQueues", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue status": { + "description": "Queue status", + "value": { + "syncing": [], + "queued": [], + "Stuck": {} + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/reachable": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get list of reachable devices", + "operationId": "listReachableDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of reachable devices": { + "description": "List of reachable devices", + "value": { + "header": { + "generatedOn": 1635230853000, + "viewKeys": { + "uniqueKey": [ + "system-ip" + ], + "preferenceKey": "grid-vManage Control Connections Tenant" + }, + "columns": [ + { + "title": "Reachability", + "property": "reachability", + "colorProperty": "reachability", + "color": [ + { + "key": "reachable", + "value": "616161" + }, + { + "key": "unreachable", + "value": "ef5350" + } + ], + "width": 100, + "minWidth": 90, + "dataType": "string" + }, + { + "title": "Hostname", + "property": "host-name", + "display": "iconAndText", + "iconProperty": "device-type", + "hideable": false, + "icon": [ + { + "key": "vmanage", + "value": "images/vmanage_table.png" + }, + { + "key": "vedge", + "value": "images/vedge_table.png" + } + ], + "width": 150, + "dataType": "string" + } + ], + "fields": [ + { + "property": "status", + "dataType": "string", + "display": "icon" + }, + { + "property": "host-name", + "dataType": "string", + "display": "iconAndText" + } + ] + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/reboothistory": { + "get": { + "tags": [ + "Real-Time Monitoring - Reboot History" + ], + "description": "Get device reboot history", + "operationId": "createRebootHistoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reboot history": { + "description": "Device reboot history", + "value": { + "data": [ + { + "reboot_date_time-date": 1642651714000, + "lastupdated": 1642656685355, + "vdevice-dataKey": "172.16.255.11-2022-01-20T04:08:34+00:00", + "reboot_date_time": "2022-01-20T04:08:34+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,dca" + } + }, + "/device/reboothistory/details": { + "get": { + "tags": [ + "Real-Time Monitoring - Reboot History" + ], + "description": "Get detailed reboot history list", + "operationId": "getRebootHistoryDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detailed device reboot history": { + "description": "Detailed device reboot history", + "value": { + "data": [ + { + "reboot_date_time-date": 1642651714000, + "lastupdated": 1642652319187, + "reboot_date_time": "2022-01-20T04:08:34+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + }, + { + "reboot_date_time-date": 1642656388000, + "lastupdated": 1642656695661, + "reboot_date_time": "2022-01-20T05:26:28+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + }, + { + "reboot_date_time-date": 1642657398000, + "lastupdated": 1642657658587, + "reboot_date_time": "2022-01-20T05:43:18+00:00", + "reboot_reason": "reload", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "reboot_date_time-date": 1642658548000, + "lastupdated": 1642659153477, + "reboot_date_time": "2022-01-20T06:02:28+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write" + } + }, + "/device/reboothistory/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Reboot History" + ], + "description": "Get device reboot history synchronously", + "operationId": "createSyncedRebootHistoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reboot history": { + "description": "Device reboot history", + "value": { + "data": [ + { + "reboot_date_time-date": 1642658548000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T06:02:28+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T06:02:28+00:00", + "createTimeStamp": 1642659153490, + "lastupdated": 1642659153477, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1078 + }, + { + "reboot_date_time-date": 1642651714000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T04:08:34+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T04:08:34+00:00", + "createTimeStamp": 1642652319194, + "lastupdated": 1642652319187, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1086 + }, + { + "reboot_date_time-date": 1642656388000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T05:26:28+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T05:26:28+00:00", + "createTimeStamp": 1642656696210, + "lastupdated": 1642656695661, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1095 + }, + { + "reboot_date_time-date": 1642659874000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T06:24:34+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T06:24:34+00:00", + "createTimeStamp": 1642660158532, + "lastupdated": 1642660158402, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1103 + }, + { + "reboot_date_time-date": 1642659181000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T06:13:01+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T06:13:01+00:00", + "createTimeStamp": 1642659460686, + "lastupdated": 1642659460446, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1104 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write" + } + }, + "/device/roleBasedCounters": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based Counters information from device", + "operationId": "getRoleBasedCounters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based counters information": { + "description": "TrustSec role based counters information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/roleBasedIpv6Counters": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based Ipv6 Counters information from device", + "operationId": "getRoleBasedIpv6Counters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based counters information": { + "description": "TrustSec role based counters information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/roleBasedIpv6Permissions": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based ipv6 Permissions information from device", + "operationId": "getRoleBasedIpv6Permissions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based permissions information": { + "description": "TrustSec role based permissions information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/roleBasedPermissions": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based Permissions information from device", + "operationId": "getRoleBasedPermissions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based permissions information": { + "description": "TrustSec role based permissions information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/roleBasedSgtMap": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based SGT Map information from device", + "operationId": "getRoleBasedSgtMap", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based SGT map information": { + "description": "TrustSec role based SGT map information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/sdwan-global-drop-statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - SDWAN Statistics" + ], + "description": "Get SD-WAN global drop statistics detail from device (Real Time)", + "operationId": "getSDWanGlobalDropStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SD-WAN global drop statistics": { + "description": "SD-WAN global drop statistics", + "value": { + "data": [ + { + "ipv4-acl-lookup-miss-octets": "0", + "ip-ttl-exceeded-pkts": "0", + "unconfigured-mpls-fia-pkts": "0", + "tunnel-pkt-sb-missed-octets": "0", + "lisp-decap-failed-octets": "0", + "sdwan-bfd-octets": "0", + "gre-bad-options-pkts": "0", + "sdwan-data-policy-octets": "0", + "inv-common-preamble-pkts": "0", + "firewall-nonsession-octets": "0", + "bqs-oor-pkts": "0", + "unconfigured-ipv4-fia-pkts": "0", + "perf-lic-policer-lo-octets": "0", + "reass-frag-too-big-octets": "0", + "unsupport-linktype-no-route-pkts": "0", + "lisp-failed-to-punt-dynmaic-eid-config-pkts": "0", + "ipv4-no-adj-pkts": "323", + "sdwan-octets": "0", + "ipv6-acl-octets": "0", + "ipv4-acl-pkts": "0", + "firewall-backpressure-octets": "0", + "ipsec-input-octets": "6185", + "ipv6-adj-drop-pkts": "0", + "lookup-oce-unsupport-linktype-octets": "0", + "ipv6-no-adj-pkts": "6", + "reass-bad-len-octets": "0", + "ipv4-null0-pkts": "0", + "tcp-badfrag-pkts": "0", + "ip-bad-options-pkts": "0", + "reass-bad-len-pkts": "0", + "reass-no-frags-left-pkts": "0", + "reass-timeout-pkts": "0", + "ipv4-no-route-octets": "63122", + "oce-drop-adj-octets": "0", + "sdwan-generic-pkts": "0", + "no-gpm-memory-err-octets": "0", + "lisp-decap-failed-pkts": "0", + "frfab-wred-drop-octets": "0", + "ipsec-ted-indicate-octets": "0", + "lisp-sfltr-pkts": "0", + "tunnel-sec-chk-fail-octets": "0", + "pa-walk-err-pkts": "0", + "loadbalance-null0-pkts": "0", + "hqf-tx-error-octets": "0", + "ipv4mc-extra-replicae-octets": "0", + "ipv4-martian-pkts": "0", + "tcp-octets": "0", + "ipv4-pbr-pkts": "0", + "ipsec-invalid-sa-octets": "0", + "no-mem-octets": "0", + "ipv4-adj-drop-octets": "0", + "glean-adj-unsupport-linktype-octets": "0", + "vdevice-name": "169.254.10.12", + "ipv4-martian-octets": "0", + "identity-cft-error-pkts": "0", + "reass-frag-too-big-pkts": "0", + "lisp-disabled-octets": "0", + "udp-octets": "0", + "multilink-cfg-pkts": "0", + "pa-walk-err-octets": "0", + "bad-adj-octets": "0", + "unconfigured-ipv6-fia-pkts": "51334", + "flow-queue-failure-id-octets": "0", + "multilink-cfg-octets": "0", + "gpm-tx-len-exceed-pkts": "0", + "tunnel-decap-too-many-times-pkts": "0", + "inv-hdr-err-pkts": "0", + "attn-invalid-spid-octets": "0", + "tail-drop-octets": "0", + "tunnel-bad-gre-checksum-octets": "0", + "ipv4mc-ttl-threshold-chk-failed-pkts": "0", + "mpass-err-octets": "0", + "nat-out2in-octets": "0", + "ip-format-err-octets": "0", + "firewall-backpressure-pkts": "0", + "illegal-obj-pkts": "0", + "reass-overlap-octets": "0", + "bad-len-octets": "0", + "tunnel-misconfiguration-pkts": "0", + "reass-too-many-frags-octets": "0", + "punt-global-policer-drop-octets": "0", + "reass-too-many-frags-pkts": "0", + "frr-oce-invalid-state-octets": "0", + "invalid-queue-pkts": "0", + "ipv4mc-extra-replicae-pkts": "0", + "mpls-adj-drop-octets": "0", + "bad-uidb-idx-octets": "0", + "mpass-err-pkts": "0", + "ipv6-truncatedpkts-octets": "0", + "lastupdated": 1645693979596, + "ip-format-err-pkts": "0", + "ipsec-deny-drop-pkts": "0", + "invalid-encap-octets": "0", + "lookup-oce-should-drop-octets": "0", + "lisp-hash-lkup-failed-octets": "0", + "unresolved-octets": "0", + "ipv4-no-route-pkts": "398", + "lisp-failed-to-punt-gsmr-enabled-pkts": "0", + "ipv6-null0-pkts": "0", + "sdwan-bfd-pkts": "0", + "ipv4mc-invalid-replica-record-pkts": "0", + "unconfigured-fia-octets": "0", + "ext-drop-path-octets": "0", + "qos-actions-pkts": "0", + "mpass-invalid-fs-vector-pkts": "0", + "oce-drop-adj-pkts": "0", + "max-tu-octets": "0", + "invalid-encap-pkts": "0", + "mpls-pkts": "0", + "punt-err-pkts": "0", + "hqf-tx-error-pkts": "0", + "reass-drop-octets": "0", + "tail-drop-pkts": "0", + "ip-frag-err-octets": "0", + "punt-policer-drop-pkts": "0", + "mlp-pkts": "0", + "max-tu-pkts": "0", + "lisp-hash-lkup-failed-pkts": "0", + "inv-l2-hdr-pkts": "0", + "ipv4-unclassified-octets": "0", + "lisp-failed-to-punt-lsb-mismatch-pkts": "0", + "nat64-v6tov4-octets": "480", + "lisp-failed-to-punt-gsmr-enabled-octets": "0", + "sdwan-data-policy-pkts": "0", + "bqs-oor-octets": "0", + "ipv4-routing-err-pkts": "0", + "disabled-pkts": "2590", + "cts-format-octets": "0", + "bad-len-pkts": "0", + "ipv6-routing-err-octets": "0", + "illegal-obj-octets": "0", + "ipv6-unclassified-octets": "0", + "bad-uidb-idx-pkts": 0, + "bad-uidb-sub-idx-pkts": "0", + "for-us-pkts": "0", + "icmp-pkts": "0", + "invalid-wred-pkts": "0", + "lisp-elig-oce-octets": "0", + "bfd-octets": "0", + "sdwan-tloc-ext-pkts": "0", + "ipv4-acl-lookup-miss-pkts": "0", + "reass-no-frag-info-octets": "0", + "mpls-adj-drop-pkts": "0", + "sdwan-generic-octets": "0", + "reass-drop-pkts": "0", + "inv-common-preamble-octets": "0", + "bad-ip-checksum-octets": "0", + "ipv6-acl-lookup-miss-pkts": "0", + "reass-no-frag-info-low-pkts": "0", + "frr-oce-no-backup-pkts": "0", + "ipv6-unclassified-pkts": "0", + "mpls-mismatch-linktype-pkts": "0", + "wred-pkts": "0", + "ipv6-badsource-pkts": "0", + "lisp-disabled-pkts": "0", + "choice-oce-octets": "0", + "ipv6-acl-lookup-miss-octets": "0", + "bad-adj-pkts": "0", + "min-tu-octets": "0", + "nat-out2in-pkts": "0", + "unsupport-linktype-null0-octets": "0", + "firewall-invalid-zone-pkts": "0", + "lisp-failed-to-punt-dynmaic-eid-config-octets": "0", + "attn-invalid-spid-pkts": "0", + "not-enabled-octets": "0", + "fia-error-pkts": "0", + "bad-ip-checksum-pkts": "0", + "ipsec-ike-indicate-octets": "0", + "sdwan-app-route-policy-pkts": "0", + "ipv6-toobigpacket-octets": "0", + "ipv6-formaterr-octets": "0", + "ipv4mc-no-route-pkts": "0", + "mpls-frag-req-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "lookup-oce-should-drop-pkts": "0", + "cts-not-enable-octets": "0", + "loadbalance-null0-octets": "0", + "frr-oce-invalid-state-pkts": "0", + "tcp-pkts": "0", + "ipv6-acl-pkts": "0", + "nat-in2out-pkts": "0", + "ipv6-badhop-pkts": "0", + "ipv6-badsource-octets": "0", + "inv-hdr-err-octets": "0", + "tcp-badfrag-octets": "0", + "ipv4-mtr-octets": "0", + "ipsec-ted-indicate-pkts": "0", + "ipsec-output-octets": "0", + "nat66-out2in-octets": "0", + "lisp-misconfiguration-octets": "0", + "ipsec-output-pkts": "0", + "cts-not-enable-pkts": "0", + "mlp-octets": "0", + "qos-actions-octets": "0", + "iphc-octets": "0", + "disabled-octets": "403111", + "unknown-ext-header-pkts": "0", + "mpls-mismatch-linktype-octets": "0", + "ipv6-no-adj-octets": "456", + "fia-error-octets": "0", + "gre-bad-options-octets": "0", + "reass-overlap-pkts": "0", + "vfr-tail-drop-octets": "0", + "sdwan-acl-octets": "0", + "ipv4-null0-octets": "0", + "unresolved-pkts": "0", + "invalid-queue-octets": "0", + "sdwan-implicit-acl-octets": "55011", + "ipv4-routing-err-octets": "0", + "inject-err-pkts": "0", + "punt-policer-drop-octets": "0", + "reass-no-frag-info-low-octets": "0", + "min-tu-pkts": "0", + "ipsec-input-pkts": "17", + "perf-lic-policer-hi-octets": "0", + "mac-acl-lookup-miss-octets": "0", + "ipv6-no-route-pkts": "3", + "cts-format-pkts": "0", + "ipsec-deny-drop-octets": "0", + "ip-bad-options-octets": "0", + "frag-tail-drop-octets": "0", + "frr-oce-no-backup-octets": "0", + "internal-ctl-pkts": "0", + "flow-queue-failure-id-pkts": "0", + "unconfigured-mpls-fia-octets": "0", + "ip-ttl-exceeded-octets": "0", + "unsupported-oce-pkts": "0", + "sdwan-acl-pkts": "0", + "no-gpm-memory-err-pkts": "0", + "perf-lic-policer-hi-pkts": "0", + "nat64-v6tov4-pkts": "6", + "unsupport-linktype-null0-pkts": "0", + "ipv4mc-ttl-threshold-chk-failed-octets": "0", + "glean-adj-unsupport-linktype-pkts": "0", + "firewall-l4-insp-pkts": "0", + "mpass-invalid-fs-vector-octets": "0", + "inv-l2-hdr-octets": "0", + "mpls-frag-req-pkts": "0", + "internal-ctl-octets": "0", + "identity-cft-error-octets": "0", + "sdwan-pkts": "0", + "reass-no-frag-info-pkts": "0", + "mpls-octets": "0", + "sdwan-interface-policy-octets": "0", + "frag-tail-drop-pkts": "0", + "ip-acl-err-octets": "0", + "discard-pkts": "0", + "sdwan-tunnel-lkup-pkts": "0", + "not-enabled-pkts": "0", + "choice-oce-pkts": "0", + "lookup-oce-unsupport-linktype-pkts": "0", + "sdwan-app-route-policy-octets": "0", + "lisp-misconfiguration-pkts": "0", + "bad-uidb-sub-idx-octets": "0", + "reass-timeout-octets": "0", + "tunnel-decap-too-many-times-octets": "0", + "vdevice-host-name": "vm5", + "icmp-octets": "0", + "ipv4-adj-drop-pkts": "0", + "tunnel-invalid-protocol-pkts": "0", + "wred-octets": "0", + "lisp-sfltr-octets": "0", + "ipv6-no-route-octets": "168", + "unconfigured-ipv6-fia-octets": "5564369", + "for-us-octets": "0", + "vfr-tail-drop-pkts": "0", + "frfab-wred-drop-pkts": "0", + "ipsec-invalid-sa-pkts": "0", + "ipv6-null0-octets": "0", + "ipv4-acl-octets": "0", + "firewall-nonsession-pkts": "0", + "ipsec-tail-drop-pkts": "0", + "tunnel-misconfiguration-octets": "0", + "bfd-pkts": "0", + "ipv4mc-invalid-replica-record-octets": "0", + "ip-acl-err-pkts": "0", + "ipsec-ike-indicate-pkts": "0", + "idle-packet-octets": "0", + "unconfigured-ipv4-fia-octets": "0", + "ipv6-toobigpacket-pkts": "0", + "idle-packet-pkts": "0", + "ipv4mc-rpf-failed-pkts": "0", + "ip-frag-err-pkts": "0", + "sdwan-interface-policy-pkts": "0", + "vfr-err-pkts": "0", + "unknown-encap-octets": "0", + "ipv4mc-no-route-octets": "0", + "unsupported-oce-octets": "0", + "unconfigured-fia-pkts": "0", + "sdwan-tloc-ext-octets": "0", + "qos-policing-octets": "0", + "sdwan-implicit-acl-pkts": "607", + "internal-intf-err-pkts": "0", + "firewall-l4-insp-octets": "0", + "mac-acl-octets": "0", + "no-mem-pkts": "0", + "ipv4-mtr-pkts": "0", + "internal-intf-err-octets": "0", + "invalid-wred-octets": "0", + "ipsec-tail-drop-octets": "0", + "lisp-elig-oce-pkts": "0", + "layer2-no-route-pkts": "0", + "ipv6-routing-err-pkts": "0", + "ext-drop-path-pkts": "0", + "unsupport-linktype-no-route-octets": "0", + "mac-acl-lookup-miss-pkts": "0", + "ipv4-fpm-pkts": "0", + "nat-in2out-octets": "0", + "ipv6-adj-drop-octets": "0", + "ipv4-no-adj-octets": "20728", + "ipv4-fpm-octets": "0", + "punt-global-policer-drop-pkts": "0", + "ipv4-pbr-octets": "0", + "nat66-in2out-octets": "0", + "nat66-out2in-pkts": "0", + "nat66-in2out-pkts": "0", + "ipv6-formaterr-pkts": "0", + "vfr-err-octets": "0", + "mac-acl-pkts": "0", + "ipv6-truncatedpkts-pkts": "0", + "tunnel-pkt-sb-missed-pkts": "0", + "qos-policing-pkts": "0", + "gpm-tx-len-exceed-octets": "0", + "layer2-no-route-octets": "0", + "perf-lic-policer-lo-pkts": "0", + "null-jib-hdr-tbl-pkts": "0", + "ipv6-badhop-octets": "0", + "udp-pkts": "0", + "unknown-encap-pkts": "0", + "ipv4-unclassified-pkts": "0", + "tunnel-bad-gre-checksum-pkts": "0", + "tunnel-invalid-protocol-octets": "0", + "reass-no-frags-left-octets": "0", + "tunnel-sec-chk-fail-pkts": "0", + "ipv4mc-rpf-failed-octets": "0", + "lisp-failed-to-punt-lsb-mismatch-octets": "0", + "inject-err-octets": "0", + "iphc-pkts": "0", + "discard-octets": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/sdwan-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - SDWAN Statistics" + ], + "description": "Get SD-WAN statistics detail from device (Real Time)", + "operationId": "getSDWanStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SD-WAN statistics": { + "description": "SD-WAN statistics", + "value": { + "data": [ + { + "ipv4-acl-out-drop-action-drop": "0", + "ipv4-acl-in-drop-action-drop": "0", + "ipv6-acl-in-drop-action-drop": "0", + "ipv4-acl-in-prior-implicit-acl-disallow-drop": "607", + "vdevice-name": "169.254.10.12", + "app-route-sla-strict-drop": "0", + "data-policy-in-drop-action-drop": "0", + "ipv6-acl-in-prior-implicit-acl-disallow-drop": "0", + "data-policy-out-drop-action-drop": "0", + "vdevice-host-name": "vm5", + "ipv4-acl-in-implicit-acl-allow-service-accept": "9484", + "ipv4-acl-out-police-exceed-drop": "0", + "ipv6-acl-out-police-exceed-drop": "0", + "ipv4-acl-in-police-exceed-drop": "0", + "ipv6-acl-in-police-exceed-drop": "0", + "vdevice-dataKey": "169.254.10.12-", + "ipv6-acl-out-drop-action-drop": "0", + "ipv6-acl-in-implicit-acl-allow-service-accept": "0", + "lastupdated": 1645691843259, + "data-policy-in-set-remote-tloc-fail-drop": "0", + "app-route-matched-none-drop": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/security/information": { + "get": { + "tags": [ + "Real-Time Monitoring - Security" + ], + "description": "Get security information from devices", + "operationId": "createSessionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Security information": { + "description": "Security information", + "value": { + "data": [ + { + "authentication-type": "deprecated", + "replay-window": "512", + "rekey": "86400", + "lastupdated": 1642754840126, + "vdevice-dataKey": "169.254.10.12", + "vdevice-host-name": "vm5", + "fips-mode": "Disabled", + "vdevice-name": "169.254.10.12" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/sfp/detail": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP detail", + "operationId": "getDetail", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ge0/0", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/0", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/1", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/2", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/3", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/3", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/4", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/5", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/5", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/6", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/7", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/7", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sfp/diagnostic": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP diagnostic", + "operationId": "getDiagnostic", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ge0/0", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/0", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/1", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/2", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/3", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/3", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/4", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/5", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/5", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/6", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/7", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/7", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sfp/diagnosticMeasurementAlarm": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP diagnostic measurement alarm", + "operationId": "getDiagnosticMeasurementAlarm", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sfp/diagnosticMeasurementValue": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP diagnostic measurement value", + "operationId": "getDiagnosticMeasurementValue", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sig/getSigTunnelList": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "get Sig TunnelList", + "operationId": "getSigTunnelList", + "parameters": [ + { + "name": "pageSize", + "in": "query", + "description": "Page Size", + "schema": { + "type": "string" + } + }, + { + "name": "offset", + "in": "query", + "description": "Page offset", + "schema": { + "type": "string" + } + }, + { + "name": "lastNHours", + "in": "query", + "description": "last n hours", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/getSigTunnelTotal": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "get Sig Tunnel Total coount", + "operationId": "getSigTunnelTotal", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": { + "count": "0" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/tunnelDashboard": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "Get SIG Zscaler tunnels from device", + "operationId": "tunnelDashboard", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/umbrella/tunnels": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "Get SIG Umbrella tunnels from device", + "operationId": "getSigUmbrellaTunnels", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Umbrella tunnels": { + "description": "Sig Umbrella tunnels", + "value": [ + { + "lastupdated": 1649242617635, + "tunnel-if-name": "Tunnel100512", + "tunnel-id": "94075", + "tunnel-name": "128.107.85.118", + "tunnel-state": "active", + "fsm-state": "fsm-state", + "http-resp-code": "200", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "last-http-req": "activate-req", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/zscaler/tunnels": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "Get SIG Zscaler tunnels from device", + "operationId": "getSigZscalerTunnels", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": [ + { + "tunnel-if-name": "Tunnel100512", + "tunnel-fsm-state": "gre-add-tunnel", + "vdevice-name": "172.16.255.15", + "fqdn": "n/a", + "vdevice-host-name": "vm5", + "tunnel-id": "94075", + "last-http-req": "activate-req", + "vdevice-dataKey": "172.16.255.15", + "http-resp-code": "200", + "tunnel-name": "128.107.85.118", + "location-id": "43551040", + "lastupdated": 1649242617635, + "location-fsm-state": "location-init-state" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/smu": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device", + "operationId": "createSmuList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/smu/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device synchronously", + "operationId": "createSyncedSmuList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/software": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device", + "operationId": "getAAAUcreateSoftwareListsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": { + "data": [ + { + "default": "true", + "vdevice-dataKey": "169.254.10.10-20.6.2-432", + "software": true, + "vdevice-name": "169.254.10.10", + "active": "true", + "lastupdated": 1643356263821, + "version": "20.6.2-432", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/software/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device synchronously", + "operationId": "createSyncedSoftwareList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "software": true, + "createTimeStamp": 1647315989838, + "active": "true", + "version": "20.9.999-1787", + "vdevice-host-name": "vm1", + "default": "true", + "vdevice-dataKey": "172.16.255.11-20.9.999-1787", + "@rid": 1084, + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315989833 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/sslproxy/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Sslproxy" + ], + "description": "Get ssl proxy statistics from device", + "operationId": "getSslProxyStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ssl proxy statistics": { + "description": "Ssl proxy statistics", + "value": { + "data": [ + { + "exception": "0", + "app-ocsp-req-int-error": "0", + "decrypt-fail-mode": "0", + "ps-pkt-rec-from-client": "0", + "tot-client-cert-val-req": "0", + "c2s-fin-rec-from-sc": "0", + "tot-req-tls1-1-flows": "0", + "ocsp-stap-unknown-resp": "0", + "tot-failed-renego": "0", + "s2c-fin-rec": "0", + "pc-pkt-rec-from-server": "0", + "s2c-cn-rec": "0", + "c2s-fin-rec": "0", + "tot-client-cert-untrusted": "0", + "c2s-cn-rec-from-sc": "0", + "s2c-cn-rec-from-sc": "0", + "tot-ssl-renego": "0", + "s2c-fin-rec-from-sc": "0", + "drop-mempool-get-fail": "0", + "drop-load-key-packet-fail": "0", + "nodecrypt-unsup-cipher": "0", + "max-conc-non-proxied-conn": "0", + "pc-clr-pkt-rec-from-sc": "0", + "c2s-rst-generated": "0", + "pc-pkt-sent-to-server": "0", + "che-bypass": "0", + "s2c-rst-rec": "0", + "c2s-rst-rec": "0", + "che-pushdown": "0", + "client-ocsp-res": "0", + "ocsp-stap-reqs": "0", + "tot-server-cert-untrusted": "0", + "alert-genrtd-c2s": "0", + "vdevice-name": "169.254.10.12", + "alert-genrtd-s2c": "0", + "pc-rst-rec-from-sc": "0", + "c2s-cn-sent-to-sc": "0", + "lwssl-send-msg-toism-fail": "0", + "c2s-rst-rec-from-sc": "0", + "c2s-fin-sent": "0", + "ps-clr-pkt-to-client": "0", + "s2c-rst-rec-from-sc": "0", + "client-ocsp-reqs": "0", + "tot-ssl-resump-ses-tkt": "0", + "s2c-rst-sent": "0", + "drop-null-ch-buf": "0", + "non-proxied-conn": "0", + "hs-unsupported": "0", + "app-ocsp-good": "0", + "s2c-fin-rec-during-hs": "0", + "drop-inv-evt-in-fsm-state": "0", + "drop-unable-to-get-pr-cert": "0", + "lastupdated": 1645776582193, + "ism-sem-post-failed": "0", + "s2c-fin-rec-after-hs": "0", + "app-ocsp-res": "0", + "c2s-rst-sent-to-sc": "0", + "s2c-rst-sent-to-sc": "0", + "app-ocsp-unknown": "0", + "c2s-cn-rec": "0", + "ism-flow-create-fail": "0", + "c2s-cn-sent": "0", + "s2c-cn-sent": "0", + "ps-clr-pkt-rec-from-sc": "0", + "tot-client-cert-val-succes": "0", + "pc-pkt-rec-from-sc": "0", + "rm-session-alloc-success": "0", + "unsup-ssl-version": "0", + "ps-pkt-sent-to-sc": "0", + "alert-recvd-c2s": "0", + "alert-recvd-s2c": "0", + "endpoint-alert": "0", + "mem-alloc-fail": "0", + "ocsp-stap-valid-resp": "0", + "client-ocsp-revoked": "0", + "min-tls-version": "0", + "ssl-parse-failure": "0", + "s2c-fin-rec-non-ssl": "0", + "ism-flow-create": "0", + "rm-session-alloc-failures": "0", + "ps-lwssl-flow-delete": "0", + "drop-ssl-parse-abort": "0", + "drop-unsup-prot-vers": "0", + "tot-select-tls1-1-flows": "0", + "client-ocsp-failures": "0", + "pc-clr-pkt-rec-from-server": "0", + "pc-clr-pkt-sent-to-sc": "0", + "c2s-pkt-drop-deny-verdict": "0", + "decrypt-untrusted-cert": "0", + "peer-pd": "0", + "tot-server-cert-expired": "0", + "vdevice-dataKey": "169.254.10.12", + "pc-fin-rec-from-sc": "0", + "drop-untrusted-cert": "0", + "ocsp-stap-resp": "0", + "tcp-close-before-hs": "0", + "nodecrypt-unsup-prot-vers": "0", + "c2s-fin-rec-non-ssl": "0", + "tot-select-tls1-0-flows": "0", + "s2c-pkt-drop-deny-verdict": "0", + "c2s-fin-sent-to-sc": "0", + "s2c-fin-sent-to-sc": "0", + "client-ocsp-req-int-error": "0", + "client-ocsp-unknown": "0", + "app-ocsp-timeout": "0", + "tot-full-ssl-hs": "0", + "rm-session-free-success": "0", + "tot-req-sslv2-flows": "0", + "ps-cn-sent": "0", + "tot-ssl-hs-completed": "0", + "ps-clr-pkt-sent-to-sc": "0", + "ism-flow-delete": "0", + "tot-client-cert-expired": "0", + "drop-unknown-status": "0", + "clear-conn": "0", + "active-non-proxied-conn": "0", + "pc-lwssl-flow-create": "0", + "che-process": "0", + "client-ocsp-good": "0", + "tot-select-tls1-2-flows": "0", + "tot-ssl-hs-started": "0", + "drop-mem-access-issue": "0", + "app-ocsp-failures": "0", + "unknown-reasons": "0", + "tot-ssl-resump-ses-id": "0", + "app-ocsp-reqs": "0", + "tot-conn": "0", + "drop-null-ssl-rec": "0", + "drop-ocsp-cert-verify-fail": "0", + "drop-de-handle-data-fail": "0", + "ism-fifo-enqueue-failed": "0", + "unsup-cipher": "0", + "drop-fail-mode": "0", + "drop-invalid-fsm-evt": "0", + "drop-invalid-fs-type": "0", + "pc-fs-mem-alloc-fail": "0", + "error-state": "0", + "tot-server-cert-val-req": "0", + "vdevice-host-name": "vm5", + "s2c-cn-sent-to-sc": "0", + "drop-invalid-ssl-rec": "0", + "ps-clr-pkt-rec-from-client": "0", + "pc-lwssl-flow-delete": "0", + "tot-server-cert-val-succes": "0", + "c2s-fin-rec-during-hs": "0", + "drop-ism-flow-create-fail": "0", + "pc-cn-sent": "0", + "ps-lwssl-flow-create": "0", + "c2s-fin-rec-after-hs": "0", + "drop-expired-cert": "0", + "drop-key-pkt-snd-fail": "0", + "proxied-conn": "0", + "drop-other-side-key-pend": "0", + "active-proxied-conn": "0", + "max-conc-proxied-conn": "0", + "mem-access-issue": "0", + "unexpected-packet": "0", + "tot-ssl-resump": "0", + "ssl-error": "0", + "decrypt-exp-cert": "0", + "ps-pkt-sent-to-client": "0", + "rm-session-free-failures": "0", + "pc-clr-pkt-to-server": "0", + "drop-send-ism-hs-msg-fail": "0", + "ocsp-stap-revoked-resp": "0", + "client-ocsp-timeout": "0", + "ps-fin-rec-from-sc": "0", + "tot-req-sslv3-flows": "0", + "drop-invalid-msg-type": "0", + "che-strip": "0", + "active-clear-conn": "0", + "non-ssl-traffic": "0", + "drop-hs-unsupported": "0", + "max-conc-clear-conn": "0", + "ps-fs-mem-alloc-fail": "0", + "tot-req-tls1-0-flows": "0", + "pc-pkt-sent-to-sc": "0", + "s2c-rst-generated": "0", + "drop-unsup-cipher": "0", + "ocsp-stap-resp-val-fail": "0", + "tot-req-tls1-3-flows": "0", + "decrypt-unknown-status": "0", + "app-ocsp-revoked": "0", + "s2c-fin-sent": "0", + "tot-ssl-fb-full-hs": "0", + "drop-exp-cert": "0", + "drop-tcp-close-before-hs": "0", + "ps-pkt-rec-from-sc": "0", + "ism-msg-mem-alloc-failed": "0", + "tot-req-tls1-2-flows": "0", + "drop-endpoint-alert": "0", + "drop-mem-alloc-fail": "0", + "tot-closed-conn": "0", + "c2s-rst-sent": "0", + "drop-nop-read-fn": "0", + "ps-rst-rec-from-sc": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/sslproxy/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Sslproxy" + ], + "description": "Get ssl proxy status from device", + "operationId": "getSslProxyStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ssl proxy status": { + "description": "Ssl proxy status", + "value": { + "data": [ + { + "failure-mode": "failure-mode-action-close", + "minimum-tls-version": "tls-ver-1", + "vdevice-name": "169.254.10.12", + "cert-lifetime-in-days": "730", + "unsup-cipher-suite": "unsup-mode-action-drop", + "expired-cert": "cert-valid-action-decrypt", + "untrusted-cert": "cert-valid-action-decrypt", + "ca-tp-label": "PROXY-SIGNING-CA", + "unknown-status": "cert-valid-action-drop", + "rsa-key-mod": "2048", + "clear-mode": "false", + "vdevice-host-name": "vm5", + "ec-key-type": "ec-key-p256", + "cert-revocation": "cert-rev-none", + "vdevice-dataKey": "169.254.10.12", + "ca-cert-bundle": "/bootflash/vmanage-admin/sslProxyDefaultCAbundle.pem", + "lastupdated": 1645776060286, + "unsup-protocol-version": "unsup-mode-action-drop" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/staticRouteTracker": { + "get": { + "tags": [ + "Real-Time Monitoring - Static Route Tracker Service" + ], + "description": "Get single static route tracker info from device", + "operationId": "getStaticRouteTrackerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Static route tracker info": { + "description": "Static route tracker info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/stats": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get stats queue information", + "operationId": "getStatsQueues", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue status": { + "description": "Queue status", + "value": { + "ProcessQueue-0": { + "syncing": [], + "queued": [], + "stuck": {} + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/status": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get devices status for vSmart,vBond,vEdge, and cEdge", + "operationId": "getAllDeviceStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device status list": { + "description": "Device status list", + "value": { + "header": { + "generatedOn": 1635236849570 + }, + "data": [ + { + "type": "vSmart", + "name": "vSmart", + "image": "images/vsmart.png", + "count": 3, + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart", + "statusList": [ + { + "status": "error", + "name": "Error", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=error", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "warning", + "name": "Warning", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=warning", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + }, + { + "status": "normal", + "name": "Normal", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=normal", + "color": "b0e276", + "icon": "images/device/device-normal.png", + "count": 3 + }, + { + "status": "new", + "name": "Discovered device", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=new", + "color": "7c8afa", + "icon": "images/device/device-new.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/sxpConnections": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec SXP Connections information from device", + "operationId": "getSxpConnections", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec SXP Connections information": { + "description": "TrustSec SXP Connections information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/sync_status": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get list of currently syncing devices", + "operationId": "listCurrentlySyncingDevices", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of currently syncing devices": { + "description": "List of currently syncing devices", + "value": { + "header": { + "generatedOn": 1635237704919 + }, + "data": [ + { + "name": "vedge-C8500-12X4QC", + "templateClass": "cedge", + "displayName": "C8500-12X4QC", + "deviceType": "vedge", + "isCliSupported": true, + "templateSupported": true, + "deviceClass": "cisco-router", + "cpuCountAttribute": { + "enable": true, + "attributeField": "total_cpu_count" + }, + "interfaces": { + "wan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "lan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "mgmt": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "day0": [ + "GigabitEthernet0/0/0" + ] + }, + "onboardCert": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/syncall/memorydb": { + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Synchronize memory database for all devices", + "operationId": "syncAllDevicesMemDB", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/system/clock": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system clock", + "operationId": "getDeviceSystemClock", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system clock": { + "description": "Device system clock", + "value": { + "data": [ + { + "current_date/date-time-string": "Tue Mar 15 16:46:40 UTC 2022" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/system/info": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device information list", + "operationId": "createDeviceInfoList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "array", + "example": "169.254.10.10", + "items": { + "type": "string", + "example": "169.254.10.10" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device info": { + "description": "Device info", + "value": { + "data": [ + { + "device-model": "vedge-cloud", + "statusOrder": 4, + "total_cpu_count": "2", + "max-controllers": "0", + "groupId": [ + "none" + ], + "certificate-not-valid-before": "Jan 29 00:19:35 2022 GMT", + "fp_cpu_count": "1", + "deviceId": "169.254.10.10", + "uuid": "bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e", + "syncScheduled": 1644759037120, + "chassis-serial-number": "None", + "cpuLoad": 1.46, + "state_description": "All daemons up", + "vsmart-list-version": "9223372036854775807", + "vbond": "10.103.135.135", + "ompPeersUp": 2, + "syncQueued": 1644759037119, + "isDeviceGeoData": false, + "device-type": "vedge", + "state": "green", + "firmwareVersion": "---", + "organization-name": "vIPtela Inc Regression-Apple Inc", + "longitude": "-122.777023", + "syncCompleted": 1644759039647, + "domain-id": "1", + "downloadedServices": [], + "availableServices": [], + "expectedControlConnections": 2, + "memUsageDisplay": "24.1", + "model_sku": "None", + "sp-organization-name": "vIPtela Inc Regression", + "version": "20.6.2-440", + "firmwareAvailablePackages": "[]", + "layoutLevel": 4, + "bootloader_version": "Not applicable", + "fips_mode": "enabled", + "name": "169.254.10.10", + "controlConnectionsUp": 3, + "controlConnectionsToVsmarts": "2", + "number-vbond-peers": "1", + "defaultVersion": "20.6.2-440", + "status": "normal", + "ompPeers": "2", + "memState": "normal", + "chassis-number": "bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e", + "board_type": "Sim", + "device-os": "next", + "local-system-ip": "172.16.254.2", + "timezone": "UTC", + "latitude": "37.666684", + "system-ip": "169.254.10.10", + "site-id": "3", + "certificate-not-valid-after": "Jan 29 00:19:35 2023 GMT", + "downloadedImages": [], + "platform": "x86_64", + "hardwareState": "normal", + "board-serial": "12345708", + "@rid": 2493, + "personality": "vedge", + "memUsage": 24.1, + "lastDataSyncTime": 1644801887955, + "certificate-status": "Installed", + "reachability": "reachable", + "controlConnections": "3", + "linux_cpu_count": "1", + "controlConnectionsDown": 0, + "availableVersions": [], + "number-vsmart-peers": 2, + "connectedVManages": [ + "169.254.10.3" + ], + "testbed_mode": true, + "syncState": "Completed", + "firmwareAvailableVersions": [], + "host-name": "vm3", + "bfdSessionsDown": 0, + "tcpd_cpu_count": "0", + "uptime": "15 days 13 hrs 52 min 15 sec", + "token": "Invalid", + "cpuLoadDisplay": "1.46", + "certificate-validity": "Valid", + "cpuState": "normal", + "number-vsmart-control-connections": 2, + "vmanage-system-ip": "169.254.10.10", + "ompPeersDown": 0, + "bfdSessions": "5", + "tenantId": "c2c6093d-a33c-400a-90e8-1f549fe7a12c", + "vmanageConnectionState": "connected", + "build_number": "440\n", + "lastupdated": 1644759039485, + "device-category": "vedge", + "device-groups": [ + "No groups" + ], + "hasGeoData": true, + "uptime-date": 1643413080000, + "isMultiStepUpgradeSupported": false, + "bfdSessionsUp": 5 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/system/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system stats list (Real Time)", + "operationId": "createDeviceSystemStatsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": { + "data": [ + { + "tx_gre_pkts": 132344, + "tx_arp_replies": 1700, + "rx_icmp_port_unreach": 303, + "rx_window_drops_tc6": 0, + "rx_window_drops_tc7": 0, + "tx_arp_reqs": 43535, + "rx_window_drops_tc4": 0, + "rx_window_drops_tc5": 0, + "pko_wred_drops": 0, + "rx_window_drops_tc2": 0, + "rx_window_drops_tc3": 0, + "rx_window_drops_tc0": 0, + "rx_window_drops_tc1": 0, + "bfd_rx_non_ip": 0, + "ip_fwd_mcast_invalid_iif": 0, + "route_to_host": 0, + "tx_pkts": 55508251, + "arp_add_fail": 51, + "tx_ipsec_policer_drops": 0, + "tx_fragment_drops": 0, + "ip_fwd_from_cpu_non_local": 0, + "ip_fwd_null_mcast_group": 0, + "buf_alloc_fails": 0, + "fragment_df_drops": 0, + "rx_drops": 0, + "tx_fragment_fail": 0, + "bfd_lkup_fail": 0, + "rx_icmp_network_unreach": 9, + "vdevice-name": "169.254.10.10", + "tx_icmp_fragment_required": 0, + "cflowd_pkts": 0, + "tx_fragment_alloc_fail": 0, + "rx_replay_integrity_drops_tc3": 0, + "rx_replay_integrity_drops_tc4": 0, + "rx_replay_integrity_drops_tc5": 0, + "rx_sa_ipsec_drops": 0, + "rx_replay_integrity_drops_tc6": 0, + "openssl_aes_encrypt": 0, + "rx_replay_integrity_drops_tc7": 0, + "to_cpu_policer_drops": 3173, + "rx_icmp_redirect": 0, + "tx_no_tunn_pre_ipsec_drops": 0, + "tx_icmp_src_quench": 0, + "rx_icmp_ttl_expired": 0, + "rx_replay_integrity_drops_tc0": 1, + "rx_replay_integrity_drops_tc1": 0, + "rx_arp_reqs": 1333, + "rx_replay_integrity_drops_tc2": 0, + "tx_icmp_ttl_expired": 0, + "ip_fwd_mirror_pkts": 0, + "rx_non_ip_drops": 1469202, + "rx_icmp_bad_ip_hdr": 0, + "tx_ip6_ipsec_drops": 0, + "nat_xlate_outbound_drops": 0, + "rx_err_pad_ipsec_drops": 0, + "rx_pre_ipsec_pkts": 0, + "lastupdated": 1644814365917, + "tx_icmp_policer_drops": 0, + "mirror_drops": 0, + "rx_ipsec_bad_inner": 0, + "rx_ip_errs": 0, + "ip_fwd_null_nhop": 132344, + "tx_bcast": 2353, + "bfd_rx_parse_err": 0, + "rx_bcast": 185, + "rx_icmp_echo_requests": 0, + "tx_if_not_preferred": 1197705, + "tx_icmp_dst_unreach_other": 0, + "rx_invalid_port": 0, + "split_horizon_drops": 0, + "rx_icmp_other_types": 5458, + "rx_arp_replies": 43098, + "tx_no_out_sa_pre_ipsec_drops": 0, + "invalid_back_ptr": 0, + "rx_pkts": 31444972, + "rx_invalid_qtags": 244, + "ip_fwd_to_cpu_nat_drops": 0, + "tx_gre_drops": 0, + "rx_icmp_src_quench": 0, + "rx_gre_policer_drops": 0, + "cbf_discards": 0, + "tx_gre_policer_drops": 0, + "rx_arp_non_local_drops": 161199, + "ip_fwd_unknown_nh_type": 0, + "tx_arp_req_fail": 0, + "tx_icmp_echo_requests": 486552, + "ip_fwd_to_egress": 22866794, + "tx_ipsec_encap": 16205725, + "rx_tunneled_pkts": 0, + "bfd_tx_record_changed": 374, + "rx_mcast_mirror_fwd_drops": 0, + "rx_unexpected_replay_drops_tc1": 0, + "rx_unexpected_replay_drops_tc2": 0, + "rx_unexpected_replay_drops_tc3": 0, + "rx_invalid_ipsec_pkt_size": 0, + "rx_unexpected_replay_drops_tc4": 0, + "ip_disabled_tx": 0, + "rx_unexpected_replay_drops_tc0": 0, + "rx_ipsec_policer_drops": 0, + "rx_unexpected_replay_drops_tc5": 0, + "rx_unexpected_replay_drops_tc6": 0, + "rx_unexpected_replay_drops_tc7": 0, + "rx_replay_drops_tc7": 0, + "rx_replay_drops_tc5": 0, + "ip_fwd_to_cpu_nat_xlates": 0, + "rx_replay_drops_tc6": 0, + "vdevice-dataKey": "169.254.10.10", + "rx_replay_drops_tc3": 0, + "rx_replay_drops_tc4": 0, + "rx_replay_drops_tc1": 0, + "rx_ipsec_decap": 16201636, + "rx_replay_drops_tc2": 0, + "rx_spi_ipsec_drops": 0, + "rx_replay_drops_tc0": 0, + "rx_host_mirror_drops": 0, + "rx_gre_drops": 0, + "ip_fwd_nat_on_tunnel": 0, + "rx_cp_non_local": 0, + "ip_fwd_to_cpu": 6893414, + "bfd_rx_record_invalid": 0, + "no_nat_nexthop": 0, + "tx_fragment_needed": 0, + "ip_fwd_mcast_life_exceeded_drops": 0, + "rx_pre_ipsec_decap": 0, + "ip_fwd": 46077192, + "rx_unexpected_replay_drops": 0, + "bfd_rec_down": 0, + "tunnel_pmtu_lowered": 0, + "filter_drops": 0, + "rx_icmp_protocol_unreach": 0, + "tx_queue_exceeded": 0, + "nat_xlate_inbound_fail": 0, + "tx_icmp_bad_ip_hdr": 0, + "nat_xlate_inbound": 0, + "rx_arp_rate_limit_drops": 0, + "bfd_rec_invalid": 1, + "rx_implicit_acl_drops": 869, + "ip_disabled_rx": 0, + "rx_mac_compare_ipsec_drops": 0, + "tx_ipsec_pkts": 16205725, + "rx_mcast_threshold_exceeded": 0, + "bfd_timer_add_fail": 0, + "openssl_aes_decrypt": 0, + "nat_xlate_outbound": 0, + "tx_ipsec_mcast_encap": 0, + "rx_gre_decap": 0, + "tx_errors": 0, + "bfd_tx_pkts": 16142569, + "service_label_fwd": 0, + "unknown_nh_type": 0, + "rx_mcast_policy_fwd_drops": 0, + "rx_pre_ipsec_drops": 0, + "tx_icmp_host_unreach": 0, + "vdevice-host-name": "vm3", + "rx_icmp_host_unreach": 0, + "rx_icmp_dst_unreach_other": 0, + "tx_icmp_redirect": 0, + "rx_mcast_link_local": 17935, + "rx_host_local_pkt": 0, + "tx_fragments": 0, + "tx_icmp_port_unreach": 50, + "icmp_redirect": 0, + "rx_mcast": 18682, + "tx_mcast": 55760, + "tx_mcast_fragment_needed": 0, + "rx_replay_integrity_drops": 1, + "rx_mcast_filter_to_cpu": 0, + "ip_fwd_rx_gre": 0, + "tx_icmp_protocol_unreach": 0, + "port_disabled_rx": 9018, + "ttl_expired": 0, + "tx_gre_encap": 132344, + "bfd_rx_pkts": 16138479, + "ip_fwd_arp": 1187, + "tx_icmp_network_unreach": 0, + "ip_fwd_invalid_tun_oil": 0, + "ip_fwd_rx_ipsec": 16202760, + "tx_icmp_other_types": 654, + "rx_no_tun_if": 0, + "app_route_policy_discards": 0, + "tx_no_out_sa_ipsec_drops": 0, + "rx_bad_label": 0, + "tx_pre_ipsec_pkts": 16205725, + "rx_mcast_filter_to_cpu_and_fwd": 0, + "tx_pre_ipsec_policer_drops": 0, + "rx_next_hdr_ipsec_drops": 0, + "bfd_tx_fail": 0, + "rx_ip6_ipsec_drops": 0, + "tunnel_loop_drops": 0, + "tx_arp_rate_limit_drops": 0, + "bfd_alloc_fail": 0, + "tx_pre_ipsec_encap": 16205725, + "ip_v6_mcast_drops": 0, + "port_disabled_tx": 193, + "ecmp_discards": 0, + "tx_icmp_echo_replies": 0, + "rx_icmp_fragment_required": 0, + "ip_fwd_from_cpu_nat_xlates": 0, + "rx_icmp_echo_replies": 486048, + "tx_no_tunn_ipsec_drops": 0, + "tx_no_arp_drop": 0, + "tx_vsmart_drop": 0, + "rx_policer_drops": 0, + "ip_fwd_invalid_oil": 0, + "rx_replay_drops": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/system/status": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system status list (Real Time)", + "operationId": "createDeviceSystemStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system status": { + "description": "Device system status", + "value": { + "data": [ + { + "mem_used": "954024", + "procs": "244", + "disk_avail": "7015M", + "disk_mount": "/", + "board_type": "Sim", + "vdevice-name": "169.254.10.10", + "total_cpu_count": "2", + "mem_cached": "740972", + "reboot_type": "Not Applicable", + "disk_fs": "/dev/root", + "fp_cpu_count": "1", + "chassis-serial-number": "None", + "min1_avg": "1.06", + "state_description": "All daemons up", + "personality": "vedge", + "disk_used": "174M", + "disk_use": "2", + "disk_status": "enabled", + "state": "green", + "config_date/date-time-string": "Mon Feb 14 04:47:05 UTC 2022", + "linux_cpu_count": "1", + "cpu_user": "5.53", + "testbed_mode": "1", + "min15_avg": "1.08", + "disk_size": "7615M", + "cpu_idle": "91.96", + "mem_buffers": "82140", + "model_sku": "None", + "cpu_system": "2.51", + "version": "20.6.2-440", + "min5_avg": "1.10", + "tcpd_cpu_count": "0", + "vdevice-host-name": "vm3", + "mem_total": "3906816", + "uptime": "16 days 05 hrs 08 min 45 sec", + "vdevice-dataKey": "169.254.10.10", + "mem_free": "2129680", + "bootloader_version": "Not applicable", + "fips_mode": "enabled", + "build_number": "440\n", + "lastupdated": 1644814027189, + "loghost_status": "disabled", + "uptime-date": 1643413080000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/device/system/synced/status": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system stats list synchronously", + "operationId": "createSyncedDeviceSystemStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "board_type": "Sim", + "total_cpu_count": "2", + "reboot_type": "NotApplicable", + "fp_cpu_count": "1", + "chassis-serial-number": "None", + "state_description": "Alldaemonsup", + "@rid": 1175, + "personality": "vedge", + "disk_status": "enabled", + "state": "green", + "linux_cpu_count": "1", + "testbed_mode": "1", + "createTimeStamp": 1647316043522, + "model_sku": "None", + "version": "20.9.999-1787", + "tcpd_cpu_count": "0", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "bootloader_version": "Notapplicable", + "fips_mode": "enabled", + "lastupdated": 1647316042867, + "build_number": "1787\n", + "loghost_status": "disabled", + "uptime-date": 1647312840000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/tcpopt/activeflows": { + "get": { + "tags": [ + "Real-Time Monitoring - TCP Optimization" + ], + "description": "Get TCP optimized active flows from device (Real Time)", + "operationId": "getActiveTCPFlows", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TCP optimized active flow": { + "description": "TCP optimized active flow", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/tcpopt/expiredflows": { + "get": { + "tags": [ + "Real-Time Monitoring - TCP Optimization" + ], + "description": "Get TCP optimized expired flows from device (Real Time)", + "operationId": "getExpiredTCPFlows", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TCP optimized expired flow": { + "description": "TCP optimized expired flow", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/tcpopt/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - TCP Optimization" + ], + "description": "Get TCP optimization summary from device (Real Time)", + "operationId": "getTCPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TCP optimization summary": { + "description": "TCP optimization summary", + "value": { + "data": [ + { + "flows-expired": "0", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "flows-optimized": "0", + "lastupdated": 1644816147644, + "flows-passthrough": "0", + "vdevice-host-name": "vm3", + "flows-in-progress": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/tcpproxy/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tcpproxy" + ], + "description": "Get tcp proxy statistics from device", + "operationId": "getTcpProxyStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tcp proxy statistics": { + "description": "Tcp proxy statistics", + "value": { + "data": [ + { + "syn-purged-enq": "0", + "tot-fin-processed": "0", + "enable-rx-called": "0", + "tot-ev-tx-enable-process": "0", + "tot-send-fail": "0", + "tot-ssl-trig-rst-wkq-fail": "0", + "tcpp-aoim-sync-done": "0", + "tot-tcp-buf-sent": "0", + "tot-ssl-pause-called": "0", + "tot-ssl2svc-buf-enq": "0", + "tcp-flow-stats-del-fail": "0", + "enable-rx-queued": "0", + "tot-tcp-buf-rcvd": "0", + "tot-bytes-read-less-512": "0", + "tot-dre-resume-to-be-sent": "0", + "sync-fail-marked-cleanup": "0", + "sync-fail-entry-invalid": "0", + "tot-clean-server-data-q": "0", + "tot-ssl-resume-done": "0", + "ssl-init-failure": "0", + "tot-bytes-read-less-1024": "0", + "tot-tcp-buf-alloc": "0", + "pre-list-enq-failed": "0", + "tot-actual-pause-done": "0", + "tot-tcp-flow-clean-done": "0", + "tot-sc-reset-rcvd": "0", + "tot-rx-ssl-pause-process": "0", + "tot-async-event-send": "0", + "tot-bytes-read-less-4096": "0", + "vpath-cleanup-from-nmrx": "0", + "tcp-flow-entries-created": "0", + "tot-ssl-pause-done": "0", + "tot-tx-async-event-proc": "0", + "tcp-flow-stats-add-fail": "0", + "unif-logg-deq-no-space": "0", + "vdevice-name": "169.254.10.12", + "tot-snort-resume-done": "0", + "tot-pause-count-buf": "0", + "tot-snort-reset-init": "0", + "tot-buf-128k-alloc-failed": "0", + "unified-logging-msg-recvd": "0", + "tot-bytes-read-less-2048": "0", + "wcapi-svc-flow-delete-f": "0", + "sync-flow-mismatch": "0", + "num-stack-cb-null-ctx": "0", + "tot-tcp-buf-128k-alloc": "0", + "tot-clean-flow-ign": "0", + "cur-rx-epoll-count": "0", + "cur-tx-epoll-count": "0", + "curr-val-tcp-flow-entries": "0", + "unified-logg-deq-succ": "0", + "tx-enq-failure-count": "0", + "tot-reset-processed": "0", + "vpath-cleanup-from-evlib": "0", + "tot-en-rx-sock-stk-cl-svr": "0", + "tot-rx-dre-pause-process": "0", + "unified-logg-data-too-long": "0", + "sync-fail-nat-entry-null": "0", + "tot-tcp-reset-rcvd": "0", + "current-conn-count": "0", + "tot-ssl-fin-rcvd": "0", + "tot-tcp-buf-16k-alloc": "0", + "tot-buf-16k-alloc-failed": "0", + "tot-ssl-server-init": "0", + "vdevice-host-name": "vm5", + "tot-sc-fin-rcvd": "0", + "sync-fail-entry-null": "0", + "tot-ssl-buf-free": "0", + "tot-buff-drop-sock-closed": "0", + "enable-rx-done": "0", + "tot-page-alloc-retry": "0", + "tot-resume-count-buf": "0", + "lastupdated": 1646012087379, + "tx-enqueue-drops-close": "0", + "unified-logg-enq-succ": "0", + "proxy-cleanup-enq": "0", + "tot-ssl-reset-init": "0", + "tot-buff-drop-sock-not-av": "0", + "conn-failed": "0", + "tot-dre-resume-done": "0", + "tcpp-aoim-sync-error": "0", + "timer-expire-cleanup-enq": "0", + "tcp-flow-inv-entries": "0", + "other-cleanup-enq": "0", + "tot-page-alloc-failed": "0", + "tot-ssl2tcp-buf-enq": "0", + "tot-clean-add-wk-q-fail": "0", + "tot-dre-resume-msg-sent": "0", + "tot-uhi-munmap": "2768", + "pre-list-enq": "0", + "tot-fin-ign-fd-close": "0", + "tot-buf-32k-alloc-failed": "0", + "flow-drop-sn-gbl-health-y": "0", + "stack-cleanup-enq": "0", + "pre-remove-cleanup": "0", + "tot-en-rx-sock-stk-cl-clnt": "0", + "total-conns": "0", + "tot-ev-resume-process": "0", + "tot-svc2ssl-buf-enq": "0", + "tot-page-free": "0", + "conn-in-progress": "0", + "tot-dre-close-init": "0", + "clean-req-watcher-called": "1104871", + "tot-async-event-process": "0", + "tot-svc-reset-processed": "0", + "tot-page-alloc-fail-size": "0", + "flows-drop-wcapi-health-y": "0", + "tot-rx-snort-pause-proc": "0", + "pre-remove-err-timer": "0", + "tot-uhi-mmap": "88936", + "tot-page-alloc": "0", + "tot-cleanup-add-to-wk-q": "0", + "stack-cleanup-enq-failed": "0", + "pre-remove-accept": "0", + "tot-tcp2ssl-buf-enq": "0", + "tot-ssl-clean-addwkq-fail": "0", + "tot-ssl-buf-alloc": "0", + "tot-actual-resume-done": "0", + "tot-pause-count": "0", + "wcapi-svc-flow-create-f": "0", + "enable-rx-enq-failed": "0", + "flow-drop-sn-inst-health-y": "0", + "max-conns": "0", + "proxy-cleanup-enq-failed": "0", + "tot-ssl-reset-rcvd": "0", + "pre-rem-err-accept": "0", + "tot-ssl-reset-rcvd-sc": "0", + "wcapi-svc-flow-close-f": "0", + "other-cleanup-enq-failed": "0", + "tot-ssl-fin-rcvd-sc": "0", + "tot-tcp-buf-free": "0", + "tot-resume-count": "0", + "tot-tcp-fin-rcvd": "0", + "tot-tcp-buf-32k-alloc": "0", + "tot-clean-msg-rcvd": "0", + "tot-clean-client-data-q": "0", + "enable-rx-failed": "0", + "curr-tcp-flow-entries": "0", + "syn-purge-enq-failed": "0", + "tot-tx-async-event-send": "0", + "wcapi-svc-data-send-f": "0", + "tcp-flow-entries-deleted": "0", + "timer-ex-clean-enq-failed": "0", + "pre-clean-time-update": "0", + "vdevice-dataKey": "169.254.10.12", + "tot-ssl-buf-alloc-failed": "0", + "tot-ssl-resume-called": "0", + "tcpp-aoim-sync-started": "0", + "tot-dre-pause-done": "0", + "tot-tcp-buf-alloc-failed": "0", + "tot-snort-pause-done": "0", + "sync-fail-entry-inuse": "0", + "syncache-add-done": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/tcpproxy/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Tcpproxy" + ], + "description": "Get tcp proxy status from device", + "operationId": "getTcpProxyStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tcp proxy status": { + "description": "Tcp proxy status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "oper-state": "running", + "sng-name": "SNG-APPQOE", + "lastupdated": 1646011762240, + "sng-addr": "192.168.2.2", + "vdevice-host-name": "vm5", + "vpg-name": "VirtualPortGroup2", + "vpg-addr": "192.168.2.1", + "vpg-netmask": "255.255.255.0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/tier": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "getTiers", + "operationId": "getTiers", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "add tier", + "operationId": "addTier", + "parameters": [ + { + "name": "addTier", + "in": "path", + "description": "addTier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tier/{tierName}": { + "delete": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "deleteTier", + "operationId": "deleteTier", + "parameters": [ + { + "name": "tierName", + "in": "path", + "description": "deletetier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tloc": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get TLOC status list", + "operationId": "getDeviceTlocStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Status color", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TLOC status list": { + "description": "TLOC status list", + "value": { + "header": { + "title": "tlocStatus", + "generatedOn": 1635302852035 + }, + "data": [ + { + "expectedControlConnections": 2, + "controlConnectionsDown": 0, + "controlConnectionsUp": 7, + "color": "default", + "controlConnectionsToVsmarts": 2, + "system-ip": "172.16.255.22" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tlocutil": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get TLOC list", + "operationId": "getDeviceTlocUtil", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TLOC list": { + "description": "TLOC list", + "value": { + "header": { + "generatedOn": 1635311915500, + "title": "Transport Interface Distribution", + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-TlocUtilization" + }, + "columns": [ + { + "title": "Percentage Distribution", + "property": "percentageDistribution", + "dataType": "string" + }, + { + "title": "Value", + "property": "value", + "dataType": "number" + } + ], + "fields": [ + { + "property": "percentageDistribution", + "dataType": "string" + }, + { + "property": "value", + "dataType": "number" + } + ] + }, + "data": [ + { + "name": "less_than_10_mbps", + "percentageDistribution": "< 10 Mbps", + "detailsURL": "/dataservice/device/tlocutil/detail?util=lessthan10mbps", + "value": 0 + }, + { + "name": "10_mbps_100_mbps", + "percentageDistribution": "10 Mbps - 100 Mbps", + "detailsURL": "/dataservice/device/tlocutil/detail?util=10mbps100mbps", + "value": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tlocutil/detail": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get detailed TLOC list", + "operationId": "getDeviceTlocUtilDetails", + "parameters": [ + { + "name": "util", + "in": "query", + "description": "Tloc util", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detailed TLOC list": { + "description": "Detailed TLOC list", + "value": { + "header": { + "generatedOn": 1635314596057, + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-TlocUtilizationDetails" + }, + "columns": [ + { + "title": "Average", + "property": "average", + "hideable": false, + "dataType": "number" + } + ], + "fields": [ + { + "property": "system-ip", + "dataType": "string" + }, + { + "property": "average", + "dataType": "number" + } + ] + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Generate admin tech logs", + "operationId": "createAdminTech", + "requestBody": { + "description": "Admin tech generation request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Generate Admin tech log": { + "description": "Generate Admin tech log", + "value": { + "deviceIP": "10.3.0.1", + "device-type": "vmanage", + "exclude-cores": true, + "exclude-tech": false, + "exclude-logs": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/copy": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "copy admin tech logs", + "operationId": "copyAdminTechOnDevice", + "requestBody": { + "description": "Admin tech copy request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Copy Admin tech log": { + "description": "Copy Admin tech log", + "value": { + "deviceIP": "10.3.0.1", + "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/delete": { + "delete": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "delete admin tech logs", + "operationId": "deleteAdminTechOnDevice", + "requestBody": { + "description": "Admin tech copy request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete Admin tech log": { + "description": "Delete Admin tech log", + "value": { + "deviceIP": "10.3.0.1", + "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/download/{filename}": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Download admin tech logs", + "operationId": "downloadAdminTechFile", + "parameters": [ + { + "name": "filename", + "in": "path", + "description": "Admin tech file", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/{requestID}": { + "delete": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Delete admin tech logs", + "operationId": "deleteAdminTechFile", + "parameters": [ + { + "name": "requestID", + "in": "path", + "description": "Request Id of admin tech generation request", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechlist": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "List admin tech logs", + "operationId": "listAdminTechsOnDevice", + "requestBody": { + "description": "Admin tech listing request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "List Admin tech log": { + "description": "List Admin tech log", + "value": { + "deviceIP": "10.3.0.1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Admin-tech information": { + "description": "Admin-tech information", + "value": "{\n \"data\":[\n {\n \"fileName\":\"10.3.0.1-20200522-102611-admin-tech.tar.gz\",\n \"creationTime\":1590186370340,\n \"size\":1081406,\n \"state\":\"done\"\n \"requestTokenId\":\"10540562-6759-40ad-917f-71d4b81ff37d\"\n }\n ]\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechs": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Get device admin-tech information", + "operationId": "listAdminTechs", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Admin-tech information": { + "description": "Admin-tech information", + "value": { + "data": [ + { + "creationTime": 1590186370340, + "size": 1081406, + "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz", + "state": "done", + "deviceIP": "10.3.0.1", + "local-system-ip": "10.3.0.1", + "requestTokenId": "10540562-6759-40ad-917f-71d4b81ff37d" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechs/inprogress": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Get device admin-tech InProgressCount", + "operationId": "getInProgressCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Admin-tech InProgressCount": { + "description": "Admin-tech InProgressCount", + "value": { + "data": [ + { + "inProgressCount": "5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechs/upload": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "upload admin tech to SR", + "operationId": "uploadAdminTech", + "requestBody": { + "description": "Admin tech upload request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "upload Admin tech log": { + "description": "upload Admin tech log", + "value": "{\n \"sr_number\":\"69131837254\",\n \"token\":\"9b42986QTUc\",\n \"vpn\":\"VPN 0\",\n \"requestTokenId\":\"ea8cb172-61c4-47e0-8957-ac83b384f53e\",\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/factoryreset": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Device factory reset", + "operationId": "factoryReset", + "requestBody": { + "description": "Device factory reset", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device factory reset": { + "description": "Device factory reset", + "value": { + "deviceIP": "172.16.255.16", + "resetOption": "full-wipe/retain-license" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/netstat": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get device tool net stat", + "operationId": "getDeviceToolsNetstat", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "options", + "in": "query", + "description": "Options", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tools netstat Data Example": { + "description": "Tools netstat Data Example", + "value": "{{\n \"rawOutput\": [\n \"Active Internet connections (w/o servers)\",\n \"Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name\",\n \"tcp 0 0 vm1:ssh 10.0.1.1:54932 ESTABLISHED 8964/sshd: admin [p\",\n \"Active UNIX domain sockets (w/o servers)\",\n \"Proto RefCnt Flags Type State I-Node PID/Program name Path\",\n \"unix 3 [ ] STREAM CONNECTED 1154465 3283/ftmd /var/run/.ftmd.512\",\n \"unix 3 [ ] STREAM CONNECTED 767015 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 1154461 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 767017 2181/cfgmgr /var/run/quagga/zebra_protobuf_notify.api.512\",\n \"unix 3 [ ] STREAM CONNECTED 1177839 8966/0 \",\n \"unix 2 [ ] STREAM CONNECTED 1177830 8964/sshd: admin [p \",\n \"unix 3 [ ] STREAM CONNECTED 1177840 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 1177838 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 766216 2519/zebra \"\n ]\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/nping/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "NPing device", + "operationId": "npingDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "NPing parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NPing parameter": { + "description": "NPing parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/nslookup": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get device tool nslookup", + "operationId": "getDeviceToolsNSlookup", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN", + "required": true, + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "dns", + "in": "query", + "description": "DNS", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "8.8.8.8" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device tool nslookup data": { + "description": "Device tool nslookup data", + "value": { + "rawOutput": [ + "Server: 10.0.1.1", + "Address 1: 10.0.1.1", + "", + "Name: 8.8.8.8", + "Address 1: 8.8.8.8" + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/ping/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Ping device", + "operationId": "pingDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ping parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ping parameter": { + "description": "Ping parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/porthopcolor/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Request port hop color", + "operationId": "processPortHopColor", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device port hop color", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device port hop color": { + "description": "Device port hop color", + "value": { + "color": "mpls" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/realtimeinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get hardware real time info from device", + "operationId": "getRealTimeinfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "hardware real time info data": { + "description": "hardware real time info data", + "value": "{\t\"hardware-info\" : \"Hardware Information\\n---------------------------------\\n\nBaseboard Details:\\nboard type : ISR1100-4G\\nboard serial number:\nISR1100-4G-FCH2414L04T\\n-------------------------------\\nTPM Details:\\nAikido FPGA : 07250006\\n---------------------------------------------------------\\nBootloader version:\\nBIOS Version:17.7(1r)\\nBootloader Source: Upgrade\nBIOS\\n----------------------------------------------------------------\\nTemperature threshold history:\\n\",\n\"Kernel-log\" : \"Critical Kernel Logs:\"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/reset/interface/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Reset device interface", + "operationId": "processInterfaceReset", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device interface", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "vpnId": "512", + "ifname": "GigabitEthernet1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/resetuser/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Request reset user", + "operationId": "processResetUser", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device user reset", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device user reset": { + "description": "Device user reset", + "value": { + "user": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/servicepath/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Service path", + "operationId": "servicePath", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Service path parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service path parameter": { + "description": "Service path parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/ss": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get device tool ss", + "operationId": "getDeviceToolsSS", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "options", + "in": "query", + "description": "Options", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device tool SS data ": { + "description": "Device tool SS data ", + "value": { + "rawOutput": [ + "Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process ", + "u_str ESTAB 0 0 * 767015 * 0 users:((\"zebra\",pid=2519,fd=13)) ", + "u_str ESTAB 0 0 /var/run/quagga/zebra_protobuf_notify.api.512 767017 * 0 users:((\"cfgmgr\",pid=2181,fd=30)) ", + "u_str ESTAB 0 0 * 1154461 * 0 users:((\"zebra\",pid=2519,fd=16)) ", + "u_str ESTAB 0 0 /var/run/.ftmd.512 1154465 * 0 users:((\"ftmd\",pid=3283,fd=58)) ", + "u_str ESTAB 0 0 * 1177830 * 0 users:((\"sshd\",pid=8966,fd=6),(\"sshd\",pid=8964,fd=6)) ", + "u_str ESTAB 0 0 * 1177839 * 0 users:((\"sshd\",pid=8966,fd=5)) ", + "u_str ESTAB 0 0 * 1177840 * 0 users:((\"sshd\",pid=8964,fd=7)) ", + "u_dgr ESTAB 0 0 * 766216 * 0 users:((\"zebra\",pid=2519,fd=3)) ", + "u_dgr ESTAB 0 0 * 1177838 * 0 users:((\"sshd\",pid=8966,fd=3),(\"sshd\",pid=8964,fd=3)) ", + "tcp ESTAB 0 0 10.0.1.11:ssh 10.0.1.1:54932 users:((\"sshd\",pid=8966,fd=4),(\"sshd\",pid=8964,fd=4)) " + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/system-netfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get system netfilter info from device", + "operationId": "getSystemNetfilter", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "System Netfilter info": { + "description": "System Netfilter info", + "value": { + "ipv4": "Chain POLICE_PROT (2 references)\n pkts bytes target prot opt in out source destination \n 113K 16M ACCEPT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT tcp -- * * 0.0.0.0/0 172.16.255.11 tcp dpt:830\n 0 0 ACCEPT icmp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT 89 -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:22\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:179\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT udp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 udp spt:67 dpt:68\nChain INPUT (policy ACCEPT 760K packets, 433M bytes)\n pkts bytes target prot opt in out source destination \n 113K 16M POLICE_PROT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 LOGGING tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 921K 494M ACCEPT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 ctstate ESTABLISHED\n 0 0 POLICE_PROT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 LOGGING all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \nChain LOGGING (2 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all -- * * 0.0.0.0/0 0.0.0.0/0 ", + "ipv6": "Chain INPUT (policy ACCEPT 90 packets, 5040 bytes)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT all ge0_2 * ::/0 ::/0 ctstate ESTABLISHED\n 30 1680 POLICE_PROT all ge0_2 * ::/0 ::/0 \n 0 0 LOGGING all ge0_2 * ::/0 ::/0 \nChain POLICE_PROT (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT tcp * * ::/0 ::/0 tcp dpt:830\n 30 1680 ACCEPT icmpv6 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT 89 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:22\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:179\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:830\n 0 0 ACCEPT udp ge0_2 * ::/0 ::/0 udp spt:547 dpt:546\nChain LOGGING (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all * * ::/0 ::/0 " + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/traceroute/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Traceroute", + "operationId": "tracerouteDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Traceroute parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Traceroute parameter": { + "description": "Traceroute parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/tunnelpath/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "TunnelPath", + "operationId": "tunnelPath", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "TunnelPath parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TunnelPath parameter": { + "description": "TunnelPath parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/transport/connection": { + "get": { + "tags": [ + "Real-Time Monitoring - Transport" + ], + "description": "Get transport connection list from device", + "operationId": "createTransportConnectionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Transport connection list": { + "description": "Transport connection list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "0", + "lastupdated": 1644816647932, + "source": "0.0.0.0", + "time": "Fri Feb 11 18:19:43 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "1", + "lastupdated": 1644816647933, + "source": "0.0.0.0", + "time": "Fri Feb 11 18:16:58 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "2", + "lastupdated": 1644816647933, + "source": "0.0.0.0", + "time": "Fri Feb 4 18:19:51 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "3", + "lastupdated": 1644816647933, + "source": "0.0.0.0", + "time": "Fri Feb 4 18:17:06 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "4", + "lastupdated": 1644816647934, + "source": "0.0.0.0", + "time": "Thu Feb 3 18:23:58 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "5", + "lastupdated": 1644816647934, + "source": "0.0.0.0", + "time": "Thu Feb 3 18:21:13 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "6", + "lastupdated": 1644816647935, + "source": "0.0.0.0", + "time": "Wed Feb 2 18:19:38 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "7", + "lastupdated": 1644816647935, + "source": "0.0.0.0", + "time": "Wed Feb 2 18:16:47 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "8", + "lastupdated": 1644816647935, + "source": "0.0.0.0", + "time": "Tue Feb 1 18:19:56 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "9", + "lastupdated": 1644816647936, + "source": "0.0.0.0", + "time": "Tue Feb 1 18:17:11 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/tunnel/bfd_statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel BFD statistics all devices", + "operationId": "createBfdStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel BFD statistics": { + "description": "Tunnel BFD statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "bfd-echo-rx-pkts": 0, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 0, + "bfd-echo-tx-octets": 0, + "bfd-pmtu-rx-octets": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "bfd-pmtu-tx-pkts": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "lastupdated": 1644817628460, + "source-ip": "10.0.3.3", + "bfd-echo-tx-pkts": 0, + "bfd-pmtu-rx-pkts": 0, + "bfd-echo-rx-octets": 0 + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "bfd-echo-rx-pkts": 427365, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 307216, + "bfd-echo-tx-octets": 71583641, + "bfd-pmtu-rx-octets": 307216, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 376, + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 427365, + "bfd-pmtu-rx-pkts": 376, + "bfd-echo-rx-octets": 71583634 + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "bfd-echo-rx-pkts": 427523, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 307090, + "bfd-echo-tx-octets": 71610106, + "bfd-pmtu-rx-octets": 305818, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 375, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 427523, + "bfd-pmtu-rx-pkts": 375, + "bfd-echo-rx-octets": 71610099 + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "bfd-echo-rx-pkts": 449468, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 531622, + "bfd-echo-tx-octets": 75208785, + "bfd-pmtu-rx-octets": 2835599, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 2157, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 449468, + "bfd-pmtu-rx-pkts": 2157, + "bfd-echo-rx-octets": 75362995 + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "bfd-echo-rx-pkts": 449575, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 531622, + "bfd-echo-tx-octets": 75226641, + "bfd-pmtu-rx-octets": 2835599, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 2157, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 449575, + "bfd-pmtu-rx-pkts": 2157, + "bfd-echo-rx-octets": 75380984 + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "bfd-echo-rx-pkts": 449641, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 531622, + "bfd-echo-tx-octets": 75237437, + "bfd-pmtu-rx-octets": 2835599, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 2157, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 449641, + "bfd-pmtu-rx-pkts": 2157, + "bfd-echo-rx-octets": 75392298 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/fec_statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel fec statistics", + "operationId": "createFecStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "tunnel fec statistics": { + "description": "tunnel fec statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "fec-tx-data-pkts": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.0.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/gre-keepalives": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get GRE keep alive information", + "operationId": "createGreKeepalivesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "GRE keep alive": { + "description": "GRE keep alive", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "vdevice-name": "169.254.10.10", + "rx-packets": 0, + "rx-errors": 0, + "oper-state": "down", + "tx-errors": 0, + "admin-state": "up", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "ka-enabled": "true", + "remote-tx-packets": 0, + "if-name": "gre1", + "vdevice-dataKey": "169.254.10.10-10-gre1", + "tx-packets": 81366, + "remote-rx-packets": 0, + "lastupdated": 1644817234436, + "source-ip": "10.0.3.3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/ipsec_statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel IPSec statistics all devices", + "operationId": "createIpsecStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel IPSec statistics": { + "description": "Tunnel IPSec statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "vdevice-name": "169.254.10.10", + "lastupdated": 1644818093996, + "source-ip": "10.0.3.3", + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre" + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "ipsec-decrypt-inbound": 428675, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 428675 + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "ipsec-decrypt-inbound": 428832, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 428832 + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "ipsec-decrypt-inbound": 452605, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 452605 + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "ipsec-decrypt-inbound": 452712, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 452712 + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "ipsec-decrypt-inbound": 452777, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 452777 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/packet-duplicate": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel statistics packet duplication statistics", + "operationId": "createPacketDuplicateStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "tunnel statistics packet duplication stats": { + "description": "tunnel statistics packet duplication stats", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.0.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel statistics all devices", + "operationId": "createStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel statistics": { + "description": "Tunnel statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "vdevice-name": "169.254.10.10", + "rx_pkts": 0, + "tcp-mss-adjust": 1392, + "tx_octets": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "tx_pkts": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "rx_octets": 0, + "tunnel-mtu": 1476, + "lastupdated": 1644819414066, + "source-ip": "10.0.3.3" + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 431317, + "system-ip": "172.16.254.1", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 72492445, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 431317, + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "rx_octets": 72492438, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 431474, + "system-ip": "172.16.254.3", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 72518784, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 431474, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "rx_octets": 72517505, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 455393, + "system-ip": "172.16.254.4", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 76373141, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 455393, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "rx_octets": 78844158, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 455504, + "system-ip": "172.16.254.5", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 76391653, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 455504, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "rx_octets": 78862831, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 455567, + "system-ip": "172.16.254.16", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 76401957, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 455567, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "rx_octets": 78873632, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/ucse/stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Ucse" + ], + "description": "Get UCSE stats entry from device", + "operationId": "createUcseStats", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + " UCSE stats entry": { + "description": " UCSE stats entry", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/umbrella/device-registration": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella device registration from device", + "operationId": "getUmbrellaDevReg", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella device registration": { + "description": "Umbrella device registration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/dnscrypt": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella DNScrypt information from device", + "operationId": "getUmbrellaDNSCrypt", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella DNScrypt information": { + "description": "Umbrella DNScrypt information", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "index": 0, + "serial-num": 0, + "vdevice-host-name": "vm3", + "certificate-valid-from": "Jan 01 00:00:00 1970 GMT", + "client-magic": "0:0:0:0", + "vdevice-dataKey": "169.254.10.10-0", + "certificate-validity": "Invalid", + "client-public-key": "B40F:FA9A:31BB:690:C9F:7FEF:60A6:7FF5:286A:F519:64B2:586B:E35E:E4F0:E496:7FEE", + "certificate-state": "Init", + "resolver-public-key": "0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0", + "certificate-valid-till": "Jan 01 00:00:00 1970 GMT", + "lastupdated": 1644823735329, + "certificate-last-refresh-time": "Jan 01 00:00:00 1970 GMT", + "resolver-address": "208.67.222.222" + }, + { + "vdevice-name": "169.254.10.10", + "index": 1, + "serial-num": 0, + "vdevice-host-name": "vm3", + "certificate-valid-from": "Jan 01 00:00:00 1970 GMT", + "client-magic": "0:0:0:0", + "vdevice-dataKey": "169.254.10.10-1", + "certificate-validity": "Invalid", + "client-public-key": "97A1:BCCD:92FE:7FCE:2EC7:CEBC:B6CB:7589:9E63:D830:5D56:FEFD:301E:56C3:D9EF:1851", + "certificate-state": "Init", + "resolver-public-key": "0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0", + "certificate-valid-till": "Jan 01 00:00:00 1970 GMT", + "lastupdated": 1644823735329, + "certificate-last-refresh-time": "Jan 01 00:00:00 1970 GMT", + "resolver-address": "208.67.220.220" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/dp-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella dp-stats from device", + "operationId": "getUmbrellaDpStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella dp-stats": { + "description": "Umbrella dp-stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/overview": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella overview from device", + "operationId": "getUmbrellaOverview", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella overview": { + "description": "Umbrella overview", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "registrations-requested": "0", + "registrations-completed": "0", + "lastupdated": 1644823908956, + "dnscrypt": "true", + "vdevice-host-name": "vm3", + "last-success-attempt": "0000-00-00T00:00:00+00:00" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/umbrella-config": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella configuration from device", + "operationId": "getUmbrellaConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella configuration": { + "description": "Umbrella configuration", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "ldb-status": "-N/A-", + "public-key": "B0E1:6D15:C32D:4E8C:996B:635A:FA90:05B9", + "lastupdated": 1644823464208, + "DNSCrypt": "Enabled", + "vdevice-host-name": "vm3", + "resolver-address": "208.67.222.222, 208.67.220.220" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/unclaimed/vedges": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get unclaimed vEdges from vbond", + "operationId": "getUnclaimedVedges", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Unclaimed vEdges": { + "description": "Unclaimed vEdges", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/unconfigured": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get wan edge devices not configured by vManage (that is, those in CLI mode)", + "operationId": "getUnconfigured", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device" + } + }, + "examples": { + "Unconfigured devices": { + "description": "Unconfigured devices", + "value": [ + { + "uuid": "3e314ce8-cbaf-4fc7-882b-bacd16bd9a33", + "systemIp": "172.16.255.11", + "deviceType": "vedge" + }, + { + "uuid": "a9d47933-ee30-4e9f-bee6-a2ac81a0b284", + "systemIp": "172.16.255.21", + "deviceType": "vedge" + }, + { + "uuid": "e417ea1d-43dd-4285-8077-f7e20975568a", + "systemIp": "172.16.255.14", + "deviceType": "vedge" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/unreachable": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get list of unreachable devices", + "operationId": "listUnreachableDevices", + "parameters": [ + { + "name": "personality", + "in": "query", + "description": "Device personality (vedge OR vsmart OR vbond... )", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of unreachable devices": { + "description": "List of unreachable devices", + "value": { + "header": { + "generatedOn": 1635316653935, + "viewKeys": { + "uniqueKey": [ + "system-ip" + ], + "preferenceKey": "grid-vManage Control Connections" + }, + "columns": [ + { + "title": "Reachability", + "property": "reachability", + "colorProperty": "reachability", + "color": [ + { + "key": "reachable", + "value": "616161" + }, + { + "key": "unreachable", + "value": "ef5350" + }, + { + "key": "auth-failed", + "value": "ffb300" + } + ], + "width": 100, + "minWidth": 90, + "dataType": "string" + }, + { + "title": "Hostname", + "property": "host-name", + "display": "iconAndText", + "iconProperty": "device-type", + "hideable": false, + "icon": [ + { + "key": "vmanage", + "value": "images/vmanage_table.png" + }, + { + "key": "vedge", + "value": "images/vedge_table.png" + }, + { + "key": "vedge-vbond", + "value": "images/vedge-vbond_table.png" + }, + { + "key": "vsmart", + "value": "images/vsmart_table.png" + }, + { + "key": "vbond", + "value": "images/vbond_table.png" + } + ], + "width": 150, + "dataType": "string" + } + ], + "fields": [ + { + "property": "board-serial", + "dataType": "string" + }, + { + "property": "lastupdated", + "dataType": "date" + } + ] + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/unreachable/{deviceIP}": { + "delete": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Delete unreachable device", + "operationId": "removeUnreachableDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/users": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get users from device (Real Time)", + "operationId": "getUsersFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Users": { + "description": "Users", + "value": [ + { + "from": "10.0.1.1", + "proto": "ssh", + "login-time": "2022-01-26T07:36:15+00:00", + "auth-group": "netadmin log ", + "lastupdated": 1644914131016, + "vdevice-dataKey": "172.16.255.11-28", + "session": "28", + "user": "admin", + "context": "cli", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/users/list": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get all users from device", + "operationId": "getAllDeviceUsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Users": { + "description": "Users", + "value": { + "data": [ + { + "user": "admin" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write,Tools-read,Tools-write" + } + }, + "/device/utd/dataplane-config": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane config from Device", + "operationId": "getUTDDataplaneConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane config": { + "description": "UTD data plane config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/dataplane-global": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane global from Device", + "operationId": "getUTDDataplaneGlobal", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane global": { + "description": "UTD data plane global", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/dataplane-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane stats from Device", + "operationId": "getUTDDataplaneStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane stats": { + "description": "UTD data plane stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/dataplane-stats-summary": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane stats summary", + "operationId": "getUTDDataplaneStatsSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane stats summary": { + "description": "UTD data plane stats summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/engine-instance-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD engine instance status from device (Real Time)", + "operationId": "getUTDEngineInstanceStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD engine instance status": { + "description": "UTD engine instance status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/engine-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD engine status from device (Real Time)", + "operationId": "getUTDEngineStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD engine status": { + "description": "UTD engine status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/file-analysis-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD file analysis status from device (Real Time)", + "operationId": "getUTDFileAnalysisStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD file analysis status": { + "description": "UTD file analysis status", + "value": { + "data": [ + { + "utd-file-analysis-status-status": "tg-client-stat-unknown", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "lastupdated": 1645768248935, + "utd-file-analysis-status-backoff-interval": "0", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/file-reputation-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD file reputation status from device (Real Time)", + "operationId": "getUTDFileReputationStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD file reputation status": { + "description": "UTD file reputation status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "utd-file-reputation-status-status": "utd-file-repu-stat-process-unknown", + "vdevice-name": "169.254.10.12", + "lastupdated": 1645773049060, + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/ips-update-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD IPS update status from device (Real Time)", + "operationId": "getUTDIpsUpdateStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD IPS update status": { + "description": "UTD IPS update status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/signature/version/details": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD Signature version information from Device", + "operationId": "getSignatureVersionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD Signature version": { + "description": "UTD Signature version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/urlf-con-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD URLF Connection status from device (Real Time)", + "operationId": "getUTDUrlfConnectionStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD URLF connection status": { + "description": "UTD URLF connection status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/utd/urlf-update-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD URLF update status from device (Real Time)", + "operationId": "getUTDUrlfUpdateStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD URLF update status": { + "description": "UTD URLF update status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/version-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD version status from device (Real Time)", + "operationId": "getUTDVersionStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD version status": { + "description": "UTD version status", + "value": { + "data": [ + { + "utd-version-status-supported": "false", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "utd-version-status-recommended-version": "1.11.1_SV2.9.18.1_XEmain", + "lastupdated": 1645756283937, + "vdevice-host-name": "vm5", + "utd-version-status-supported-regex": "^1\\.11\\.([0-9]+)_SV(.*)_XEmain$" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/coLineSpecificStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service line bonding stats from device", + "operationId": "getCoLineSpecificStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service line bonding stats": { + "description": "VDSL service line bonding stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/coStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get CO stats from device", + "operationId": "getCoStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CO stats": { + "description": "CO stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/cpeLineSpecificStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service CPE line specific stats from device", + "operationId": "getCpeLineSpecificStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service CPE line specific stats": { + "description": "VDSL service CPE line specific stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/cpeStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get CPE stats from device", + "operationId": "getCpeStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CPE stats": { + "description": "CPE stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/lineBondingStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service line bonding stats from device", + "operationId": "getLineBondingStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service line bonding stats": { + "description": "VDSL service line bonding stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/lineSpecificStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service line specific stats from device", + "operationId": "getLineSpecificStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service line specific stats": { + "description": "VDSL service line specific stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/vdslInfo": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL info from device", + "operationId": "getVdslInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL info": { + "description": "VDSL info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vedgeinventory/detail": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get detailed vEdge inventory", + "operationId": "getVedgeInventory", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "Device status", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detailed vEdge inventory": { + "description": "Detailed vEdge inventory", + "value": { + "data": [ + { + "site-id": "400", + "serialNumber": "12346576", + "validity": "valid", + "host-name": "vm4", + "deviceType": "vedge", + "local-system-ip": "172.16.255.14", + "chasisNumber": "59414e3c-24cd-44de-8072-261224224c25", + "system-ip": "172.16.255.14" + }, + { + "site-id": "100", + "serialNumber": "12346568", + "validity": "valid", + "host-name": "vm11", + "deviceType": "vedge", + "local-system-ip": "172.16.255.21", + "chasisNumber": "63e8518c-e76f-4d5f-a4c7-28ffb669526b", + "system-ip": "172.16.255.21" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/vedgeinventory/summary": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get vEdge inventory", + "operationId": "getVedgeInventorySummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge inventory": { + "description": "vEdge inventory", + "value": { + "header": { + "generatedOn": 1635390164998, + "title": "WAN Edge Inventory", + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-vedgeInventory" + }, + "columns": [ + { + "title": "Inventory List", + "property": "list", + "dataType": "string" + } + ], + "fields": [ + { + "property": "list", + "dataType": "string" + } + ] + }, + "data": [ + { + "name": "Total", + "list": "Total", + "value": 0, + "detailsURL": "/dataservice/device/vedgeinventory/detail" + }, + { + "name": "Authorized", + "list": "Authorized", + "detailsURL": "/dataservice/device/vedgeinventory/detail?status=authorized", + "value": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/virtualApplication/te": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get ThousandEyes app list from device", + "operationId": "createTeList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Te apps list": { + "description": "Te apps list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/virtualApplication/utd": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get Utd apps list from device", + "operationId": "createUtdList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Utd apps list": { + "description": "Utd apps list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/virtualApplication/waas": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get Waas apps list from device", + "operationId": "createWaasList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Waas apps list": { + "description": "Waas apps list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/vm/nics": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get vbranch vm lifecycle state (NIC)", + "operationId": "getVbranchVMLifecycleNics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vBranch VM lifecycle state (NIC)": { + "description": "vBranch VM lifecycle state (NIC)", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vm/notifications": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get CloudDock vm lifecycle state", + "operationId": "getCloudDockVMLifecycleNics", + "parameters": [ + { + "name": "userGroup", + "in": "query", + "description": "userGroup Name", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudDock VM lifecycle state ": { + "description": "CloudDock VM lifecycle state ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vm/oper/state": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get vbranch vm lifecycle state", + "operationId": "getVbranchVMLifecycle", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vBranch VM lifecycle state": { + "description": "vBranch VM lifecycle state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vm/state": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get vm lifecycle state", + "operationId": "getVMLifeCycleState", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VM lifecycle state": { + "description": "VM lifecycle state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vmanage": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get vManage system IP", + "operationId": "getVManageSystemIP", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage system IP": { + "description": "vManage system IP", + "value": { + "header": { + "generatedOn": 1635317321149 + }, + "data": { + "ipAddress": "169.254.10.1" + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/voice/dspActive": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm Active DSP info from device", + "operationId": "getDspActive", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm Active DSP info": { + "description": "DSPFarm Active DSP info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/phoneInfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get phone registration info from device", + "operationId": "getPhoneInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VOIP call info": { + "description": "VOIP call info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/profiles": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm Profiles info from device", + "operationId": "getDSPFarmProfiles", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm Profiles info": { + "description": "DSPFarm Profiles info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/sccpCcmGroups": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm SCCP CCM Groups info from device", + "operationId": "getSccpCcmGroups", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm SCCP CCM Groups info": { + "description": "DSPFarm SCCP CCM Groups info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/sccpConnections": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm SCCP Connections info from device", + "operationId": "getSccpConnections", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm SCCP Connections info": { + "description": "DSPFarm SCCP Connections info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/voiceCalls": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get voice call info from device", + "operationId": "getVoiceCalls", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Voice call info": { + "description": "Voice call info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/voipCalls": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get VOIP call info from device", + "operationId": "getVoipCalls", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VOIP call info": { + "description": "VOIP call info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voiceisdninfo/isdnstatus": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Retrieve Voice ISDN Status from device", + "operationId": "getT1e1IsdnStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device voice ISDN status": { + "description": "Device voice ISDN status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voicet1e1controllerinfo/current15minstats": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Retrieve T1E1 controller last 15 min stats from device (Real Time)", + "operationId": "getControllerT1e1InfoCurrent15MinStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "T1E1 controller status": { + "description": "T1E1 controller status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voicet1e1controllerinfo/totalstats": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Retrieve T1E1 controller total stats from device (Real Time)", + "operationId": "getControllerT1e1InfoTotalStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "T1E1 controller status": { + "description": "T1E1 controller status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/vpn": { + "get": { + "tags": [ + "Real-Time Monitoring - VPN" + ], + "description": "Get VPN instance list from device (Real Time)", + "operationId": "getVPNInstances", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPN instance list ": { + "description": "VPN instance list ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/vrrp": { + "get": { + "tags": [ + "Real-Time Monitoring - VRRP" + ], + "description": "Get VRRP interface list from device", + "operationId": "getVRRPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VRRP interface": { + "description": "VRRP interface", + "value": { + "data": [ + { + "omp-state": "up", + "group-id": "123", + "if-name": "ge0/0", + "virtual-mac": "00:00:5e:00:01:7b", + "lastupdated": 1650878690993, + "vpn-id": "10", + "vdevice-dataKey": "169.254.10.9-10-ge0/0-123", + "advertisement-timer": "1", + "last-state-change-time": "0000-00-00T00:00:00+00:00", + "vdevice-host-name": "vm2", + "vrrp-state": "init", + "vdevice-name": "169.254.10.9", + "priority": "101" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/wireless/client": { + "get": { + "tags": [ + "Real-Time Monitoring - Wireless" + ], + "description": "Get wireless clients from device", + "operationId": "getWirelessClients", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wireless client": { + "description": "Wireless client", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/wireless/radio": { + "get": { + "tags": [ + "Real-Time Monitoring - Wireless" + ], + "description": "Get wireless Radios from device", + "operationId": "getWirelessRadios", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wireless Radio": { + "description": "Wireless Radio", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/wireless/ssid": { + "get": { + "tags": [ + "Real-Time Monitoring - Wireless" + ], + "description": "Get wireless SSID from device", + "operationId": "getWirelessSsid", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wireless SSID": { + "description": "Wireless SSID", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/wlan/clients": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN client from device", + "operationId": "getWLANClients", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN client": { + "description": "WLAN client", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/wlan/interfaces": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN interface from device", + "operationId": "getWLANInterfaces", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN interface": { + "description": "WLAN interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/wlan/radios": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN Radios from device", + "operationId": "getWLANRadios", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN Radios": { + "description": "WLAN Radios", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/wlan/radius": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN RADIUS authentication from device", + "operationId": "getWLANRadius", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN RADIUS authentication": { + "description": "WLAN RADIUS authentication", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/diagnostics/dbschema": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get the current database schema", + "operationId": "getDBSchema", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Schema definition": { + "description": "Schema definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/diagnostics/threadpools": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get information on the threadpools", + "operationId": "getThreadPools", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Thread pool": { + "description": "Thread pool", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/activate": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Activate cluster to start working as primary", + "operationId": "activate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/clusterInfo": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery cluster info", + "operationId": "getClusterInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR cluster info": { + "description": "DR cluster info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/dbrestore": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Signal vManage to initiate configuration-db restore operation", + "operationId": "restoreConfigDb", + "requestBody": { + "description": "Config-db meta payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Config-db meta payload": { + "description": "Config-db meta payload", + "value": { + "compressed_db": "db_bkp.tar.gz", + "destinationIP": "10.0.1.32", + "replicationToken": "38400000-8cf0-11bd-b23e-10b96e4ef00d" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/dbrestorestatus": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Config-db restore status", + "operationId": "getConfigDBRestoreStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Config-db Restore Status": { + "description": "Config-db Restore Status", + "value": { + "currentState": "DOWNLOADING" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/deleteLocalDataCenter": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Delete local data center", + "operationId": "deleteLocalDC", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request status": { + "description": "Request status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/deleteRemoteDataCenter": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Delete data center", + "operationId": "deleteDC", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request status": { + "description": "Request status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/deregister": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Delete disaster recovery", + "operationId": "delete", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/details": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery details", + "operationId": "getDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR details": { + "description": "DR details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/download/backup/{token}/db_bkp.tar.gz": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Downloading stats file", + "operationId": "download", + "parameters": [ + { + "name": "token", + "in": "path", + "description": "Token", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": {} + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/download/{token}/{fileName}": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Download replication data", + "operationId": "downloadReplicationData", + "parameters": [ + { + "name": "token", + "in": "path", + "description": "Token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fileName", + "in": "path", + "description": "File name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Property replication info": { + "description": "Property replication info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/drstatus": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Disaster recovery status", + "operationId": "getDisasterRecoveryStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DR status": { + "description": "DR status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/history": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery switchover history", + "operationId": "getHistory", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR switchover history": { + "description": "DR switchover history", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/localLatestHistory": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery local switchover history", + "operationId": "getLocalHistory", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR local switchover history": { + "description": "DR local switchover history", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/localdc": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get local data center details", + "operationId": "getLocalDataCenterState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Local datacenters detail": { + "description": "Local datacenters detail", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/password": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update data centers and vBonds passwords for disaster recovery", + "operationId": "update", + "requestBody": { + "description": "Datacenter/vBond password update request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter/vBond password update request": { + "description": "Datacenter/vBond password update request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR setting updated": { + "description": "DR setting updated", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pause": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR", + "operationId": "pauseDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pauseLocalArbitrator": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR for Local Arbitrator", + "operationId": "pauseLocalArbitrator", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pauseLocalDC": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR for Local datacenter", + "operationId": "pauseLocalDCForDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pauseLocalReplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR replication for Local datacenter", + "operationId": "pauseLocalDCReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/pausereplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR data replication", + "operationId": "disasterRecoveryPauseReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/register": { + "put": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update data centers for disaster recovery", + "operationId": "update_1", + "requestBody": { + "description": "Datacenter registration request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration request": { + "description": "Datacenter registration request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR setting updated": { + "description": "DR setting updated", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + }, + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Register data centers for disaster recovery", + "operationId": "register", + "requestBody": { + "description": "Datacenter registration request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration request": { + "description": "Datacenter registration request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/remoteDcState": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Gets remote data center member state", + "operationId": "getRemoteDCMembersState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote DC member details": { + "description": "Remote DC member details", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/remotePassword": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update disaster recovery information with updated password to remote data center", + "operationId": "updateDisasterRecoveryState", + "requestBody": { + "description": "Datacenter registration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Disaster recovery information with updated password to remote data center": { + "description": "Disaster recovery information with updated password to remote data center", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/remotedc": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get remote data center details", + "operationId": "getRemoteDataCenterState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote datacenters detail": { + "description": "Remote datacenters detail", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + }, + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update complete disaster recovery information to remote data center", + "operationId": "updateDisasterRecoveryState_1", + "requestBody": { + "description": "Datacenter registration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration": { + "description": "Datacenter registration", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/remotedc/swversion": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get remote data center vManage version", + "operationId": "getRemoteDataCenterVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage version": { + "description": "vManage version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/requestimport": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Replication Request message sent from primary", + "operationId": "disasterRecoveryReplicationRequest", + "requestBody": { + "description": "DR request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR request": { + "description": "DR request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/restartDataCenter": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Restart data center", + "operationId": "restartDataCenter", + "requestBody": { + "description": "Datacenter registration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration": { + "description": "Datacenter registration", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/schedule": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery local replication schedule", + "operationId": "getDisasterRecoveryLocalReplicationSchedule", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR replication schedule": { + "description": "DR replication schedule", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/status": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery status", + "operationId": "getdrStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR status": { + "description": "DR status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/unpause": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR", + "operationId": "unpauseDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/unpauseLocalArbitrator": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR for Local Arbitrator", + "operationId": "unpauseLocalArbitrator", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/unpauseLocalDC": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR for Local datacenter", + "operationId": "unpauseLocalDCForDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/unpauseLocalReplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR replication for local datacenter", + "operationId": "unpauseLocalDCReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/unpausereplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Un-Pause DR data replication", + "operationId": "disasterRecoveryUnPauseReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/updateDRConfigOnArbitrator": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update arbitrator with primary and secondary states cluster", + "operationId": "updateDrState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request status": { + "description": "Request status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/updateReplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update DR replication status", + "operationId": "updateReplication", + "requestBody": { + "description": "Replication status", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Replication status": { + "description": "Replication status", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/usernames": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Fetch data centers and vBonds usernames for disaster recovery", + "operationId": "get", + "requestBody": { + "description": "Datacenter/vBond password update request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter/vBond password update request": { + "description": "Datacenter/vBond password update request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR setting updated": { + "description": "DR setting updated", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/validateNodes": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Validate a list of nodes", + "operationId": "getReachabilityInfo", + "requestBody": { + "description": "Node list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Node list": { + "description": "Node list", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Node reachability list": { + "description": "Node reachability list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/entityownership/list": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "List all entity ownership info", + "operationId": "listEntityOwnershipInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Entity ownership": { + "description": "Entity ownership", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/entityownership/tree": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Entity ownership info grouped by buckets", + "operationId": "entityOwnershipInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Entity ownership": { + "description": "Entity ownership", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_25", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/event/aggregation": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events", + "$ref": "examples/elasticsearch/monitoring/parameter_example/Events.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events", + "$ref": "examples/elasticsearch/monitoring/response_example/Events.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_24", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events", + "$ref": "examples/elasticsearch/monitoring/parameter_example/Events.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events", + "$ref": "examples/elasticsearch/monitoring/response_example/Events.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/event/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_24", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events", + "$ref": "examples/elasticsearch/monitoring/parameter_example/Events.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events", + "$ref": "examples/elasticsearch/monitoring/response_example/Events.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/event/component/keyvalue": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve components as key/value pairs", + "operationId": "getComponentsAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Components as key value pair": { + "description": "Components as key value pair", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/csv": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/event/doccount": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get response count of a query", + "operationId": "getCount_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_27", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event/enable/fileprocess": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Set enable events from file flag", + "operationId": "enableEventsFromFile", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "enable.events.from.files flag": { + "description": "enable.events.from.files flag", + "value": { + "enable.events.from.files": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/event/fields": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event/getEventsByComponent": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve components as key/value pairs", + "operationId": "getEventsByComponent", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Components as key value pair": { + "description": "Components as key value pair", + "value": { + "header": { + "generatedOn": 1637035489933 + }, + "data": [ + { + "value": "Policy", + "key": "Policy" + }, + { + "value": "BFD", + "key": "BFD" + }, + { + "value": "App-Route", + "key": "App-Route" + }, + { + "value": "Security", + "key": "Security" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/listeners": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve listener information", + "operationId": "getListenersInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Event listener": { + "description": "Event listener", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/page": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_25", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/event/query/fields": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event/query/input": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Create query configuration", + "operationId": "createEventsQueryConfig", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Event query config": { + "description": "Event query config", + "value": { + "timeOptions": [ + { + "enableDateFields": false, + "value": "Last 24 hours", + "key": "last_24_hours" + }, + { + "enableDateFields": false, + "value": "Last 12 hours", + "key": "last_12_hours" + }, + { + "enableDateFields": true, + "value": "Custom", + "key": "custom" + } + ], + "component": [ + { + "value": "System", + "key": "system" + }, + { + "value": "Hardware", + "key": "hardware" + }, + { + "value": "BFD", + "key": "bfd" + } + ], + "severityOptions": [ + { + "value": "Critical", + "key": "critical" + }, + { + "value": "Major", + "key": "major" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/severity": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve events", + "operationId": "findEvents", + "parameters": [ + { + "name": "severity-level", + "in": "query", + "description": "Severity level", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "critical", + "major", + "minor" + ] + }, + "enum": [ + "critical", + "major", + "minor" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Severity histogram": { + "description": "Severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/severity/summary": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve severity histogram", + "operationId": "getSeverityHistogram", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Severity histogram": { + "description": "Severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/types/keyvalue": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve event types as key/value pairs", + "operationId": "getEventTypesAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Events as key value pair": { + "description": "Events as key value pair", + "value": { + "header": { + "generatedOn": 1637030060147 + }, + "data": [ + { + "value": "system-software-install-change", + "key": "system-software-install-change" + }, + { + "value": "system-software-install-status", + "key": "system-software-install-status" + }, + { + "value": "system-firmware-install-status", + "key": "system-firmware-install-status" + }, + { + "value": "im-event", + "key": "im-event" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/featurecertificate/certificate": { + "get": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Get feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getDeviceCertificate", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device feature cert": { + "description": "Device feature cert", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + }, + "put": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Upload feature cert for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "installFeatureCertificate", + "requestBody": { + "description": "Install feature cert request for cEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature cert request": { + "description": "Feature cert request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/featurecertificate/devicecsr": { + "get": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Get CSR from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getDeviceCsr", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device CSR": { + "description": "Device CSR", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + }, + "put": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Create CSR for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "genDeviceCsr", + "requestBody": { + "description": "CSR request for cEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/featurecertificate/revoke": { + "put": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Revoke feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "revokeFeatureCertificate", + "requestBody": { + "description": "Revoking feature cert request for cEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoking feature cert request": { + "description": "Revoking feature cert request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/featurecertificate/syslogconfig": { + "get": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Get Feature CA state


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getFeatureCaState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature CA state": { + "description": "Feature CA state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/fedramp/dnssec/actions": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Request DNS-Sec actions", + "operationId": "requesDNSSecActions", + "parameters": [ + { + "name": "action", + "in": "query", + "description": "DNS-Sec action", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DNS-Sec action status": { + "description": "DNS-Sec action status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/fedramp/dnssec/config": { + "post": { + "tags": [ + "Deployment Mode" + ], + "description": "Configure DNS-Sec", + "operationId": "configureDNSSec", + "requestBody": { + "description": "DNS sec config request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DNS sec config request": { + "description": "DNS sec config request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,FedRamp-write" + } + }, + "/fedramp/dnssec/status": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Get DNS-Sec status", + "operationId": "getDNSSecStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DNS-Sec status": { + "description": "DNS-Sec status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/fedramp/status": { + "post": { + "tags": [ + "Deployment Mode" + ], + "description": "Set network deployment mode", + "operationId": "configFedrampMode", + "requestBody": { + "description": "Network deployment mode", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network deployment mode": { + "description": "Network deployment mode", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,FedRamp-write" + } + }, + "/fedramp/wazuh/actions": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Wazuh agent action", + "operationId": "requestWazuhActions", + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Wazhuh Action", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Wazhug agent action status": { + "description": "Wazhug agent action status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/fedramp/wazuh/config": { + "post": { + "tags": [ + "Deployment Mode" + ], + "description": "Configure Wazuh agent", + "operationId": "configureWazuhClient", + "requestBody": { + "description": "Wazhuh configuration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wazhuh configuration request": { + "description": "Wazhuh configuration request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,FedRamp-write" + } + }, + "/fedramp/wazuh/status": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Get Wazuh agent status", + "operationId": "getWazuhAgentStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Wazhug agent status": { + "description": "Wazhug agent status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/group": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve device group list", + "operationId": "listDeviceGroupList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device group list": { + "description": "Device group list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/group/device": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve device groups", + "operationId": "listDeviceGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device group": { + "description": "Device group", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/group/devices": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve devices in group", + "operationId": "listGroupDevices", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ssh", + "in": "query", + "description": "SSH", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/group/map/devices": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve group devices for map", + "operationId": "listGroupDevicesForMap", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Group devices map": { + "description": "Group devices map", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/group/map/devices/links": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve devices in group for map", + "operationId": "listGroupLinksForMap", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices in group map": { + "description": "Devices in group map", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/health/devices": { + "get": { + "tags": [ + "Monitoring - Health" + ], + "description": "get the devices health properties", + "operationId": "getDevicesHealth", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "Page Number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "Page Size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "Sort By Property", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "Sort Order", + "schema": { + "type": "string" + } + }, + { + "name": "startingDeviceId", + "in": "query", + "description": "Optional device ID to start first page", + "schema": { + "type": "string" + } + }, + { + "name": "siteId", + "in": "query", + "description": "Optional site ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "group_id", + "in": "query", + "description": "Optional group ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "groupId", + "in": "query", + "description": "Optional group ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "Optional vpn ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "reachable", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "controlStatus", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "personality", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "health", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "devices health properties": { + "description": "devices health properties", + "value": { + "total_devices": 3, + "devices": [ + { + "name": "vm3", + "personality": "vedge", + "uuid": "04a116f8-9a16-4bf6-9f1f-f58e2619312d", + "reachability": "reachable", + "longitude": "-122.777023", + "latitude": "37.666684", + "health": "green", + "qoe": 10, + "location": "lat: 37.666684, long: -122.777023", + "site_id": "3", + "system_ip": "169.254.10.10", + "device_type": "vedge", + "local_system_ip": "172.16.254.2", + "device_model": "vEdge Cloud", + "software_version": "20.6.0-231", + "cpu_load": 1.32, + "memory_utilization": 25.0, + "control_connections": 3, + "control_connections_up": 3, + "has_geo_data": true, + "uptime_date": 1629963840000, + "device_groups": [ + "No groups" + ], + "connected_vmanages": [ + "169.254.10.3" + ], + "bfd_sessions_up": 5, + "bfd_sessions": 5, + "omp_peers": 2, + "omp_peers_up": 2, + "board_serial_number": "12345708", + "chassis_number": "04a116f8-9a16-4bf6-9f1f-f58e2619312d", + "vpn_ids": null + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/health/devices/overview": { + "get": { + "tags": [ + "Monitoring - Health" + ], + "description": "gets devices health overview", + "operationId": "getDevicesHealthOverview", + "parameters": [ + { + "name": "vpn_id", + "in": "query", + "description": "Optional vpn ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "Optional vpn ID to filter devices", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "devices health overview": { + "description": "devices health overview", + "value": { + "good": 3, + "fair": 3, + "poor": 0 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/hsec/activate": { + "post": { + "tags": [ + "Hsec Activate" + ], + "description": "Activate Hsec licenses on devices", + "operationId": "activateHsecLicenses", + "requestBody": { + "description": "Tenant List", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant List": { + "description": "Tenant List", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "License Management-write" + } + }, + "/hsec/assign": { + "post": { + "tags": [ + "HSEC License" + ], + "description": "hsec ", + "operationId": "hsecassign", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/assignSlac": { + "post": { + "tags": [ + "HSEC" + ], + "description": "Assign Hsec License to devices from uploaded SLAC file", + "operationId": "assignSlac", + "requestBody": { + "description": "SLAC File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/uploadHSECAuthFile" + }, + "examples": { + "License": { + "description": "License", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/hsec/devices": { + "get": { + "tags": [ + "HSEC" + ], + "description": "Give list of HSEC license devices", + "operationId": "device Summmary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/devices/install": { + "get": { + "tags": [ + "HSEC" + ], + "description": "Give list of HSEC license devices", + "operationId": "device Summmary_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/download": { + "post": { + "tags": [ + "HSEC" + ], + "description": "Download SLAC Request file for CSSM", + "operationId": "downloadSlacRequestFile", + "requestBody": { + "description": "Device List", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/hsec/fetchaccounts": { + "get": { + "tags": [ + "HSEC" + ], + "description": "fetch sava accounts that support HSEC Licensing", + "operationId": "fetchAccounts_1", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "userName", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pwd", + "in": "query", + "description": "password", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "mode", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/uploadAuth": { + "post": { + "tags": [ + "HSEC" + ], + "description": "upload SLAC File and fetch device summary", + "operationId": "uploadSlacFile", + "requestBody": { + "description": "SLAC File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/uploadHSECAuthFile" + }, + "examples": { + "License": { + "description": "License", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/ise/connect": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "ISE connect", + "operationId": "connect_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "ISE connect": { + "description": "ISE connect", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write,default" + } + }, + "/ise/credentials": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get Ise server credentials", + "operationId": "getIseServerCredentials", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IseServer": { + "description": "IseServer", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + }, + "put": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Configure Ise server credentials", + "operationId": "updateIseServerCredentials", + "requestBody": { + "description": "Config Ise server request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server request": { + "description": "Ise server request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server": { + "description": "Ise server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Add Ise server credentials", + "operationId": "addIseServerCredentials", + "requestBody": { + "description": "Config Ise server request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server request": { + "description": "Ise server request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server": { + "description": "Ise server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/credentials/iseandpxgrid": { + "delete": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Delete ISE and PxGrid on vManage", + "operationId": "deleteIseAndPxGridAccount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ISE and PxGrid Deleted": { + "description": "ISE and PxGrid Deleted", + "value": true + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/credentials/pxgrid": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get PXGrid account", + "operationId": "getPxGridAccount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PXGrid": { + "description": "PXGrid", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + }, + "delete": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Delete PxGrid on vManage", + "operationId": "deletePxGrid", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PxGrid Deleted": { + "description": "PxGrid Deleted", + "value": true + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/credentials/pxgrid/cert": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "getPXgridCert", + "operationId": "getPXgridCert", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IseServer": { + "description": "IseServer", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + } + }, + "/ise/credentials/vsmart/sync": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "syncVsmart", + "operationId": "syncVsmart", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IseServer": { + "description": "IseServer", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + } + }, + "/ise/pxgrid/activate": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "pxGrid Account Activate", + "operationId": "AccountActivate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "pxGrid Account Activate": { + "description": "pxGrid Account Activate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/pxgrid/approve": { + "put": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "pxGrid Account Approve with ERS API", + "operationId": "approve", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "pxGrid Account Approve": { + "description": "pxGrid Account Approve", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/pxgrid/create": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "pxGrid Account Create", + "operationId": "AccountCreate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "pxGrid Account Create": { + "description": "pxGrid Account Create", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/localization/supportedLocales": { + "get": { + "tags": [ + "Locale" + ], + "description": "Get Supported locales", + "operationId": "Get Supported locales", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "locales": [ + { + "code": "en_US", + "displayName": "English (US)" + }, + { + "code": "fr_CA", + "displayName": "French (Canadian)" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/attachDevices/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP attached devices", + "operationId": "Retrieve MDP attached devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Edit attached devices", + "operationId": "Edit attached devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "deviceList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "devices": { + "description": "devices", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Share devices with MDP", + "operationId": "Attach devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "deviceList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Devices": { + "description": "Devices", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/detachDevices/{nmsId}": { + "post": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Disconnect devices from mpd controller", + "operationId": "Detach devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "deviceList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Onboard": { + "description": "Onboard", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/devices/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP supported devices", + "operationId": "Retrieve MDP supported devices ", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/disconnect/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "disconnect from mpd controller", + "operationId": "disconnect from mdp", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "status": { + "description": "status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/onboard": { + "post": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Start MDP onboarding operation", + "operationId": "onboardMDP", + "requestBody": { + "description": "Onboard", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "onboarding-payload": { + "description": "onboarding-payload", + "value": { + "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", + "name": "sdwane2e", + "description": "sdwan24", + "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", + "uri": "10.10.10.1:24038" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "nmsId": { + "description": "nmsId", + "value": { + "nmsId": "fc335c24-fb30-46bb-81ff-fda84264eb58" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/onboard/status": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Get MDP onboarding status", + "operationId": "Get MDP onboarding status", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "completed" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/onboard/{nmsId}": { + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "update MDP onboarding document", + "operationId": "updateOnboardingPayload", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Onboard", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "onboarding-payload": { + "description": "onboarding-payload", + "value": { + "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", + "name": "sdwane2e", + "description": "sdwan24", + "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", + "uri": "10.10.10.1:24038" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "nmsId": { + "description": "nmsId", + "value": { + "nmsId": "fc335c24-fb30-46bb-81ff-fda84264eb58" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + }, + "delete": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "offboard the mdp application", + "operationId": "offboard", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/policies/mdpconfig": { + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Add internal policy from vmanage", + "operationId": "addInternalPolicy", + "requestBody": { + "description": "addInternalPolicy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "mdpConfig-payload": { + "description": "mdpConfig-payload", + "value": { + "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", + "name": "sdwane2e", + "description": "sdwan24", + "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", + "uri": "10.10.10.1:24038" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "deviceId": { + "description": "deviceId", + "value": { + "deviceId": "fc335c24-fb30-46bb-81ff-fda84264eb58" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/policies/mdpconfig/{deviceId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP ConfigObject", + "operationId": "Retrieve MDP ConfigObject", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "MdpConfig": { + "description": "MdpConfig", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/policies/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP policies", + "operationId": "Retrieve MDP policies", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policies": { + "description": "Policies", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "update policy status", + "operationId": "update policy status", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "policyList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "policies": { + "description": "policies", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/messaging/device/vmanage": { + "get": { + "tags": [ + "Device - Messaging" + ], + "description": "Create device vManage connection list", + "operationId": "createDeviceVmanageConnectionList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Connection list": { + "description": "Connection list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/monitor/sdavccloudconnector/domain": { + "get": { + "tags": [ + "SD AVC Domain-based App Rules" + ], + "description": "Get SD_AVC App Rules based on Domain", + "operationId": "getCloudConnectorDomainAppRules", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/monitor/sdavccloudconnector/ipaddress": { + "get": { + "tags": [ + "SD AVC IP Address based App Rules" + ], + "description": "Get SD_AVC App Rules based on IP Address", + "operationId": "getCloudConnectorIpAddressAppRules", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/msla/devices": { + "get": { + "tags": [ + "MSLA" + ], + "description": "Retrieve devices subscription", + "operationId": "getMSLADevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device subscription": { + "description": "Device subscription", + "value": { + "data": [ + { + "configuredHostname": "vm11", + "chasisNumber": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "UUID": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "deviceModel": "vedge-cloud", + "configuredSystemIP": "172.16.255.21", + "licenseStatus": "Subscription Needed" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/licenses/sync": { + "post": { + "tags": [ + "MSLA" + ], + "description": "Retrieve MSLA subscription/licenses", + "operationId": "syncLicenses_2", + "requestBody": { + "description": "Sync license", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sync license": { + "description": "Sync license", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription license": { + "description": "Subscription license", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/monitoring/licensedDeviceCount": { + "get": { + "tags": [ + "MSLA" + ], + "description": "get license and device count", + "operationId": "get license and device count", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/monitoring/licensedDistributionDetails": { + "get": { + "tags": [ + "MSLA" + ], + "description": "get license and device count", + "operationId": "get license and device count_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/monitoring/packagingDistributionDetails": { + "get": { + "tags": [ + "MSLA" + ], + "description": "get packaging distribution details", + "operationId": "get packaging distribution details", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/template": { + "get": { + "tags": [ + "MSLA" + ], + "description": "Retrieve all MSLA template", + "operationId": "getAllTemplate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/template/licenses": { + "post": { + "tags": [ + "MSLA" + ], + "description": "Retrieve MSLA subscription/licenses", + "operationId": "getSubscriptions_1", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/va/License": { + "get": { + "tags": [ + "MSLA" + ], + "description": "Retrieve MSLA subscription/licenses", + "operationId": "getSubscriptions", + "parameters": [ + { + "name": "virtual_account_id", + "in": "query", + "description": "virtual_account_id", + "schema": { + "type": "string" + } + }, + { + "name": "licenseType", + "in": "query", + "description": "licenseType", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/multicloud/accounts": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get All cloud accounts", + "operationId": "getAllCloudAccounts", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "cloudGatewayEnabled", + "in": "query", + "description": "Cloud gateway enabled flag", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud accounts": { + "description": "Cloud accounts" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Authenticate cloud account credentials", + "operationId": "validateAccountAdd", + "requestBody": { + "description": "Multicloud account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/accounts/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get all Multicloud edge accounts", + "operationId": "getEdgeAccounts", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge accounts": { + "description": "Edge accounts" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Authenticate edge account credentials", + "operationId": "validateEdgeAccountAdd", + "requestBody": { + "description": "Multicloud edge account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Account info": { + "description": "Edge Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/accounts/edge/{accountId}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get edge account by account Id", + "operationId": "getEdgeAccountDetails", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Multicloud edge account", + "operationId": "updateEdgeAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Multicloud Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud edge account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete edge account", + "operationId": "deleteEdgeAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/accounts/edge/{accountId}/credentials": { + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Multicloud edge account credential", + "operationId": "validateEdgeAccountUpdateCredentials", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Multicloud Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud edge account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/accounts/{accountId}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud account by account Id", + "operationId": "getCloudAccountDetails", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update multicloud account", + "operationId": "updateAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete cloud account", + "operationId": "deleteAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/accounts/{accountId}/credentials": { + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update multicloud account credential", + "operationId": "validateAccountUpdateCredentials", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/audit": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an audit with dry run", + "operationId": "auditDryRun", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an audit", + "operationId": "audit", + "requestBody": { + "description": "Audit", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Audit": { + "description": "Audit" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/audit/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an edge audit with dry run", + "operationId": "edgeAuditDryRun", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an edge audit", + "operationId": "edgeAudit", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Billing Accounts", + "operationId": "getEdgeBillingAccounts", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Interconnect Provider", + "required": true, + "schema": { + "type": "string", + "enum": [ + "EQUINIX" + ] + } + }, + { + "name": "edgeAccountId", + "in": "path", + "description": "Interconnect Provider Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Billing Accounts": { + "description": "Edge Billing Accounts", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/cloudRoutersAndAttachments": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get all Cloud Routers and their Attachments", + "operationId": "getCloudRoutersAndAttachments", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "network", + "in": "query", + "description": "Network", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGatewayName", + "in": "query", + "description": "Connectivity Gateway Name", + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "State", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud Router": { + "description": "Cloud Router", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/cloudgateway": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateways", + "operationId": "getCgws", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud gateway name", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityState", + "in": "query", + "description": "Connectivity State", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateways": { + "description": "Cloud gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create cloud gateway", + "operationId": "createCgw", + "requestBody": { + "description": "Cloud gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway": { + "description": "Cloud gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get NVA Security Rules", + "operationId": "getNvaSecurityRules", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Get NVA security Rules", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get NVA Security Rules": { + "description": "Get NVA Security Rules" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NVA Security Rules": { + "description": "NVA Security Rules", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update NVA Security Rules", + "operationId": "updateNvaSecurityRules", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update NVA security Rules", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update NVA Security Rules": { + "description": "Update NVA Security Rules" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task ID": { + "description": "Task ID", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/cloudgateway/nvas": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Virtual NVAs", + "operationId": "getAzureNetworkVirtualAppliances", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accoundId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "query", + "description": "Resource Group Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupSource", + "in": "query", + "description": "Resource Group Source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vhubName", + "in": "query", + "description": "VHUB name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vhubSource", + "in": "query", + "description": "VHUB source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Virtual NVAs": { + "description": "Discover Azure Virtual NVAs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/nvasku": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Azure NVA SKUs", + "operationId": "getAzureNvaSkuList", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateways NVA SKUs": { + "description": "Cloud gateways NVA SKUs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/resource": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateways", + "operationId": "getCgwOrgResources", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateways": { + "description": "Cloud gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/resourceGroups": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Resource Groups", + "operationId": "getAzureResourceGroups", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Resource Groups": { + "description": "Discover Azure Resource Groups", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/vhubs": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Virtual HUBs", + "operationId": "getAzureVirtualHubs", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accoundId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "query", + "description": "Resource Group Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupSource", + "in": "query", + "description": "Resource Group Source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vwanName", + "in": "query", + "description": "VWAN name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vwanSource", + "in": "query", + "description": "VWAN source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Virtual HUBs": { + "description": "Discover Azure Virtual HUBs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/vwans": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Virtual WANs", + "operationId": "getAzureVirtualWans", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accoundId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "query", + "description": "Resource Group Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupSource", + "in": "query", + "description": "Resource Group Source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Virtual WANs": { + "description": "Discover Azure Virtual WANs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/{cloudGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateway by name", + "operationId": "getCgwDetails", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway": { + "description": "Cloud gateway", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update cloud gateway", + "operationId": "updateCgw", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cloud gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway": { + "description": "Cloud gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete cloud gateway", + "operationId": "deleteCgw", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deleteAllResources", + "in": "query", + "description": "Optional Flag for deletion of Azure Resource Group, Default: True", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/cloudgateway/{cloudGatewayName}/site": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites attached to CGW", + "operationId": "getSites_1", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "systemIp", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "siteId", + "in": "query", + "description": "Site Id", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Color", + "schema": { + "type": "string" + } + }, + { + "name": "vpnTunnelStatus", + "in": "query", + "description": "Fetch vpnTunnelStatus", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update tunnel scaling and accelerated vpn parameter for a branch endpoint", + "operationId": "TunnelScaling", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Site information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TunnelScalingPayload": { + "description": "TunnelScalingPayload", + "value": "{\n \"cloudType\":\"AWS\",\n \"branchEndpoints\":[\n \"siteId\":\"578\",\n \"systemIp\":\"1.1.1.178\",\n \"color\":\"red\",\n \"acceleratedVpn\":\"true\",\n \"tunnelCount\":\"4\"]\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Attach sites to cloud gateway", + "operationId": "attachSites", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Site information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Detach sites from cloud gateway", + "operationId": "detachSites_1", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Site information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/cloudgateways/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the cloud by cloud type", + "operationId": "getCloudGateways", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud Gateways": { + "description": "Cloud Gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgatewaysetting/{cloudGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateway custom setting by cloud gateway name", + "operationId": "getCgwCustomSettingDetails", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway custom setting": { + "description": "Cloud gateway custom setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgatewaytype": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateway types for specified cloudType", + "operationId": "getCgwTypes", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway type": { + "description": "Cloud gateway type", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/connected-sites/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the interconnect gateways by edge type", + "operationId": "getCloudConnectedSites_1", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Interconnect Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect connected sites": { + "description": "Interconnect connected sites", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/connected-sites/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the cloud by cloud type", + "operationId": "getCloudConnectedSites", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud connected sites": { + "description": "Cloud connected sites", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/connectivity/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Connectivity details", + "operationId": "getEdgeConnectivityDetails", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "connectivityName", + "in": "query", + "description": "Connectivity Name", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Connectivity Type", + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Interconnect Gateway name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IC-GW Connectivity": { + "description": "IC-GW Connectivity", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Interconnect connectivity", + "operationId": "updateEdgeConnectivity", + "requestBody": { + "description": "Edge connectivity", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge connectivity": { + "description": "Edge connectivity" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Interconnect connectivity", + "operationId": "createEdgeConnectivity", + "requestBody": { + "description": "Edge connectivity", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge connectivity": { + "description": "Edge connectivity" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivity/edge/{connectionName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Interconnect connectivity", + "operationId": "deleteEdgeConnectivity", + "parameters": [ + { + "name": "connectionName", + "in": "path", + "description": "Edge connectivity name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivity/edge/{connectivityName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Connectivity by name", + "operationId": "getEdgeConnectivityDetailByName", + "parameters": [ + { + "name": "connectivityName", + "in": "path", + "description": "IC-GW connectivity name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IC-GW Connectivity Name": { + "description": "IC-GW Connectivity Name", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivitygateway": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get all Connectivity Gateways", + "operationId": "getConnectivityGateways", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Cloud Connectivity Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGatewayName", + "in": "query", + "description": "Connectivity Gateway Name", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "network", + "in": "query", + "description": "Network", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "State", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + }, + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge gateways": { + "description": "Edge gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Connectivity gateway", + "operationId": "createConnectivityGateway", + "requestBody": { + "description": "Connectivity gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connectivity gateway": { + "description": "Connectivity gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete all Connectivity Gateways in local DB", + "operationId": "cleanUpAllConnectivityGatewaysInLocalDB", + "parameters": [ + { + "name": "deletionType", + "in": "query", + "description": "Deletion Type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Connectivity Gateway", + "operationId": "deleteConnectivityGateway", + "parameters": [ + { + "name": "cloudProvider", + "in": "path", + "description": "Cloud Provider", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGatewayName", + "in": "path", + "description": "Connectivity gateway name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Cloud Connectivity Type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivitygatewaycreationoptions": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get connectivity gateway creation options", + "operationId": "getConnectivityGatewayCreationOptions", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Cloud Connectivity Type", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connectivity Gateway Creation options": { + "description": "Connectivity Gateway Creation options", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/dashboard/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get interconnect edge gateway dashboard info", + "operationId": "getDashboardEdgeInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Dashboard edge info": { + "description": "Dashboard edge info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/device": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get available WAN edge devices", + "operationId": "getWanDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge devices": { + "description": "Edge devices" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/devicelink/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Device Links", + "operationId": "getDeviceLinks", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "deviceLinkName", + "in": "query", + "description": "Device Link Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Links": { + "description": "Device Links", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Device Link", + "operationId": "updateDeviceLink", + "requestBody": { + "description": "Device Link", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Link": { + "description": "Device Link" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Device Link", + "operationId": "createDeviceLink", + "requestBody": { + "description": "Device Link", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Link": { + "description": "Device Link" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devicelink/edge/portspeed/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get supported port speed for Device Link", + "operationId": "getDlPortSpeed", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Interconnect Provider", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "port-speed": { + "description": "port-speed", + "value": "{100, 200}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devicelink/edge/{deviceLinkName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Device Link", + "operationId": "deleteDeviceLink", + "parameters": [ + { + "name": "deviceLinkName", + "in": "path", + "description": "Device Link Name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devicelink/metroSpeed/edge": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Device Link Metro Speed based on device link config", + "operationId": "getDeviceLinkMetroSpeed", + "requestBody": { + "description": "Device Link", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Link": { + "description": "Device Link", + "value": { + "edgeType": "EQUINIX", + "edgeAccountId": "cisco_dev", + "deviceLinkName": "test", + "bandwidth": "50", + "deviceList": [ + { + "deviceName": "test-dev-0" + }, + { + "deviceName": "test-dev-1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "dlMetroBandwidth": { + "description": "dlMetroBandwidth", + "value": 1000 + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devices/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud devices by cloud type", + "operationId": "getCloudDevices_1", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Edge Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud devices": { + "description": "Cloud devices", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/devices/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud devices by cloud type", + "operationId": "getCloudDevices", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud devices": { + "description": "Cloud devices", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/edge/{edgeType}/device": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get available WAN edge devices", + "operationId": "getEdgeWanDevices", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge devices": { + "description": "Edge devices" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/gateway/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateways", + "operationId": "getIcgws", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "regionId", + "in": "query", + "description": "Region Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceState", + "in": "query", + "description": "Resource State", + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Edge gateway name", + "schema": { + "type": "string" + } + }, + { + "name": "billingAccountId", + "in": "query", + "description": "billing Account Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateways": { + "description": "Interconnect Gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Interconnect Gateway", + "operationId": "createIcgw", + "requestBody": { + "description": "Interconnect Gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway": { + "description": "Interconnect Gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateway/edge/setting/{edgeGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateway custom setting by Interconnect Gateway name", + "operationId": "getIcgwCustomSettingDetails", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway custom setting": { + "description": "Interconnect Gateway custom setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateway/edge/types": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateway type for specified Edge Provider", + "operationId": "getIcgwTypes", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway type": { + "description": "Interconnect Gateway type", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateway/edge/{edgeGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateway by name", + "operationId": "getIcgwDetails", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway": { + "description": "Interconnect Gateway", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Interconnect Gateway", + "operationId": "updateIcgw", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Interconnect Gateway", + "operationId": "deleteIcgw", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateways/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the interconnect gateways by edge type", + "operationId": "getEdgeGateways", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Gateways": { + "description": "Edge Gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/hostvpc": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get tagged, untagged, or all Host VPCs", + "operationId": "getHostVpcs", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "accountIds", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "untagged", + "in": "query", + "description": "Untagged flag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/hostvpc/tags": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get vpc tags", + "operationId": "getVpcTags", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "tagName", + "in": "query", + "description": "Tag name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Edit VPCs for a tag", + "operationId": "editTag", + "requestBody": { + "description": "VPC tag", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC tag": { + "description": "VPC tag" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Tag a VPC", + "operationId": "hostvpcTagging", + "requestBody": { + "description": "VPC tag", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC tag": { + "description": "VPC tag" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/hostvpc/tags/{tagName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete a tag", + "operationId": "unTag", + "parameters": [ + { + "name": "tagName", + "in": "path", + "description": "Tag name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/imagename/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge provider supported images", + "operationId": "getSupportedEdgeImageNames", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge provider images": { + "description": "Edge provider images" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/instancesize": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Transit VPC supported size", + "operationId": "getSupportedInstanceSize", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "accountId", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Transit VPC size": { + "description": "Transit VPC size" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/instancesize/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge provider supported size", + "operationId": "getSupportedEdgeInstanceSize", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge provider size": { + "description": "Edge provider size" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/interfacecolor": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get WAN interface colors", + "operationId": "getWanInterfaceColors", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface Colors": { + "description": "Interface Colors" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/license/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get License Info for Edge Gateways/Connections", + "operationId": "getLicenses", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Edge Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "productType", + "in": "query", + "description": "product Type", + "schema": { + "type": "string", + "enum": [ + "GATEWAY", + "CONNECTION", + "AWSHC" + ] + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh License Cache from Megaport", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Licenses": { + "description": "Licenses", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/locations/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Locations", + "operationId": "getEdgeLocationsInfo", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + }, + { + "name": "accountId", + "in": "query", + "description": "Edge Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge locations": { + "description": "Edge locations" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete edge account", + "operationId": "deleteEdgeAccount_1", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/locations/edge/{edgeType}/accountId/{accountId}": { + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Edge Locations", + "operationId": "updateEdgeLocationsInfo", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + }, + { + "name": "accountId", + "in": "path", + "description": "Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge locations": { + "description": "Edge locations" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/loopbackCGWColor/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Loopback CGW supported colors", + "operationId": "getSupportedLoopbackCgwColors", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Loopback CGW colors": { + "description": "Edge Loopback CGW colors" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/loopbacktransportcolor/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Loopback Tunnel supported colors", + "operationId": "getSupportedLoopbackTransportColors", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Loopback Tunnel colors": { + "description": "Edge Loopback Tunnel colors", + "value": { + "loopbackTunnelColor": [ + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/map": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getMappingMatrix", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map matrix": { + "description": "VPC cloud gateway map matrix", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Process intent of connecting VPNs with VPCs through cloud gateway", + "operationId": "processMapping", + "requestBody": { + "description": "VPC mapping", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC mapping": { + "description": "VPC mapping" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/map/defaults": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getDefaultMappingValues", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map": { + "description": "VPC cloud gateway map", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/status": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get mapping status", + "operationId": "getMappingStatus", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map status": { + "description": "VPC cloud gateway map status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/summary": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get mapping summary", + "operationId": "getMappingSummary", + "parameters": [ + { + "name": "vpnTunnelStatus", + "in": "query", + "description": "VPN tunnel status", + "schema": { + "type": "boolean" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map summary": { + "description": "VPC cloud gateway map summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/tags": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getMappingTags", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map tags": { + "description": "VPC cloud gateway map tags", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/tags/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default Interconnect mapping tag values", + "operationId": "getEdgeMappingTags", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Cloud Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Cloud Tags": { + "description": "Interconnect Cloud Tags", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/vpns": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getMappingVpns", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map VPN": { + "description": "VPC cloud gateway map VPN", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/mapping/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get associated mappings to the CGW", + "operationId": "getCgwAssociatedMappings", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "siteUuid", + "in": "query", + "description": "Site Device UUID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud Gateway Mappings": { + "description": "Cloud Gateway Mappings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/partnerports/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get partner ports", + "operationId": "getPartnerPorts", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Edge Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectType", + "in": "query", + "description": "Connect Type filter", + "schema": { + "type": "string" + } + }, + { + "name": "vxcPermitted", + "in": "query", + "description": "VXC Permitted on the port", + "schema": { + "type": "string" + } + }, + { + "name": "authorizationKey", + "in": "query", + "description": "authorization Key", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Partners ": { + "description": "Edge Partners ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get supported port speed", + "operationId": "getPortSpeed", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Interconnect Provider", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "edgeAccountId", + "in": "path", + "description": "Interconnect Provider Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "path", + "description": "Interconnect Connectivity Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Service Provider", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AZURE", + "GCP" + ] + } + }, + { + "name": "cloudAccountId", + "in": "query", + "description": "Cloud Service Provider Account ID", + "schema": { + "type": "string" + } + }, + { + "name": "connectType", + "in": "query", + "description": "Connection Type filter", + "schema": { + "type": "string" + } + }, + { + "name": "connectSubType", + "in": "query", + "description": "Connection Sub-Type filter", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGateway", + "in": "query", + "description": "Connectivity Gateway", + "schema": { + "type": "string" + } + }, + { + "name": "partnerPort", + "in": "query", + "description": "partnerPort", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "port-speed": { + "description": "port-speed", + "value": "{100, 200}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/regions": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud regions", + "operationId": "getCloudRegions", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud regions": { + "description": "Cloud regions" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/settings/edge/global": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get edge global settings", + "operationId": "getEdgeGlobalSettings", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MP", + "EQ" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update edge global settings for Edge provider", + "operationId": "updateEdgeGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Add global settings for Edge provider", + "operationId": "addEdgeGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/settings/global": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get global settings", + "operationId": "getGlobalSettings", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update ip in resource pool", + "operationId": "updateGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Acquire ip from resource pool", + "operationId": "addGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/site": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get available sites", + "operationId": "getSites", + "parameters": [ + { + "name": "color", + "in": "query", + "description": "Color", + "schema": { + "type": "string" + } + }, + { + "name": "attached", + "in": "query", + "description": "Is endpoint attached", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/sshkeys": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get SSH keys", + "operationId": "getSshKeyList", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SSH key": { + "description": "SSH key" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/statistics/interface/aggregation": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_25", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/multicloud/swimages": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get software image list", + "operationId": "getSupportedSoftwareImageList", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Software images": { + "description": "Software images" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/telemetry": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "reports telemetry data", + "operationId": "telemetry", + "requestBody": { + "description": "telemetry", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "telemetry": { + "description": "telemetry" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/tunnels/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get tunnel names", + "operationId": "getTunnelNames", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud gateway name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel names": { + "description": "Tunnel names" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/types": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud types", + "operationId": "getCloudTypes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud types": { + "description": "Cloud types" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/types/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get edge types", + "operationId": "getEdgeTypes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud types": { + "description": "Cloud types" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vhubs": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Virtual Hubs", + "operationId": "getVHubs", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + }, + { + "name": "vWanName", + "in": "query", + "description": "VWan Name", + "schema": { + "type": "string" + } + }, + { + "name": "vNetTags", + "in": "query", + "description": "VNet Tags", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Azure Virtual WANs": { + "description": "Azure Virtual WANs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vwan": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Virtual WAN", + "operationId": "createVirtualWan", + "requestBody": { + "description": "Virtual WAN", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Virtual WAN": { + "description": "Virtual WAN" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vwan/{cloudProvider}/{vWanName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Virtual Wan", + "operationId": "deleteVirtualWan", + "parameters": [ + { + "name": "cloudProvider", + "in": "path", + "description": "Cloud Provider", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vWanName", + "in": "path", + "description": "Virtual Wan name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vwans": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Virtual Wans", + "operationId": "getVWans", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Azure Virtual WANs": { + "description": "Azure Virtual WANs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/widget/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Edge widget by edge type", + "operationId": "getEdgeWidget", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge widget": { + "description": "Edge widget", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/widget/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud widget by cloud type", + "operationId": "getCloudWidget", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud widget": { + "description": "Cloud widget", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/network/connectionssummary": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve vManage control status", + "operationId": "getVmanageControlStatus", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Is cached flag", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage control status": { + "description": "vManage control status", + "value": { + "data": [ + { + "name": "vSmart", + "count": 2, + "detailsURL": "/dataservice/device/reachable?personality=vsmart", + "status": "error", + "statusList": [ + { + "name": "vSmart", + "status": "error", + "message": "Number of devices down", + "detailsURL": "/dataservice/device/unreachable?personality=vsmart", + "count": 0 + } + ] + }, + { + "name": "WAN Edge", + "count": 5, + "detailsURL": "/dataservice/device/reachable?personality=vedge", + "status": "error", + "statusList": [ + { + "name": "vEdge", + "status": "error", + "message": "Number of devices down", + "detailsURL": "/dataservice/device/unreachable?personality=vedge", + "count": 0 + } + ] + }, + { + "name": "vBond", + "count": 1, + "detailsURL": "/dataservice/device/reachable?personality=vbond", + "status": "error", + "statusList": [ + { + "name": "vBond", + "status": "error", + "message": "Number of devices down", + "detailsURL": "/dataservice/device/unreachable?personality=vbond", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/network/issues/rebootcount": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve reboot count", + "operationId": "getRebootCount", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Is cached flag", + "required": true, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reboot count": { + "description": "Reboot count", + "value": { + "data": [ + { + "type": "Reboot count", + "name": "Reboot", + "showTitle": false, + "count": 3, + "detailView": "dialog", + "detailsURL": "dataservice/device/reboothistory/details", + "status": "error" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/network/issues/summary": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve network issues summary", + "operationId": "getNetworkIssuesSummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network issues": { + "description": "Network issues", + "value": { + "data": [ + { + "type": "Status summary", + "name": "Status summary", + "showTitle": false, + "count": 3, + "detailView": "dialog", + "statusList": [ + { + "status": "Crashes", + "name": "Crashes", + "detailView": "dialog", + "detailsURL": "dataservice/device/crashlog/details", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "Reboots", + "name": "Reboots", + "detailView": "dialog", + "detailsURL": "dataservice/device/reboothistory/details", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 3 + }, + { + "status": "Hardware errors", + "name": "Hardware errors", + "detailView": "dialog", + "detailsURL": "dataservice/device/hardware/errors", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/network/status": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve network status summary", + "operationId": "getNetworkStatusSummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Network status": { + "description": "Network status", + "value": { + "header": { + "generatedOn": 1635483849920 + }, + "data": [ + { + "type": "vSmart", + "name": "vSmart", + "image": "images/vsmart.png", + "count": 3, + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart", + "statusList": [ + { + "status": "error", + "name": "Error", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=error", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "warning", + "name": "Warning", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=warning", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + }, + { + "status": "normal", + "name": "Normal", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=normal", + "color": "b0e276", + "icon": "images/device/device-normal.png", + "count": 3 + }, + { + "status": "new", + "name": "Discovered device", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=new", + "color": "7c8afa", + "icon": "images/device/device-new.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/networkdesign": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get existing network design", + "operationId": "getNetworkDesign", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design": { + "description": "Network design", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Edit network segment", + "operationId": "editNetworkDesign", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network design payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design template": { + "description": "Network design template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + }, + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Create network design", + "operationId": "createNetworkDesign", + "requestBody": { + "description": "Network design payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": { + "dc": [ + { + "name": "DC4", + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb" + ], + "deviceProfiles": [ + { + "deviceProfileName": "ASR1001", + "deviceModel": "vedge-ASR-1001-X", + "deviceTemplateID": "", + "deviceProfileId": "", + "circuits": [ + "07dce48b-3c7d-46c0-ac91-36f0d64d61e7" + ] + } + ] + } + ], + "showDeviceProfileHelpText": true, + "globalParameters": [ + { + "templateType": "aaa", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cisco_snmp", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "omp-vedge", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "banner", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "ntp", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "snmp", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cisco_bfd", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cisco_ntp", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cedge_global", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cisco_logging", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "bfd-vedge", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cedge_aaa", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "logging", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cisco_omp", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cisco_banner", + "gTemplateClass": "cedge", + "isUsed": false + } + ], + "customizedProfiles": [] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": { + "id": "07c1e0a1-d28a-4372-b819-0f1ab5fc8e39" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + } + }, + "/networkdesign/attachment": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Attach network design", + "operationId": "pushNetworkDesign", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/networkdesign/circuit": { + "get": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Get network circuits", + "operationId": "getCircuits", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuits": { + "description": "Network circuits", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Create network circuits", + "operationId": "createCircuit", + "requestBody": { + "description": "Network circuit", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuit": { + "description": "Network circuit", + "value": { + "type": "private", + "color": "biz-internet" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuit Id": { + "description": "Network circuit Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/networkdesign/circuit/{id}": { + "put": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Edit network circuits", + "operationId": "editCircuit", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network circuit", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuit": { + "description": "Network circuit" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Delete network circuits", + "operationId": "deleteCircuit", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/networkdesign/global/parameters": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get global parameter templates", + "operationId": "getGlobalParameters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global parameters": { + "description": "Global parameters", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/global/template/{templateId}": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Get global template", + "operationId": "getGlobalTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design template": { + "description": "Network design template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + }, + "put": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Edit global template", + "operationId": "editGlobalTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design template": { + "description": "Network design template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/networkdesign/lock/edit": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Acquire edit lock", + "operationId": "acquireEditLock", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Lock Id": { + "description": "Lock Id", + "value": { + "id": "nd_edit-96c1ff5a-44fa-4316-ad15-cc820347f7d3" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + } + }, + "/networkdesign/mytest/{name}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get all device templates for this feature template", + "operationId": "runMyTest", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Test bane", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/attachment/{profileId}": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Attach to device profile", + "operationId": "pushDeviceProfileTemplate", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/networkdesign/profile/feature": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Generate device profile template list", + "operationId": "getDeviceProfileFeatureTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + } + }, + "/networkdesign/profile/lock/{profileId}": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get the service profile config for a given device profile id", + "operationId": "acquireAttachLock", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/networkdesign/profile/status": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration status", + "operationId": "getDeviceProfileConfigStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config status": { + "description": "Device config status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/status/{profileId}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration status by profile Id", + "operationId": "getDeviceProfileConfigStatusByProfileId", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config status": { + "description": "Device config status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/task/count": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration task count", + "operationId": "getDeviceProfileTaskCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config task count": { + "description": "Device config task count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/task/status": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration task status", + "operationId": "getDeviceProfileTaskStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config task status": { + "description": "Device config task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/task/status/{profileId}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration status by profile Id", + "operationId": "getDeviceProfileTaskStatusByProfileId", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config task status": { + "description": "Device config task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/template": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Generate profile template list", + "operationId": "generateProfileTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/template/{templateId}": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Get device profile template", + "operationId": "getDeviceProfileTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device profile template": { + "description": "Device profile template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + }, + "put": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Edit device profile template", + "operationId": "editDeviceProfileTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device profile template": { + "description": "Device profile template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/networkdesign/serviceProfileConfig/{profileId}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get the service profile config for a given device profile id", + "operationId": "getServiceProfileConfig", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceModel", + "in": "query", + "description": "Device model", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device profile": { + "description": "Device profile", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/notifications/rule": { + "put": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Update notification rule", + "operationId": "updateNotificationRule", + "parameters": [ + { + "name": "ruleId", + "in": "query", + "description": "Rule Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Notification rule", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "notificationRuleName": "testwebhook", + "severity": "Medium", + "alarmName": "BFD_Node_Up", + "accountDetails": "noreply@cisco.com", + "webHookEnabled": true, + "webhookUsername": "admin", + "webhookPassword": "admin", + "webhookUrl": "https://localhost:8444", + "updatedBy": "admin", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "accountDetailsArray": [ + "noreply@cisco.com" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + }, + "post": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Add notification rule", + "operationId": "createNotificationRule", + "requestBody": { + "description": "Notification rule", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "notificationRuleName": "testwebhook", + "severity": "Medium", + "alarmName": "BFD_Node_Up", + "accountDetails": "noreply@cisco.com", + "webHookEnabled": true, + "webhookUsername": "admin", + "webhookPassword": "admin", + "webhookUrl": "https://localhost:8444", + "updatedBy": "admin", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "accountDetailsArray": [ + "noreply@cisco.com" + ] + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "notificationRuleName": "testwebhook", + "severity": "Medium", + "alarmName": "BFD_Node_Up", + "accountDetails": "noreply@cisco.com", + "webHookEnabled": true, + "webhookUsername": "admin", + "webhookPassword": "admin", + "webhookUrl": "https://localhost:8444", + "updatedBy": "admin", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "accountDetailsArray": [ + "noreply@cisco.com" + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/notifications/rules": { + "get": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Get all rules or specific notification rule by its Id", + "operationId": "getNotificationRule", + "parameters": [ + { + "name": "ruleId", + "in": "query", + "description": "Rule Id", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "data": [ + { + "severity": "Medium", + "webhookPassword": "$CRYPT$R21YRfP4HWOv+Z9nSi7zRw==$hEU/zplzA+IJlI/4LsNY/Q==", + "updatedBy": "admin", + "alarmName": "BFD_Node_Up", + "webhookUrl": "https://localhost:8444", + "notificationRuleName": "testwebhook", + "lastUpdated": 1588177200725, + "@rid": 1158, + "accountDetails": "cqx@cisco.com", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "webhookUsername": "admin", + "notificationRuleId": "e947efc8-e86a-4eb4-b8ce-7ed0c2828f13" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,Settings-read" + }, + "delete": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Delete notification rule", + "operationId": "deleteNotificationRule", + "parameters": [ + { + "name": "ruleId", + "in": "query", + "description": "Rule Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/opentaccase/authcode": { + "get": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Gets Access Token for SSO Logjn", + "operationId": "oauthAccess", + "parameters": [ + { + "name": "code", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "redirect", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "isRefreshNeeded", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Access Token": { + "description": "Access Token", + "value": { + "access_token": "emQHZjOpma4gfco2c14BShVrdAqQ", + "refresh_token": "6cGDKZhHbYRR1ySrVpeKVmtIBSJifPopC8k5NeXVRW", + "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjJNc1VCbzE3Rnl4QVpMUVhGVHpqQVdoX2htcyJ9.eyJzdWIiOiJzaG9hYmFzdSIsImF1ZCI6InZtYW5hZ2Vfc2NtX2NsaWVudCIsImp0aSI6IlNKa1pKYWNsNkE4SVJ6UlBOTTFNbkMiLCJpc3MiOiJodHRwczovL2Nsb3Vkc3NvLXRlc3QuY2lzY28uY29tIiwiaWF0IjoxNjQ5ODM1ODcyLCJleHAiOjE2NDk4MzYxNzIsInBpLnNyaSI6Ikp4N1dJcmp4U1hDdFJuZ0hiT2tQRzhyV0MtYy4uVm45ZyIsImFjciI6InN0ZG5vbWZhIn0.IErZIsHsytpseCO1ReE-Y1i37bST3NPDnbHRiBInO8xhM6L0cbb7f7OhvWnKTSTaFQ_n-qDcG9iqCPZsNBGVX_e88L48S39QTn8OKndNfOmbmqZwkl5chno_6zUgXK-TsVWBKov3jEH2tC0TWRApIl0q9JGXkbrIzWh0qDnEhdk0aMtQf0WyhYvxAjR6W5ErzcqvZOiYBcWcfL4oRzr8wf2kULv1Z9V69aKIucA_Sxs3HflgamqzUaRVafeJW2rtJcnM4hHVMRZ5rjRtVj7KJz1xiZs9AyVuBceaF_XFEmzLrHiEbeNfPdCX0DVZl39uJNO9Z0Fe9wdj3Kq-TEa-VQ", + "token_type": "Bearer", + "expires_in": 3599 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + } + }, + "/opentaccase/getClientID": { + "get": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Gets vManage Client ID", + "operationId": "getClientID", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Access Token": { + "description": "Access Token", + "value": "{ client_id: xxxxxxxxx}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + } + }, + "/opentaccase/scmwidget/{var}": { + "get": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Proxy API for SCM Widget", + "operationId": "getCall", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "banner.json (Files needed by scm to load widget )": { + "description": "banner.json (Files needed by scm to load widget )", + "value": { + "statusCode": "SUCCESS", + "webexCategoriesList": [ + { + "categoryHeader": "Meetings", + "category": "Joining a meeting", + "techId": "81", + "techName": "Cloud and Hybrid Products", + "subTechId": "3604", + "subTechName": "Webex joining a meeting", + "problemCodeDescription": "Configuration Assistance", + "problemCode": "CONFIG_ASSISTANCE", + "labelKey": "webexcategory.joiningameeting.tooltip", + "customerActivity": "Configuration", + "containerType": "W", + "type": "webex", + "enableVA": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + }, + "post": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Prxoy API for SCM Widget", + "operationId": "postCall", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "getAuthCodeUrl.json (Files needed by scm to load widget )": { + "description": "getAuthCodeUrl.json (Files needed by scm to load widget )", + "value": "{CSRFTOKEN: \"1da3fee1-18c9-4cfd-a8ff-8fe28aafbbd7\",\napixAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=48cvgdjcuf72je6x37ztbv52&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fcase%2F\",\nlogoutURL: \"https://www-stage.cisco.com/autho/logout.html\",\nmaxAppReload: 5 ,\nmuleAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=f7371b79ebeb4c0f8a5a0052120c2efa&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fmule\",\nrmaAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=b69k7tfhs45wf59yfpcdu98c&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fauthcode%2Frmaapi\",\nstatus: \"SUCCESS\",\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + }, + "delete": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Proxy API for SCM Widget", + "operationId": "deleteCall", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "banner.json (Files needed by scm to load widget )": { + "description": "banner.json (Files needed by scm to load widget )", + "value": "{\"clientTrxId\":\"SCM-1650876738048-shoabasu\",\"errorMessages\":null,\"responseOut\":\"2022-04-25T08:52:19.369Z\",\"requestId\":\"02e8c630-c475-11ec-a61b-005056bc2cda\",\"recordCount\":1,\"\"responseDetails\":{\"draftNumber\":\"9010540440\"},\"messageId\":null,\"eventLog\":null,\"eventResult\":null,\"statusCode\":\"SUCCESS\"}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + } + }, + "/partner": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get all NMS partners", + "operationId": "getPartners", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Partners": { + "description": "Partners", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "type": "dnac", + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5", + "description": "dnac-test", + "owner": "admin", + "registrationDate": "1632900123277", + "devicesAttached": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + } + }, + "/partner/aci/policy": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get ACI definitions", + "operationId": "getACIDefinitions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACI policy": { + "description": "ACI policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/dscpmapping/{partnerId}": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get DSCP policy", + "operationId": "getDscpMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSCP policy": { + "description": "DSCP policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + }, + "post": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Create an ACI definition entry", + "operationId": "createDscpMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "ACI definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACI definition": { + "description": "ACI definition", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action Id": { + "description": "Action Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write" + }, + "delete": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Delete DSCP mapping", + "operationId": "deleteDscpMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action Id": { + "description": "Action Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/events/{partnerId}": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get ACI events", + "operationId": "getEvents", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "starttime", + "in": "query", + "description": "Start time", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "endtime", + "in": "query", + "description": "End time", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "ACI events": { + "description": "ACI events", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/prefixmapping/{partnerId}": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get prefix mapping", + "operationId": "getDataPrefixMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Prefix mapping": { + "description": "Prefix mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + }, + "post": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Create data prefix mapping", + "operationId": "setDataPrefixMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Prefix definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Prefix definition": { + "description": "Prefix definition", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action Id": { + "description": "Action Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/sequences": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get data prefix sequence", + "operationId": "getDataPrefixSequences", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Data prefix sequence": { + "description": "Data prefix sequence", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + } + }, + "/partner/dnac/sda/config/{partnerId}": { + "post": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Create SDA enabled device", + "operationId": "createSDAConfig", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device SDA configuration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device SDA configuration": { + "description": "Device SDA configuration", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceConfig": "PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg==" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Id": { + "description": "Device Id", + "value": { + "id": "push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Integration Management-write" + } + }, + "/partner/dnac/sda/device/{partnerId}": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get SDA enabled devices", + "operationId": "getSDAEnabledDevices", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices list": { + "description": "Devices list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "uuid": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "reachability": "reachable", + "status": "normal", + "personality": "vedge", + "device-type": "normal", + "device-model": "C8000v", + "version": "17.06.01.0.1422", + "site-id": "500", + "platform": "x86_64", + "device-os": "next", + "state": "green", + "chassis-serial-number": "SSI130300YK", + "host-name": "vm5", + "system-ip": "172.16.255.15", + "serialNumber": "12345712", + "templateStatus": "Success", + "validity": "valid", + "configuredAaaUser": [ + "admin" + ], + "wanInterfaces": [ + "GigabitEthernet1" + ], + "discoveredDeviceInterfaces": [ + "GigabitEthernet8", + "GigabitEthernet1", + "GigabitEthernet2" + ], + "registrationDate": "1632900123277", + "devicesAttached": 0, + "loopback": [] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/dnac/sda/device/{partnerId}/{uuid}": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get SDA enabled devices detail", + "operationId": "getDeviceDetails", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string", + "example": "C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device detail list": { + "description": "Device detail list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "uuid": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "reachability": "reachable", + "status": "normal", + "personality": "vedge", + "device-type": "normal", + "device-model": "C8000v", + "version": "17.06.01.0.1422", + "site-id": "500", + "platform": "x86_64", + "device-os": "next", + "state": "green", + "chassis-serial-number": "SSI130300YK", + "host-name": "vm5", + "system-ip": "172.16.255.15", + "serialNumber": "12345712", + "templateStatus": "Success", + "validity": "valid", + "configuredAaaUser": [ + "admin" + ], + "wanInterfaces": [ + "GigabitEthernet1" + ], + "discoveredDeviceInterfaces": [ + "GigabitEthernet8", + "GigabitEthernet1", + "GigabitEthernet2" + ], + "registrationDate": "1632900123277", + "devicesAttached": 0, + "loopback": [] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/dnac/sda/netconfconfig/{partnerId}": { + "post": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Create SDA enabled device from Netconf", + "operationId": "createSDAConfigFromNetconf", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device SDA configuration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device SDA configuration": { + "description": "Device SDA configuration", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceConfig": "PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg==" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template push Id": { + "description": "Device template push Id", + "value": { + "id": "push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Integration Management-write" + } + }, + "/partner/dnac/sda/site/{partnerId}": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get SDA enabled devices", + "operationId": "getSitesForPartner", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Sites": { + "description": "Sites", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "partnerId": "dnac-test", + "sites": [ + "400" + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/dnac/sda/vpn": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get Overlay VPN list", + "operationId": "getOverlayVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN list": { + "description": "VPN list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "vpnId": "33", + "vpnType": "configuredVPN" + }, + { + "vpnId": "0", + "vpnType": "vmanageVPN" + }, + { + "vpnId": "512", + "vpnType": "vmanageVPN" + }, + { + "vpnId": "65528", + "vpnType": "vmanageVPN" + }, + { + "vpnId": "Mgmt-intf", + "vpnType": "vmanageVPN" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "DNAC SDA-read,DNAC SDA-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/vpn": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get all VPNs", + "operationId": "getVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN list": { + "description": "VPN list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "vpnId": "1", + "vpnType": "configuredVPN" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + } + }, + "/partner/wcm/netconf/{nmsId}": { + "post": { + "tags": [ + "Partner - WCM Configs" + ], + "description": "Push device configs", + "operationId": "pushNetconfConfigs", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Netconf configuration", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Netconf configuration": { + "description": "Netconf configuration", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Integration Management-write" + } + }, + "/partner/{partnerType}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get NMS partners by partner type", + "operationId": "getPartnersByPartnerType", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string" + }, + "example": "dnac" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Partners": { + "description": "Partners", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "type": "dnac", + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5", + "description": "dnac-test", + "owner": "admin", + "registrationDate": "1632900123277", + "devicesAttached": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + }, + "post": { + "tags": [ + "Partner - Registration" + ], + "description": "Register NMS partner", + "operationId": "registerPartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "description": "dnac-test" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": { + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/partner/{partnerType}/map/{nmsId}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "List mapped devices for the partner", + "operationId": "getPartnerDevices", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PartnerType" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "example": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Devices": { + "description": "Devices", + "value": "[{ \"uuid\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"deviceId\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"reachability\": \"reachable\", \"status\": \"normal\", \"personality\": \"vedge\", \"device-type\": \"normal\", \"device-model\": \"C8000v\", \"version\": \"17.06.01.0.1422\", \"site-id\": \"500\", \"platform\": \"x86_64\", \"device-os\": \"next\", \"state\": \"green\", \"chassis-serial-number\": \"SSI130300YK\", \"host-name\": \"vm5\", \"system-ip\": \"172.16.255.15\", \"serialNumber\": \"12345712\", \"templateStatus\": \"Success\", \"validity\": \"valid\", \"configuredAaaUser\": [\"admin\"], \"wanInterfaces\": [\"GigabitEthernet1\"], \"discoveredDeviceInterfaces\": [\"GigabitEthernet8\",\"GigabitEthernet1\"\"GigabitEthernet2\"], \"registrationDate\": \"1632900123277\", \"devicesAttached\": 0, \"loopback\": []}]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write,Policy Configuration-write" + }, + "post": { + "tags": [ + "Partner - Registration" + ], + "description": "Map devices for the partner", + "operationId": "mapDevices", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "requestBody": { + "description": "List of devices", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "List of devices": { + "description": "List of devices", + "value": { + "devices": [ + "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + }, + "delete": { + "tags": [ + "Partner - Registration" + ], + "description": "Unmap all devices for the partner", + "operationId": "unmapDevices", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PartnerType" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/partner/{partnerType}/unmap/{nmsId}": { + "post": { + "tags": [ + "Partner - Registration" + ], + "description": "Unmap a set of devices for the partner", + "operationId": "deleteDeviceMapping", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "requestBody": { + "description": "List of devices", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "List of devices": { + "description": "List of devices", + "value": { + "devices": [ + "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/partner/{partnerType}/{nmsId}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get NMS partners by partner type and Id", + "operationId": "getPartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partners": { + "description": "Partners", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "type": "dnac", + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5", + "description": "dnac-test", + "owner": "admin", + "registrationDate": "1632900123277", + "devicesAttached": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + }, + "put": { + "tags": [ + "Partner - Registration" + ], + "description": "Update NMS partner details", + "operationId": "updatePartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": { + "name": "DNAC-test-new", + "description": "dnac-test-new" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + }, + "delete": { + "tags": [ + "Partner - Registration" + ], + "description": "Delete NMS partner", + "operationId": "deletePartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PartnerType" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/resourcepool/resource/vpn": { + "get": { + "tags": [ + "Resource - Pool" + ], + "description": "Get tenant device vpn resource", + "operationId": "getResources", + "parameters": [ + { + "name": "tenantId", + "in": "query", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tenantVpn", + "in": "query", + "description": "Tenant Vpn Number", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Resources": { + "description": "Resources", + "value": { + "resourcePoolDataType": "vpn", + "tenantId": "foobar", + "tenantVpn": 2, + "deviceVpn": 1 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Resource - Pool" + ], + "description": "Create Vpn resource pool and return tenant device vpn", + "operationId": "createResources", + "requestBody": { + "description": "create resources from resource pool", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Resources": { + "description": "Resources", + "value": "{\n\t\"resourcePoolDataType\": \"vpn\",\n\t\"tenantId\": \"foobar\",\n\t\"tenantVpn\": 2,\n} " + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Resources": { + "description": "Resources", + "value": { + "resourcePoolDataType": "vpn", + "tenantId": "foobar", + "tenantVpn": 2, + "deviceVpn": 1 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Resource - Pool" + ], + "description": "Delete tenant device vpn and release the resource", + "operationId": "deleteResources", + "parameters": [ + { + "name": "tenantId", + "in": "query", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tenantVpn", + "in": "query", + "description": "Tenant Vpn Number", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/restore/import": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Submit a previously backed up file and import the data and apply it to the configuraion database", + "operationId": "importScheduledBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/restore/remoteimport": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Remote import backup from a remote URL and import the data and apply it to the configuraion database", + "operationId": "remoteImportBackup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/schedule/create": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "create backup scheduler config-db and statstics database with startDateTime and persist to config-db", + "operationId": "scheduleBackup", + "requestBody": { + "description": "schedule request information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/schedule/list": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Get a schedule record for backup by scheduler id", + "operationId": "listSchedules", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "size", + "schema": { + "type": "integer", + "format": "int64", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get backup schedule ": { + "description": "Get backup schedule ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/schedule/{schedulerId}": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Get a schedule record for backup by scheduler id", + "operationId": "getScheduleRecordForBackup", + "parameters": [ + { + "name": "schedulerId", + "in": "path", + "description": "scheduler id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get backup schedule ": { + "description": "Get backup schedule ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Delete a schedule record for backup in vManage by scheduler id", + "operationId": "deleteSchedule", + "parameters": [ + { + "name": "schedulerId", + "in": "path", + "description": "scheduler id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete backup scheduler job ": { + "description": "Delete backup scheduler job ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/sdavc/cloudconnector": { + "get": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Get SD_AVC Cloud Connector Config", + "operationId": "getCloudConnector", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Disable SD_AVC Cloud Connector", + "operationId": "disableCloudConnector", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Enable SD_AVC Cloud Connector", + "operationId": "enableCloudConnector", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/sdavc/cloudconnector/status": { + "get": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Get SD_AVC Cloud Connector Status", + "operationId": "getCloudConnectorStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/sdavc/customapps": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Displays the user-defined applications", + "operationId": "getCustomApp", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Custom applications": { + "description": "Custom applications", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/sdavc/task/{taskId}": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Activate container", + "operationId": "activateContainer", + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "Task Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Container task config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Container task config": { + "description": "Container task config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/sdavc/test": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Test SD_AVC load balancer", + "operationId": "testLoadBalancer", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/segment": { + "get": { + "tags": [ + "Configuration - Segments" + ], + "description": "Get network segments", + "operationId": "getSegments", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Segment list": { + "description": "Segment list", + "value": { + "data": [ + { + "segmentName": "Discovered_VPN_10", + "segmentId": "10", + "id": "c952c18b-30b3-4f0b-b985-494693d7adfb", + "referenceCount": 2 + }, + { + "segmentName": "Discovered_VPN_65529", + "segmentId": "65529", + "id": "5dd3f122-e52f-437e-b5e5-5ae94ad09cd6", + "referenceCount": 0 + }, + { + "segmentName": "Discovered_VPN_20", + "segmentId": "20", + "id": "83b6309d-f61d-4ac5-9699-7d3c04a1caef", + "referenceCount": 0 + }, + { + "segmentName": "Discovered_VPN_40", + "segmentId": "40", + "id": "64b30b74-08e2-4b4b-81ca-d019c7e452d5", + "referenceCount": 1 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Segments" + ], + "description": "Create network segment", + "operationId": "createSegment", + "requestBody": { + "description": "Network segment", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network segment": { + "description": "Network segment", + "value": { + "segmentName": "Discovered_VPN_80", + "segmentId": "80" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "bab577b9-e3c7-4385-abc1-d800dacb5f36" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/segment/{id}": { + "get": { + "tags": [ + "Configuration - Segments" + ], + "description": "Get network segment", + "operationId": "getSegment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Segment Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Segment list": { + "description": "Segment list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Segments" + ], + "description": "Edit network segment", + "operationId": "editSegment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Segment Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network segment", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network segment": { + "description": "Network segment", + "value": "{{\n \"segmentName\":\"Discovered_VPN_80\",\n \"segmentId\":\"90\",\n \"id\":\"bab577b9-e3c7-4385-abc1-d800dacb5f36\",\n \"referenceCount\":0\n}}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Segments" + ], + "description": "Delete network segment", + "operationId": "deleteSegment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Segment Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/server/info": { + "get": { + "tags": [ + "Monitoring - Server Info" + ], + "description": "Get Server info", + "operationId": "createServerInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage server info": { + "description": "vManage server info", + "value": { + "Achitecture": "amd64", + "Available processors": 8 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/serverlongpoll/event/poll/{partnerId}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Retrieve registration change information", + "operationId": "getDataChangeInfo", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "event_id", + "in": "query", + "description": "Continuation token of ongoing event-polling session", + "schema": { + "type": "string" + } + }, + { + "name": "eventNames", + "in": "query", + "description": "Names of type of events to filter on", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventName" + } + } + }, + { + "name": "wait_time", + "in": "query", + "description": "Maximum polling wait time in seconds", + "schema": { + "type": "integer", + "format": "int64", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/setting/configuration/webserver/certificate": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Retrieves Certificate Signing Request information", + "operationId": "showInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR detail info": { + "description": "CSR detail info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "put": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Import a signed web server certificate", + "operationId": "importCertificate", + "requestBody": { + "description": "Singed certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Singed certificate": { + "description": "Singed certificate", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + }, + "post": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Generate Certificate Signing Request", + "operationId": "getCSR", + "requestBody": { + "description": "CSR signing request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR signing request": { + "description": "CSR signing request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR": { + "description": "CSR", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/setting/configuration/webserver/certificate/certificate": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Get certificate with alias name", + "operationId": "DumpCertificate", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Key alias", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + } + }, + "/setting/configuration/webserver/certificate/getcertificate": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Get certificate for alias server", + "operationId": "GetCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + } + }, + "/setting/configuration/webserver/certificate/rollback": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Rollback certificate with alias name", + "operationId": "rollback", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Key alias", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + } + }, + "/settings/banner": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve banner", + "operationId": "getBanner", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Banner": { + "description": "Banner", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/settings/clientSessionTimeout": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Get client session timeout", + "operationId": "getSessionTimout", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Client session timeout": { + "description": "Client session timeout", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/settings/configuration/analytics/dca": { + "post": { + "tags": [ + "Configuration - Settings" + ], + "description": "Create analytics data file", + "operationId": "createAnalyticsDataFile", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write,dca" + } + }, + "/settings/configuration/certificate/{settingType}": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve certificate configuration value by settingType", + "operationId": "getCertConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate configuration value": { + "description": "Certificate configuration value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write,dca" + }, + "put": { + "tags": [ + "Configuration - Settings" + ], + "description": "Update certificate configuration", + "operationId": "editCertConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Certificate config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write" + }, + "post": { + "tags": [ + "Configuration - Settings" + ], + "description": "Add new certificate configuration", + "operationId": "newCertConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Certificate config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write" + } + }, + "/settings/configuration/googleMapKey": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve Google map key", + "operationId": "getGoogleMapKey", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Google map key": { + "description": "Google map key", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,RBAC VPN-read,RBAC VPN-write" + } + }, + "/settings/configuration/maintenanceWindow": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve maintenance window", + "operationId": "getMaintenanceWindow", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Maintenance window": { + "description": "Maintenance window", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/settings/configuration/{settingType}": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve configuration value by settingType", + "operationId": "getConfigurationBySettingType", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration value": { + "description": "Configuration value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write,dca,Certificates-read" + }, + "put": { + "tags": [ + "Configuration - Settings" + ], + "description": "Update configuration setting", + "operationId": "editConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Configuration setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write" + }, + "post": { + "tags": [ + "Configuration - Settings" + ], + "description": "Add new configuration", + "operationId": "newConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Configuration setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write,dca" + } + }, + "/settings/passwordPolicy": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve password policy from global settings", + "operationId": "getPasswordPolicy", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Password policy": { + "description": "Password policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/sig/datacenters/{type}/{tunneltype}/{devicetype}": { + "get": { + "tags": [ + "Configuration - Policy Secure Internet Gateway Data Centers Builder" + ], + "description": "Get list of data centers for zscaler or umbrella", + "operationId": "getSigDataCenterList", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Provider type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tunneltype", + "in": "path", + "description": "Type of the tunnel ipsec/gre", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "devicetype", + "in": "path", + "description": "Type of the device vedge/cedge", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/smartLicensing/authenticate": { + "post": { + "tags": [ + "Smart License" + ], + "description": "authenticate user for sle", + "operationId": "sleauthenticate", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/fetchAccounts": { + "get": { + "tags": [ + "Smart License" + ], + "description": "fetch sava for sle", + "operationId": "fetchAccounts", + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "mode", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/fetchAllSa": { + "get": { + "tags": [ + "Smart License" + ], + "description": "fetch reports offline for sle", + "operationId": "fetchReports_1", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SLE": { + "description": "SLE", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/fetchReportsForSa": { + "get": { + "tags": [ + "Smart License" + ], + "description": "fetch reports offline for sle", + "operationId": "fetchReports", + "parameters": [ + { + "name": "saDomain", + "in": "query", + "description": "saDomain", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saId", + "in": "query", + "description": "saId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SLE": { + "description": "SLE", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/getUserSettings": { + "get": { + "tags": [ + "Smart License" + ], + "description": "get settings", + "operationId": "get settings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Devices": { + "description": "Devices", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/removeSaVaSelection": { + "post": { + "tags": [ + "Smart License" + ], + "description": "get all licenses for sa/va", + "operationId": "syncLicenses_1", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/syncLicenses": { + "post": { + "tags": [ + "Smart License" + ], + "description": "get all licenses for sa/va", + "operationId": "syncLicenses", + "requestBody": { + "description": "Partner", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/LicenseUplodFile" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "license": { + "description": "license", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/smartLicensing/uploadAck": { + "post": { + "tags": [ + "Smart License" + ], + "description": "upload ack file for sa/va", + "operationId": "uploadAck", + "requestBody": { + "description": "Partner", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/AckUplodFile" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "license": { + "description": "license", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/software/compliance/ip/origin/check": { + "post": { + "tags": [ + "Utility - Security" + ], + "description": "Block IP based on list", + "operationId": "checkGivenIpList", + "requestBody": { + "description": "Device detail", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device detail": { + "description": "Device detail", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IP validation status": { + "description": "IP validation status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/sslproxy/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get edge proxy certificate", + "operationId": "getProxyCertOfEdge", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge proxy certificate": { + "description": "Edge proxy certificate", + "value": { + "enterpriseCA": true, + "vManageRootCA": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "put": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Upload device certificate", + "operationId": "updateCertificate", + "requestBody": { + "description": "Upload device certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Upload device certificate": { + "description": "Upload device certificate", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{id: \"210c2bc2-5423-4a6b-9269-22eaf058d774\"}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/certificate/wanedge/{deviceId}": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Add SSL proxy wan edge", + "operationId": "addWANEdge", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cert state", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cert state": { + "description": "Cert state", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/certificates": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Upload device certificates", + "operationId": "uploadCertificiates", + "requestBody": { + "description": "Certificate file", + "content": { + "multipart/form-data": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate file": { + "description": "Certificate file" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "207": { + "description": "Multi-status" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/csr": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get SSL proxy CSR", + "operationId": "getSslProxyCSR", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "device UUID", + "required": true, + "schema": { + "type": "string", + "example": "8d86d8b2-2239-402e-9fef-467f7bad3f2f" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR": { + "description": "CSR", + "value": { + "csr": [ + { + "hostCommonName": "vManageCA_vm12", + "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n", + "last updated": "07 Apr 2022 07:56:17 UTC", + "commonName": "vManageCA", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/devicecertificates": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get certificate for all cEdges", + "operationId": "getAllDeviceCertificates", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [ + { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate": { + "description": "Certificate", + "value": { + "header": { + "generatedOn": 1650355912089 + }, + "data": [ + { + "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/devicecsr": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get CSR for all cEdges", + "operationId": "getAllDeviceCSR", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [ + { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR": { + "description": "CSR", + "value": { + "header": { + "generatedOn": 1650354738278 + }, + "data": [ + { + "csr": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n", + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/generate/csr/sslproxy": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "CSR request SSL proxy for edge", + "operationId": "generateSslProxyCSR", + "requestBody": { + "description": "CSR request for edge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request for edge": { + "description": "CSR request for edge" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/generate/vmanage/csr": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Generate CSR", + "operationId": "generateSSLProxyCSR", + "requestBody": { + "description": "CSR request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request", + "value": { + "commonName": "vManageCA", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com", + "intermediateCA": "true" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "ba6586b6-6caf-4eac-a6ae-ec4d57d0fe2c" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/list": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get SSL proxy certificate list", + "operationId": "getSslProxyList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Certificate list": { + "description": "Certificate list", + "value": [ + { + "deviceModel": "vedge-C8000V", + "chasisNumber": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "configuredHostname": "vm5", + "managementSystemIP": "172.16.255.15", + "deviceSerialNumber": "12345712", + "configuredSiteId": "500", + "commonName": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "csr": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n", + "serialNumber": "", + "@rid": 1023, + "last updated": "07 Apr 2022 09:07:34 UTC", + "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "state": "CSR_GENERATED", + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "scep": false, + "expirationDate": "Apr 08 09:07:34 2022 UTC", + "hasCert": true, + "hasCSR": true, + "hasEnterpriseCert": false + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/renew": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Renew device certificate", + "operationId": "renewCertificate", + "requestBody": { + "description": "Renew device certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Renew device certificate request": { + "description": "Renew device certificate request", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "0ed22d4e-ba07-4828-9bd6-f3ea9d281513" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/revoke": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Revoke device certificate", + "operationId": "revokeCertificate", + "requestBody": { + "description": "Revoke device certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoke device certificate request": { + "description": "Revoke device certificate request", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "revokeReason": "Unspecified" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/revokerenew": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Revoke and renew device certificate", + "operationId": "revokeRenewCertificate", + "requestBody": { + "description": "Revoke device certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoke and renew device certificate request": { + "description": "Revoke and renew device certificate request", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "revokeReason": "Unspecified" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get certificate state", + "operationId": "getCertificateState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate State": { + "description": "Certificate State", + "value": { + "enterpriseCA": false, + "vManageRootCA": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/settings/enterprise/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get enterprise certificate", + "operationId": "getEnterpriseCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise certificate": { + "description": "Enterprise certificate", + "value": { + "scep": false, + "last updated": "07 Apr 2022 03:45:59 UTC", + "commonName": "OCSP-CA", + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Configure enterprise certificate", + "operationId": "setEnterpriseCert", + "requestBody": { + "description": "Config enterprise certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise certificate request": { + "description": "Enterprise certificate request", + "value": { + "scep": "false", + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate": { + "description": "Certificate", + "value": { + "scep": false, + "last updated": "07 Apr 2022 03:45:59 UTC", + "commonName": "OCSP-CA", + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/enterprise/rootca": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage enterprise root certificate", + "operationId": "getVManageEnterpriseRootCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise root certificate": { + "description": "Enterprise root certificate", + "value": { + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289", + "last updated": "07 Apr 2022 03:53:12 UTC" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Set vManage enterprise root certificate", + "operationId": "setEnterpriseRootCaCert", + "requestBody": { + "description": "Set enterprise root CA request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise root CA": { + "description": "Enterprise root CA", + "value": { + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "intermediateCA": "true" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise root certificate": { + "description": "Enterprise root certificate", + "value": { + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289", + "last updated": "07 Apr 2022 03:53:12 UTC" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/vmanage/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage intermediate certificate", + "operationId": "getvManageCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage intermediate certificate": { + "description": "vManage intermediate certificate", + "value": { + "header": { + "generatedOn": 1649322823353 + }, + "data": [ + { + "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "hostCommonName": "vManageCA_vm12", + "commonName": "vManageCA_vm12", + "fingerprint": "fcb9c623aa9022354fecd95b1f355e1372802aeb", + "last updated": "07 Apr 2022 07:56:17 UTC", + "intermediateCA": "true" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Set vManage root certificate", + "operationId": "setvManageintermediateCert", + "requestBody": { + "description": "Set vManage intermediate CA request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage intermediate CA": { + "description": "vManage intermediate CA", + "value": { + "data": [ + { + "commonName": "vManageCA_vm12", + "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "intermediateCA": "true" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage intermediate certificate": { + "description": "vManage intermediate certificate", + "value": { + "header": { + "generatedOn": 1649318177975 + }, + "data": [ + { + "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "hostCommonName": "vManageCA_vm12", + "commonName": "vManageCA_vm12", + "fingerprint": "fcb9c623aa9022354fecd95b1f355e1372802aeb", + "last updated": "07 Apr 2022 07:56:17 UTC", + "intermediateCA": "true" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/vmanage/csr": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage CSR", + "operationId": "getvManageCSR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage CSR": { + "description": "vManage CSR", + "value": { + "csr": [ + { + "hostCommonName": "vManageCA_vm12", + "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n", + "last updated": "07 Apr 2022 04:37:37 UTC", + "commonName": "vManageCA", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/settings/vmanage/rootca": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage root certificate", + "operationId": "getvManageRootCA", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage root certificate": { + "description": "vManage root certificate", + "value": { + "header": { + "generatedOn": 1649300400918 + }, + "data": [ + { + "vManageRootCA": "...", + "publickey": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n", + "hostCommonName": "vManageRootCa_vm12", + "last updated": "07 Apr 2022 02:59:59 UTC", + "uuid": "3a0733ad-3967-4f71-b4fc-a64c3f634366", + "fingerprint": "1aef4396ce2c71e5df49c448a5eb49b488e9305b", + "commonName": "vManageRootCa", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com", + "validity": "10" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Set vManage root certificate", + "operationId": "setvManageRootCA", + "requestBody": { + "description": "Set vManage root CA request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage root CA": { + "description": "vManage root CA", + "value": { + "commonName": "vManageRootCa", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "validity": 10, + "email": "name@cisco.com" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage root certificate": { + "description": "vManage root certificate", + "value": { + "id": "4aa25a65-b65a-443c-9ebf-21d1dee0ed20" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/statistics": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get statistics types", + "operationId": "getStatisticType", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Stats type": { + "description": "Stats type", + "value": [ + "interfacestatistics", + "eioltestatistics", + "providerdpistatistics", + "sulstatistics", + "qosstatistics", + "devicesystemstatusstatistics", + "bridgemacstatistics", + "dpistatistics", + "approutestatsstatistics", + "provideraggregatedappsdpistatistics", + "wlanclientinfostatistics", + "flowlogstatistics", + "urlf", + "fwall", + "vnfstatistics", + "umbrella", + "apphostingstatistics", + "utddaqioxstatistics", + "ipsalert", + "aggregatedappsdpistatistics", + "bridgeinterfacestatistics", + "artstatistics", + "trackerstatistics", + "cloudxstatistics", + "deviceevents", + "sleofflinereport", + "alarm", + "auditlog", + "deviceconfiguration", + "nwpi", + "nwpiflowraw", + "speedtest" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_1", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting/aggregation": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_1", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphosting/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_1", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphosting/csv": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting/doccount": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCount_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_3", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphosting/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphosting/page": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_1", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting/query/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphostinginterface": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphostinginterface/aggregation": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphostinginterface/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphostinginterface/csv": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphostinginterface/doccount": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCount_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_2", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphostinginterface/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphostinginterface/page": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphostinginterface/query/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_2", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/aggregation": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated each result": { + "description": "Aggregated each result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_2", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/approute/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_2", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/approute/csv": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/device/tunnel/summary": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get statistics for top applications per tunnel in a grid table", + "operationId": "getApprouteGridStat", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics for top application": { + "description": "Statistics for top application", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/device/tunnels": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get statistics for top applications per tunnel in a grid table", + "operationId": "getTunnel", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/doccount": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get response count of a query", + "operationId": "getCount_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_4", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute/fec/aggregation": { + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregation data and fec recovery rate", + "operationId": "getAggregationDataAppRoute", + "requestBody": { + "description": "Query filter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.254.16" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1, + "size": 50 + }, + { + "property": "state", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "metrics": [ + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + }, + { + "property": "latency", + "type": "avg" + }, + { + "property": "jitter", + "type": "avg" + }, + { + "property": "rx_octets", + "type": "sum" + }, + { + "property": "tx_octets", + "type": "sum" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data and fec recovery rate": { + "description": "Aggregation data and fec recovery rate", + "value": { + "data": [ + { + "loss_percentage": 0, + "latency": 0.0012674271229404308, + "count": 1578, + "tx_octets": 0, + "jitter": 0.0025348542458808617, + "rx_octets": 0, + "proto": "IPSEC", + "name": "172.16.254.16:default-172.16.254.2:default", + "state": "Up", + "fecLossRecovery": "-", + "vqoe_score": 10 + }, + { + "loss_percentage": 0.1266624445851805, + "latency": 0.0031665611146295125, + "count": 1579, + "tx_octets": 0, + "jitter": 0.006333122229259025, + "rx_octets": 0, + "proto": "IPSEC", + "name": "172.16.254.16:default-172.16.254.3:default", + "state": "Up", + "fecLossRecovery": "-", + "vqoe_score": 10 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/fields": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute/page": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_2", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/query/fields": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute/transport/summary/{type}": { + "get": { + "tags": [ + "Monitoring - Application-Aware Routing Statistics", + "Monitoring - Application Aware Routing" + ], + "description": "Get application-aware routing statistics summary from device", + "operationId": "getTransportHealthSummary", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type (example:latency)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64", + "default": 5 + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "operator": "last_n_hours", + "value": [ + "12" + ], + "field": "entry_time", + "type": "date" + } + ], + "type": "latency" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application-aware routing statistics summary": { + "description": "Application-aware routing statistics summary", + "value": { + "data": [ + { + "entry_time": 1640066400000, + "jitter": 0.0, + "color": "", + "loss_percentage": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640062800000, + "color": "default:default", + "loss_percentage": 0.0, + "jitter": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640059200000, + "color": "default:default", + "loss_percentage": 0.0, + "jitter": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640055600000, + "color": "default:default", + "loss_percentage": 0.05, + "jitter": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640052000000, + "color": "default:default", + "loss_percentage": 0.015, + "jitter": 0.001, + "latency": 0.001, + "app_probe_class": "" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/transport/{type}": { + "get": { + "tags": [ + "Monitoring - Application-Aware Routing Statistics", + "Monitoring - Application Aware Routing" + ], + "description": "Get application-aware routing statistics from device", + "operationId": "getTransportHealth", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application-aware routing statistics": { + "description": "Application-aware routing statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnel/{type}/summary": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel top statistics in as chart", + "operationId": "getTunnelChart", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnels/health/{type}": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel health", + "operationId": "getTunnelsHealth", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type (example:latency)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64", + "default": 10 + } + }, + { + "name": "last_n_hours", + "in": "query", + "description": "Time range for health average", + "schema": { + "type": "integer", + "format": "int64", + "default": 3 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": { + "data": [ + { + "name": "172.16.254.16:default-172.16.254.3:default", + "remote_system_ip": "172.16.254.3", + "local_system_ip": "172.16.254.16", + "vqoe_score": 9.997916666666667, + "jitter": 0.002777777777777778, + "rx_octets": 0.0, + "loss_percentage": 0.06944444444444445, + "latency": 0.001388888888888889, + "state": "Up", + "tx_octets": 0.0, + "health": "green" + }, + { + "name": "172.16.254.16:default-172.16.254.1:default", + "remote_system_ip": "172.16.254.1", + "local_system_ip": "172.16.254.16", + "vqoe_score": 10.0, + "jitter": 0.001388888888888889, + "rx_octets": 0.0, + "loss_percentage": 0.0, + "latency": 0.0006944444444444445, + "state": "Up", + "tx_octets": 0.0, + "health": "green" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnels/summary/{type}": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel top statistics from device", + "operationId": "getTunnelsSummary", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64", + "default": 10 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnels/{type}": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel top statistics from device", + "operationId": "getTunnels", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_3", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art/aggregation": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_3", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/art/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_3", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/art/csv": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art/doccount": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get response count of a query", + "operationId": "getCount_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_5", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/art/fields": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/art/page": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_3", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art/query/fields": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bfd": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_4", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bfd/aggregation": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_4", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bfd/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_4", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bfd/csv": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bfd/doccount": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get response count of a query", + "operationId": "getCount_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_6", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bfd/fields": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bfd/page": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_4", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bfd/query/fields": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgeinterface": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_5", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgeinterface/aggregation": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_5", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgeinterface/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_5", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgeinterface/csv": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgeinterface/doccount": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCount_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_7", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgeinterface/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgeinterface/page": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_5", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgeinterface/query/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgemac": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_6", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgemac/aggregation": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_6", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgemac/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_6", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgemac/csv": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgemac/doccount": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCount_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_8", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgemac/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgemac/page": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_6", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgemac/query/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cflowd": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_8", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/aggregation": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_8", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cflowd/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_8", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cflowd/applications": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Generate cflowd flows list in a grid table", + "operationId": "createFlowsGrid", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Limit", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Flows": { + "description": "Flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/applications/summary": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Generate cflowd flows list in a grid table", + "operationId": "createFlowssummary", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Limit", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Flows": { + "description": "Flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/csv": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/device/applications": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Generate cflowd flows list in a grid table", + "operationId": "createFlowDeviceData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Flows": { + "description": "Flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/doccount": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get response count of a query", + "operationId": "getCount_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_10", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cflowd/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cflowd/page": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_8", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/query/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cloudx": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_9", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cloudx/aggregation": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_9", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cloudx/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_9", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cloudx/csv": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cloudx/doccount": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get response count of a query", + "operationId": "getCount_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_11", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cloudx/fields": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cloudx/page": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_9", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cloudx/query/fields": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/collect": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Start stats collect", + "operationId": "startStatsCollection", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "ActivateDataCollection": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/collect/thread/status": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get stats collect thread report", + "operationId": "generateStatsCollectThreadReport", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Process thread report": { + "description": "Process thread report", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/collection/reset/{processQueue}": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Reset stats collect thread report", + "operationId": "resetStatsCollection", + "parameters": [ + { + "name": "processQueue", + "in": "path", + "description": "Process queue", + "required": true, + "schema": { + "type": "integer", + "format": "int64", + "default": -1 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "statisticsCollectionReset": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/demomode": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Enable statistic demo mode", + "operationId": "enableStatisticsDemoMode", + "parameters": [ + { + "name": "enable", + "in": "query", + "description": "Demo mode flag", + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Demo mode": { + "description": "Demo mode", + "value": { + "DemoMode": "Stats collection interval: 1 minute, Stats Processing interval: 1 min" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/device": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_15", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/device/aggregation": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_14", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/device/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_14", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/device/csv": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/device/doccount": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCount_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_17", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/device/fields": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/device/page": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_15", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/device/query/fields": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/download/{processType}/fetchvManageList": { + "get": { + "tags": [ + "Monitoring - Stats Download" + ], + "operationId": "fetchList", + "parameters": [ + { + "name": "processType", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}": { + "get": { + "tags": [ + "Monitoring - Stats Download" + ], + "description": "Downloading stats file", + "operationId": "download_1", + "parameters": [ + { + "name": "processType", + "in": "path", + "description": "Process type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fileType", + "in": "path", + "description": "File type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "queue", + "in": "path", + "description": "Queue name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceIp", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "token", + "in": "path", + "description": "Token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fileName", + "in": "path", + "description": "File name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": {} + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/download/{processType}/filelist": { + "post": { + "tags": [ + "Monitoring - Stats Download" + ], + "description": "Downloading list of stats file", + "operationId": "downloadList", + "parameters": [ + { + "name": "processType", + "in": "path", + "description": "Possible types are: remoteprocessing, dr", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_12", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/agg-app/aggregation": { + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get raw aggregated data and display applications with the highest utilization for a device", + "operationId": "getPostAggregationAppData", + "requestBody": { + "description": "Query filter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data and fec recovery rate": { + "description": "Aggregation data and fec recovery rate", + "value": { + "data": [ + { + "latency": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/dpi/aggregation": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - DPI": { + "description": "generated by base class - Monitoring - DPI", + "$ref": "examples/elasticsearch/monitoring/parameter_example/DPI.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - DPI": { + "description": "generated by base class - Monitoring - DPI", + "$ref": "examples/elasticsearch/monitoring/response_example/DPI.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get raw aggregated data and display applications with the highest utilization for a device", + "operationId": "getPostAggregationData", + "requestBody": { + "description": "Query filter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data and fec recovery rate": { + "description": "Aggregation data and fec recovery rate", + "value": { + "data": [ + { + "latency": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/dpi/applications": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI application flows list in a grid table", + "operationId": "createDPIFlowsGridListQuery", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "limit", + "in": "query", + "description": "Query size (example: 10)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": { + "header": { + "fields": [ + { + "dataType": "string", + "property": "application" + }, + { + "dataType": "number", + "property": "octets" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_applications", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.clientViewDpiApplication.time", + "title": "view.statistics.clientViewDpiApplication.dpiApplication", + "series": [ + "" + ], + "yAxis": [ + "octets" + ], + "yAxisLabel": "view.statistics.clientViewDpiApplication.count", + "xAxis": [ + "application" + ] + }, + "columns": [ + { + "hideable": false, + "dataType": "string", + "property": "application", + "title": "Application" + }, + { + "hideable": false, + "dataType": "number", + "property": "octets", + "title": "Octets" + } + ], + "generatedOn": 1637722663222 + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/statistics/dpi/applications/summary": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI application flows summary", + "operationId": "createDPISummary", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "limit", + "in": "query", + "description": "Query size", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI application summary": { + "description": "DPI application summary", + "value": { + "header": { + "fields": [ + { + "dataType": "string", + "property": "application" + }, + { + "dataType": "number", + "property": "octets" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_applications", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.clientViewDpiApplication.time", + "title": "view.statistics.clientViewDpiApplication.dpiApplication", + "series": [ + "" + ], + "yAxis": [ + "octets" + ], + "yAxisLabel": "view.statistics.clientViewDpiApplication.count", + "xAxis": [ + "application" + ] + }, + "columns": [ + { + "hideable": false, + "dataType": "string", + "property": "application", + "title": "Application" + }, + { + "hideable": false, + "dataType": "number", + "property": "octets", + "title": "Octets" + } + ], + "generatedOn": 1637722663222 + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/csv": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/device/application/flowcount": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get application flow count per tunnel", + "operationId": "getUniqueFlowCount", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "interval", + "in": "query", + "description": "Interval", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "window", + "in": "query", + "description": "Window", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application flow count per tunnel": { + "description": "Application flow count per tunnel", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/device/applications": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI flows list", + "operationId": "createDPIDeviceGridData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "limit", + "in": "query", + "description": "Query size", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI flows": { + "description": "DPI flows", + "value": { + "header": { + "fields": [ + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "number", + "property": "octets" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_devices", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.clientViewDpiDevices.time", + "title": "view.statistics.clientViewDpiDevices.dpiDevice", + "series": [ + "" + ], + "yAxis": [ + "octets" + ], + "yAxisLabel": "view.statistics.clientViewDpiDevices.count", + "xAxis": [ + "vdevice_name" + ] + }, + "columns": [ + { + "dataType": "string", + "property": "vdevice_name", + "title": "Devices" + }, + { + "dataType": "number", + "property": "octets", + "title": "Octets" + } + ], + "generatedOn": 1637749963171 + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/statistics/dpi/device/details/applications": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI device and app list", + "operationId": "createDPIDeviceAndAppDetails", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI device and app list": { + "description": "DPI device and app list", + "value": { + "header": { + "fields": [ + { + "dataType": "number", + "property": "packets" + }, + { + "dataType": "number", + "property": "ip_proto" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_devices_detials", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.viewDpiDevicesDetails.time", + "title": "view.statistics.viewDpiDevicesDetails.dpiDeviceAppli", + "series": [ + "application", + "vdevice_name" + ], + "yAxis": [ + "octets", + "packets" + ], + "yAxisLabel": "view.statistics.viewDpiDevicesDetails.count", + "xAxis": [ + "entry_time" + ] + }, + "columns": [ + { + "dataType": "numberStr", + "property": "dest_port", + "title": "Destination port" + }, + { + "dataType": "number", + "property": "packets", + "title": "Packets" + } + ], + "generatedOn": 1637749402671 + }, + "data": [], + "pageInfo": { + "count": 0 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/doccount": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get response count of a query", + "operationId": "getCount_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_14", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi/fields": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi/page": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_12", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/pktdup/aggregation": { + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get time series aggregation data for packet duplication for an application over TLOCs if available", + "operationId": "getAggregationDataForPacketDup", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "1" + ], + "field": "packets", + "type": "number", + "operator": "greater" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "packets", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data rate": { + "description": "Aggregation data rate", + "value": { + "data": [ + { + "packets": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/query/fields": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi/recovery/aggregation": { + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get aggregation data and fec recovery rate if available", + "operationId": "getAggregationDataDPI", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "1" + ], + "field": "packets", + "type": "number", + "operator": "greater" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "packets", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data rate": { + "description": "Aggregation data rate", + "value": { + "data": [ + { + "packets": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/eiolte": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_7", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/eiolte/aggregation": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_7", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/eiolte/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_7", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/eiolte/csv": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/eiolte/doccount": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get response count of a query", + "operationId": "getCount_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_9", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/eiolte/fields": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/eiolte/page": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_7", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/eiolte/query/fields": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/endpointTracker": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + }, + "size": 10000 + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "entry_time": "1623811598645", + "tracker_name": "track1", + "vmanage_system_ip": "172.16.255.15", + "host_name": "vm5", + "vdevice_name": "172.16.255.15", + "device_model": "vedge-CSR-1000v", + "vpn_idx": 2, + "tracker_status": "DOWN", + "rtt_avg": 4, + "rtt_min": 0, + "rtt_max": 42, + "tenant": "default", + "statcycletime": "1623813001149", + "id": "xELMEnoBED2frxv5D_e_" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_18", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/endpointTracker/aggregation": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_17", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/endpointTracker/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_17", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/endpointTracker/csv": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/endpointTracker/doccount": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get response count of a query", + "operationId": "getCount_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_20", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/endpointTracker/fields": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/endpointTracker/page": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_18", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/endpointTracker/query/fields": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/flowlog": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_26", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/flowlog/aggregation": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_26", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/flowlog/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_25", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/flowlog/csv": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/flowlog/doccount": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get response count of a query", + "operationId": "getCount_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_28", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/flowlog/fields": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/flowlog/page": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_26", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/flowlog/query/fields": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/fwall": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_23", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/fwall/aggregation": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns", + "$ref": "examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns", + "$ref": "examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_22", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns", + "$ref": "examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns", + "$ref": "examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/fwall/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_22", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns", + "$ref": "examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns", + "$ref": "examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/fwall/csv": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/fwall/doccount": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get response count of a query", + "operationId": "getCount_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_25", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/fwall/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/fwall/page": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_23", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/fwall/query/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_10", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/aggregation": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics", + "$ref": "examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics", + "$ref": "examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_10", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics", + "$ref": "examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics", + "$ref": "examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/interface/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_10", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics", + "$ref": "examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics", + "$ref": "examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/interface/ccapacity/distribution": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get bandwidth distribution", + "operationId": "getBandwidthDistribution", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Bandwidth distribution": { + "description": "Bandwidth distribution", + "value": { + "header": { + "fields": [ + { + "dataType": "number", + "property": "min_up_capacity_percentage" + }, + { + "dataType": "number", + "property": "bw_down" + } + ], + "generatedOn": 1635413183137 + }, + "distribution": { + ">100": 0, + "75-100": 0, + "0-25": 30, + "50-75": 0, + "25-50": 0, + "uncategorized": 0 + }, + "data": [ + { + "count": 262, + "avg_up_capacity_percentage": 0.0022625954198473284, + "bw_up": 1000000, + "bw_down": 1000000, + "avg_down_capacity_percentage": 0.0017068702290076335, + "max_down_capacity_percentage": 0.0034, + "range": "0-25", + "min_up_capacity_percentage": 0.0089, + "vdevice_name": "172.16.255.16", + "min_down_capacity_percentage": 0.0034, + "interface": "GigabitEthernet1", + "max_up_capacity_percentage": 0.0089 + }, + { + "count": 262, + "avg_up_capacity_percentage": 0, + "bw_up": 1000000, + "bw_down": 1000000, + "avg_down_capacity_percentage": 0, + "max_down_capacity_percentage": 0, + "range": "0-25", + "min_up_capacity_percentage": 0, + "vdevice_name": "172.16.255.16", + "min_down_capacity_percentage": 0, + "interface": "GigabitEthernet2", + "max_up_capacity_percentage": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/csv": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/doccount": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCount_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_12", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface/fields": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface/page": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_10", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/query/fields": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface/type": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get statistics per interface", + "operationId": "getStatisticsPerInterface", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics per interface": { + "description": "Statistics per interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_21", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert/aggregation": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert", + "$ref": "examples/elasticsearch/monitoring/parameter_example/IPsAlert.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert", + "$ref": "examples/elasticsearch/monitoring/response_example/IPsAlert.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_20", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert", + "$ref": "examples/elasticsearch/monitoring/parameter_example/IPsAlert.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert", + "$ref": "examples/elasticsearch/monitoring/response_example/IPsAlert.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/ipsalert/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_20", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert", + "$ref": "examples/elasticsearch/monitoring/parameter_example/IPsAlert.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert", + "$ref": "examples/elasticsearch/monitoring/response_example/IPsAlert.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/ipsalert/csv": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert/doccount": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get response count of a query", + "operationId": "getCount_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_23", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/ipsalert/fields": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/ipsalert/page": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_21", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert/query/fields": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/on-demand/queue": { + "get": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "gets current on-demand queue entries", + "operationId": "getQueueEntries", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue Entries": { + "description": "Queue Entries", + "value": { + "entries": [ + { + "status": "COMPLETED", + "complete": true, + "data_type": "ConnectionEvents", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640765713644, + "value": 48, + "completionTime": 1640765718372, + "end_time": 0, + "startProcessingTime": 1640765717682, + "time_period": "LAST_N_HOURS", + "id": "0a43d31b-fde9-400a-b0ed-319f72115323", + "device_id": "172.16.255.11" + }, + { + "status": "QUEUED", + "complete": false, + "data_type": "DPI", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640764758920, + "value": 24, + "completionTime": 0, + "end_time": 0, + "startProcessingTime": 0, + "time_period": "LAST_N_HOURS", + "id": "93629fed-ec81-4f37-9c85-24b577191c9c", + "device_id": "10.0.1.17" + }, + { + "status": "COMPLETED", + "complete": true, + "data_type": "DPI", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640765915038, + "value": 48, + "completionTime": 1640765918258, + "end_time": 0, + "startProcessingTime": 1640765917678, + "time_period": "LAST_N_HOURS", + "id": "d9111cd6-59ab-482c-bd95-41fdaba9fc5b", + "device_id": "172.16.255.11" + }, + { + "status": "QUEUED", + "complete": false, + "data_type": "ConnectionEvents", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640767377708, + "value": 24, + "completionTime": 0, + "end_time": 0, + "startProcessingTime": 0, + "time_period": "LAST_N_HOURS", + "id": "544ce0e1-9f57-4266-b789-ed50d043761c", + "device_id": "10.0.1.17" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + }, + "post": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "Create on-demand troubleshooting queue entry", + "operationId": "createQueueEntry", + "requestBody": { + "description": "On-demand queue entry", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "device_id": "10.0.1.17", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "value": 24 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "complete": false, + "creationTime": 1641373054019, + "startProcessingTime": 0, + "completionTime": 0, + "id": "bc4e2dbe-a226-4a01-aa1a-1859978014d3", + "device_id": "169.254.10.10", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "tenant_id": "a200c754-22bc-4a99-b0b9-a2957755e3ba", + "value": 3, + "start_time": 0, + "end_time": 0, + "status": "QUEUED" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/on-demand/queue/properties": { + "get": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "gets current size of on-demand queue", + "operationId": "getQueueProperties", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue size is 2": { + "description": "Queue size is 2", + "value": { + "tenant_current_size": 2, + "max_size": 20, + "tenant_max_size": 5 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/on-demand/queue/{entryId}": { + "put": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "Updates on-demand troubleshooting queue entry", + "operationId": "updateQueueEntry", + "parameters": [ + { + "name": "entryId", + "in": "path", + "description": "Entry Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "On-demand queue entry", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "device_id": "10.0.1.17", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "value": 24 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "id": "ac031e7b-9c6e-4375-8589-ad503f9d52d2", + "device_id": "10.0.1.17", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "value": 24 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + }, + "delete": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "removes on-demand queue entry", + "operationId": "deleteQueueEntry", + "parameters": [ + { + "name": "entryId", + "in": "path", + "description": "Entry Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-write" + } + }, + "/statistics/process": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Process stats data", + "operationId": "processStatisticsData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "ActivateDataProcessing": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/process/counters": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get statistics processing counters", + "operationId": "getStatisticsProcessingCounters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics processing counters": { + "description": "Statistics processing counters", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/process/status": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get stats process report", + "operationId": "generateStatsProcessReport", + "parameters": [ + { + "name": "processQueue", + "in": "query", + "description": "Process queue", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Process report": { + "description": "Process report", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/process/thread/status": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get stats process thread report", + "operationId": "generateStatsProcessThreadReport", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Process thread report": { + "description": "Process thread report", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/qos": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_13", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/qos/aggregation": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS", + "$ref": "examples/elasticsearch/monitoring/parameter_example/QoS.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS", + "$ref": "examples/elasticsearch/monitoring/response_example/QoS.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_12", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS", + "$ref": "examples/elasticsearch/monitoring/parameter_example/QoS.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS", + "$ref": "examples/elasticsearch/monitoring/response_example/QoS.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/qos/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_12", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS", + "$ref": "examples/elasticsearch/monitoring/parameter_example/QoS.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS", + "$ref": "examples/elasticsearch/monitoring/response_example/QoS.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/qos/csv": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/qos/doccount": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get response count of a query", + "operationId": "getCount_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_15", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/qos/fields": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/qos/page": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_13", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/qos/query/fields": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/settings/disable/devicelist/{indexName}": { + "get": { + "tags": [ + "Monitoring - Status" + ], + "description": "Get list of disabled devices for a statistics index", + "operationId": "getDisabledDeviceList", + "parameters": [ + { + "name": "indexName", + "in": "path", + "description": "Index name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Disabled device list": { + "description": "Disabled device list", + "value": [ + "172.16.255.14" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read" + }, + "put": { + "tags": [ + "Monitoring - Status" + ], + "description": "Update list of disabled devices for a statistics index", + "operationId": "updateStatisticsDeviceList", + "parameters": [ + { + "name": "indexName", + "in": "path", + "description": "Index name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Disabled device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Disabled device": { + "description": "Disabled device", + "value": [ + "172.16.255.14" + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update status": { + "description": "Update status", + "value": { + "response": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/statistics/settings/status": { + "get": { + "tags": [ + "Monitoring - Status" + ], + "description": "Get statistics settings", + "operationId": "getStatisticsSettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics settings": { + "description": "Statistics settings", + "value": [ + { + "indexName": "approutestatsstatistics", + "status": "enable", + "displayName": "Approute" + }, + { + "indexName": "interfacestatistics", + "status": "enable", + "displayName": "Interface" + }, + { + "indexName": "wlanclientinfostatistics", + "status": "enable", + "displayName": "Wlan Client Info" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,dca" + }, + "put": { + "tags": [ + "Monitoring - Status" + ], + "description": "Update statistics settings", + "operationId": "updateStatisticsSettings", + "requestBody": { + "description": "Stats setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": [ + { + "indexName": "interfacestatistics", + "status": "enable" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,dca" + } + }, + "/statistics/settings/status/device": { + "get": { + "tags": [ + "Monitoring - Status" + ], + "description": "Get list of enabled device for statistics index", + "operationId": "getEnabledIndexForDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enabled device": { + "description": "Enabled device", + "value": [ + "interfacestatistics", + "eioltestatistics", + "sulstatistics", + "qosstatistics", + "devicesystemstatusstatistics", + "bridgemacstatistics", + "dpistatistics", + "approutestatsstatistics", + "wlanclientinfostatistics", + "flowlogstatistics", + "urlf", + "fwall", + "vnfstatistics", + "umbrella", + "apphostingstatistics", + "utddaqioxstatistics", + "ipsalert", + "aggregatedappsdpistatistics", + "bridgeinterfacestatistics", + "artstatistics", + "trackerstatistics", + "cloudxstatistics" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read" + } + }, + "/statistics/speedtest": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_28", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/speedtest/aggregation": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_28", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/speedtest/app-agg/aggregation": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_27", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/speedtest/csv": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/speedtest/doccount": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCount_30", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_30", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/speedtest/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/speedtest/page": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_28", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/speedtest/query/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get security connection events stats raw data", + "operationId": "getSulStatDataRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "fw_zone_pair": "ulogging_in2out", + "statcycletime": 1616121001459, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616120034778, + "create_time": 1616120009235, + "fw_dst_zone": "ulogging_z_out", + "end_time": 1616120024267, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_src_zone": "ulogging_z_in", + "fw_policy": "p1", + "src_port": 34128, + "start_time": 1616120009235, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "103.235.46.39", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "_dlRSHgBQcANHsKKdbP0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_14", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "fw_zone_pair": "ulogging_in2out", + "statcycletime": 1616121001459, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616120034778, + "create_time": 1616120009235, + "fw_dst_zone": "ulogging_z_out", + "end_time": 1616120024267, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_src_zone": "ulogging_z_in", + "fw_policy": "p1", + "src_port": 34128, + "start_time": 1616120009235, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "103.235.46.39", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "_dlRSHgBQcANHsKKdbP0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/sul/connections/aggregation": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated each result": { + "description": "Aggregated each result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_13", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "statcycletime": 1616170802027, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616170026992, + "create_time": 1616170001492, + "end_time": 1616170016505, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_policy": "p1", + "src_port": 53105, + "start_time": 1616170001492, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "90.130.70.73", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "uNlJS3gBQcANHsKKW_5s" + } + ], + "pageInfo": { + "startTime": "1615956601540", + "endTime": "1616170802027", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", + "hasMoreData": false, + "count": 14, + "totalCount": 14 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/sul/connections/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_13", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/sul/connections/csv": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "168" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "1" + ], + "field": "vpn_id", + "type": "int", + "operator": "in" + }, + { + "value": [ + "p1" + ], + "field": "fw_policy", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/sul/connections/doccount": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get response count of a query", + "operationId": "getCount_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_16", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections/fields": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections/filter/policy_name/{policyType}": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get filter Policy Name list", + "operationId": "getFilterPolicyNameList", + "parameters": [ + { + "name": "policyType", + "in": "path", + "description": "Policy type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "zoneBasedFW", + "intrusionPrevention", + "urlFiltering", + "advancedMalwareProtection" + ] + } + }, + { + "name": "query", + "in": "query", + "description": "query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "vdevice_name", + "type": "string", + "operator": "in", + "value": [ + "172.16.255.15" + ] + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Filter Policy Name list": { + "description": "Filter Policy Name list", + "value": [ + { + "fw_policy": "FW-Block-AV" + }, + { + "fw_policy": "FW-Block-p2p" + }, + { + "fw_policy": "FW_policy1" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections/page": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "168" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "1" + ], + "field": "vpn_id", + "type": "int", + "operator": "in" + }, + { + "value": [ + "p1" + ], + "field": "fw_policy", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "statcycletime": 1616170802027, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616170026992, + "create_time": 1616170001492, + "end_time": 1616170016505, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_policy": "p1", + "src_port": 53105, + "start_time": 1616170001492, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "90.130.70.73", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "uNlJS3gBQcANHsKKW_5s" + } + ], + "pageInfo": { + "startTime": "1615956601540", + "endTime": "1616170802027", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", + "hasMoreData": false, + "count": 14, + "totalCount": 14 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_14", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "168" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "1" + ], + "field": "vpn_id", + "type": "int", + "operator": "in" + }, + { + "value": [ + "p1" + ], + "field": "fw_policy", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "statcycletime": 1616170802027, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616170026992, + "create_time": 1616170001492, + "end_time": 1616170016505, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_policy": "p1", + "src_port": 53105, + "start_time": 1616170001492, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "90.130.70.73", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "uNlJS3gBQcANHsKKW_5s" + } + ], + "pageInfo": { + "startTime": "1615956601540", + "endTime": "1616170802027", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", + "hasMoreData": false, + "count": 14, + "totalCount": 14 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/sul/connections/query/fields": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_16", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/aggregation": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_15", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/app-agg/aggregation": { + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_15", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/cpu": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get device system CPU stats list", + "operationId": "createDeviceSystemCPUStat", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/csv": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/doccount": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get response count of a query", + "operationId": "getCount_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_18", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/memory": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get device system memory stats list", + "operationId": "createDeviceSystemMemoryStat", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/page": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_16", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/query/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/stats": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_17", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/stats/aggregation": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_16", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/stats/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_16", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/stats/csv": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/stats/doccount": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get response count of a query", + "operationId": "getCount_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_19", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/stats/fields": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/stats/page": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_17", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/stats/query/fields": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/umbrella": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_24", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/umbrella/aggregation": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella", + "$ref": "examples/elasticsearch/monitoring/parameter_example/Umbrella.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella", + "$ref": "examples/elasticsearch/monitoring/response_example/Umbrella.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_23", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella", + "$ref": "examples/elasticsearch/monitoring/parameter_example/Umbrella.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella", + "$ref": "examples/elasticsearch/monitoring/response_example/Umbrella.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/umbrella/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_23", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella", + "$ref": "examples/elasticsearch/monitoring/parameter_example/Umbrella.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella", + "$ref": "examples/elasticsearch/monitoring/response_example/Umbrella.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/umbrella/csv": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/umbrella/doccount": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get response count of a query", + "operationId": "getCount_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_26", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/umbrella/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/umbrella/page": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_24", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/umbrella/query/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/urlf": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_22", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/urlf/aggregation": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering", + "$ref": "examples/elasticsearch/monitoring/parameter_example/URLFiltering.json" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering", + "$ref": "examples/elasticsearch/monitoring/response_example/URLFiltering.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_21", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering", + "$ref": "examples/elasticsearch/monitoring/parameter_example/URLFiltering.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering", + "$ref": "examples/elasticsearch/monitoring/response_example/URLFiltering.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/urlf/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_21", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering", + "$ref": "examples/elasticsearch/monitoring/parameter_example/URLFiltering.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering", + "$ref": "examples/elasticsearch/monitoring/response_example/URLFiltering.json" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/urlf/csv": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/urlf/doccount": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get response count of a query", + "operationId": "getCount_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_24", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/urlf/fields": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/urlf/page": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_22", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/urlf/query/fields": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/vnfstatistics": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_11", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/vnfstatistics/aggregation": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_11", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/vnfstatistics/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_11", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/vnfstatistics/csv": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/vnfstatistics/doccount": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCount_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_13", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/vnfstatistics/fields": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/vnfstatistics/page": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_11", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/vnfstatistics/query/fields": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/wlanclientinfo": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_19", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/wlanclientinfo/aggregation": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_18", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/wlanclientinfo/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_18", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/wlanclientinfo/csv": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/wlanclientinfo/doccount": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get response count of a query", + "operationId": "getCount_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_21", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/wlanclientinfo/fields": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/wlanclientinfo/page": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_19", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/wlanclientinfo/query/fields": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/capture": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSessionInfoCapture", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/disable/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "disablePacketCaptureSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/download/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "downloadFile", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/octet-stream": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/forcedisbale/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "forceStopPcapSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/start/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "startPcapSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/status/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFileDownloadStatus", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/stop/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "stopPcapSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/vnicsInfo/{vnfId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getVnicInfoByVnfId", + "parameters": [ + { + "name": "vnfId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/{deviceUUID}/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "formPostPacketCapture", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "*/*": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSessionInfoLog", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/disable/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "disableDeviceLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/download/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "downloadDebugLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/octet-stream": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/renew/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "renewSessionInfo", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/search/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "searchDeviceLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/sessions": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSessions", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/sessions/clear/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "clearSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/type": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getLogType", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/{logType}/{deviceUUID}/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "streamLog", + "parameters": [ + { + "name": "logType", + "in": "path", + "description": "Log type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceUUID", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getDeviceLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + }, + { + "name": "logId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64", + "default": -1 + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_27", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/aggFlow": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated flow data for NWPI.", + "operationId": "getAggFlow", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "traceState", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/aggregation": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_27", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/stream/device/nwpi/app-agg/aggregation": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_26", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/stream/device/nwpi/appQosData": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get QoS Application data for NWPI.", + "operationId": "getAppQosData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "receivedTimestamp", + "in": "query", + "description": "received timestamp", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/appQosState": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get QoS Application state to received timestamp mapping for NWPI.", + "operationId": "getAppQosState", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "traceState", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/concurrentData": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get concurrent data for NWPI.", + "operationId": "getConcurrentData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/concurrentDomainData": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get concurrent domain data for NWPI.", + "operationId": "getConcurrentDomainData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/csv": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/currentTimestamp": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getCurrentTimestamp", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/doccount": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCount_29", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_29", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/domainMetric": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getDomainMetric", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "domain", + "in": "query", + "description": "domain name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "firstTimestamp", + "in": "query", + "description": "first timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "lastTimestamp", + "in": "query", + "description": "last timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/eventAppHopList": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Application and HopList for NWPI.", + "operationId": "getEventAppHopList", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "event app hop list": { + "description": "event app hop list", + "value": "{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-hoplist\",\"application\": \"smtp\",\"upHopListInfo\": [[ {\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\"}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\"}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\"}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\"}]]}]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/eventAppScoreBandwidth": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Event Application Performance Score and Bandwidth for NWPI.", + "operationId": "getEventAppScoreBandwidth", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "receivedTimestamp", + "in": "query", + "description": "received timestamp", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "event application score and bandwidth": { + "description": "event application score and bandwidth", + "value": "{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-score-bandwidth\",\"data\": {\"received_timestamp\": 1647581328105,\"detail\": [{\"application\": \"smtp\",\"received_timestamp\":1647581328105,\"upHopListInfo\": [[{\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 249381,\"performanceScore\": 95,\"bandwidth\": 79998}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 683820,\"performanceScore\": 95,\"bandwidth\": 207353.2}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 15690,\"performanceScore\": 95,\"bandwidth\": 5598}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 20775,\"performanceScore\": 95,\"bandwidth\": 5472}]]}]}, \"tenant\":\"default\"}]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/eventFlowFromAppHop": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Event Flow From Application And Hop for NWPI.", + "operationId": "getEventFlowFromAppHop", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "app name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "direction", + "in": "query", + "description": "direction", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "from", + "in": "query", + "description": "from", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "to", + "in": "query", + "description": "to", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceTraceId", + "in": "query", + "description": "deviceTraceId", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "event flow from app and hop": { + "description": "event flow from app and hop", + "value": "{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-flow\",\"data\": {\"app_name\": \"smtp\",\"received_timestamp\": 1647581328105,\"direction\": \"upstream\",\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"intervalActiveFlow\": 7,\"intervalFinFlow\": 7,\"inspectedFlow\": 7,\"qosCongestedFlow\": 0,\"slaViolatedFlow\": 0,\"asymmetryFlow\": 0,\"fifNotClassifiledFlow\": 0,\"pathChangedFlow\": 0,\"policyBypassedFlow\": 0,\"wanAsymmetryFlow\": 0},\"tenant\":\"default\"}]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/eventReadout": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Event Readout for NWPI.", + "operationId": "getEventReadout", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/finalizedData": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFinalizedData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/finalizedDomainData": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFinalizedDomainData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/flowDetail": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFlowDetail", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "flowId", + "in": "query", + "description": "flow id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/flowMetric": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFlowMetric", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "flowId", + "in": "query", + "description": "flow id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "firstTimestamp", + "in": "query", + "description": "first timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "lastTimestamp", + "in": "query", + "description": "last timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/getMonitorState": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getMonitorState", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/monitor/overrideStart": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "CXP Monitor Action - Override Start", + "operationId": "monitorOverrideStart", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Start CXP Monitor": { + "description": "Start CXP Monitor", + "value": { + "source-site": "500", + "duration": "5", + "vpn-id": "1", + "src-ip": "100.0.0.1", + "dst-ip": "200.0.0.1", + "app": "webex", + "src-if": "GigabitEthernet0/1", + "protocol": "1", + "src-port": "8080", + "dst-port": "8443", + "dscp-is-valid": "true", + "dscp": "1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/monitor/start": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "CXP Monitor Action - Start", + "operationId": "monitorStart", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Start CXP Monitor": { + "description": "Start CXP Monitor", + "value": { + "source-site": "500", + "duration": "5", + "vpn-id": "1", + "src-ip": "100.0.0.1", + "dst-ip": "200.0.0.1", + "app": "webex", + "src-if": "GigabitEthernet0/1", + "protocol": "1", + "src-port": "8080", + "dst-port": "8443", + "dscp-is-valid": "true", + "dscp": "1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/monitor/stop": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "CXP Monitor Action - Stop", + "operationId": "monitorStop", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stop CXP Monitor": { + "description": "Stop CXP Monitor", + "value": { + "source-site": "500", + "duration": "5", + "vpn-id": "1", + "src-ip": "100.0.0.1", + "dst-ip": "200.0.0.1", + "app": "webex", + "src-if": "GigabitEthernet0/1", + "protocol": "1", + "src-port": "8080", + "dst-port": "8443", + "dscp-is-valid": "true", + "dscp": "1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/nwpiDSCP": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getNwpiDscp", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/nwpiNbarAppGroup": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getNwpiNbarAppGroup", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/nwpiProtocol": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getNwpiProtocol", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/packetFeatures": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getPacketFeatures", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "flowId", + "in": "query", + "description": "flow id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/page": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_27", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/preloadinfo": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getPreloadInfo", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/query/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/routingDetail": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Routing Details for NWPI.", + "operationId": "getRoutingDetailFromLocal", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "traceState", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "routePrefixs", + "in": "query", + "description": "route prefixs", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": { + "upstream": [ + { + "hostname": "Site20-cEdge-1", + "system_ip": "4.4.4.2", + "route": "119.0.0.0/8", + "route_preference": 1, + "metric": 0, + "next_hop": { + "outgoing_interface": "NULL0", + "next_hop_address": "168.19.1.200" + }, + "source_protocol": "static", + "last_update_time": 1646093417790 + } + ], + "downstream": [ + { + "hostname": "Site20-cEdge-2", + "system_ip": "4.4.4.3", + "route": "10.20.25.0/24", + "route_preference": 1, + "metric": 0, + "next_hop": { + "outgoing_interface": "NULL0", + "next_hop_address": "168.19.1.201" + }, + "source_protocol": "static", + "last_update_time": 1646093417790 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/trace/delete": { + "delete": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Trace Action - Delete", + "operationId": "traceDelete", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/trace/record/{deviceUUID}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "post flow data", + "operationId": "nwpiPostFlowData", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,vmanage-http-stream" + } + }, + "/stream/device/nwpi/trace/start": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Trace Action - Start", + "operationId": "traceStart", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Start Flow Monitor trace": { + "description": "Start Flow Monitor trace", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_1", + "device-list": [ + { + "local-system-ip": "172.16.255.16", + "deviceId": "172.16.255.16", + "uuid": "C8K-25e26fb8-e692-4b24-bf10-1da949728c41", + "version": "17.07.01.0.144090" + }, + { + "local-system-ip": "172.16.255.15", + "deviceId": "172.16.255.15", + "uuid": "C8K-bea08f58-91b6-498a-86f3-9b74646c318b", + "version": "17.04.01.0.144091" + } + ], + "app": [ + "webex-meeting", + "ms-office-365" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000", + "source-site-version": "17.04.01.0.144091", + "warning": " " + } + }, + "Start Flow Monitor trace for a specific device": { + "description": "Start Flow Monitor trace for a specific device", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_2", + "device-ip": "172.16.255.16", + "device-list": [ + { + "local-system-ip": "172.16.255.16", + "deviceId": "172.16.255.16", + "uuid": "C8K-25e26fb8-e692-4b24-bf10-1da949728c41", + "version": "17.07.01.0.144090" + } + ], + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000", + "source-site-version": "17.07.01.0.144090", + "warning": " " + } + }, + "Start Domain Monitor trace": { + "description": "Start Domain Monitor trace", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_3", + "device-list": [ + { + "local-system-ip": "172.16.255.16", + "deviceId": "172.16.255.16", + "uuid": "C8K-25e26fb8-e692-4b24-bf10-1da949728c41", + "version": "17.07.01.0.144090" + }, + { + "local-system-ip": "172.16.255.14", + "deviceId": "172.16.255.14", + "uuid": "C8K-0ea91298-f8db-41e4-a167-e7af0461ed81", + "version": "17.06.01.0.144092" + } + ], + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "client-ip": "100.0.0.0/8", + "domain-mon": "true", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000", + "source-site-version": "17.06", + "warning": " " + } + }, + "Start Flow Monitor trace (without vManage UI)": { + "description": "Start Flow Monitor trace (without vManage UI)", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_4", + "app": [ + "webex-meeting", + "ms-office-365" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000" + } + }, + "Start Flow Monitor trace for a specific device (without vManage UI)": { + "description": "Start Flow Monitor trace for a specific device (without vManage UI)", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_5", + "device-ip": "172.16.255.16", + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000" + } + }, + "Start Domain Monitor trace (without vManage UI)": { + "description": "Start Domain Monitor trace (without vManage UI)", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_6", + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "client-ip": "100.0.0.0/8", + "domain-mon": "true", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/trace/stop/{traceId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Trace Action - Stop", + "operationId": "traceStop", + "parameters": [ + { + "name": "traceId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFinFlowCount": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Retrieve total Fin Flow counts", + "operationId": "getFinalizedFlowCount", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Finalized flow count": { + "description": "Finalized flow count", + "value": { + "total_flow_count": "10000" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFinFlowTimeRange": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Retrieve Fin Flow time range", + "operationId": "getFinFlowTimeRange", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Finalized flow time range": { + "description": "Finalized flow time range", + "value": [ + { + "start_time": "1651543925251", + "end_time": "1651545413468" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFinFlowWithQuery": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Retrieve Certain Fin Flows", + "operationId": "traceFinFlowWithQuery", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Severity histogram": { + "description": "Severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFlow": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getTraceFlow", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/traceHistory": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getTraceHistory", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSession", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/disable/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "disableSpeedTestSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/interface/bandwidth": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getInterfaceBandwidth", + "parameters": [ + { + "name": "circuit", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceUUID", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceUuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/start/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "startSpeedTest", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/status/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSpeedTestStatus", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/stop/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "stopSpeedTest", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/{deviceUUID}/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "saveSpeedTestResults", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "*/*": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSpeedTest", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + }, + { + "name": "logId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64", + "default": 0 + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/status/{deviceUUID}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get device status stream", + "operationId": "processDeviceStatus", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "*/*": {} + } + } + }, + "x-roles-required": "vmanage-http-stream" + } + }, + "/system/device": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create new device


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createDevice", + "requestBody": { + "description": "Create device request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/device/{uuid}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create vEdge device config", + "operationId": "generateBootstrapConfigForVedge", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configtype", + "in": "query", + "description": "Device config type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "inclDefRootCert", + "in": "query", + "description": "Include default root certs flag", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "version", + "in": "query", + "description": "cloud-init format version", + "schema": { + "type": "string", + "default": "v1" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": { + "bootstrapConfig": "#cloud-config\nvinitparam:\n - otp : 7f162ca042174e37ae8a633ce7b08d4a\n - vbond : 10.0.12.26\n - uuid : 71001c48-fdcf-4ac0-aaf3-ca4a20386a18\n - org : vIPtela Inc Regression\n" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/devices": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create bootstrap config for software vEdges", + "operationId": "generateBootstrapConfigForVedges", + "requestBody": { + "description": "Device bootstrap type and id", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap config type and id": { + "description": "Device bootstrap config type and id", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/download/{id}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Download vEdge device config", + "operationId": "getBootstrapConfigZip", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Bootstrap config id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/generic/devices": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create bootstrap config for software vEdges", + "operationId": "generateGenericBootstrapConfigForVedges", + "parameters": [ + { + "name": "wanif", + "in": "query", + "description": "Device WAN interface", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/claimDevices": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Claim the selected unclaimed devices", + "operationId": "claimDevices", + "requestBody": { + "description": "Claim device request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Claim device request": { + "description": "Claim device request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Claimed device info": { + "description": "Claimed device info", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/system/device/controllers/vedge/status": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get controllers vEdge sync status", + "operationId": "getControllerVEdgeSyncStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vEdge status": { + "description": "vEdge status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/decommission/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Decomission vEdge device", + "operationId": "decommissionVedgeCloud", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task id": { + "description": "Task id", + "value": { + "id": "4279226e-162e-4df0-a174-73215c5d839f" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/devicesWithoutSubjectSudi": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "retrieve devices without subject sudi", + "operationId": "devicesWithoutSubjectSudi", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/system/device/fileupload": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Upload file to vEdge", + "operationId": "formPost", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/generate-payg": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Authenticate vSmart user account", + "operationId": "validateUser_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access token": { + "description": "Access token", + "value": "{accessToken: }" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/lifecycle/management/{uuid}": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Set device lifecycle needed flag", + "operationId": "setLifeCycle", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enable", + "in": "query", + "description": "lifecycle needed flag", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device lifecycle needed value": { + "description": "Device lifecycle needed value", + "value": true + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/management/systemip": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get management system IP mapping", + "operationId": "getManagementSystemIPInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "System IP mapping": { + "description": "System IP mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/migrateDevice/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Migrate device software to vedge/cedge", + "operationId": "migrateDevice", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device migration result": { + "description": "Device migration result", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/reset/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Reset vEdge device", + "operationId": "resetVedgeCloud", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task id": { + "description": "Task id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/rma/candidates/{deviceType}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get RMA candidates by device type", + "operationId": "getRMACandidates", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vsmart" + ] + } + }, + { + "name": "uuid", + "in": "query", + "description": "Excluded currently selected uuid", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device type": { + "description": "Device type", + "value": "[\"data\": [\n {\n \"uuid\": \"347eca1b-a0ae-42be-92d1-4702b5285aae\",\n \"deviceIP\": \"8.8.8.8\",\n \"validity\": \"valid\",\n \"managementSystemIP\": \"169.254.0.1\"\n \"host-name\": \"vm130\"\n }\n\"]\"]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/rootcertchain/status": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get controllers vEdge sync status", + "operationId": "getRootCertStatusAll", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Root certificate state", + "required": true, + "schema": { + "type": "string", + "enum": [ + "pending", + "done" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vEdge sync status": { + "description": "vEdge sync status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/selfsignedcert/iscreated": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Whether self signed certificate created", + "operationId": "checkSelfSignedCert", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Self signed certificate created": { + "description": "Self signed certificate created", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/smartaccount/authenticate": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Authenticate vSmart user account", + "operationId": "validateUser", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartAccountModel" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access token": { + "description": "Access token", + "value": "{accessToken: }" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/smartaccount/sync": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Sync devices from Smart-Account", + "operationId": "syncDevices", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartAccountModel" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/sync/rootcertchain": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Sync root certificate", + "operationId": "syncRootCertChain", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/tenant/management/systemip": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get management system IP


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantManagementSystemIPs", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "System IP": { + "description": "System IP", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/type/{deviceCategory}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get devices details", + "operationId": "getCloudDockDataBasedOnDeviceType", + "parameters": [ + { + "name": "deviceCategory", + "in": "path", + "description": "Device category", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedges", + "controllers" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device info": { + "description": "Device info", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/type/{deviceCategory}/defaultConfig": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get devices default config", + "operationId": "getCloudDockDefaultConfigBasedOnDeviceType", + "parameters": [ + { + "name": "deviceCategory", + "in": "path", + "description": "Device category", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedges", + "controllers" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device default config": { + "description": "Device default config", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/unclaimedDevices": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get list of all unclaimed devices", + "operationId": "getAllUnclaimedDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device info": { + "description": "Device info", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/updateDeviceSubjectSUDI/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "update subject sudi value of given device uuid", + "operationId": "updateDeviceSubjectSUDI", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/system/device/vmanagerootca/{uuid}": { + "delete": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Invalidate vManage root CA", + "operationId": "invalidateVmanageRootCA", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/{deviceCategory}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart.\nWhen {deviceCategory = vedges}, it returns all available vEdge routers", + "operationId": "getDevicesDetails", + "parameters": [ + { + "name": "deviceCategory", + "in": "path", + "description": "Device category", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "model", + "in": "query", + "description": "Device model", + "schema": { + "type": "string", + "enum": [ + "vedge-cloud", + "vedge-1000", + "vedge-2000", + "vedge-100", + "vedge-ISR1100-4G", + "vedge-ISR1100-4GLTE", + "vedge-ISR1100X-4G", + "vedge-ISR1100-6G", + "vedge-ISR1100X-6G", + "vedge-100-B", + "vedge-100-WM", + "vedge-100-M", + "vEdge-5000", + "vedge-CSR-1000v", + "vedge-IR-1101", + "vedge-IR-1821", + "vedge-IR-1831", + "vedge-IR-1833", + "vedge-IR-1835", + "vedge-IR-8140H", + "vedge-IR8140H-P", + "vedge-IR-8340", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-IR-1101", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-ISR-4221X", + "vedge-ISR-4431", + "vedge-ISR-4451-X", + "vedge-ASR-1001-HX", + "vedge-ASR-1002-X", + "vedge-ASR-1002-HX", + "vedge-ASR-1006-X", + "vedge-C1111-8P", + "vedge-C1121X-8P", + "vedge-C1111X-8P", + "vedge-C1111-8PLTELAW", + "vedge-C1111-8PLTEEA", + "vedge-C1121-8PLTEPW", + "vedge-C1111-8PLTELA", + "vedge-C1117-4PLTEEA", + "vedge-C1126X-8PLTEP", + "vedge-C1127X-8PLTEP", + "vedge-C1127X-8PMLTEP", + "vedge-C1127-8PMLTEP", + "vedge-C1117-4PLTELA", + "vedge-ISRv", + "vedge-C8000V", + "vedge-ASR-1001-X", + "vedge-C1111-4P", + "vedge-C1101-4P", + "vedge-C1101-4PLTEP", + "vedge-C8500-12X4QC", + "vedge-C8500-12X", + "vedge-C8500L-8S4X", + "vedge-C1111-8PW", + "vedge-C1111-8PLTEEAW", + "vedge-C1111-4PLTEEA", + "vedge-C1101-4PLTEPW", + "vedge-C1109-4PLTE2PW", + "vedge-C1109-4PLTE2P", + "vedge-C1121X-8PLTEP", + "vedge-C1161X-8PLTEP", + "vedge-C1113-8PMLTEEA", + "vedge-C1111-4PLTELA,vedge-C1116-4P", + "vedge-C1116-4PLTEEA", + "vedge-C1117-4P", + "vedge-C1117-4PM", + "vedge-C1117-4PMLTEEA", + "vsmart", + "vmanage", + "vbond", + "vedge-ISR-4461", + "vedge-C8300-1N1S-4T2X", + "vedge-C8300-1N1S-6T", + "vedge-C1161X-8P", + "vedge-C8300-2N2S-4T2X", + "vedge-C8300-2N2S-6T", + "vedge-C8200-1N-4T", + "vedge-C8200L-1N-4T", + "vedge-C1161-8P", + "vedge-C1126-8PLTEP", + "vedge-C1127-8PLTEP", + "vedge-C1121-4P", + "vedge-C1121-4PLTEP", + "vedge-C1128-8PLTEP", + "vedge-C1121X-8PLTEPW", + "vedge-C1121-8PLTEP", + "vedge-C1121-8P", + "vedge-C1161-8PLTEP", + "vedge-C1113-8PLTEEA", + "vedge-C1131-8PW", + "vedge-C1131X-8PW", + "vedge-C1131-8PLTEPW", + "vedge-C1131X-8PLTEPW", + "vedge-C1113-8PLTEW", + "vedge-C1111-4PW", + "vedge-C1112-8P", + "vedge-C1112-8PLTEEA", + "vedge-C1112-8PLTEEAWE", + "vedge-C1112-8PWE", + "vedge-C1113-8P", + "vedge-C1113-8PLTEEAW", + "vedge-C1113-8PLTELA", + "vedge-C1113-8PLTELAWZ", + "vedge-C1113-8PM", + "vedge-C1113-8PMWE", + "vedge-C1113-8PW", + "vedge-C1116-4PLTEEAWE", + "vedge-C1116-4PWE", + "vedge-C1117-4PLTEEAW", + "vedge-C1117-4PLTELAWZ", + "vedge-C1117-4PMLTEEAWE", + "vedge-C1117-4PMWE", + "vedge-C1117-4PW", + "vedge-C1118-8P", + "vedge-C1109-2PLTEGB", + "vedge-C1109-2PLTEUS", + "vedge-C1109-2PLTEVZ" + ] + } + }, + { + "name": "state", + "in": "query", + "description": "List of states", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CertificateStates" + }, + "enum": [ + "tokengenerated", + "bootstrapconfiggenerated", + "csrgenerated", + "csrfailed", + "certinstalled", + "certinstallfailed" + ] + } + }, + { + "name": "uuid", + "in": "query", + "description": "List of device uuid", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUuid" + } + } + }, + { + "name": "deviceIP", + "in": "query", + "description": "List of device system IP", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + }, + { + "name": "validity", + "in": "query", + "description": "List of device validity", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CertificateValidity" + }, + "enum": [ + "valid", + "invalid", + "staging" + ] + } + }, + { + "name": "family", + "in": "query", + "description": "The platform family to filter for", + "schema": { + "type": "string", + "enum": [ + "aon", + "cedge" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Edit device", + "operationId": "editDevice", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + }, + "delete": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Delete vEdges", + "operationId": "deleteDevice", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/reverseproxy/{uuid}": { + "get": { + "tags": [ + "System - Reverse Proxy" + ], + "description": "Get reverse proxy IP/Port mappings for controller", + "operationId": "getReverseProxyMappings", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reverse proxy mappings": { + "description": "Device reverse proxy mappings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "System - Reverse Proxy" + ], + "description": "Create reverse proxy IP/Port mappings for controller", + "operationId": "createReverseProxyMappings", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device reverse proxy mappings", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reverse proxy mappings": { + "description": "Device reverse proxy mappings", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag": { + "get": { + "tags": [ + "Tag" + ], + "description": "Get all tags", + "operationId": "getTag", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagRestfulResource" + } + }, + "examples": { + "Group": { + "description": "Group", + "value": [ + { + "name": "US - West coast", + "id": "1" + }, + { + "name": "US - East coast", + "id": "2" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Tag" + ], + "description": "Create a tag", + "operationId": "createTag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "create or associate tag": { + "description": "create or associate tag", + "value": { + "associate": [ + { + "deviceId": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "tagList": [ + { + "name": "PR_Tag1", + "tagId": "a4f6ed92-31b9-4f4c-8f6d-30257916b912", + "tagType": "device" + } + ], + "devicesAdded": [ + { + "configGroupName": "PR_Tagging", + "configGroupId": "34787e8e-7b4e-4b1e-829a-a0e5452da54e", + "@rid": 1250, + "tagId": "0bacc10d-384d-4d0a-9c4e-272eb1b45c05", + "values": "[\"PR_Tag1\"]", + "rule": "equal", + "deviceAttribute": "tags" + } + ] + } + ], + "create": [] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": "{\"C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5\":{\"configGroupId\":\"34787e8e-7b4e-4b1e-829a-a0e5452da54e\",\"configGroupName\":\"PR_Tagging\u201d}}\n" + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/checkRules": { + "post": { + "tags": [ + "Tag" + ], + "description": "This API will check if a rule can be created or not", + "operationId": "checkRules", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Config Group": { + "description": "Config Group", + "value": "{\"configGroupId\":\"34787e8e-7b4e-4b1e-829a-a0e5452da54e\",\"deviceAttribute\":\"tags\",\"rule\":\"equal\",\"values\":[\"PR_Tag1\"],\"tagId\":\u201d\"}\n" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": { + "devices": [ + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "serialNumber": "12345711", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.14", + "configuredSiteId": "", + "deploymentStatus": "" + }, + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-363f3468-d0ac-469d-ad53-e47c8ada5a0e", + "serialNumber": "12345712", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.15", + "configuredSiteId": "", + "deploymentStatus": "" + } + ], + "isConflict": false + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/conflictCheck": { + "post": { + "tags": [ + "Tag" + ], + "description": "Check for conflicts when tagging", + "operationId": "check for conflicts when tagging", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "conflict check": { + "description": "conflict check", + "value": { + "associate": [ + { + "deviceId": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "deviceModel": "vedge-C8000V", + "tagList": [ + { + "name": "PR_Tag1", + "tagId": "a4f6ed92-31b9-4f4c-8f6d-30257916b912", + "tagType": "device" + } + ] + } + ], + "create": [] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": [ + { + "deviceId": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "devicesAdded": [ + { + "configGroupName": "PR_Tagging", + "configGroupId": "34787e8e-7b4e-4b1e-829a-a0e5452da54e", + "@rid": 1250, + "tagId": "0bacc10d-384d-4d0a-9c4e-272eb1b45c05", + "values": "[\"PR_Tag1\"]", + "rule": "equal", + "deviceAttribute": "tags" + } + ] + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/reindex": { + "get": { + "tags": [ + "Tag" + ], + "description": "Re-index device tags for search. Only call this API very occasionally if tag search is not returning expected results.", + "operationId": "reindexTag", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/remove": { + "post": { + "tags": [ + "Tag" + ], + "description": "Deletes multiple tags", + "operationId": "deleteTag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/tagRules": { + "put": { + "tags": [ + "Tag" + ], + "description": "Edit a tag rule", + "operationId": "editTagRule", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Tag" + ], + "description": "Create a tag rule", + "operationId": "createTagRule", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tag Rule Creation": { + "description": "Tag Rule Creation", + "value": { + "configGroupId": "34787e8e-7b4e-4b1e-829a-a0e5452da54e", + "deviceAttribute": "tags", + "rule": "equal", + "values": [ + "PR_Tag1" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": { + "devices": [ + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "serialNumber": "12345711", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.14", + "configuredSiteId": "", + "deploymentStatus": "" + }, + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-363f3468-d0ac-469d-ad53-e47c8ada5a0e", + "serialNumber": "12345712", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.15", + "configuredSiteId": "", + "deploymentStatus": "" + } + ], + "isConflict": false + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/tagRules/{configGroupId}": { + "get": { + "tags": [ + "Tag" + ], + "description": "Get tag rules", + "operationId": "getTagRules", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "ConfigGroup Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/tagRules/{tagRuleId}": { + "delete": { + "tags": [ + "Tag" + ], + "description": "Delete a tag rule", + "operationId": "deleteTagRule", + "parameters": [ + { + "name": "tagRuleId", + "in": "path", + "description": "tagRule Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configGroupId", + "in": "query", + "description": "ConfigGroup Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/cloudx": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get CloudX feature list", + "operationId": "getCloudXStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX status": { + "description": "CloudX status", + "value": { + "data": [ + { + "appType": "amazon_aws", + "longName": "Amazon AWS", + "totalSites": 2, + "goodSites": 0, + "badSites": 0, + "averageSites": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read" + } + }, + "/template/cloudx/addcloudx/{type}": { + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Add cloudx gateway", + "operationId": "addCloudxType", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Cloudx type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cloudx", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx": { + "description": "Cloudx" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/cloudx/attachedclient": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get attached client site list", + "operationId": "getAttachedClientList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX attached client site": { + "description": "CloudX attached client site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/attacheddia": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get attached Dia site list", + "operationId": "getAttachedDiaList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX attached Dia site": { + "description": "CloudX attached Dia site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/attachedgateway": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get attached gateway list", + "operationId": "getAttachedGatewayList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX attached gateway": { + "description": "CloudX attached gateway", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/availableapps": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get CloudX available apps list", + "operationId": "getCloudXAvailableApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX app list": { + "description": "CloudX app list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read" + } + }, + "/template/cloudx/clientlist": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get site list", + "operationId": "getSiteList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX site": { + "description": "CloudX site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/dialist": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get Dia site list", + "operationId": "getDiaList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX Dia site": { + "description": "CloudX Dia site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/gatewaylist": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get gateway list", + "operationId": "getGatewayList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX gateway": { + "description": "CloudX gateway", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/interfaces": { + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Enable cloudx gateway", + "operationId": "addCloudxInterfaces", + "requestBody": { + "description": "Cloudx", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx": { + "description": "Cloudx" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/cloudx/manage/apps": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get apps and vpns", + "operationId": "getApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + }, + "put": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Edit apps and vpns", + "operationId": "editApps", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx apps and vpns": { + "description": "Cloudx apps and vpns", + "value": { + "appList": [ + { + "appType": "amazon_aws", + "longName": "Amazon AWS", + "appVpnList": "1,10" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Change required": { + "description": "Change required", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Add apps and vpns", + "operationId": "addApps", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx apps and vpns": { + "description": "Cloudx apps and vpns", + "value": { + "appList": [ + { + "appType": "amazon_aws", + "longName": "Amazon AWS", + "appVpnList": "1,5" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/cloudx/sig_tunnels": { + "get": { + "tags": [ + "Configuration - Secure Internet Gateway Tunnels" + ], + "description": "Get Secure Internet Gateway Tunnel List", + "operationId": "getSigTunnelList_1", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/status": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get sites per application per vpn", + "operationId": "sitePerApp", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "App name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX site": { + "description": "CloudX site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read" + } + }, + "/template/config/attach/{deviceId}": { + "put": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Upload device config", + "operationId": "uploadConfig", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template config": { + "description": "Template config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write,Template Deploy-write" + } + }, + "/template/config/attached/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get local template attached config for given device", + "operationId": "getAttachedConfig", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "Config type", + "schema": { + "type": "string", + "enum": [ + "CFS", + "RFS", + "DRAFT_RFS", + "DRAFT_CFS" + ], + "default": "CFS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attached config": { + "description": "Attached config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write" + } + }, + "/template/config/device/mode/cli": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Generates a JSON object that contains a list of valid devices in CLI mode", + "operationId": "generateCLIModeDevices", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Device type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge", + "controller", + "vmanage" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": "data" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template", + "operationId": "updateDeviceToCLIMode", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "deviceType": "vedge", + "devices": [ + { + "deviceId": "932f70dd-5815-4712-b9ed-3d34a238f2ca", + "deviceIP": "172.16.255.21" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template Id": { + "description": "Device template Id", + "value": { + "id": "device_config_mode_cli-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write,Template Deploy-write" + } + }, + "/template/config/device/mode/vmanage": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get list of devices that are allowable for vmanage modes", + "operationId": "generatevManageModeDevices", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Device type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge", + "controller", + "vmanage" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/diff/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Generates a JSON object that contains the diff for a given device", + "operationId": "getDeviceDiff", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Config diff": { + "description": "Config diff", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/quickConnect/submitDevices": { + "post": { + "tags": [ + "Configuration - Quick Connect" + ], + "description": "Creates and pushes bootstrap configurations onto day0 devices.", + "operationId": "submitDay0Config", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "data": { + "description": "data", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/rmalist/{oldDeviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get compatible devices of model, chassis number, certificate serial number with the old device", + "operationId": "getCompatibleDevices", + "parameters": [ + { + "name": "oldDeviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/rmaupdate": { + "put": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Update new device", + "operationId": "rmaUpdate", + "requestBody": { + "description": "Template config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template config": { + "description": "Template config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write,Template Deploy-write" + } + }, + "/template/config/running/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get device running config", + "operationId": "getRunningConfig", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Running config": { + "description": "Running config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write" + } + }, + "/template/config/vpn/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get list of configured VPN (excluding reserved VPN) for a device", + "operationId": "getVpnForDevice", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN": { + "description": "VPN", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cor": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get Cloud On Ramp list", + "operationId": "getCORStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cloud on ramp status": { + "description": "Cloud on ramp status", + "value": { + "data": [ + { + "accountId": "010098612700", + "accountName": "010098612700", + "cloudType": "AWS", + "mappedAccountCount": 0, + "cloudRegionList": [ + { + "cloudRegion": "us-west-1", + "transitVpcCount": 1, + "hostVpcCount": 0, + "deviceCount": 2, + "hostVpcReachableCount": 0, + "hostVpcUnreachableCount": 0, + "deviceReachableCount": 0, + "deviceUnreachableCount": 2 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Map Host to Transit VPC/VNet", + "operationId": "createAndMap", + "requestBody": { + "description": "Map host to transit VPC request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Map host to transit VPC request": { + "description": "Map host to transit VPC request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/accountid/{accountid}": { + "delete": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Delete transit VPC/VNet", + "operationId": "removeTransitVPC", + "parameters": [ + { + "name": "accountid", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transitvpcid", + "in": "query", + "description": "Cloud VPC Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/acquireResourcePool": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Acquire IP from resource pool", + "operationId": "acquireResourcePool", + "requestBody": { + "description": "Add IP from resource pool request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add IP from resource pool request": { + "description": "Add IP from resource pool request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/ami": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get AMI list", + "operationId": "getAmiList", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "AMI": { + "description": "AMI", + "value": "{\"data\":{\n \"amis\":[\n {\n \"amiId\":\"ami-00c8377340219e9fc\",\n \"version\":\"18.3.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-0136d4095d027e741\",\n \"version\":\"19.1.0-temp\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02a3c4c89a7e3294e\",\n \"version\":\"19.1.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02f9c3711e326dcb6\",\n \"version\":\"csr-CSR_SDWAN-AMI.16.12.01b-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0be17bfec080cee40.4\",\n \"modelType\":\"csr\"\n },\n {\n \"amiId\":\"ami-053eee5e68e33f25b\",\n \"version\":\"Cisco-CSR-SDWAN-16.12.03-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0379a842c0f9e5378.4\",\n \"modelType\":\"csr\"\n }\n ]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud list", + "operationId": "getCloudList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cloud type": { + "description": "Cloud type", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud/account": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud accounts", + "operationId": "getCloudAccounts", + "parameters": [ + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudEnvironment", + "in": "query", + "description": "Cloud environment", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud/authenticate": { + "put": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Authenticate and update cloud account credentials", + "operationId": "authenticateCredAndUpdate", + "requestBody": { + "description": "Cloud account credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account credential": { + "description": "Cloud account credential", + "value": { + "cloudType": "AWS", + "authType": "KEY", + "apiKey": "dummy", + "secretKey": "dummy" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Authenticate cloud account credentials", + "operationId": "authenticateCloudOnRampCredAndAdd", + "requestBody": { + "description": "Cloud account credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account credential": { + "description": "Cloud account credential", + "value": { + "cloudType": "AWS", + "authType": "KEY", + "apiKey": "dummy", + "secretKey": "dummy" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/cloud/host/accountdetails": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud host VPC account details", + "operationId": "getCloudHostVpcAccountDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud host account": { + "description": "Cloud host account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud/mappedhostaccounts": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud mapped accounts view", + "operationId": "getCloudMappedHostAccounts", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud mapped host account": { + "description": "Cloud mapped host account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/createResourcePool": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Add resource pool", + "operationId": "createResourcePool", + "requestBody": { + "description": "Add resource pool request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add resource pool request": { + "description": "Add resource pool request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/deleteDevicepair": { + "delete": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Remove device pair", + "operationId": "removeDeviceId", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transitvpcid", + "in": "query", + "description": "VPC Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transitvpcname", + "in": "query", + "description": "VPC Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + }, + { + "name": "devicePairId", + "in": "query", + "description": "Device pair Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/device": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get available device list", + "operationId": "getCloudOnRampDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": "data" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/devicepair": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Add device pair", + "operationId": "addDevicePair", + "requestBody": { + "description": "Add device pair request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add device pair request": { + "description": "Add device pair request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/devicepair/hostvpc": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get host VPC details", + "operationId": "getHostVPCs", + "parameters": [ + { + "name": "transitVpcId", + "in": "query", + "description": "Transit VPC Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "devicePairId", + "in": "query", + "description": "Device pair Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Host VPC": { + "description": "Host VPC", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/externalId": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get the vManage external ID for AWS", + "operationId": "getExternalId", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "externalId": { + "description": "externalId", + "value": "12345abcd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/getTransitDevicePairAndHostList": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get device and host details", + "operationId": "getTransitDevicePairAndHostList", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device and host": { + "description": "Device and host", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/getTransitVpnList": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPN list", + "operationId": "getTransitVpcVpnList", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Transit VPN": { + "description": "Transit VPN", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/hostvpc": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get host VPC/VNet list", + "operationId": "getCloudHostVPCs", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPC/VNet": { + "description": "VPC/VNet", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/map": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get mapped VPC/VNet list", + "operationId": "getMappedVPCs", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Map host to transit VPC/VNet", + "operationId": "mapVPCs", + "requestBody": { + "description": "Map host to VPC/VNet", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Map host to VPC/VNet": { + "description": "Map host to VPC/VNet" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Unmap host from transit VPC/VNet", + "operationId": "unmapVPCs", + "requestBody": { + "description": "Unmap host to VPC/VNet", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Unmap host to VPC/VNet": { + "description": "Unmap host to VPC/VNet" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/pem": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPC PEM key list", + "operationId": "getPemKeyList", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PEM key": { + "description": "PEM key", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/scale/down": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Scale down cloud on ramp", + "operationId": "scaleDown", + "requestBody": { + "description": "Update VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update VPC": { + "description": "Update VPC" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "viptela-reserved-cloud" + } + }, + "/template/cor/scale/up": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Scale up cloud on ramp", + "operationId": "scaleUp", + "requestBody": { + "description": "Update VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update VPC": { + "description": "Update VPC" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "viptela-reserved-cloud" + } + }, + "/template/cor/transitvpc": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPC/VNet list", + "operationId": "getTransitVPCs", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPC/VNet list": { + "description": "VPC/VNet list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Update transit VPC/VNet", + "operationId": "updateTransitVPC", + "requestBody": { + "description": "VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC", + "value": { + "accountId": "010098612700", + "cloudRegion": "us-west-1", + "cloudType": "AWS", + "transitVpcName": "DemoVPC", + "transitVpcId": "vpc-0dfdd169a61492554", + "dia": "DISABLED" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Create transit VPC/VNet", + "operationId": "addTransitVPC", + "requestBody": { + "description": "VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC", + "value": { + "accountId": "010098612700", + "cloudRegion": "us-west-1", + "cloudType": "AWS", + "transitVpcName": "DemoVPC", + "transitVpcSize": "c3.large", + "amiId": "ami-0f0f993e800121941", + "deviceModelType": "vedge", + "transitVpcSubnet": "", + "maxHostVpcPerDevicePair": 1, + "devicePairList": [ + { + "deviceList": [ + { + "uuid": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35", + "preference": "active" + }, + { + "uuid": "52c7911f-c5b0-45df-b826-3155809a2a1a", + "preference": "backup" + } + ], + "devicePairId": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35", + "isPrimary": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "b634bf94-b47b-40a2-ba72-d289036234fd" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/transitvpc/autoscale-properties": { + "put": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Update transit VPC autoscale properties", + "operationId": "updateTransitVpcAutoscaleProperties", + "requestBody": { + "description": "VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC", + "value": { + "accountId": "010098612700", + "cloudRegion": "us-west-1", + "cloudType": "AWS", + "transitVpcName": "DemoVPC", + "transitVpcId": "vpc-0dfdd169a61492554", + "maxHostVpcPerDevicePair": 2 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/transitvpc/size": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPC supported size", + "operationId": "getTransitVPCSupportedSize", + "parameters": [ + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + }, + { + "name": "cloudEnvironment", + "in": "query", + "description": "Cloud environment", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPC size": { + "description": "VPC size", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cortex": { + "get": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Get Cortex List", + "operationId": "getCortexStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cortex status": { + "description": "Cortex status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-read" + } + }, + "/template/cortex/cloud/authenticate": { + "post": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Authenticate Cloud Account Credentials", + "operationId": "authenticateAzureConnectCredAndAdd", + "requestBody": { + "description": "Credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Credential": { + "description": "Credential" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/cortex/map": { + "get": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Get Mapped WAN Resource Groups", + "operationId": "getMappedWanResourceGroups", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource groups": { + "description": "WAN resource groups", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/cortex/sync": { + "post": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Sync WAN Resource Groups", + "operationId": "syncWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/cortex/wanrg": { + "get": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Get WAN Resource Groups", + "operationId": "getWanResourceGroups", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource groups": { + "description": "WAN resource groups", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + }, + "put": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Edit WAN Resource Groups", + "operationId": "editWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + }, + "post": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Create WAN Resource Groups", + "operationId": "saveWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + }, + "delete": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Delete WAN Resource Groups", + "operationId": "deleteWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/device": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Generate template list


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateMasterTemplateList", + "parameters": [ + { + "name": "feature", + "in": "query", + "description": "Feature", + "required": true, + "schema": { + "type": "string", + "enum": [ + "lawful-interception", + "cloud-dock", + "network-design", + "vmanage-default", + "all" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": { + "data": [ + { + "deviceType": "vsmart", + "lastUpdatedBy": "admin", + "factoryDefault": false, + "templateName": "vSmartConfigurationTemplate", + "devicesAttached": 0, + "draftMode": false, + "templateDescription": "Config template for vSmarts", + "templateClass": "vedge", + "lastUpdatedOn": 1529606745011, + "configType": "file", + "templateId": "e1f3de23-1ded-49d8-85b1-1e6ab668775f", + "templateAttached": 0 + }, + { + "deviceType": "vedge-C1111-8PLTELA", + "lastUpdatedBy": "system", + "templateClass": "cedge", + "configType": "template", + "templateId": "b6aacdc9-ae1f-4471-a359-13657ce98204", + "factoryDefault": true, + "templateName": "Factory_Default_C1111_8PLTELA_V01", + "devicesAttached": 0, + "draftMode": false, + "templateDescription": "Factory Default template for C1111-8PLTELA", + "lastUpdatedOn": 1588082428579, + "templateAttached": 15 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/cli": { + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Create CLI template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createCLITemplate", + "requestBody": { + "description": "Create template request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": "{\n \"templateId\":\"e1f3de23-1ded-49d8-85b1-1e6ab668775f\",\n \"templateName\":\"vSmartConfigurationTemplate\",\n \"templateDescription\":\"Config template for vSmarts\",\n \"deviceType\":\"vsmart\",\n \"templateConfiguration\":\n \"system\n host-name {{Hostname}}\n gps-location latitude {{gps-latitude}}\n gps-location longitude {{gps-longitude}}\n system-ip {{System-IP}}\n site-id {{Site-ID}}\n organization-name \"Cisco Sy1 - 19968\"\n vbond vbond.cisco.com\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n user admin\n password $6$YsNdljyTklJyRlUZ$u.vOqeMSUbzfc.aWBty9OIovNCxlUASviwfgXO2bTCJV5ddUoV7EG8Q3EA3Yl0aMv./GnJLPPbjC6uQPjtwVo.\n !\n !\n logging\n disk\n enable\n !\n !\n !\n omp\n no shutdown\n send-path-limit 8\n send-backup-paths\n graceful-restart\n !\n banner\n login \"Cisco SD-WAN/Viptela dCloud Demo V2\"\n !\n !\n vpn 0\n dns 198.18.1.1 secondary\n dns 198.18.1.254 primary\n host vbond.cisco.com ip 198.18.1.11 198.18.1.21\n interface eth0\n ip address {{Tunnel-IP-Address}}\n ipv6 dhcp-client\n tunnel-interface\n allow-service dhcp\n allow-service dns\n allow-service icmp\n allow-service sshd\n allow-service netconf\n no allow-service ntp\n no allow-service stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 {{Default GW}}\n !\n vpn 512\n!\"\n \"factoryDefault\":false,\n \"configType\":\"file\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/config/attachBootStrap": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "pushMasterTemplate_1", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "deviceTemplateList": [ + { + "templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "device": [ + { + "csv-status": "complete", + "csv-deviceId": "5e5f45e7-3062-44b2-b6f6-40c682149e05", + "csv-deviceIP": "172.16.255.11", + "csv-host-name": "vm1", + "//system/host-name": "vm1", + "//system/system-ip": "172.16.255.11", + "//system/site-id": "100", + "csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "selected": "true" + } + ], + "isEdited": false, + "isMasterEdited": false, + "isDraftDisabled": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attachcli": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach CLI device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "pushCLITemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": "{\n \"deviceTemplateList\":[\n {\n \"templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\", \n \"device\":[ \n {\n \"csv-status\":\"complete\",\n \"csv-deviceId\":\"5e5f45e7-3062-44b2-b6f6-40c682149e05\",\n \"csv-deviceIP\":\"172.16.255.11\",\n \"csv-host-name\":\"vm1\",\n \"//system/host-name\":\"vm1\",\n \"//system/system-ip\":\"172.16.255.11\",\n \"//system/site-id\":\"100\",\n \"csv-templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\",\n \"selected\":\"true\"\n \"pseudoCommitTimer\":11\n }\n ],\n \"isEdited\":false, \n \"isMasterEdited\":false, \n \"isDraftDisabled\":false \n }\n ]\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attachcloudx": { + "put": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Edit already enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editCloudxConfig", + "requestBody": { + "description": "CloudX config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudX config": { + "description": "CloudX config", + "value": { + "isEdited": true, + "siteList": [ + 100, + 400 + ], + "siteType": "dia" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Tenant Id": { + "description": "Tenant Id", + "value": { + "id": "push_file_template_configuration-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Enable gateways, clients, dias", + "operationId": "pushCloudxConfig", + "requestBody": { + "description": "CloudX config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudX config": { + "description": "CloudX config", + "value": { + "isEdited": false, + "siteList": [ + 100 + ], + "siteType": "dia" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Tenant Id": { + "description": "Tenant Id", + "value": { + "id": "push_file_template_configuration-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attached/{masterTemplateId}": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get attached device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAttachedDeviceList", + "parameters": [ + { + "name": "masterTemplateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Configuration-read" + } + }, + "/template/device/config/attachedconfig": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get attached config to device


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAttachedConfigToDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "policyId", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CLI config": { + "description": "CLI config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Device Inventory-read" + } + }, + "/template/device/config/attachfeature": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "pushMasterTemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "deviceTemplateList": [ + { + "templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "device": [ + { + "csv-status": "complete", + "csv-deviceId": "5e5f45e7-3062-44b2-b6f6-40c682149e05", + "csv-deviceIP": "172.16.255.11", + "csv-host-name": "vm1", + "//system/host-name": "vm1", + "//system/system-ip": "172.16.255.11", + "//system/site-id": "100", + "csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "selected": "true" + } + ], + "isEdited": false, + "isMasterEdited": false, + "isDraftDisabled": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attachment": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "attachDeviceTemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/available/{masterTemplateId}": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get possible device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDeviceListByMasterTemplateId", + "parameters": [ + { + "name": "masterTemplateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/template/device/config/config": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get device configuration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDeviceConfigurationPreview", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "templateId": "45d94bf1-30fb-4b00-8bde-2a62c8af97b5", + "device": { + "csv-status": "complete", + "csv-deviceId": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "csv-deviceIP": "172.16.255.21", + "csv-host-name": "vm11", + "csv-templateId": "45d94bf1-30fb-4b00-8bde-2a62c8af97b5" + }, + "isEdited": false, + "isMasterEdited": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": "system\nhost-name vm11\ngps-location latitude 35.0\ngps-location longitude -78.0\nsystem-ip 172.16.255.21\nsite-id 100\norganization-name \"vIPtela Inc Regression\"\nclock timezone America/Los_Angeles\nvbond 10.0.12.26\naaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write" + } + }, + "/template/device/config/detach": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Detach device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "detachDeviceTemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/detachcloudx": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Disable enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "detachSites", + "requestBody": { + "description": "CloudX config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudX config": { + "description": "CloudX config", + "value": { + "siteList": [ + 100 + ], + "siteType": "none" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Tenant Id": { + "description": "Tenant Id", + "value": { + "id": "push_file_template_configuration-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/duplicateip": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDevicesWithDuplicateIP", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "device": [ + { + "csv-deviceIP": "10.1.0.1", + "csv-deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de", + "csv-host-name": "DC1-VEDGE1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/device/config/duplicatelocationname": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDevicesWithDuplicateLocationName", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "locations": [ + { + "locationName": "Milpitas, CA", + "csv-deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/device/config/exportcsv": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Export the device template to CSV format for given template id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createInputWithoutDevice", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "templateId": "e1f3de23-1ded-49d8-85b1-1e6ab668775f", + "isEdited": false, + "isMasterEdited": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device input": { + "description": "Device input", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/input": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Create device input


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createDeviceInput", + "requestBody": { + "description": "Template device input", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template device input": { + "description": "Template device input", + "value": "{{\n \"templateId\":\"6c7d22bc-73d5-4877-9402-26c75a22bd08\",\n \"deviceIds\":[\n \"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de\"\n ],\n \"isEdited\":false,\n \"isMasterEdited\":false\n}}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device input": { + "description": "Device input", + "value": { + "data": [ + { + "csv-status": "in_complete", + "csv-deviceId": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "csv-deviceIP": "172.16.255.21", + "csv-host-name": "vm11", + "//system/host-name": "vm11", + "//system/system-ip": "172.16.255.21", + "//system/site-id": "11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/process/input/file": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Process input comma separated file


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "processInputCommaSepFile", + "requestBody": { + "description": "Device template", + "content": { + "multipart/form-data": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/quickconnectvariable": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get connection variables to be configured", + "operationId": "getQuickConnectVariables", + "requestBody": { + "description": "Device List", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device List": { + "description": "Device List", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Variable list": { + "description": "Variable list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/vbond": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Check if vBond is configured


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "checkVbond", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Is vBond configured": { + "description": "Is vBond configured", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Configuration-read" + } + }, + "/template/device/config/verify": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Validate full template\"\n


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "validateTemplate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "deprecated": true, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/feature": { + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Create a device template from feature templates and sub templates


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createMasterTemplate", + "requestBody": { + "description": "Create template request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "templateName": "vEdge_Device_Template", + "templateDescription": "Demo device template", + "deviceType": "vedge-100", + "configType": "template", + "factoryDefault": false, + "policyId": "", + "featureTemplateUidRange": [], + "connectionPreferenceRequired": true, + "connectionPreference": true, + "generalTemplates": [ + { + "templateId": "3b30e089-2e26-44f1-b5b2-ac44f3f4279e", + "templateType": "aaa" + }, + { + "templateId": "0419c4f6-eb61-4048-a3fe-78ea7f7248b0", + "templateType": "bfd-vedge" + }, + { + "templateId": "eb7162be-b018-47c5-b1de-bbb65ff802e3", + "templateType": "omp-vedge" + }, + { + "templateId": "486d419f-4e6c-44a5-a6fb-7b5ccf94ff90", + "templateType": "security-vedge" + }, + { + "templateId": "7d7396a2-4715-44d8-8f6e-ddf0ca06be44", + "templateType": "system-vedge", + "subTemplates": [ + { + "templateId": "edf3d309-91d4-45be-98d9-cfd57a05a479", + "templateType": "logging" + } + ] + }, + { + "templateId": "171e9bd4-7a7b-460d-b692-83f0d5ce0124", + "templateType": "vpn-vedge", + "subTemplates": [ + { + "templateId": "a632ee5f-f489-46ec-8761-1b493d5a6a40", + "templateType": "vpn-vedge-interface" + } + ] + }, + { + "templateId": "45ea940a-45d2-4fd9-8da2-570a1a6d6874", + "templateType": "vpn-vedge" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": { + "templateId": "81610551-9dc5-492f-ad3b-b2c30077b992" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/is_migration_required": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Check if any device templates need migration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "isMigrationRequired", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Boolean": { + "description": "Boolean", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/migration": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateForMigration", + "parameters": [ + { + "name": "hasAAA", + "in": "query", + "description": "Return only those uses AAA", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "data": [ + { + "deviceType": "vedge-CSR-1000v", + "lastUpdatedBy": "admin", + "templateClass": "cedge_vedge", + "templateId": "c62e6fba-fb53-4562-b436-3878de0fbbc2", + "configType": "template", + "factoryDefault": false, + "templateName": "BranchType1Template-CSR", + "devicesAttached": 2, + "templateDescription": "Branch Type 1 Template for CSR Routers", + "lastUpdatedOn": 1588093291553, + "templateAttached": 22 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Migrate the device templates given the template Ids", + "operationId": "migrateTemplates", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Template Id", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "prefix", + "in": "query", + "description": "Prefix", + "schema": { + "type": "string", + "default": "cisco" + } + }, + { + "name": "includeAll", + "in": "query", + "description": "Include all flag", + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "status": "Template migration started", + "taskId": "TEMPLATE_MIGRATIONa548c416-bfb8-46dd-9866-d0aa042f17ab" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/migration_info": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Returns the mapping between old and migrated templates


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "migrationInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Migrated templates mapping": { + "description": "Migrated templates mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/object/{templateId}": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Generate template by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getMasterTemplateDefinition", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/resource-group/{resourceGroupName}/{templateId}": { + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Change template resource group", + "operationId": "changeTemplateResourceGroup_1", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/syncstatus": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Get template sync status


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getOutOfSyncTemplates", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/syncstatus/{templateId}": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Get out of sync devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getOutOfSyncDevices", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/{templateId}": { + "put": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Edit template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editMasterTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "templateId": "81610551-9dc5-492f-ad3b-b2c30077b992", + "templateName": "vEdge_Device_Template", + "templateDescription": "Demo device template", + "deviceType": "vedge-100", + "configType": "template", + "factoryDefault": false, + "policyId": "", + "featureTemplateUidRange": [], + "connectionPreferenceRequired": true, + "connectionPreference": true, + "draftMode": false, + "generalTemplates": [ + { + "templateId": "3b30e089-2e26-44f1-b5b2-ac44f3f4279e", + "templateType": "aaa" + }, + { + "templateId": "e1b5b6e9-3b54-4279-a532-a2aaaef3e6a1", + "templateType": "bfd-vedge" + }, + { + "templateId": "998725f9-3572-4950-a5e5-d48827d347cd", + "templateType": "omp-vedge" + }, + { + "templateId": "486d419f-4e6c-44a5-a6fb-7b5ccf94ff90", + "templateType": "security-vedge" + }, + { + "templateId": "7d7396a2-4715-44d8-8f6e-ddf0ca06be44", + "templateType": "system-vedge", + "subTemplates": [ + { + "templateId": "edf3d309-91d4-45be-98d9-cfd57a05a479", + "templateType": "logging" + } + ] + }, + { + "templateId": "171e9bd4-7a7b-460d-b692-83f0d5ce0124", + "templateType": "vpn-vedge", + "subTemplates": [ + { + "templateId": "a632ee5f-f489-46ec-8761-1b493d5a6a40", + "templateType": "vpn-vedge-interface" + } + ] + }, + { + "templateId": "45ea940a-45d2-4fd9-8da2-570a1a6d6874", + "templateType": "vpn-vedge" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attached devices": { + "description": "Attached devices", + "value": { + "data": { + "attachedDevices": [] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Delete template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteMasterTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/feature": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get feature template list


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateFeatureTemplateList", + "parameters": [ + { + "name": "summary", + "in": "query", + "description": "Flag to include template definition", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit on templateId", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Feature template": { + "description": "Feature template", + "value": { + "data": [ + { + "templateId": "07a5de3c-4dfa-4eb3-bf52-7ee8076e29a9", + "templateName": "Default_Azure_vWAN_C8000V_VPN0_INTF_GE1_V01", + "templateDescription": "Default VPN 0 Interface GigabitEthernet1 template for Azure vWAN C8000V", + "templateType": "cisco_vpn_interface", + "deviceType": [ + "vedge-C8000V" + ], + "lastUpdatedBy": "system", + "lastUpdatedOn": 1631281281614, + "factoryDefault": true, + "devicesAttached": 0, + "attachedMastersCount": 1, + "templateMinVersion": "20.4.0", + "configType": "xml", + "createdBy": "system", + "createdOn": 1631281281614, + "resourceGroup": "global" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + }, + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Create feature template", + "operationId": "createFeatureTemplate", + "requestBody": { + "description": "Feature template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CedgeVoiceCard-example": { + "description": "CedgeVoiceCard-example", + "$ref": "examples/template/general/CedgeVoiceCard.json" + }, + "CedgeVoiceSrst-example": { + "description": "CedgeVoiceSrst-example", + "$ref": "examples/template/general/CedgeVoiceSrst.json" + }, + "aaa-example": { + "description": "aaa-example", + "$ref": "examples/template/general/aaa.json" + }, + "appqoe-example": { + "description": "appqoe-example", + "$ref": "examples/template/general/appqoe.json" + }, + "archive-example": { + "description": "archive-example", + "$ref": "examples/template/general/archive.json" + }, + "banner-example": { + "description": "banner-example", + "$ref": "examples/template/general/banner.json" + }, + "bfd-vedge-example": { + "description": "bfd-vedge-example", + "$ref": "examples/template/general/bfd-vedge.json" + }, + "bgp-example": { + "description": "bgp-example", + "$ref": "examples/template/general/bgp.json" + }, + "bridge-example": { + "description": "bridge-example", + "$ref": "examples/template/general/bridge.json" + }, + "cedge_aaa-example": { + "description": "cedge_aaa-example", + "$ref": "examples/template/general/cedge_aaa.json" + }, + "cedge_global-example": { + "description": "cedge_global-example", + "$ref": "examples/template/general/cedge_global.json" + }, + "cedge_igmp-example": { + "description": "cedge_igmp-example", + "$ref": "examples/template/general/cedge_igmp.json" + }, + "cedge_multicast-example": { + "description": "cedge_multicast-example", + "$ref": "examples/template/general/cedge_multicast.json" + }, + "cedge_pim-example": { + "description": "cedge_pim-example", + "$ref": "examples/template/general/cedge_pim.json" + }, + "cellular-cedge-controller-example": { + "description": "cellular-cedge-controller-example", + "$ref": "examples/template/general/cellular-cedge-controller.json" + }, + "cellular-cedge-gps-controller-example": { + "description": "cellular-cedge-gps-controller-example", + "$ref": "examples/template/general/cellular-cedge-gps-controller.json" + }, + "cellular-cedge-profile-example": { + "description": "cellular-cedge-profile-example", + "$ref": "examples/template/general/cellular-cedge-profile.json" + }, + "cellular-gateway-platform-example": { + "description": "cellular-gateway-platform-example", + "$ref": "examples/template/general/cellular-gateway-platform.json" + }, + "cellular-gateway-profile-example": { + "description": "cellular-gateway-profile-example", + "$ref": "examples/template/general/cellular-gateway-profile.json" + }, + "cellular-profile-example": { + "description": "cellular-profile-example", + "$ref": "examples/template/general/cellular-profile.json" + }, + "cisco_banner-example": { + "description": "cisco_banner-example", + "$ref": "examples/template/general/cisco_banner.json" + }, + "cisco_bfd-example": { + "description": "cisco_bfd-example", + "$ref": "examples/template/general/cisco_bfd.json" + }, + "cisco_bgp-example": { + "description": "cisco_bgp-example", + "$ref": "examples/template/general/cisco_bgp.json" + }, + "cisco_dhcp_server-example": { + "description": "cisco_dhcp_server-example", + "$ref": "examples/template/general/cisco_dhcp_server.json" + }, + "cisco_dsp_farm-example": { + "description": "cisco_dsp_farm-example", + "$ref": "examples/template/general/cisco_dsp_farm.json" + }, + "cisco_logging-example": { + "description": "cisco_logging-example", + "$ref": "examples/template/general/cisco_logging.json" + }, + "cisco_ntp-example": { + "description": "cisco_ntp-example", + "$ref": "examples/template/general/cisco_ntp.json" + }, + "cisco_omp-example": { + "description": "cisco_omp-example", + "$ref": "examples/template/general/cisco_omp.json" + }, + "cisco_ospf-example": { + "description": "cisco_ospf-example", + "$ref": "examples/template/general/cisco_ospf.json" + }, + "cisco_ospfv3-example": { + "description": "cisco_ospfv3-example", + "$ref": "examples/template/general/cisco_ospfv3.json" + }, + "cisco_secure_internet_gateway-example": { + "description": "cisco_secure_internet_gateway-example", + "$ref": "examples/template/general/cisco_secure_internet_gateway.json" + }, + "cisco_security-example": { + "description": "cisco_security-example", + "$ref": "examples/template/general/cisco_security.json" + }, + "cisco_sig_credential-example": { + "description": "cisco_sig_credential-example", + "$ref": "examples/template/general/cisco_sig_credentials.json" + }, + "cisco_snmp-example": { + "description": "cisco_snmp-example", + "$ref": "examples/template/general/cisco_snmp.json" + }, + "cisco_system-example": { + "description": "cisco_system-example", + "$ref": "examples/template/general/cisco_system.json" + }, + "cisco_thousandeye-example": { + "description": "cisco_thousandeye-example", + "$ref": "examples/template/general/cisco_thousandeyes.json" + }, + "cisco_trustsec-example": { + "description": "cisco_trustsec-example", + "$ref": "examples/template/general/cisco_trustsec.json" + }, + "cisco_vp-example": { + "description": "cisco_vp-example", + "$ref": "examples/template/general/cisco_vpn.json" + }, + "cisco_vpn_interface-example": { + "description": "cisco_vpn_interface-example", + "$ref": "examples/template/general/cisco_vpn_interface.json" + }, + "cisco_vpn_interface_gre-example": { + "description": "cisco_vpn_interface_gre-example", + "$ref": "examples/template/general/cisco_vpn_interface_gre.json" + }, + "cisco_vpn_interface_ipsec-example": { + "description": "cisco_vpn_interface_ipsec-example", + "$ref": "examples/template/general/cisco_vpn_interface_ipsec.json" + }, + "cisco_wireless_la-example": { + "description": "cisco_wireless_la-example", + "$ref": "examples/template/general/cisco_wireless_lan.json" + }, + "cli-template-example": { + "description": "cli-template-example", + "$ref": "examples/template/general/cli-template.json" + }, + "dhcp-server-example": { + "description": "dhcp-server-example", + "$ref": "examples/template/general/dhcp-server.json" + }, + "eigrp-example": { + "description": "eigrp-example", + "$ref": "examples/template/general/eigrp.json" + }, + "igmp-example": { + "description": "igmp-example", + "$ref": "examples/template/general/igmp.json" + }, + "logging-example": { + "description": "logging-example", + "$ref": "examples/template/general/logging.json" + }, + "multicast-example": { + "description": "multicast-example", + "$ref": "examples/template/general/multicast.json" + }, + "ntp-example": { + "description": "ntp-example", + "$ref": "examples/template/general/ntp.json" + }, + "omp-vedge-example": { + "description": "omp-vedge-example", + "$ref": "examples/template/general/omp-vedge.json" + }, + "omp-vsmart-example": { + "description": "omp-vsmart-example", + "$ref": "examples/template/general/omp-vsmart.json" + }, + "ospf-example": { + "description": "ospf-example", + "$ref": "examples/template/general/ospf.json" + }, + "pim-example": { + "description": "pim-example", + "$ref": "examples/template/general/pim.json" + }, + "probe-example": { + "description": "probe-example", + "$ref": "examples/template/general/probes.json" + }, + "secure-internet-gateway-example": { + "description": "secure-internet-gateway-example", + "$ref": "examples/template/general/secure-internet-gateway.json" + }, + "security-vedge-example": { + "description": "security-vedge-example", + "$ref": "examples/template/general/security-vedge.json" + }, + "security-vsmart-example": { + "description": "security-vsmart-example", + "$ref": "examples/template/general/security-vsmart.json" + }, + "sig-credential-example": { + "description": "sig-credential-example", + "$ref": "examples/template/general/sig-credentials.json" + }, + "snmp-example": { + "description": "snmp-example", + "$ref": "examples/template/general/snmp.json" + }, + "switchport-example": { + "description": "switchport-example", + "$ref": "examples/template/general/switchport.json" + }, + "system-vedge-example": { + "description": "system-vedge-example", + "$ref": "examples/template/general/system-vedge.json" + }, + "system-vsmart-example": { + "description": "system-vsmart-example", + "$ref": "examples/template/general/system-vsmart.json" + }, + "t1-e1-controller-example": { + "description": "t1-e1-controller-example", + "$ref": "examples/template/general/t1-e1-controller.json" + }, + "tenant-example": { + "description": "tenant-example", + "$ref": "examples/template/general/tenant.json" + }, + "ucse-example": { + "description": "ucse-example", + "$ref": "examples/template/general/ucse.json" + }, + "virtual-application-utd-example": { + "description": "virtual-application-utd-example", + "$ref": "examples/template/general/virtual-application-utd.json" + }, + "vpn-cedge-interface-cellular-example": { + "description": "vpn-cedge-interface-cellular-example", + "$ref": "examples/template/general/vpn-cedge-interface-cellular.json" + }, + "vpn-cedge-interface-multilink-controller-example": { + "description": "vpn-cedge-interface-multilink-controller-example", + "$ref": "examples/template/general/vpn-cedge-interface-multilink-controller.json" + }, + "vpn-interface-ethpppoe-example": { + "description": "vpn-interface-ethpppoe-example", + "$ref": "examples/template/general/vpn-interface-ethpppoe.json" + }, + "vpn-interface-ipoe-example": { + "description": "vpn-interface-ipoe-example", + "$ref": "examples/template/general/vpn-interface-ipoe.json" + }, + "vpn-interface-pppoa-example": { + "description": "vpn-interface-pppoa-example", + "$ref": "examples/template/general/vpn-interface-pppoa.json" + }, + "vpn-interface-pppoe-example": { + "description": "vpn-interface-pppoe-example", + "$ref": "examples/template/general/vpn-interface-pppoe.json" + }, + "vpn-interface-svi-example": { + "description": "vpn-interface-svi-example", + "$ref": "examples/template/general/vpn-interface-svi.json" + }, + "vpn-interface-t1-e1-example": { + "description": "vpn-interface-t1-e1-example", + "$ref": "examples/template/general/vpn-interface-t1-e1.json" + }, + "vpn-vedge-interface-bridge-example": { + "description": "vpn-vedge-interface-bridge-example", + "$ref": "examples/template/general/vpn-vedge-interface-bridge.json" + }, + "vpn-vedge-interface-cellular-example": { + "description": "vpn-vedge-interface-cellular-example", + "$ref": "examples/template/general/vpn-vedge-interface-cellular.json" + }, + "vpn-vedge-interface-gre-example": { + "description": "vpn-vedge-interface-gre-example", + "$ref": "examples/template/general/vpn-vedge-interface-gre.json" + }, + "vpn-vedge-interface-ipsec-example": { + "description": "vpn-vedge-interface-ipsec-example", + "$ref": "examples/template/general/vpn-vedge-interface-ipsec.json" + }, + "vpn-vedge-interface-natpool-example": { + "description": "vpn-vedge-interface-natpool-example", + "$ref": "examples/template/general/vpn-vedge-interface-natpool.json" + }, + "vpn-vedge-interface-ppp-example": { + "description": "vpn-vedge-interface-ppp-example", + "$ref": "examples/template/general/vpn-vedge-interface-ppp.json" + }, + "vpn-vedge-interface-vap-example": { + "description": "vpn-vedge-interface-vap-example", + "$ref": "examples/template/general/vpn-vedge-interface-vap.json" + }, + "vpn-vedge-interface-example": { + "description": "vpn-vedge-interface-example", + "$ref": "examples/template/general/vpn-vedge-interface.json" + }, + "vpn-vedge-pppoe-enabled-interface-example": { + "description": "vpn-vedge-pppoe-enabled-interface-example", + "$ref": "examples/template/general/vpn-vedge-pppoe-enabled-interface.json" + }, + "vpn-vedge-example": { + "description": "vpn-vedge-example", + "$ref": "examples/template/general/vpn-vedge.json" + }, + "vpn-vmanage-interface-example": { + "description": "vpn-vmanage-interface-example", + "$ref": "examples/template/general/vpn-vmanage-interface.json" + }, + "vpn-vsmart-interface-example": { + "description": "vpn-vsmart-interface-example", + "$ref": "examples/template/general/vpn-vsmart-interface.json" + }, + "vpn-vsmart-example": { + "description": "vpn-vsmart-example", + "$ref": "examples/template/general/vpn-vsmart.json" + }, + "wla-example": { + "description": "wla-example", + "$ref": "examples/template/general/wlan.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature template": { + "description": "Feature template", + "value": { + "templateId": "ff3b31b1-0262-44d3-badf-d9cf472fb4b1" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/template/feature/clone": { + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Clone a feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "cloneTemplate", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Template Id to clone from", + "required": true, + "schema": { + "type": "string" + }, + "example": "220a6bd0-28ef-4c88-92e6-ee7539396fd7" + }, + { + "name": "name", + "in": "query", + "description": "Name for the cloned template", + "required": true, + "schema": { + "type": "string" + }, + "example": "BR2-VPN10-Feature" + }, + { + "name": "desc", + "in": "query", + "description": "Description for the cloned template", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": { + "templateId": "ff3b31b1-0262-44d3-badf-d9cf472fb4b1" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/template/feature/default/networkinterface": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get default network interface


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getNetworkInterface", + "parameters": [ + { + "name": "deviceModel", + "in": "query", + "description": "Device model", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ENCS", + "C8200-UCPE", + "C8200-UCPEVM" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Default network Interface": { + "description": "Default network Interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/feature/default/networks": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get default networks


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDefaultNetworks", + "parameters": [ + { + "name": "deviceModel", + "in": "query", + "description": "Device model", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge-nfvis-ENCS5400", + "vedge-nfvis-C8200-UCPE", + "vedge-nfvis-C8200-UCPEVM" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Default network": { + "description": "Default network", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/definition/{templateId}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get the configured template definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTemplateDefinition", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template definition": { + "description": "Template definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + } + }, + "/template/feature/devicetemplates/{templateId}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get all device templates for this feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDeviceTemplatesAttachedToFeature", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Feature template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/li": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get LI feature template", + "operationId": "listLITemplate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "LI template": { + "description": "LI template", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Lawful Interception-read" + }, + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Create LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createLITemplate", + "requestBody": { + "description": "LI template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "LI template": { + "description": "LI template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Lawful Interception-write" + } + }, + "/template/feature/li/{templateId}": { + "put": { + "tags": [ + "Configuration - General Template" + ], + "description": "Update LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editLITemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "LI template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "LI template": { + "description": "LI template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Lawful Interception-write" + } + }, + "/template/feature/master/{type_name}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template type definition by device type


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateMasterTemplateDefinition", + "parameters": [ + { + "name": "type_name", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/migration": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTemplateForMigration", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": { + "data": [ + { + "deviceType": "vedge-CSR-1000v", + "lastUpdatedBy": "admin", + "templateClass": "cedge_vedge", + "templateId": "c62e6fba-fb53-4562-b436-3878de0fbbc2", + "configType": "template", + "factoryDefault": false, + "templateName": "BranchType1Template-CSR", + "devicesAttached": 2, + "templateDescription": "Branch Type 1 Template for CSR Routers", + "lastUpdatedOn": 1588093291553, + "templateAttached": 22 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read,Lawful Interception-read" + } + }, + "/template/feature/object/{templateId}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get template object definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getGeneralTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + } + }, + "/template/feature/resource-group/{resourceGroupName}/{templateId}": { + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Change template resource group", + "operationId": "changeTemplateResourceGroup", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resrouce group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/feature/types": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template types


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateTypes", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Device type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge", + "cedge", + "all", + "default" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template type": { + "description": "Template type", + "value": { + "data": [ + { + "parent": "basic_info", + "default": "aaa/aaa.json", + "deviceModels": [ + { + "name": "vedge-1000" + }, + { + "name": "vedge-2000" + }, + { + "name": "vedge-cloud" + }, + { + "name": "vedge-5000" + }, + { + "name": "vedge-ISR1100-6G" + }, + { + "name": "vedge-100-B" + }, + { + "name": "vedge-ISR1100-4G" + }, + { + "name": "vedge-100" + }, + { + "name": "vsmart" + }, + { + "name": "vedge-ISR1100-4GLTE" + }, + { + "name": "vedge-100-WM" + }, + { + "name": "vmanage" + }, + { + "name": "vbond" + }, + { + "name": "vedge-100-M" + }, + { + "name": "vedge-ISR1100X-6G" + }, + { + "name": "vedge-ISR1100X-4G" + } + ], + "displayName": "AAA", + "name": "aaa", + "typeClass": "DefaultGeneralTemplate", + "description": "AAA", + "write_permission": true, + "read_permission": true, + "helperType": [] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/types/definition/{type_name}/{version}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template type definition


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateTypeDefinition", + "parameters": [ + { + "name": "type_name", + "in": "path", + "description": "Feature template type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template type": { + "description": "Template type", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/{deviceType}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template based on device


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateByDeviceType", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Feature template": { + "description": "Feature template", + "value": "[\"data\": [\n{\n \"deviceType\": [\n \"vedge-1000\",\n \"vedge-2000\",\n \"vedge-cloud\",\n \"vedge-5000\",\n \"vedge-ISR1100-6G\",\n \"vedge-100-B\",\n \"vedge-ISR1100-4G\",\n \"vedge-100\",\n \"vedge-ISR1100-4GLTE\",\n \"vedge-100-WM\",\n \"vedge-100-M\",\n \"vedge-ISR1100X-6G\",\n \"vedge-ISR1100X-4G\"\n ],\n \"templateType\": \"system-vedge\",\n \"templateMinVersion\": \"15.0.0\",\n \"lastUpdatedBy\": \"system\",\n \"editedTemplateDefinition\": \"{\"clock\":{\"timezone\":{\"vipObjectType\":\"object\",\"vipValue\":\"America/Los_Angeles\",\"vipType\":\"ignore\"}},\"gps-location\":{\"latitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"longitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"}},\"timer\":{\"dns-cache-timeout\":{\"vipObjectType\":\"object\",\"vipValue\":30,\"vipType\":\"ignore\"}},\"location\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"system-tunnel-mtu\":{\"vipObjectType\":\"object\",\"vipValue\":1024,\"vipType\":\"ignore\"},\"track-transport\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"port-offset\":{\"vipObjectType\":\"object\",\"vipValue\":0,\"vipType\":\"ignore\"},\"port-hop\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"control-session-pps\":{\"vipObjectType\":\"object\",\"vipValue\":300,\"vipType\":\"ignore\"},\"description\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"device-groups\":{\"vipObjectType\":\"list\",\"vipType\":\"ignore\"},\"site-id\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"system-ip\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"host-name\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"console-baud-rate\":{\"vipObjectType\":\"object\",\"vipValue\":\"115200\",\"vipType\":\"ignore\"},\"max-controllers\":{\"vipObjectType\":\"object\",\"vipValue\":2,\"vipType\":\"ignore\"},\"usb-controller\":{\"vipObjectType\":\"object\",\"vipValue\":\"false\",\"vipType\":\"ignore\"},\"track-default-gateway\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"host-policer-pps\":{\"vipObjectType\":\"object\",\"vipValue\":5000,\"vipType\":\"ignore\"},\"icmp-error-pps\":{\"vipObjectType\":\"object\",\"vipValue\":100,\"vipType\":\"ignore\"}}\",\n \"gTemplateClass\": \"vedge\",\n \"templateDefinition\": \"{\"clock\":{\"timezone\":{\"vipObjectType\":\"object\",\"vipValue\":\"America/Los_Angeles\",\"vipType\":\"ignore\"}},\"gps-location\":{\"latitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"longitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"}},\"timer\":{\"dns-cache-timeout\":{\"vipObjectType\":\"object\",\"vipValue\":30,\"vipType\":\"ignore\"}},\"location\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"system-tunnel-mtu\":{\"vipObjectType\":\"object\",\"vipValue\":1024,\"vipType\":\"ignore\"},\"track-transport\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"port-offset\":{\"vipObjectType\":\"object\",\"vipValue\":0,\"vipType\":\"ignore\"},\"port-hop\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"control-session-pps\":{\"vipObjectType\":\"object\",\"vipValue\":300,\"vipType\":\"ignore\"},\"description\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"device-groups\":{\"vipObjectType\":\"list\",\"vipType\":\"ignore\"},\"site-id\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"system-ip\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"host-name\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"console-baud-rate\":{\"vipObjectType\":\"object\",\"vipValue\":\"115200\",\"vipType\":\"ignore\"},\"max-controllers\":{\"vipObjectType\":\"object\",\"vipValue\":2,\"vipType\":\"ignore\"},\"usb-controller\":{\"vipObjectType\":\"object\",\"vipValue\":\"false\",\"vipType\":\"ignore\"},\"track-default-gateway\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"host-policer-pps\":{\"vipObjectType\":\"object\",\"vipValue\":5000,\"vipType\":\"ignore\"},\"icmp-error-pps\":{\"vipObjectType\":\"object\",\"vipValue\":100,\"vipType\":\"ignore\"}}\",\n \"templateId\": \"347eca1b-a0ae-42be-92d1-4702b5285aae\",\n \"attachedMastersCount\": 0,\n \"configType\": \"xml\",\n \"createdOn\": 1588001883034,\n \"@rid\": 49,\n \"feature\": \"vmanage-default\",\n \"factoryDefault\": true,\n \"createdBy\": \"system\",\n \"templateName\": \"Factory_Default_vEdge_System_Template\",\n \"devicesAttached\": 0,\n \"templateDescription\": \"Default System template settings for vEdge\",\n \"lastUpdatedOn\": 1588001883034\n}\n]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/{templateId}": { + "put": { + "tags": [ + "Configuration - General Template" + ], + "description": "Update feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editFeatureTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CedgeVoiceCard-example": { + "description": "CedgeVoiceCard-example", + "$ref": "examples/template/general/CedgeVoiceCard.json" + }, + "CedgeVoiceSrst-example": { + "description": "CedgeVoiceSrst-example", + "$ref": "examples/template/general/CedgeVoiceSrst.json" + }, + "aaa-example": { + "description": "aaa-example", + "$ref": "examples/template/general/aaa.json" + }, + "appqoe-example": { + "description": "appqoe-example", + "$ref": "examples/template/general/appqoe.json" + }, + "archive-example": { + "description": "archive-example", + "$ref": "examples/template/general/archive.json" + }, + "banner-example": { + "description": "banner-example", + "$ref": "examples/template/general/banner.json" + }, + "bfd-vedge-example": { + "description": "bfd-vedge-example", + "$ref": "examples/template/general/bfd-vedge.json" + }, + "bgp-example": { + "description": "bgp-example", + "$ref": "examples/template/general/bgp.json" + }, + "bridge-example": { + "description": "bridge-example", + "$ref": "examples/template/general/bridge.json" + }, + "cedge_aaa-example": { + "description": "cedge_aaa-example", + "$ref": "examples/template/general/cedge_aaa.json" + }, + "cedge_global-example": { + "description": "cedge_global-example", + "$ref": "examples/template/general/cedge_global.json" + }, + "cedge_igmp-example": { + "description": "cedge_igmp-example", + "$ref": "examples/template/general/cedge_igmp.json" + }, + "cedge_multicast-example": { + "description": "cedge_multicast-example", + "$ref": "examples/template/general/cedge_multicast.json" + }, + "cedge_pim-example": { + "description": "cedge_pim-example", + "$ref": "examples/template/general/cedge_pim.json" + }, + "cellular-cedge-controller-example": { + "description": "cellular-cedge-controller-example", + "$ref": "examples/template/general/cellular-cedge-controller.json" + }, + "cellular-cedge-gps-controller-example": { + "description": "cellular-cedge-gps-controller-example", + "$ref": "examples/template/general/cellular-cedge-gps-controller.json" + }, + "cellular-cedge-profile-example": { + "description": "cellular-cedge-profile-example", + "$ref": "examples/template/general/cellular-cedge-profile.json" + }, + "cellular-gateway-platform-example": { + "description": "cellular-gateway-platform-example", + "$ref": "examples/template/general/cellular-gateway-platform.json" + }, + "cellular-gateway-profile-example": { + "description": "cellular-gateway-profile-example", + "$ref": "examples/template/general/cellular-gateway-profile.json" + }, + "cellular-profile-example": { + "description": "cellular-profile-example", + "$ref": "examples/template/general/cellular-profile.json" + }, + "cisco_banner-example": { + "description": "cisco_banner-example", + "$ref": "examples/template/general/cisco_banner.json" + }, + "cisco_bfd-example": { + "description": "cisco_bfd-example", + "$ref": "examples/template/general/cisco_bfd.json" + }, + "cisco_bgp-example": { + "description": "cisco_bgp-example", + "$ref": "examples/template/general/cisco_bgp.json" + }, + "cisco_dhcp_server-example": { + "description": "cisco_dhcp_server-example", + "$ref": "examples/template/general/cisco_dhcp_server.json" + }, + "cisco_dsp_farm-example": { + "description": "cisco_dsp_farm-example", + "$ref": "examples/template/general/cisco_dsp_farm.json" + }, + "cisco_logging-example": { + "description": "cisco_logging-example", + "$ref": "examples/template/general/cisco_logging.json" + }, + "cisco_ntp-example": { + "description": "cisco_ntp-example", + "$ref": "examples/template/general/cisco_ntp.json" + }, + "cisco_omp-example": { + "description": "cisco_omp-example", + "$ref": "examples/template/general/cisco_omp.json" + }, + "cisco_ospf-example": { + "description": "cisco_ospf-example", + "$ref": "examples/template/general/cisco_ospf.json" + }, + "cisco_ospfv3-example": { + "description": "cisco_ospfv3-example", + "$ref": "examples/template/general/cisco_ospfv3.json" + }, + "cisco_secure_internet_gateway-example": { + "description": "cisco_secure_internet_gateway-example", + "$ref": "examples/template/general/cisco_secure_internet_gateway.json" + }, + "cisco_security-example": { + "description": "cisco_security-example", + "$ref": "examples/template/general/cisco_security.json" + }, + "cisco_sig_credential-example": { + "description": "cisco_sig_credential-example", + "$ref": "examples/template/general/cisco_sig_credentials.json" + }, + "cisco_snmp-example": { + "description": "cisco_snmp-example", + "$ref": "examples/template/general/cisco_snmp.json" + }, + "cisco_system-example": { + "description": "cisco_system-example", + "$ref": "examples/template/general/cisco_system.json" + }, + "cisco_thousandeye-example": { + "description": "cisco_thousandeye-example", + "$ref": "examples/template/general/cisco_thousandeyes.json" + }, + "cisco_trustsec-example": { + "description": "cisco_trustsec-example", + "$ref": "examples/template/general/cisco_trustsec.json" + }, + "cisco_vp-example": { + "description": "cisco_vp-example", + "$ref": "examples/template/general/cisco_vpn.json" + }, + "cisco_vpn_interface-example": { + "description": "cisco_vpn_interface-example", + "$ref": "examples/template/general/cisco_vpn_interface.json" + }, + "cisco_vpn_interface_gre-example": { + "description": "cisco_vpn_interface_gre-example", + "$ref": "examples/template/general/cisco_vpn_interface_gre.json" + }, + "cisco_vpn_interface_ipsec-example": { + "description": "cisco_vpn_interface_ipsec-example", + "$ref": "examples/template/general/cisco_vpn_interface_ipsec.json" + }, + "cisco_wireless_la-example": { + "description": "cisco_wireless_la-example", + "$ref": "examples/template/general/cisco_wireless_lan.json" + }, + "cli-template-example": { + "description": "cli-template-example", + "$ref": "examples/template/general/cli-template.json" + }, + "dhcp-server-example": { + "description": "dhcp-server-example", + "$ref": "examples/template/general/dhcp-server.json" + }, + "eigrp-example": { + "description": "eigrp-example", + "$ref": "examples/template/general/eigrp.json" + }, + "igmp-example": { + "description": "igmp-example", + "$ref": "examples/template/general/igmp.json" + }, + "logging-example": { + "description": "logging-example", + "$ref": "examples/template/general/logging.json" + }, + "multicast-example": { + "description": "multicast-example", + "$ref": "examples/template/general/multicast.json" + }, + "ntp-example": { + "description": "ntp-example", + "$ref": "examples/template/general/ntp.json" + }, + "omp-vedge-example": { + "description": "omp-vedge-example", + "$ref": "examples/template/general/omp-vedge.json" + }, + "omp-vsmart-example": { + "description": "omp-vsmart-example", + "$ref": "examples/template/general/omp-vsmart.json" + }, + "ospf-example": { + "description": "ospf-example", + "$ref": "examples/template/general/ospf.json" + }, + "pim-example": { + "description": "pim-example", + "$ref": "examples/template/general/pim.json" + }, + "probe-example": { + "description": "probe-example", + "$ref": "examples/template/general/probes.json" + }, + "secure-internet-gateway-example": { + "description": "secure-internet-gateway-example", + "$ref": "examples/template/general/secure-internet-gateway.json" + }, + "security-vedge-example": { + "description": "security-vedge-example", + "$ref": "examples/template/general/security-vedge.json" + }, + "security-vsmart-example": { + "description": "security-vsmart-example", + "$ref": "examples/template/general/security-vsmart.json" + }, + "sig-credential-example": { + "description": "sig-credential-example", + "$ref": "examples/template/general/sig-credentials.json" + }, + "snmp-example": { + "description": "snmp-example", + "$ref": "examples/template/general/snmp.json" + }, + "switchport-example": { + "description": "switchport-example", + "$ref": "examples/template/general/switchport.json" + }, + "system-vedge-example": { + "description": "system-vedge-example", + "$ref": "examples/template/general/system-vedge.json" + }, + "system-vsmart-example": { + "description": "system-vsmart-example", + "$ref": "examples/template/general/system-vsmart.json" + }, + "t1-e1-controller-example": { + "description": "t1-e1-controller-example", + "$ref": "examples/template/general/t1-e1-controller.json" + }, + "tenant-example": { + "description": "tenant-example", + "$ref": "examples/template/general/tenant.json" + }, + "ucse-example": { + "description": "ucse-example", + "$ref": "examples/template/general/ucse.json" + }, + "virtual-application-utd-example": { + "description": "virtual-application-utd-example", + "$ref": "examples/template/general/virtual-application-utd.json" + }, + "vpn-cedge-interface-cellular-example": { + "description": "vpn-cedge-interface-cellular-example", + "$ref": "examples/template/general/vpn-cedge-interface-cellular.json" + }, + "vpn-cedge-interface-multilink-controller-example": { + "description": "vpn-cedge-interface-multilink-controller-example", + "$ref": "examples/template/general/vpn-cedge-interface-multilink-controller.json" + }, + "vpn-interface-ethpppoe-example": { + "description": "vpn-interface-ethpppoe-example", + "$ref": "examples/template/general/vpn-interface-ethpppoe.json" + }, + "vpn-interface-ipoe-example": { + "description": "vpn-interface-ipoe-example", + "$ref": "examples/template/general/vpn-interface-ipoe.json" + }, + "vpn-interface-pppoa-example": { + "description": "vpn-interface-pppoa-example", + "$ref": "examples/template/general/vpn-interface-pppoa.json" + }, + "vpn-interface-pppoe-example": { + "description": "vpn-interface-pppoe-example", + "$ref": "examples/template/general/vpn-interface-pppoe.json" + }, + "vpn-interface-svi-example": { + "description": "vpn-interface-svi-example", + "$ref": "examples/template/general/vpn-interface-svi.json" + }, + "vpn-interface-t1-e1-example": { + "description": "vpn-interface-t1-e1-example", + "$ref": "examples/template/general/vpn-interface-t1-e1.json" + }, + "vpn-vedge-interface-bridge-example": { + "description": "vpn-vedge-interface-bridge-example", + "$ref": "examples/template/general/vpn-vedge-interface-bridge.json" + }, + "vpn-vedge-interface-cellular-example": { + "description": "vpn-vedge-interface-cellular-example", + "$ref": "examples/template/general/vpn-vedge-interface-cellular.json" + }, + "vpn-vedge-interface-gre-example": { + "description": "vpn-vedge-interface-gre-example", + "$ref": "examples/template/general/vpn-vedge-interface-gre.json" + }, + "vpn-vedge-interface-ipsec-example": { + "description": "vpn-vedge-interface-ipsec-example", + "$ref": "examples/template/general/vpn-vedge-interface-ipsec.json" + }, + "vpn-vedge-interface-natpool-example": { + "description": "vpn-vedge-interface-natpool-example", + "$ref": "examples/template/general/vpn-vedge-interface-natpool.json" + }, + "vpn-vedge-interface-ppp-example": { + "description": "vpn-vedge-interface-ppp-example", + "$ref": "examples/template/general/vpn-vedge-interface-ppp.json" + }, + "vpn-vedge-interface-vap-example": { + "description": "vpn-vedge-interface-vap-example", + "$ref": "examples/template/general/vpn-vedge-interface-vap.json" + }, + "vpn-vedge-interface-example": { + "description": "vpn-vedge-interface-example", + "$ref": "examples/template/general/vpn-vedge-interface.json" + }, + "vpn-vedge-pppoe-enabled-interface-example": { + "description": "vpn-vedge-pppoe-enabled-interface-example", + "$ref": "examples/template/general/vpn-vedge-pppoe-enabled-interface.json" + }, + "vpn-vedge-example": { + "description": "vpn-vedge-example", + "$ref": "examples/template/general/vpn-vedge.json" + }, + "vpn-vmanage-interface-example": { + "description": "vpn-vmanage-interface-example", + "$ref": "examples/template/general/vpn-vmanage-interface.json" + }, + "vpn-vsmart-interface-example": { + "description": "vpn-vsmart-interface-example", + "$ref": "examples/template/general/vpn-vsmart-interface.json" + }, + "vpn-vsmart-example": { + "description": "vpn-vsmart-example", + "$ref": "examples/template/general/vpn-vsmart.json" + }, + "wla-example": { + "description": "wla-example", + "$ref": "examples/template/general/wlan.json" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - General Template" + ], + "description": "Delete feature template", + "operationId": "deleteGeneralTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + } + }, + "/template/lock/{processId}": { + "put": { + "tags": [ + "Configuration - Template Lock" + ], + "description": "Update lease", + "operationId": "updateLeaseTime", + "parameters": [ + { + "name": "processId", + "in": "path", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Template Lock" + ], + "description": "Remove lock", + "operationId": "removeLock", + "parameters": [ + { + "name": "processId", + "in": "path", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/template/policy/assembly/security": { + "post": { + "tags": [ + "Configuration - Policy Security Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/security/{id}": { + "get": { + "tags": [ + "Configuration - Policy Security Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vedge": { + "post": { + "tags": [ + "Configuration - Policy vEdge Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview_1", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vedge/{id}": { + "get": { + "tags": [ + "Configuration - Policy vEdge Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/voice": { + "post": { + "tags": [ + "Configuration - Policy Voice Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview_2", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/voice/{id}": { + "get": { + "tags": [ + "Configuration - Policy Voice Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vsmart": { + "post": { + "tags": [ + "Configuration - Policy vSmart Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview_3", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vsmart/{id}": { + "get": { + "tags": [ + "Configuration - Policy vSmart Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/clouddiscoveredapp": { + "get": { + "tags": [ + "Configuration - Policy Cloud Application Builder" + ], + "description": "Get all cloud discovered applications", + "operationId": "getCloudDiscoveredApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cloud Discovered App": { + "description": "Cloud Discovered App", + "value": { + "data": [ + { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05", + "appName": "DemoApp", + "lastUpdated": "1590201349732", + "owner": "admin" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Set SLA class for policy cloud discovered applications", + "operationId": "MapTrafficProfiles", + "requestBody": { + "description": "App payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App payload": { + "description": "App payload", + "value": "[\n {\n \"appId\":\"71001c48-fdcf-4ac0-aaf3-ca4a20386a18\",\n \"slaClass\":\"video\",\n }\n]" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App": { + "description": "App", + "value": { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/customapp": { + "get": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Get all policy custom applications", + "operationId": "getCustomApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Custom App": { + "description": "Custom App", + "value": { + "data": [ + { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05", + "appName": "DemoApp", + "lastUpdated": "1590201349732", + "owner": "admin" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Create a policy custom applications", + "operationId": "createCustomApp", + "requestBody": { + "description": "App payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App payload": { + "description": "App payload", + "value": { + "appName": "DemoApp" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App Id": { + "description": "App Id", + "value": { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/customapp/{id}": { + "get": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Get a policy custom applications", + "operationId": "getCustomAppById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Custom App": { + "description": "Custom App", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Edit a policy custom applications", + "operationId": "editCustomApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "App payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App payload": { + "description": "App payload", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Delete a policy custom applications", + "operationId": "deleteCustomApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/definition/acl": { + "get": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_8", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/acl/bulk": { + "put": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_8", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/acl/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/acl/preview": { + "post": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_8", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/acl/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/acl/{id}": { + "get": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/aclv6": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_9", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/aclv6/bulk": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_9", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/aclv6/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/aclv6/preview": { + "post": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_9", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/aclv6/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/aclv6/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/advancedMalwareProtection": { + "get": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_11", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/bulk": { + "put": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_11", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/preview": { + "post": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_11", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/{id}": { + "get": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile": { + "get": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_10", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/bulk": { + "put": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_10", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/preview": { + "post": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_10", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/{id}": { + "get": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/approute": { + "get": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_12", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-writeAppRoute Policy-write" + } + }, + "/template/policy/definition/approute/bulk": { + "put": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_12", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/approute/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/approute/preview": { + "post": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_12", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/approute/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/approute/{id}": { + "get": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-writeAppRoute Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-writeAppRoute Policy-write" + } + }, + "/template/policy/definition/cflowd": { + "get": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_13", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,CFlowD Policy-write" + } + }, + "/template/policy/definition/cflowd/bulk": { + "put": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_13", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/cflowd/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/cflowd/preview": { + "post": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_13", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/cflowd/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/cflowd/{id}": { + "get": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,CFlowD Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,CFlowD Policy-write" + } + }, + "/template/policy/definition/control": { + "get": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_14", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/control/bulk": { + "put": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_14", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/control/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/control/preview": { + "post": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_14", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/control/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/control/{id}": { + "get": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/data": { + "get": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_15", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/data/bulk": { + "put": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_15", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/data/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/data/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_15", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/data/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/data/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicy": { + "get": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_16", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/bulk": { + "put": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_16", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/preview": { + "post": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_16", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/{id}": { + "get": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_17", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/bulk": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_17", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/preview": { + "post": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_17", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/dialpeer": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_25", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dialpeer/bulk": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_25", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dialpeer/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dialpeer/preview": { + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_25", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dialpeer/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dialpeer/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity/bulk": { + "put": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity/preview": { + "post": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dnssecurity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dnssecurity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport": { + "get": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_26", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport/bulk": { + "put": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_26", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport/preview": { + "post": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_26", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxoport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxoport/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport": { + "get": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_28", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport/bulk": { + "put": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_28", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport/preview": { + "post": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_28", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsdidport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsdidport/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport": { + "get": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_27", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport/bulk": { + "put": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_27", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport/preview": { + "post": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_27", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsport/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke": { + "get": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_4", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke/bulk": { + "put": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_4", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke/preview": { + "post": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_4", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/hubandspoke/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/hubandspoke/{id}": { + "get": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention": { + "get": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_18", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention/bulk": { + "put": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_18", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention/preview": { + "post": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_18", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/intrusionprevention/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/intrusionprevention/{id}": { + "get": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/mesh": { + "get": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_5", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/mesh/bulk": { + "put": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_5", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/mesh/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/mesh/preview": { + "post": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_5", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/mesh/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/mesh/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport": { + "get": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_29", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport/bulk": { + "put": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_29", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport/preview": { + "post": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_29", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/priisdnport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/priisdnport/{id}": { + "get": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap": { + "get": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write" + }, + "post": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_1", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap/bulk": { + "put": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_1", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap/preview": { + "post": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_1", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/qosmap/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/qosmap/{id}": { + "get": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/rewriterule": { + "get": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_19", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Rewrite Policy-write" + } + }, + "/template/policy/definition/rewriterule/bulk": { + "put": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_19", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/rewriterule/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/rewriterule/preview": { + "post": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_19", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/rewriterule/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/rewriterule/{id}": { + "get": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Rewrite Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Rewrite Policy-write" + } + }, + "/template/policy/definition/ruleset": { + "get": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_20", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ruleset/bulk": { + "put": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_20", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ruleset/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ruleset/preview": { + "post": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_20", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ruleset/preview/{id}": { + "get": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ruleset/{id}": { + "get": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup": { + "get": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_21", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup/bulk": { + "put": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_21", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup/preview": { + "post": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_21", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/securitygroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/securitygroup/{id}": { + "get": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_30", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile/bulk": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_30", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile/preview": { + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_30", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/srstphoneprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/srstphoneprofile/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption": { + "get": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_3", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption/bulk": { + "put": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_3", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption/multiple/{id}": { + "put": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption/preview": { + "post": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_3", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ssldecryption/preview/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ssldecryption/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile": { + "get": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_22", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile/bulk": { + "put": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_22", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile/multiple/{id}": { + "put": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile/preview": { + "post": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_22", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/sslutdprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/sslutdprofile/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering": { + "get": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_23", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering/bulk": { + "put": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_23", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering/preview": { + "post": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_23", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/urlfiltering/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/urlfiltering/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vedgeroute": { + "get": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_24", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Route Policy-write" + } + }, + "/template/policy/definition/vedgeroute/bulk": { + "put": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_24", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vedgeroute/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vedgeroute/preview": { + "post": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_24", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vedgeroute/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vedgeroute/{id}": { + "get": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Route Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Route Policy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup": { + "get": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_6", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,VPN Membership Policy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/bulk": { + "put": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_6", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/preview": { + "post": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_6", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,VPN Membership Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,VPN Membership Policy-write" + } + }, + "/template/policy/definition/vpnqosmap": { + "get": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write" + }, + "post": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_2", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/vpnqosmap/bulk": { + "put": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_2", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnqosmap/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnqosmap/preview": { + "post": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_2", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnqosmap/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnqosmap/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw": { + "get": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_7", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw/bulk": { + "put": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_7", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw/preview": { + "post": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_7", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/zonebasedfw/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/zonebasedfw/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/ise/identity/deleteAllLists": { + "delete": { + "tags": [ + "Configuration - Identity Service Engine" + ], + "description": "Delete all identity lists", + "operationId": "deleteAllIdentityLists", + "requestBody": { + "description": "Delete lists", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete Identity Listsr": { + "description": "Delete Identity Listsr", + "value": { + "type": "identity" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "deleteAllLists": { + "description": "deleteAllLists", + "value": true + }, + "deleteSomeOrNoLists": { + "description": "deleteSomeOrNoLists", + "value": false + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/ise/identity/referenced/{listType}": { + "get": { + "tags": [ + "Configuration - Identity Service Engine" + ], + "description": "Get all referenced Identity Lists", + "operationId": "getIdentityListReference", + "parameters": [ + { + "name": "listType", + "in": "path", + "description": "list type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "referenced identity list Ids": { + "description": "referenced identity list Ids", + "value": "[\n {\n \"listId\": \"851cb243-d0da-4d7f-bdf9-124d979eadb9\",\n \"name\": \"universal\",\n \"type\": \"identity\",\n \"description\": \"test\",\n \"entries\": [\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Schema Admins\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Enterprise Admins\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Enterprise Read-only Domain Controllers\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Enterprise Key Admins\"\n }\n ],\n \"lastUpdated\": 1644359006986,\n \"owner\": \"admin\",\n \"readOnly\": false,\n \"version\": \"0\",\n \"infoTag\": \"\",\n \"referenceCount\": 1,\n \"references\": [\n {\n \"id\": \"0836d356-b89a-4fb9-abbc-1bb14d270ac8\",\n \"type\": \"zoneBasedFW\"\n }\n ],\n \"isActivatedByVsmart\": false\n },\n {\n \"listId\": \"5ad0dd2d-cc45-4710-8965-94965fe45ad4\",\n \"name\": \"test\",\n \"type\": \"identity\",\n \"description\": \"test\",\n \"entries\": [\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Cert Publishers\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/RAS and IAS Servers\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Allowed RODC Password Replication Group\"\n },\n {\n " + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/ise/identity/usergroups": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get all identity user groups", + "operationId": "getIdentityUserGroups", + "requestBody": { + "description": "Get Users", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UserGroup Filter": { + "description": "UserGroup Filter", + "value": { + "filter": "Cert Publishers" + } + }, + "UserGroup Empty Braces": { + "description": "UserGroup Empty Braces", + "value": {} + }, + "UserGroup Filter No Entry": { + "description": "UserGroup Filter No Entry" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User/Group return Json": { + "description": "User/Group return Json", + "value": { + "header": { + "generatedOn": 1643067620683, + "viewKeys": {}, + "columns": {}, + "fields": {} + }, + "data": { + "ERSActiveDirectoryGroups": { + "groups": [ + { + "name": "b1.com/Builtin/Administrators", + "sid": "b1.com/S-1-5-32-544", + "type": "BUILTIN, DOMAIN LOCAL" + } + ] + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/ise/identity/users": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get all identity users", + "operationId": "getIdentityUsers", + "requestBody": { + "description": "Get Users", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User Filter": { + "description": "User Filter", + "value": { + "filter": "a*" + } + }, + "User Filter Empty Braces": { + "description": "User Filter Empty Braces", + "value": {} + }, + "User Filter No Entry": { + "description": "User Filter No Entry" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User/Group return Json": { + "description": "User/Group return Json", + "value": { + "header": { + "generatedOn": 1641942304491, + "viewKeys": {}, + "columns": {}, + "fields": {} + }, + "data": { + "ERSActiveDirectoryUsers": { + "users": [ + { + "adUserSamAccountName": "guest" + }, + { + "adUserSamAccountName": "defaultaccount" + }, + { + "adUserSamAccountName": "administrator" + }, + { + "adUserSamAccountName": "krbtgt" + }, + { + "adUserSamAccountName": "waseem" + } + ] + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list": { + "get": { + "tags": [ + "Configuration - Policy List Builder" + ], + "description": "Get all policy lists", + "operationId": "getAllPolicyLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/app": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_3", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_3", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/app/filtered": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_3", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/app/preview": { + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_3", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/app/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/app/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/appprobe": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_4", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_4", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/appprobe/filtered": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_4", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/appprobe/preview": { + "post": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_4", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/appprobe/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/appprobe/{id}": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/aspath": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_5", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_5", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/aspath/filtered": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_5", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/aspath/preview": { + "post": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_5", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/aspath/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/aspath/{id}": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/class": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_14", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_14", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/class/filtered": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_14", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/class/preview": { + "post": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_14", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/class/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/class/{id}": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/color": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_6", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_6", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/color/filtered": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_6", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/color/preview": { + "post": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_6", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/color/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/color/{id}": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/community": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_7", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_7", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/community/filtered": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_7", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/community/preview": { + "post": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_7", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/community/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/community/{id}": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataipv6prefix": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_8", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_8", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataipv6prefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_8", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataipv6prefix/preview": { + "post": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_8", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataipv6prefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataipv6prefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataprefix": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_10", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_10", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_10", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefix/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_10", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataprefixall": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Get policy lists for all data prefixes", + "operationId": "getListsForAllDataPrefixes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_9", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_9", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixall/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_9", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixall/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_9", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixall/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixall/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataprefixfqdn": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Get lists for all all data-prefix(IPv4) and Fqdn lists", + "operationId": "getAllDataPrefixAndFQDNLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Data prefix and FQDN": { + "description": "Data prefix and FQDN", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_15", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_15", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixfqdn/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_15", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixfqdn/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_15", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixfqdn/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixfqdn/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/expandedcommunity": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_11", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_11", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/expandedcommunity/filtered": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_11", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/expandedcommunity/preview": { + "post": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_11", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/expandedcommunity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/expandedcommunity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/extcommunity": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_12", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_12", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/extcommunity/filtered": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_12", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/extcommunity/preview": { + "post": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_12", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/extcommunity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/extcommunity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/faxprotocol": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_13", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_13", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/faxprotocol/filtered": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_13", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/faxprotocol/preview": { + "post": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_13", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/faxprotocol/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/faxprotocol/{id}": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/fqdn": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_16", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_16", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/fqdn/filtered": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_16", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/fqdn/preview": { + "post": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_16", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/fqdn/preview/{id}": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/fqdn/{id}": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/geolocation": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_17", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_17", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/geolocation/entries": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get list of countries and continents for geo location", + "operationId": "getGeoLocationLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/geolocation/filtered": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_17", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/geolocation/preview": { + "post": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_17", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/geolocation/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/geolocation/{id}": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/identity": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_18", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_18", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/identity/filtered": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_18", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/identity/preview": { + "post": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_18", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/identity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/identity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/ipprefixall": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Get lists for all prefixes", + "operationId": "getListsForAllPrefixes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Prefixes": { + "description": "Prefixes", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_21", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_21", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipprefixall/filtered": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_21", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipprefixall/preview": { + "post": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_21", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipprefixall/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipprefixall/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/ipssignature": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_19", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_19", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipssignature/filtered": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_19", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipssignature/preview": { + "post": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_19", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipssignature/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipssignature/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/ipv6prefix": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_20", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_20", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipv6prefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_20", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipv6prefix/preview": { + "post": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_20", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipv6prefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipv6prefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/localapp": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_22", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_22", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localapp/filtered": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_22", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localapp/preview": { + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_22", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localapp/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localapp/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/localdomain": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_23", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_23", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localdomain/filtered": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_23", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localdomain/preview": { + "post": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_23", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localdomain/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localdomain/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/mediaprofile": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mediaprofile/filtered": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mediaprofile/preview": { + "post": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mediaprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mediaprofile/{id}": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/mirror": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_24", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_24", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mirror/filtered": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_24", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mirror/preview": { + "post": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_24", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mirror/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mirror/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/modempassthrough": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_25", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_25", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/modempassthrough/filtered": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_25", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/modempassthrough/preview": { + "post": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_25", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/modempassthrough/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/modempassthrough/{id}": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/policer": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_26", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_26", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/policer/filtered": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_26", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/policer/preview": { + "post": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_26", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/policer/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/policer/{id}": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/port": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_27", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_27", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/port/filtered": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_27", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/port/preview": { + "post": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_27", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/port/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/port/{id}": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/preferredcolorgroup": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_28", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_28", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/preferredcolorgroup/filtered": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_28", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/preferredcolorgroup/preview": { + "post": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_28", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/preferredcolorgroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/preferredcolorgroup/{id}": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/prefix": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_29", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_29", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/prefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_29", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/prefix/preview": { + "post": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_29", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/prefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/prefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/protocolname": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_30", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_30", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/protocolname/filtered": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_30", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/protocolname/preview": { + "post": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_30", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/protocolname/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/protocolname/{id}": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/region": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_31", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_31", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/region/filtered": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_31", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/region/preview": { + "post": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_31", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/region/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/region/{id}": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/site": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_32", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_32", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/site/defaultsite": { + "post": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Create default site list for sites missing from centralized policy", + "operationId": "createDefaultSiteList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Site list": { + "description": "Site list", + "value": { + "name": "Demo_site_list", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "200" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/template/policy/list/site/filtered": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_32", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/site/preview": { + "post": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_32", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/site/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/site/{id}": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/sla": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_33", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_33", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/sla/filtered": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_33", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/sla/preview": { + "post": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_33", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/sla/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/sla/{id}": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/supervisorydisc": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_31", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_34", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_34", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/supervisorydisc/filtered": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_34", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/supervisorydisc/preview": { + "post": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_34", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/supervisorydisc/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/supervisorydisc/{id}": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/tgapikey": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_32", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Create policy list", + "operationId": "createPolicyList_35", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_35", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tgapikey/filtered": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_35", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tgapikey/preview": { + "post": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_35", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tgapikey/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tgapikey/{id}": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/tloc": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_33", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_36", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_36", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tloc/filtered": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_36", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tloc/preview": { + "post": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_36", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tloc/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tloc/{id}": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/translationprofile": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_1", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_1", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationprofile/filtered": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_1", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationprofile/preview": { + "post": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_1", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationprofile/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/translationrules": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_2", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_2", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationrules/filtered": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_2", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationrules/preview": { + "post": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_2", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationrules/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationrules/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/trunkgroup": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_34", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_37", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_37", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/trunkgroup/filtered": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_37", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/trunkgroup/preview": { + "post": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_37", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/trunkgroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/trunkgroup/{id}": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/umbrelladata": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_35", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_38", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_38", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/umbrelladata/filtered": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_38", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/umbrelladata/preview": { + "post": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_38", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/umbrelladata/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/umbrelladata/{id}": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/urlblacklist": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_36", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_39", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_39", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlblacklist/filtered": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_39", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlblacklist/preview": { + "post": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_39", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlblacklist/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlblacklist/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/urlwhitelist": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_37", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_40", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_40", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlwhitelist/filtered": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_40", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlwhitelist/preview": { + "post": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_40", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlwhitelist/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlwhitelist/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/vpn": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_38", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_41", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_41", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/vpn/filtered": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_41", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/vpn/preview": { + "post": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_41", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/vpn/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/vpn/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/webex": { + "post": { + "tags": [ + "Configuration - Policy List Builder" + ], + "description": "TEMP-Create Webex policy lists", + "operationId": "createWebexPrefixLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/webex/update": { + "post": { + "tags": [ + "Configuration - Policy List Builder" + ], + "description": "TEMP-Update Webex policy lists from Webex config", + "operationId": "createWebexPrefixLists_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/zone": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_39", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_42", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_42", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/zone/filtered": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_42", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/zone/preview": { + "post": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_42", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/zone/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/zone/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/security": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Generate template list", + "operationId": "generateSecurityTemplateList", + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "Mode", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Create Template", + "operationId": "createSecurityTemplate", + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "Security Policy", + "policyType": "feature", + "policyName": "securitypolicy", + "policyUseCase": "guestAccess", + "policyDefinition": { + "assembly": [ + { + "definitionId": "840f9d3e-b31d-48b6-8365-79b75ba206a9", + "type": "urlFiltering" + } + ], + "settings": { + "logging": [ + { + "vpn": "512", + "serverIP": "10.0.0.1" + } + ], + "failureMode": "open" + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get Template", + "operationId": "getSecurityTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/devices": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get device list", + "operationId": "getSecurityPolicyDeviceList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/devices/{policyId}": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get device list by Id", + "operationId": "getDeviceListById", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/staging/{policyId}": { + "put": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Edit Template", + "operationId": "editTemplateWithLenientLock", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/summary": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Generate security policy summary", + "operationId": "generateSecurityPolicySummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Security policy summary": { + "description": "Security policy summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/{deviceModel}": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get templates that map a device model", + "operationId": "getSecurityTemplatesForDevice", + "parameters": [ + { + "name": "deviceModel", + "in": "path", + "description": "Device model", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/{policyId}": { + "put": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Edit Template", + "operationId": "editSecurityTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "Security Policy", + "policyType": "feature", + "policyName": "securitypolicy", + "policyUseCase": "guestAccess", + "policyDefinition": { + "assembly": [ + { + "definitionId": "f41167bd-6948-42ff-bc06-94f450e43999", + "type": "zoneBasedFW" + }, + { + "definitionId": "840f9d3e-b31d-48b6-8365-79b75ba206a9", + "type": "urlFiltering" + } + ], + "settings": { + "zoneToNozoneInternet": "deny", + "logging": [ + { + "vpn": "512", + "serverIP": "10.0.0.1" + } + ], + "failureMode": "open" + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Delete Template", + "operationId": "deleteSecurityTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get policy details", + "operationId": "generatePolicyTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Create template", + "operationId": "createVEdgeTemplate", + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "policyDescription": "Demo", + "policyType": "feature", + "policyName": "demo-policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "b628d664-d4ec-428f-831c-aff2b688c54c", + "type": "vedgeRoute" + }, + { + "definitionId": "e4b25c74-f594-49db-b78b-61bbb41464ba", + "type": "acl" + } + ], + "settings": { + "appVisibility": true, + "logFrequency": 60 + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy Id": { + "description": "Policy Id", + "value": { + "policyId": "f8efb9ed-7524-41ff-aa12-1b6635087ce1" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get template", + "operationId": "getVEdgeTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "data": [ + { + "mastersAttached": 0, + "lastUpdatedBy": "admin", + "policyName": "AppVisibility", + "policyDefinition": "policy\n app-visibility\n flow-visibility\n!\n", + "policyDefinitionEdit": "policy\n app-visibility\n flow-visibility\n!\n", + "createdOn": 1505676829880, + "policyDescription": "Application Visibility Only", + "@rid": 481, + "policyId": "0b860b3a-9446-4c19-86f4-49699f4ed2c7", + "createdBy": "admin", + "devicesAttached": 0, + "lastUpdatedOn": 1505676829880, + "policyType": "cli" + }, + { + "mastersAttached": 1, + "lastUpdatedBy": "admin", + "policyName": "BaselinePolicy", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}", + "policyDefinitionEdit": "{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}", + "createdOn": 1548341101877, + "policyDescription": "Baseline dCloud Policy for all WAN Edge", + "@rid": 2095, + "policyId": "f73b285f-72eb-4f6d-865f-eae0e453bd8e", + "createdBy": "admin", + "devicesAttached": 2, + "policyType": "feature", + "lastUpdatedOn": 1548341101877 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/devices": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get device list", + "operationId": "getVEdgePolicyDeviceList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/devices/{policyId}": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get device list by policy", + "operationId": "getDeviceListByPolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/{policyId}": { + "put": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Edit template", + "operationId": "editVEdgeTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": "{\n \"policyId\":\"8715a21d-9367-47ea-9bc6-e25163ed9513\",\n \"policyState\":\"edit\",\n \"mastersAttached\":2,\n \"lastUpdatedBy\":\"admin\",\n \"policyName\":\"LocalizedPolicyBaseline\",\n \"policyDefinition\": \"\"\n \"policyDefinitionEdit\":\"\"\n \"createdOn\":1548015105326,\n \"policyDescription\":\"Baseline Localized Policiy for dcloud\",\n \"@rid\":483,\n \"createdBy\":\"admin\",\n \"devicesAttached\":2,\n \"policyType\":\"cli\",\n \"lastUpdatedOn\":1548015105326\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Delete template", + "operationId": "deleteVEdgeTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/{resourceGroupName}/{policyId}": { + "post": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Change policy resource group", + "operationId": "changePolicyResourceGroup", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resrouce group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Generate template list", + "operationId": "generateVoiceTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": { + "data": [ + { + "lastUpdatedBy": "admin", + "mastersAttached": 0, + "policyName": "SIPpolicy", + "virtualApplicationTemplates": [], + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}", + "policyDefinitionEdit": "{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}", + "createdOn": 1590272854518, + "policyDescription": "SIP dail peers", + "policyUseCase": "custom", + "@rid": 1124, + "policyId": "87fed5e0-3b95-47a3-9dae-bed8b68562ed", + "createdBy": "admin", + "devicesAttached": 0, + "policyType": "feature", + "lastUpdatedOn": 1590272854518, + "supportedDevices": [ + "vedge-C8300-2N2S-4T2X", + "vedge-C8200-1N-4T", + "vedge-C8200L-1N-4T", + "vedge-C8300-2N2S-6T", + "vedge-C8300-1N1S-4T2X", + "vedge-C8300-1N1S-6T", + "vedge-ISR-4451-X", + "vedge-ISR-4351", + "vedge-ISR-4461", + "vedge-ISR-4431", + "vedge-ISR-4321", + "vedge-ISR-4331" + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Create Template", + "operationId": "createVoiceTemplate", + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "SIP dail peers", + "policyType": "feature", + "policyName": "SIPpolicy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac", + "type": "dialPeer", + "portType": "sipDialPeer" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy Id": { + "description": "Policy Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get templates by policy Id", + "operationId": "getTemplateById", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/devices": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get all device list", + "operationId": "getVoicePolicyDeviceList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/devices/{policyId}": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get device list by policy Id", + "operationId": "getDeviceListByPolicyId", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/summary": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get templates that map a device model", + "operationId": "generateVoicePolicySummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy summary": { + "description": "Policy summary", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/{deviceModel}": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get templates that map a device model", + "operationId": "getVoiceTemplatesForDevice", + "parameters": [ + { + "name": "deviceModel", + "in": "path", + "description": "Device model", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/{policyId}": { + "put": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Edit Template", + "operationId": "editVoiceTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "SIP dail peers", + "policyType": "feature", + "policyName": "SIPpolicy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac", + "type": "dialPeer", + "portType": "sipDialPeer" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Delete Template", + "operationId": "deleteVoiceTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Get all template vsmart policy list", + "operationId": "generateVSmartPolicyTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template vSmart policy list": { + "description": "Template vSmart policy list", + "value": { + "data": [ + { + "policyVersion": "12282017T235740495", + "lastUpdatedBy": "admin", + "policyName": "StrictHub-n-Spoke", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"4ddd51c0-d8a4-4dff-8874-09c24742b518\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}", + "createdOn": 1514732091489, + "isPolicyActivated": false, + "policyDescription": "BFD/IPSec based Hub-n-Spoke Topology", + "@rid": 6, + "policyId": "a8205140-92d9-4688-a127-c70d5f1b93a5", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514732091489 + }, + { + "policyVersion": "12302017T143348286", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPolicy", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]}]}", + "createdOn": 1514732164516, + "isPolicyActivated": false, + "policyDescription": "Multi-Topology Policy", + "@rid": 7, + "policyId": "45f0b251-bce6-4b6b-bb8c-de7dbf13ea0f", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514732164516 + }, + { + "policyVersion": "12312017T143840434", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPlusFWInsertion", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"1ded189f-4c6b-41cf-a686-655120fdf179\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"73096eaf-8bfe-43bd-a67a-9fcaaa2f8c38\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}", + "createdOn": 1514732296993, + "isPolicyActivated": false, + "policyDescription": "Adding FW for inter-branch communication in VPN 10", + "@rid": 8, + "policyId": "b33477d1-1ebc-4080-ba44-b89dbf14fef7", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514732296993 + }, + { + "policyVersion": "12312017T153128841", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPlusACL", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"968d1ce3-7ff7-4f97-8b69-01e4e06ecad2\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"19f53630-0ce6-4f6b-8e4f-6a527cd15ca4\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}", + "createdOn": 1514734542150, + "isPolicyActivated": false, + "policyDescription": "Application/ACL Policy for inter-branch traffic in VPN 20", + "@rid": 9, + "policyId": "7f156d32-537d-493f-9a7d-53d9e1f05a19", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514734542150 + }, + { + "policyVersion": "04092018T121824907", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPlusAppRoute", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"433db0fb-c89a-4642-a498-e3b9a257faef\",\"type\":\"appRoute\",\"entries\":[{\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]},{\"siteLists\":[\"1baf2339-97c0-43fb-98d2-285428a61820\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}", + "createdOn": 1514736045181, + "isPolicyActivated": false, + "policyDescription": "App Aware Routing Policy based on SLA", + "@rid": 10, + "policyId": "12df3ed9-6b1f-4b0a-91a2-377cefb8039f", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514736045181 + }, + { + "policyVersion": "06212018T190131728", + "lastUpdatedBy": "admin", + "policyName": "cflowd_policy", + "policyDefinition": "policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template\n ", + "createdOn": 1530540307108, + "isPolicyActivated": false, + "policyDescription": "cflowd", + "@rid": 12, + "policyId": "1c865c35-05ac-43a7-a6ee-6328138cd1c4", + "createdBy": "admin", + "policyType": "cli", + "lastUpdatedOn": 1530540307108 + }, + { + "policyVersion": "02242019T10524417", + "lastUpdatedBy": "admin", + "policyName": "Hub-Spoke-Policy-PCI", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"605fabbd-4c99-4be4-8842-aebb256f7010\",\"type\":\"hubAndSpoke\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"}]}", + "createdOn": 1551005623067, + "isPolicyActivated": false, + "policyDescription": "Enforce PCI VPN to be Hub and Spoke per corporate requirements", + "@rid": 1365, + "policyId": "67b2d453-671f-4eaf-b79a-d1c4c0069f1a", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1551005623067 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Create template for given policy", + "operationId": "createVSmartTemplate", + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "policyDescription": "demoVPN", + "policyType": "feature", + "policyName": "demoVPN", + "policyDefinition": { + "assembly": [ + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy Id": { + "description": "Policy Id", + "value": { + "policyId": "05917007-14e4-42b0-9575-3d3d11f8a371" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/activate/central/{policyId}": { + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Activate vsmart policy for a given policy id", + "operationId": "activatePolicyForCloudServices", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/activate/{policyId}": { + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Activate vsmart policy for a given policy id", + "operationId": "activatePolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Activate policy": { + "description": "Activate policy", + "value": { + "isEdited": false + } + }, + "Deactivate policy": { + "description": "Deactivate policy", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "vsmart_policy_config-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/central/{policyId}": { + "put": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Edit template for given policy id to allow for multiple component edits", + "operationId": "editTemplateWithoutLockChecks", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/connectivity/status": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Check VSmart Connectivity Status", + "operationId": "checkVSmartConnectivityStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connectivity Status": { + "description": "Connectivity Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/deactivate/{policyId}": { + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Deactivate vsmart policy for a given policy id", + "operationId": "deActivatePolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "vsmart_policy_config-60851f10-d9f0-4f41-a27e-9eedbd1bae65" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Get template policy definition by policy id", + "operationId": "getTemplateByPolicyId", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template vSmart policy": { + "description": "Template vSmart policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/qosmos_nbar_migration_warning": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Qosmos Nbar migration", + "operationId": "QosmosNbarMigrationWarning", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NBAR list": { + "description": "NBAR list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/{policyId}": { + "put": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Edit template for given policy id", + "operationId": "editVSmartTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "policyId": "1c865c35-05ac-43a7-a6ee-6328138cd1c4", + "policyState": "edit", + "policyVersion": "06212018T190131728", + "lastUpdatedBy": "admin", + "policyName": "cflowd_policy", + "policyDefinition": "policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template\n ", + "createdOn": 1530540307108, + "isPolicyActivated": false, + "policyDescription": "cflowd", + "@rid": 12, + "createdBy": "admin", + "policyType": "cli", + "lastUpdatedOn": 1530540307108, + "isEdited": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Delete template for a given policy id", + "operationId": "deleteVSmartTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/security/encryptText/encrypt": { + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get Type 6 Encryptedd String for a given value", + "operationId": "getEncryptedString", + "requestBody": { + "description": "Type6 Encryption", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Encryption": { + "description": "Encryption", + "value": { + "inputString": "string " + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Encrypted String": { + "description": "Encrypted String", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/tenant": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAllTenants", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "List all tenants associated with a vSmart", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Tenant models": { + "description": "Tenant models", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + }, + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createTenant", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/async": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createTenantAsync", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/bulk/async": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createTenantAsyncBulk", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": [ + { + "orgName": "fq-tenan1 - 19442", + "subDomain": "tenant1-fq-dev-dev.viptela.info", + "name": "fq-tenan1 - 19442", + "desc": "fq-tenan1 - 19442", + "wanEdgeForecast": "100" + }, + { + "orgName": "fq-tenan2 - 19442", + "subDomain": "tenant1-fq-dev-dev.viptela.info", + "name": "fq-tenan1 - 19442", + "desc": "fq-tenan1 - 19442", + "wanEdgeForecast": "100", + "vSmarts": "[vSmartUUID1, vSmartUUID2]" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "[{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + }, + "delete": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteTenantAsyncBulk", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": { + "password": "12345", + "tenantIdList": [ + "0f4f1c6e-47da-40c4-8517-9d1e918965d9", + "6b7b23bf-5dba-4cca-a36c-1c3cc2254d68" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{[\n \"id\": \u201c537911061561\u201d .\n]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/vsmart": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantvSmartMapping", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart tenant mapping": { + "description": "vSmart tenant mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + } + }, + "/tenant/vsmart-mt/migrate": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "tenantvSmartMtMigrate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/vsmart/capacity": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantHostingCapacityOnvSmarts", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart Capacity": { + "description": "vSmart Capacity", + "value": "[\"data\": [\n {\n \"vSmartUuid\": \"6dbf3f8d-d537-4650-9200-154d8b98b302\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"05aab9ac-44f7-4292-b8c5-2cc40f3afb5a\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"b20b4468-7a5f-48f1-8ee6-f393afd3ac72\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n }\n ]]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + } + }, + "/tenant/{tenantId}": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read" + }, + "put": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "updateTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": { + "orgName": "fq-tenan1 - 19442", + "subDomain": "tenant1-fq-dev-dev.viptela.info", + "desc": "fq-tenan1 - 19442" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"id\": \u201c537911061561\u201d .\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/{tenantId}/delete": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": { + "password": "password" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/{tenantId}/switch": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "switchTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vSession model": { + "description": "vSession model", + "value": "{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read" + } + }, + "/tenant/{tenantId}/vsessionid": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "vSessionId", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vSession model": { + "description": "vSession model", + "value": "{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + } + }, + "/tenant/{tenantId}/vsmart": { + "put": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "updateTenantvSmartPlacement", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UpdateTenantvSmartModel": { + "description": "UpdateTenantvSmartModel", + "value": { + "srcvSmartUuid": "UUID", + "destvSmartUuid": "UUID" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenantbackup/delete": { + "delete": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteTenantBackup", + "parameters": [ + { + "name": "fileName", + "in": "query", + "description": "File name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Deleted file list": { + "description": "Deleted file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write,Tenant Status-write" + } + }, + "/tenantbackup/download/{path}": { + "get": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Download a Backup File that is already stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "downloadExistingBackupFile", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "File path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file stream": { + "description": "Backup file stream" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" + } + }, + "/tenantbackup/export": { + "get": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Trigger a backup of configuration database and store it in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "exportTenantBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" + } + }, + "/tenantbackup/import": { + "post": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "importTenantBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write,Tenant Status-write" + } + }, + "/tenantbackup/list": { + "get": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "List all backup files of a tenant stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "listTenantBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file list": { + "description": "Backup file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" + } + }, + "/tenantmigration/download/{path}": { + "get": { + "tags": [ + "Tenant Migration" + ], + "description": "Download tenant data", + "operationId": "downloadTenantData", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "File path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant data": { + "description": "Tenant data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/export": { + "post": { + "tags": [ + "Tenant Migration" + ], + "description": "Export tenant data", + "operationId": "exportTenantData", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTenantModel" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/import": { + "post": { + "tags": [ + "Tenant Migration" + ], + "description": "Import tenant data", + "operationId": "importTenantData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/migrationToken": { + "get": { + "tags": [ + "Tenant Migration" + ], + "description": "Get migration token", + "operationId": "getMigrationToken", + "parameters": [ + { + "name": "migrationId", + "in": "query", + "description": "Migration Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Migration token": { + "description": "Migration token", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/networkMigration": { + "get": { + "tags": [ + "Tenant Migration" + ], + "description": "Re-trigger network migration", + "operationId": "reTriggerNetworkMigration", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + }, + "post": { + "tags": [ + "Tenant Migration" + ], + "description": "Migrate network", + "operationId": "migrateNetwork", + "requestBody": { + "description": "Network migration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network migration": { + "description": "Network migration", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantstatus": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAllTenantStatuses", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Tenant status": { + "description": "Tenant status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read" + } + }, + "/tenantstatus/force": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "forceStatusCollection", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/topology": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Create full topology", + "operationId": "createFullTopology", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Topologies": { + "description": "Topologies", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/topology/device": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Create device topology", + "operationId": "createDeviceTopology", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Topology": { + "description": "Topology", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/topology/device/site/{siteId}": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Get topology for a given site id", + "operationId": "getSiteTopology", + "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write" + } + }, + "/topology/monitor/site/{siteId}": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Get topology monitor data for a given site id", + "operationId": "getSiteTopologyMonitorData", + "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Site topology monitor": { + "description": "Site topology monitor", + "value": { + "data": [ + { + "device-id": "C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88", + "device-health": "yellow", + "circuits": [ + { + "color": "lte", + "system_ip": "172.16.255.14", + "circuit-health": "yellow", + "tunnels": [ + { + "name": "172.16.255.14:lte-172.16.255.15:lte", + "health": "yellow", + "state": "Up", + "vqoe_score": 7 + } + ] + } + ], + "if-speed": [ + { + "interface": "GigabitEthernet1", + "count": 34, + "tx_kbps": 0, + "rx_kbps": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/topology/physical": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Create pysical topology", + "operationId": "createPhysicalTopology", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Topology": { + "description": "Topology", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/troubleshooting/control/{uuid}": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Troubleshoot control connections", + "operationId": "getControlConnections", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device control connection": { + "description": "Device control connection", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-read" + } + }, + "/troubleshooting/devicebringup": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Debug device bring up", + "operationId": "getDeviceConfiguration", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device configuration": { + "description": "Device configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-read" + } + }, + "/umbrella/getkeys": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get keys from Umbrella", + "operationId": "getAllKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/umbrella/getkeys/management": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get management keys from Umbrella", + "operationId": "getManagementKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/umbrella/getkeys/networkdevices": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get network devices keys from Umbrella", + "operationId": "getNetworkKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/umbrella/getkeys/reporting": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get reporting keys from Umbrella", + "operationId": "getReportingKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/util/configdb/size": { + "get": { + "tags": [ + "Utility - Configuration DB" + ], + "description": "Fetches the disk usage by configuration-db", + "operationId": "getDBSizeOnFile", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Size": { + "description": "Size", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/util/logfile/appserver": { + "get": { + "tags": [ + "Utility - Logging" + ], + "description": "Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.", + "operationId": "listLogFileDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "log content": { + "description": "log content" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/util/logfile/appserver/lastnlines": { + "get": { + "tags": [ + "Utility - Logging" + ], + "description": "List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.", + "operationId": "listVManageServerLogLastNLines", + "parameters": [ + { + "name": "lines", + "in": "query", + "description": "Number of lines", + "schema": { + "type": "integer", + "format": "int64", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "log content": { + "description": "log content" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/util/logging/debuglog": { + "post": { + "tags": [ + "Utility - Logging" + ], + "description": "Test whether logging works", + "operationId": "debugLog", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "required": [ + "logMessage", + "loggerName" + ], + "type": "object", + "properties": { + "loggerName": { + "type": "string" + }, + "logMessage": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "admin" + } + }, + "/util/logging/level": { + "post": { + "tags": [ + "Utility - Logging" + ], + "description": "Set log level for logger", + "operationId": "setLogLevel", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "required": [ + "logLevel", + "loggerName" + ], + "type": "object", + "properties": { + "loggerName": { + "type": "string" + }, + "logLevel": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/util/logging/loggers": { + "get": { + "tags": [ + "Utility - Logging" + ], + "description": "List loggers", + "operationId": "listLoggers", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Loggers": { + "description": "Loggers", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/v1/config-group": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a Configuration Group by Solution", + "operationId": "GetConfigGroupBySolution", + "parameters": [ + { + "name": "solution", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-read" + }, + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Create a new Configuration Group", + "operationId": "CreateConfigGroup", + "requestBody": { + "description": "Config Group", + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/post/request_schema.json" + }, + "examples": { + "AON-ConfigGroup1-SF": { + "$ref": "schema/configgroup/common/post/request_schema.json#/propertyNames/examples/AON-ConfigGroup1-SF" + }, + "CEDGE-ConfigGroup1-NY": { + "$ref": "schema/configgroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/post/response_schema.json#/propertyNames/examples/example_1" + }, + "example_2": { + "$ref": "schema/configgroup/common/post/response_schema.json#/propertyNames/examples/example_2" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write,Config Group-write" + } + }, + "/v1/config-group/schema/sdwan": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a Cedge famiy Configuration Group Schema by Schema Type", + "operationId": "GetCedgeConfigGroupSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "post", + "put", + "associate/post", + "associate/put", + "associate/delete", + "deploy/post" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-read" + } + }, + "/v1/config-group/{configGroupId}": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a Configuration Group by ID", + "operationId": "GetConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigGroup" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-read" + }, + "put": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Edit a Configuration Group", + "operationId": "EditConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Config Group", + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/put/request_schema.json" + }, + "examples": { + "AON-ConfigGroup1-SF": { + "$ref": "schema/configgroup/common/put/request_schema.json#/propertyNames/examples/AON-ConfigGroup1-SF" + }, + "CEDGE-ConfigGroup1-NY": { + "$ref": "schema/configgroup/common/put/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/put/response_schema.json#/propertyNames/examples/example_1" + }, + "example_2": { + "$ref": "schema/configgroup/common/put/response_schema.json#/propertyNames/examples/example_2" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-write" + }, + "delete": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Delete Config Group", + "operationId": "DeleteConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-write" + } + }, + "/v1/config-group/{configGroupId}/device/associate": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get devices association with a config group", + "operationId": "GetConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-read" + }, + "put": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Move the devices from one config group to another", + "operationId": "UpdateConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/associate/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/associate/put/request_schema.json#/propertyNames/examples/example_1" + }, + "example_2": { + "$ref": "schema/configgroup/common/associate/put/request_schema.json#/propertyNames/examples/example_2" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + }, + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Create associations with device and a config group", + "operationId": "CreateConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/associate/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/associate/post/request_schema.json#/propertyNames/examples/example_1" + }, + "example_2": { + "$ref": "schema/configgroup/common/associate/post/request_schema.json#/propertyNames/examples/example_2" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + }, + "delete": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Delete Config Group Association from devices", + "operationId": "DeleteConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/associate/delete/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/associate/delete/request_schema.json#/propertyNames/examples/example_1" + }, + "example_2": { + "$ref": "schema/configgroup/common/associate/delete/request_schema.json#/propertyNames/examples/example_2" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + } + }, + "/v1/config-group/{configGroupId}/device/deploy": { + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "deploy config group to devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deployConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/deploy/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/deploy/post/request_schema.json#/propertyNames/examples/example_1" + }, + "example_2": { + "$ref": "schema/configgroup/common/deploy/post/request_schema.json#/propertyNames/examples/example_2" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/deploy/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/deploy/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + } + }, + "/v1/config-group/{configGroupId}/device/variables": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get device variables", + "operationId": "getConfigGroupDeviceVariables", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "device-id", + "in": "query", + "description": "Comma separated device id's like d1,d2", + "schema": { + "type": "string" + } + }, + { + "name": "suggestions", + "in": "query", + "description": "Suggestions for possible values", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-read" + }, + "put": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "assign values to device variables", + "operationId": "createConfigGroupDeviceVariables", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "schema/configgroup/common/variables/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/configgroup/common/variables/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + } + }, + "/v1/config-group/{configGroupId}/device/variables/schema": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "assign values to device variables", + "operationId": "createConfigGroupDeviceVariables_1", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-read" + } + }, + "/v1/config-group/{configGroupId}/device/{deviceId}/preview": { + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a preview of the configuration for a device", + "operationId": "getConfigGroupDeviceConfigurationPreview", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "path", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + } + }, + "/v1/feature-profile/mobility/global/basic/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get a Mobility Global Basic Parcel Schema by Schema Type", + "operationId": "GetMobilityGlobalBasicParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/mobility/global/{profileId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get a Mobility Global Feature Profile by profileId", + "operationId": "GetMobilityFeatureProfileByGlobalId", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "profileId": { + "description": "profileId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/basic": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Basic Profile Parcels for Mobility Global Feature Profile", + "operationId": "GetBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create a Basic Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/mobility/global/basic/post/request_schema.json" + }, + "examples": { + "AonBasicParcelConfig": { + "$ref": "schema/profileparcel/mobility/global/basic/post/request_schema.json#/propertyNames/examples/AonBasicParcelConfig" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "profileId": { + "description": "profileId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile", + "operationId": "GetBasicProfileParcelByParcelIdForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parcelId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Update a Basic Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parcelId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/mobility/global/basic/put/request_schema.json" + }, + "examples": { + "AonBasicParcelConfig": { + "$ref": "schema/profileparcel/mobility/global/basic/put/request_schema.json#/propertyNames/examples/AonBasicParcelConfig" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "profileId": { + "description": "profileId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Basic Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parcelId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/cellular": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetCellularProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729307062 + }, + "data": [ + { + "parcelId": "8b698d5b-be6e-47bd-8567-1e5087b4b8d9", + "parcelType": "cellular", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729253148, + "lastUpdatedOn": 1628729253148, + "payload": { + "id": "1", + "name": "ATTSingleSimPap", + "variables": null, + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none", + "userName": null, + "password": null + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfile": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none", + "userName": null, + "password": null + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfile": 1 + }, + "primarySlot": 1, + "wanConfig": null, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "cellular" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateCellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CellularProfile" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "cellular", + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "primarySlot": 1, + "id": "1", + "name": "ATTSingleSimPap" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetCellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "cellular", + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "primarySlot": 1, + "id": "1", + "name": "ATTSingleSimPap" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditCellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cellular" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "cellular", + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "primarySlot": 1, + "id": "1", + "name": "ATTSingleSimPap" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteACellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Ethernet Profile Parcels for feature profile", + "operationId": "GetEthernetProfileParcels", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Ethernet Profile Parcel For Mobility Global Feature Profile": { + "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "portType": "WAN", + "wanConfiguration": "Active", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "5.5.5.5" + }, + { + "interfaceName": "GigabitEthernet0/1", + "portType": "LAN", + "adminState": "enabled", + "corporateLan": true + }, + { + "interfaceName": "GigabitEthernet0/2", + "portType": "LAN", + "adminState": "disabled" + } + ], + "parcelType": "ethernet", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an ethernet Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateEthernetProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Ethernet" + }, + "examples": { + "Ethernet Profile Parcel For Aon Feature Profile": { + "description": "Ethernet Profile Parcel For Aon Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "portType": "WAN", + "wanConfiguration": "Active", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "5.5.5.5" + }, + { + "interfaceName": "GigabitEthernet0/1", + "portType": "LAN", + "adminState": "enabled", + "corporateLan": true + }, + { + "interfaceName": "GigabitEthernet0/2", + "portType": "LAN", + "adminState": "disabled" + } + ], + "parcelType": "ethernet", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "ethernetId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Ethernet Profile Parcels for feature profile", + "operationId": "GetEthernetProfileParcel", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Ethernet Profile Parcel For Mobility Global Feature Profile": { + "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "portType": "WAN", + "wanConfiguration": "Active", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "5.5.5.5" + }, + { + "interfaceName": "GigabitEthernet0/1", + "portType": "LAN", + "adminState": "enabled", + "corporateLan": true + }, + { + "interfaceName": "GigabitEthernet0/2", + "portType": "LAN", + "adminState": "disabled" + } + ], + "parcelType": "ethernet", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Update a Ethernet Profile Parcel for feature profile", + "operationId": "EditEthernetProfileParcelForSystem", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Ethernet Profile Parcel For Mobility Global Feature Profile": { + "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "ethernet", + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "wanConfiguration": "Active", + "portType": "WAN", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "3.3.3.3" + }, + { + "interfaceName": "GigabitEthernet0/1", + "adminState": "enabled" + }, + { + "interfaceName": "GigabitEthernet0/2", + "adminState": "disabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Ethernet Profile Parcel for feature profile", + "operationId": "DeleteEthernetProfileParcelForSystem", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/networkProtocol": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetNetworkProtocolProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { + "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729936548 + }, + "data": [ + { + "parcelId": "4e958a77-03dc-4558-a45b-eeba554bb873", + "parcelType": "networkProtocol", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729896431, + "lastUpdatedOn": 1628729896431, + "payload": { + "id": null, + "name": null, + "variables": null, + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": 2, + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DNSSettings": "1.1.1.1", + "NTPInherit": false, + "NTPSettings": [ + "1.1.1.1", + "1.1.1.2" + ], + "DHCPOptions": [ + { + "type": 2, + "dhcpValue": "2", + "dataType": "integer" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test", + "interface": "Cellular1/0" + } + ], + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "networkProtocol" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "NetworkProtocol Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkProtocol" + }, + "examples": { + "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { + "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "networkProtocol", + "DNSSettings": "1.1.1.1", + "NTPInherit": false, + "NTPSettings": [ + "1.1.1.1", + "1.1.1.2" + ], + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": "2", + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DHCPOptions": [ + { + "type": 2, + "dataType": "integer", + "dhcpValue": "2" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "networkProtocolId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { + "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "networkProtocol", + "DNSSettings": "1.1.1.1", + "NTPInherit": false, + "NTPSettings": [ + "1.1.1.1", + "1.1.1.2" + ], + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": "2", + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DHCPOptions": [ + { + "type": 2, + "dataType": "integer", + "dhcpValue": "2" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "networkProtocolId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network Protocol Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkProtocol" + }, + "examples": { + "Network Protocol Profile Parcel For Mobility Global Feature Profile": { + "description": "Network Protocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "networkProtocol", + "DNSSettings": "1.1.1.1", + "NTPInherit": true, + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": "2", + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DHCPOptions": [ + { + "type": 2, + "dataType": "integer", + "dhcpValue": "2" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "networkProtocolId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/securityPolicy": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetSecurityPolicyProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { + "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729560981 + }, + "data": [ + { + "parcelId": "b79d5ede-263f-4229-aa9b-7b6581058c50", + "parcelType": "securityPolicy", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729517699, + "lastUpdatedOn": 1628729517699, + "payload": { + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ], + "type": "securityPolicy" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SecurityPolicy Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + }, + "examples": { + "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { + "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "securityPolicy", + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "securityPolicyId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { + "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "securityPolicy", + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Security Policy Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "securityPolicyId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Security Policy Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + }, + "examples": { + "Security Policy Profile Parcel For Mobility Global Feature Profile": { + "description": "Security Policy Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "securityPolicy", + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Security Policy Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "securityPolicyId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Vpn Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetVpnProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729629351 + }, + "data": [ + { + "parcelId": "75cfe22c-228c-4421-9527-62dddc81572f", + "parcelType": "vpn", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729605834, + "lastUpdatedOn": 1628729605834, + "payload": { + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "5", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "vpn" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Vpn" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "tunnelDnsAddress": "2.0.0.3", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-cbc-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "21", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "parcelType": "vpn", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "tunnelDnsAddress": "2.0.0.3", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-cbc-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "21", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "parcelType": "vpn", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Vpn" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "tunnelDnsAddress": "2.0.0.3", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-cbc-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "21", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "parcelType": "vpn", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteAVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/wifi": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Wifi Profile Parcel List for Mobility feature profile", + "operationId": "GetWifiProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729177130 + }, + "data": [ + { + "parcelId": "70c55c19-5043-4c6f-9b64-d710ee174bfd", + "parcelType": "wifi", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729108424, + "lastUpdatedOn": 1628729108424, + "payload": { + "id": null, + "name": null, + "ssid0": { + "ssid": "myWIFI", + "security": "WLAN_VAP_SECURITY_WPA", + "password": "mypasswd", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "visibility": true + }, + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_NONE", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1", + "encryptionKey": "B1C2DE1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1WPA2", + "encryptionKey": "A4B5EA1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_8021X", + "wpaEncryptionMode": "WPA2", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + } + } + }, + "variables": null, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "wifi" + } + }, + { + "parcelId": "ef215fe9-af7f-4fa1-83c5-0d1e281749a0", + "parcelType": "wifi", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628716782903, + "lastUpdatedOn": 1628716782903, + "payload": { + "id": null, + "name": null, + "ssid0": { + "ssid": "myWIFI", + "security": "WLAN_VAP_SECURITY_WPA", + "password": "mypasswd", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "visibility": true + }, + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_NONE", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1", + "encryptionKey": "B1C2DE1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1WPA2", + "encryptionKey": "A4B5EA1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_8021X", + "wpaEncryptionMode": "WPA2", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + } + } + }, + "variables": null, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "wifi" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an Wifi Profile Parcel for Mobility feature profile", + "operationId": "CreateWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wifi Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Wifi" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "OPEN", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "B1C2DE1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A4B5EA1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WPA2-Enterprise", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": "11", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": "36", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + } + } + }, + "parcelType": "wifi", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Wifi Profile Parcel for Mobility feature profile", + "operationId": "GetWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wifiId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "OPEN", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "B1C2DE1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A4B5EA1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WPA2-Enterprise", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": "11", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": "36", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + } + } + }, + "parcelType": "wifi", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Wifi Profile Parcel for Mobility feature profile", + "operationId": "EditWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wifiId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wifi Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Wifi" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "OPEN", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "B1C2DE1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A4B5EA1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WPA2-Enterprise", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": "11", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": "36", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + } + } + }, + "parcelType": "wifi", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete an Wifi Profile Parcel for Mobility feature profile", + "operationId": "DeleteWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wifiId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-write" + } + }, + "/v1/feature-profile/sdwan": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles", + "operationId": "GetSdwanFeatureProfileBySdwanFamily", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cliId": { + "description": "cliId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile-read" + } + }, + "/v1/feature-profile/sdwan/cli": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanFeatureProfilesByFamilyAndType", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cliId": { + "description": "cliId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Feature Profile with profile type", + "operationId": "CreateSdwanFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/v1/feature-profile/sdwan/cli/{cliId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Feature Profile with Cli profile type", + "operationId": "GetSdwanFeatureProfileByProfileId", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cliId": { + "description": "cliId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Feature Profile", + "operationId": "EditSdwanFeatureProfile", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanFeatureProfileForCli", + "parameters": [ + { + "name": "cliId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/v1/feature-profile/sdwan/cli/{cliId}/config": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get config Profile Parcels for cli feature profile", + "operationId": "GetConfigProfileParcelForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-read,Config Group > Device > Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a config Profile Parcel for cli feature profile", + "operationId": "CreateSdwanConfigProfileParcelForCli", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "cli config Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/cli/config/post/request_schema.json" + }, + "examples": { + "CliConfigParcel1": { + "$ref": "schema/profileparcel/sdwan/cli/config/post/request_schema.json#/propertyNames/examples/CliConfigParcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + } + }, + "/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get config Profile Parcel by configId for cli feature profile", + "operationId": "GetConfigProfileParcelByParcelIdForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-read,Config Group > Device > Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a config Profile Parcel for cli feature profile", + "operationId": "EditConfigProfileParcelForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "cli config Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/cli/config/put/request_schema.json" + }, + "examples": { + "CliConfigParcel1": { + "$ref": "schema/profileparcel/sdwan/cli/config/put/request_schema.json#/propertyNames/examples/CliConfigParcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a config Profile Parcel for cli feature profile", + "operationId": "DeleteConfigProfileParcelForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + } + }, + "/v1/feature-profile/sdwan/other": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanOtherFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Other Feature Profile", + "operationId": "CreateSDWANOtherFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-write" + } + }, + "/v1/feature-profile/sdwan/other/thousandeyes/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Other Thousandeyes Parcel Schema by Schema Type", + "operationId": "GetSdwanOtherThousandeyesParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-read" + } + }, + "/v1/feature-profile/sdwan/other/{otherId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Other Feature Profile with otherId", + "operationId": "GetSdwanOtherFeatureProfileByProfileId", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Other Feature Profile", + "operationId": "EditSdwanOtherFeatureProfile", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanOtherFeatureProfile", + "parameters": [ + { + "name": "otherId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-write" + } + }, + "/v1/feature-profile/sdwan/other/{otherId}/thousandeyes": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Thousandeyes Profile Parcels for Other feature profile", + "operationId": "GetThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Thousandeyes Profile Parcel for Other feature profile", + "operationId": "CreateThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Thousandeyes Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/other/thousandEyes/post/request_schema.json" + }, + "examples": { + "thousandeyesParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/other/thousandEyes/post/request_schema.json#/propertyNames/examples/thousandeyesParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-write" + } + }, + "/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Thousandeyes Profile Parcel by parcelId for Other feature profile", + "operationId": "GetThousandeyesProfileParcelByParcelIdForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "thousandeyesId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Thousandeyes Profile Parcel for Other feature profile", + "operationId": "EditThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "thousandeyesId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Thousandeyes Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/other/thousandEyes/put/request_schema.json" + }, + "examples": { + "thousandeyesParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/other/thousandEyes/put/request_schema.json#/propertyNames/examples/thousandeyesParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Thousandeyes Profile Parcel for Other feature profile", + "operationId": "DeleteThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "thousandeyesId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-write" + } + }, + "/v1/feature-profile/sdwan/service": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanServiceFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Service Feature Profile", + "operationId": "CreateSdwanServiceFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-write" + } + }, + "/v1/feature-profile/sdwan/service/dhcp-server/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service DhcpServer Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceDhcpServerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-read" + } + }, + "/v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service LanVpn InterfaceEthernet Schema by Schema Type", + "operationId": "GetSdwanServiceLanVpnInterfaceEthernetParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + } + }, + "/v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a Cedge Service LanVpn InterfaceSvi Schema by Schema Type", + "operationId": "GetCedgeServiceLanVpnInterfaceSviParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + } + }, + "/v1/feature-profile/sdwan/service/lan/vpn/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service LanVpn Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceLanVpnParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/routing/bgp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service RoutingBgp Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceRoutingBgpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/routing/ospf/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service RoutingOspf Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceRoutingOspfParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/switchport/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a Cedge Service Switchport Parcel Schema by Schema Type", + "operationId": "GetCedgeServiceSwitchportParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Feature Profile > Service > Switchport-read" + } + }, + "/v1/feature-profile/sdwan/service/wirelesslan/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a sdwan Service Wirelesslan Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceWirelesslanParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service Feature Profile with serviceId", + "operationId": "GetSdwanServiceFeatureProfileByProfileId", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Service Feature Profile", + "operationId": "EditSdwanServiceFeatureProfile", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanServiceFeatureProfile", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Dhcp Server Profile Parcels for Service feature profile", + "operationId": "GetDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Dhcp Server Profile Parcel for Service feature profile", + "operationId": "CreateDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Dhcp Server Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/dhcp-server/post/request_schema.json" + }, + "examples": { + "Default_DHCP_Server_Parcel": { + "$ref": "schema/profileparcel/sdwan/service/dhcp-server/post/request_schema.json#/propertyNames/examples/Default_DHCP_Server_Parcel" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Dhcp Server Profile Parcel by parcelId for Service feature profile", + "operationId": "GetDhcpServerProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Dhcp Server Profile Parcel for Service feature profile", + "operationId": "EditDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Dhcp Server Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/dhcp-server/put/request_schema.json" + }, + "examples": { + "Default_DHCP_Server_Parcel": { + "$ref": "schema/profileparcel/sdwan/service/dhcp-server/put/request_schema.json#/propertyNames/examples/Default_DHCP_Server_Parcel" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Dhcp Server Profile Parcel for Service feature profile", + "operationId": "DeleteDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Lan Vpn Profile Parcels for Service feature profile", + "operationId": "GetLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Lan Vpn Profile Parcel for Service feature profile", + "operationId": "CreateLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_Service_Lan_Vpn_parcel1": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Lan_Vpn_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Lan Vpn Profile Parcel by parcelId for Service feature profile", + "operationId": "GetLanVpnProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Lan Vpn Profile Parcel for Service feature profile", + "operationId": "EditLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_Service_Lan_Vpn_parcel1": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Lan_Vpn_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Lan Vpn Profile Parcel for Service feature profile", + "operationId": "DeleteLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceEthernet Parcels for service LanVpn Parcel", + "operationId": "GetInterfaceEthernetParcelsForServiceLanVpn", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a LanVpn InterfaceEthernet parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceEthernetParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/post/request_schema.json" + }, + "examples": { + "ServiceLanVpnInterfaceEthernetParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/post/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceEthernetParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "LanVpn Interface Ethernet Parcel For Service Feature Profile": { + "description": "LanVpn Interface Ethernet Parcel For Service Feature Profile", + "value": { + "data": { + "shutdown": { + "optionType": "global", + "value": false + }, + "interfaceName": { + "optionType": "variable", + "variableName": "{{lan_int_0}}" + }, + "description": { + "optionType": "global", + "value": "LAN Interface - LocalInternetAccessforGuestUsersInterface" + }, + "nat": { + "optionType": "default", + "value": false + }, + "dhcpHelper": { + "optionType": "global", + "value": [ + "5.6.7.8" + ] + }, + "intfIpAddress": { + "static": { + "staticIpV4AddressPrimary": { + "ipAddress": { + "optionType": "global", + "value": "4.4.4.4" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + "staticIpV4AddressSecondary": [ + { + "ipAddress": { + "optionType": "global", + "value": "5.5.5.5" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + { + "ipAddress": { + "optionType": "global", + "value": "6.6.6.6" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + } + ] + } + }, + "intfIpV6Address": { + "static": { + "primaryIpV6Address": { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.6/24" + } + }, + "secondaryIpV6Address": [ + { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.7/24" + } + }, + { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.8/24" + } + } + ], + "dhcpHelperV6": [ + { + "ipAddress": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.9" + }, + "vpn": { + "optionType": "default" + } + }, + { + "ipAddress": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.10" + }, + "vpn": { + "optionType": "global", + "value": 1 + } + } + ] + } + }, + "natIpv6": { + "optionType": "global", + "value": true + }, + "natAttributesIpv6": { + "nat64": { + "optionType": "global", + "value": false + }, + "nat66": { + "optionType": "global", + "value": true + }, + "staticNat66": [ + { + "sourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.11/24" + }, + "translatedSourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.12/24" + }, + "sourceVpnId": { + "optionType": "global", + "value": 1 + } + } + ] + }, + "advanced": { + "ipMtu": { + "optionType": "default", + "value": 1500 + }, + "arpTimeout": { + "optionType": "default", + "value": 1200 + }, + "loadInterval": { + "optionType": "default", + "value": 30 + }, + "ipDirectedBroadcast": { + "optionType": "default", + "value": false + } + }, + "vrrp": [], + "vrrpIpv6": [ + { + "optionalRow": { + "optionType": "global", + "value": false + }, + "groupId": { + "optionType": "global", + "value": 2 + }, + "priority": { + "optionType": "global", + "value": 100 + }, + "timer": { + "optionType": "global", + "value": 100 + }, + "trackOmp": { + "optionType": "global", + "value": true + }, + "ipv6": [ + { + "ipv6LinkLocal": { + "optionType": "global", + "value": "fe80::1" + }, + "prefix": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.13/24" + } + } + ] + } + ] + }, + "name": "LocalInternetAccessforGuestUsersInterface", + "description": "LocalInternetAccessforGuestUsersInterface" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn InterfaceEthernet Parcel by ethernetId for service feature profile", + "operationId": "GetLanVpnInterfaceEthernetParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn InterfaceEthernet Parcel for service feature profile", + "operationId": "EditLanVpnInterfaceEthernetParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/put/request_schema.json" + }, + "examples": { + "ServiceLanVpnInterfaceEthernetParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/put/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceEthernetParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn InterfaceEthernet Parcel for service feature profile", + "operationId": "DeleteLanVpnInterfaceEthernetForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceEthernet associated DhcpServer Parcels for service feature profile", + "operationId": "GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelsForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceEthernet associated DhcpServer Parcel by dhcpServerId for service feature profile", + "operationId": "GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpnInterfaceEthernet parcel and a DhcpServer Parcel association for service feature profile", + "operationId": "EditLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpnInterfaceEthernet and a DhcpServer Parcel association for service feature profile", + "operationId": "DeleteLanVpnInterfaceEthernetAndDhcpServerAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceSvi Parcels for service LanVpn Parcel", + "operationId": "GetInterfaceSviParcelsForServiceLanVpn", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read,Feature Profile > Service > Lan/Vpn-write" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a LanVpn InterfaceSvi parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceSviParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Svi Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/svi/post/request_schema.json" + }, + "examples": { + "ServiceLanVpnInterfaceSviParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/svi/post/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceSviParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn InterfaceSvi Parcel by sviId for service feature profile", + "operationId": "GetLanVpnInterfaceSviParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn InterfaceSvi Parcel for service feature profile", + "operationId": "EditLanVpnInterfaceSviParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Svi Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/svi/put/request_schema.json" + }, + "examples": { + "ServiceLanVpnInterfaceSviParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/lan/vpn/interface/svi/put/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceSviParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn InterfaceSvi Parcel for service feature profile", + "operationId": "DeleteLanVpnInterfaceSviForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceSvi associated DhcpServer Parcels for service feature profile", + "operationId": "GetLanVpnInterfaceSviAssociatedDhcpServerParcelsForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-read" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceSvi associated DhcpServer Parcel by dhcpServerId for service feature profile", + "operationId": "GetLanVpnInterfaceSviAssociatedDhcpServerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpnInterfaceSvi parcel and a DhcpServer Parcel association for service feature profile", + "operationId": "EditLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpnInterfaceSvi and a DhcpServer Parcel association for service feature profile", + "operationId": "DeleteLanVpnInterfaceSviAndDhcpServerAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn associated Routing Bgp Parcels for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingBgpParcelsForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a lanvpn parcel with a routingbgp Parcel for service feature profile", + "operationId": "CreateLanVpnAndRoutingBgpParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Lan Vpn Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn parcel associated RoutingBgp Parcel by bgpId for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingBgpParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn parcel and a RoutingBgp Parcel association for service feature profile", + "operationId": "EditLanVpnAndRoutingBgpParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn parcel and a RoutingBgp Parcel association for service feature profile", + "operationId": "DeleteLanVpnAndRoutingBgpAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn associated Routing Ospf Parcels for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingOspfParcelsForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a lanvpn parcel with a routingospf Parcel for service feature profile", + "operationId": "CreateLanVpnAndRoutingOspfParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Lan Vpn Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn parcel associated RoutingOspf Parcel by ospfId for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingOspfParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Routing Ospf Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn parcel and a RoutingOspf Parcel association for service feature profile", + "operationId": "EditLanVpnAndRoutingOspfParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Routing Ospf ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn parcel and a RoutingOspf Parcel association for service feature profile", + "operationId": "DeleteLanVpnAndRoutingOspfAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Routing Ospf Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a LanVpnInterfaceEthernet parcel with a DhcpServer Parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a LanVpnInterfaceSvi parcel with a DhcpServer Parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcels for Service feature profile", + "operationId": "GetRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Routing Bgp Profile Parcel for Service feature profile", + "operationId": "CreateRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/routing/bgp/post/request_schema.json" + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/routing/bgp/post/request_schema.json#/propertyNames/examples/ServiceBgpParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcel by parcelId for Service feature profile", + "operationId": "GetRoutingBgpProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Routing Bgp Profile Parcel for Service feature profile", + "operationId": "EditRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/routing/bgp/put/request_schema.json" + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/routing/bgp/put/request_schema.json#/propertyNames/examples/ServiceBgpParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Routing Bgp Profile Parcel for Service feature profile", + "operationId": "DeleteRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Ospf Profile Parcels for Service feature profile", + "operationId": "GetRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Routing Ospf Profile Parcel for Service feature profile", + "operationId": "CreateRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/routing/ospf/post/request_schema.json" + }, + "examples": { + "ServiceOspfParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/routing/ospf/post/request_schema.json#/propertyNames/examples/ServiceOspfParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Ospf Profile Parcel by parcelId for Service feature profile", + "operationId": "GetRoutingOspfProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Routing Ospf Profile Parcel for Service feature profile", + "operationId": "EditRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/routing/ospf/put/request_schema.json" + }, + "examples": { + "ServiceOspfParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/routing/ospf/put/request_schema.json#/propertyNames/examples/ServiceOspfParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Routing Ospf Profile Parcel for Service feature profile", + "operationId": "DeleteRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/switchport": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Switchport Parcels for service feature profile", + "operationId": "GetSwitchportParcelsForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a switchport Parcel to a service feature profile", + "operationId": "CedgeServiceProfileSwitchportParcelRestfulResource", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Feature Profile Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/switchport/post/request_schema.json" + }, + "examples": { + "SwitchPortParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/switchport/post/request_schema.json#/propertyNames/examples/SwitchPortParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Switchport Parcel by switchportId for service feature profile", + "operationId": "GetSwitchportParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "switchportId", + "in": "path", + "description": "Switchport Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Switchport Parcel association for service feature profile", + "operationId": "EditSwitchportParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "switchportId", + "in": "path", + "description": "Switchport ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Switchport Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/switchport/put/request_schema.json" + }, + "examples": { + "SwitchPortParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/switchport/put/request_schema.json#/propertyNames/examples/SwitchPortParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Switchport Parcel for service feature profile", + "operationId": "DeleteSwitchportProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "switchportId", + "in": "path", + "description": "Switchport Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wirelesslan Profile Parcels for Service feature profile", + "operationId": "GetWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Wirelesslan Profile Parcel for Service feature profile", + "operationId": "CreateWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wirelesslan Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/wirelesslan/post/request_schema.json" + }, + "examples": { + "wirelessParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/wirelesslan/post/request_schema.json#/propertyNames/examples/wirelessParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wirelesslan Profile Parcel by parcelId for Service feature profile", + "operationId": "GetWirelesslanProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wirelesslanId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Wirelesslan Profile Parcel for Service feature profile", + "operationId": "EditWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wirelesslanId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wirelesslan Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/service/wirelesslan/put/request_schema.json" + }, + "examples": { + "wirelessParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/service/wirelesslan/put/request_schema.json#/propertyNames/examples/wirelessParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Wirelesslan Profile Parcel for Service feature profile", + "operationId": "DeleteWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wirelesslanId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-write" + } + }, + "/v1/feature-profile/sdwan/system": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanSystemFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN System Feature Profile", + "operationId": "CreateSdwanSystemFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-write" + } + }, + "/v1/feature-profile/sdwan/system/aaa/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Aaa Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemAaaParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/banner/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Banner Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemBannerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/basic/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Basic Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemBasicParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/bfd/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Bfd Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemBfdParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/global/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a Cedge System Global Parcel Schema by Schema Type", + "operationId": "GetCedgeSystemGlobalParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/logging/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Logging Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemLoggingParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/ntp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Ntp Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemNtpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/omp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Omp Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemOmpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/snmp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Snmp Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemSnmpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Feature Profile with systemId", + "operationId": "GetSdwanSystemFeatureProfileByProfileId", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN System Feature Profile", + "operationId": "EditSdwanSystemFeatureProfile", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanSystemFeatureProfile", + "parameters": [ + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/aaa": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Aaa Profile Parcels for System feature profile", + "operationId": "GetAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Aaa Profile Parcel for System feature profile", + "operationId": "CreateAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Aaa Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/aaa/post/request_schema.json" + }, + "examples": { + "CedgeSystemAAAParcelConfig": { + "$ref": "schema/profileparcel/sdwan/system/aaa/post/request_schema.json#/propertyNames/examples/CedgeSystemAAAParcelConfig" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Aaa Profile Parcel by parcelId for System feature profile", + "operationId": "GetAaaProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "aaaId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Aaa Profile Parcel for System feature profile", + "operationId": "EditAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "aaaId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Aaa Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/aaa/put/request_schema.json" + }, + "examples": { + "CedgeSystemAAAParcelConfig": { + "$ref": "schema/profileparcel/sdwan/system/aaa/put/request_schema.json#/propertyNames/examples/CedgeSystemAAAParcelConfig" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Aaa Profile Parcel for System feature profile", + "operationId": "DeleteAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "aaaId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/banner": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Banner Profile Parcels for System feature profile", + "operationId": "GetBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Banner Profile Parcel for System feature profile", + "operationId": "CreateBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Banner Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/banner/post/request_schema.json" + }, + "examples": { + "SystemBannerParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/system/banner/post/request_schema.json#/propertyNames/examples/SystemBannerParcelGlobalDefault" + }, + "SystemBannerParcelVariable": { + "$ref": "schema/profileparcel/sdwan/system/banner/post/request_schema.json#/propertyNames/examples/SystemBannerParcelVariable" + }, + "SystemBannerParcelDefaultGlobal": { + "$ref": "schema/profileparcel/sdwan/system/banner/post/request_schema.json#/propertyNames/examples/SystemBannerParcelDefaultGlobal" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Banner Profile Parcel by parcelId for System feature profile", + "operationId": "GetBannerProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bannerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Banner Profile Parcel for System feature profile", + "operationId": "EditBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bannerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Banner Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/banner/put/request_schema.json" + }, + "examples": { + "SystemBannerParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/system/banner/put/request_schema.json#/propertyNames/examples/SystemBannerParcelGlobalDefault" + }, + "SystemBannerParcelVariable": { + "$ref": "schema/profileparcel/sdwan/system/banner/put/request_schema.json#/propertyNames/examples/SystemBannerParcelVariable" + }, + "SystemBannerParcelDefaultGlobal": { + "$ref": "schema/profileparcel/sdwan/system/banner/put/request_schema.json#/propertyNames/examples/SystemBannerParcelDefaultGlobal" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Banner Profile Parcel for System feature profile", + "operationId": "DeleteBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bannerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/basic": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Basic Profile Parcels for System feature profile", + "operationId": "GetBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Basic Profile Parcel for System feature profile", + "operationId": "CreateBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/basic/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_basic_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/basic/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_basic_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Basic Profile Parcel by parcelId for System feature profile", + "operationId": "GetBasicProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "basicId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Basic Profile Parcel for System feature profile", + "operationId": "EditBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "basicId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/basic/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_basic_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/basic/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_basic_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Basic Profile Parcel for System feature profile", + "operationId": "DeleteBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "basicId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/bfd": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Bfd Profile Parcels for System feature profile", + "operationId": "GetBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Bfd Profile Parcel for System feature profile", + "operationId": "CreateBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Bfd Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/bfd/post/request_schema.json" + }, + "examples": { + "SystemBfdParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/system/bfd/post/request_schema.json#/propertyNames/examples/SystemBfdParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Bfd Profile Parcel by parcelId for System feature profile", + "operationId": "GetBfdProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bfdId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Bfd Profile Parcel for System feature profile", + "operationId": "EditBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bfdId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Bfd Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/bfd/put/request_schema.json" + }, + "examples": { + "SystemBfdParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/system/bfd/put/request_schema.json#/propertyNames/examples/SystemBfdParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Bfd Profile Parcel for System feature profile", + "operationId": "DeleteBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bfdId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/global": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Global Profile Parcels for System feature profile", + "operationId": "GetGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Global Profile Parcel for System feature profile", + "operationId": "CreateGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/global/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_Globalsettings_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/global/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Globalsettings_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post request example": { + "description": "post request example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Global Profile Parcel by parcelId for System feature profile", + "operationId": "GetGlobalProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "globalId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Global Profile Parcel for System feature profile", + "operationId": "EditGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "globalId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/global/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_Globalsettings_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/global/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Globalsettings_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Global Profile Parcel for System feature profile", + "operationId": "DeleteGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "globalId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/logging": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Logging Profile Parcels for System feature profile", + "operationId": "GetLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Logging Profile Parcel for System feature profile", + "operationId": "CreateLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Logging Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/logging/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_Logging_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/logging/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Logging_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Logging Profile Parcel by parcelId for System feature profile", + "operationId": "GetLoggingProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "loggingId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Logging Profile Parcel for System feature profile", + "operationId": "EditLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "loggingId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Logging Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/logging/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_Logging_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/logging/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Logging_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Logging Profile Parcel for System feature profile", + "operationId": "DeleteLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "loggingId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/ntp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Ntp Profile Parcels for System feature profile", + "operationId": "GetNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Ntp Profile Parcel for System feature profile", + "operationId": "CreateNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ntp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/ntp/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/sdwan/system/ntp/post/request_schema.json#/propertyNames/examples/example_1" + }, + "ntp_parcel_post1": { + "$ref": "schema/profileparcel/sdwan/system/ntp/post/request_schema.json#/propertyNames/examples/ntp_parcel_post1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Ntp Profile Parcel by parcelId for System feature profile", + "operationId": "GetNtpProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ntpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Ntp Profile Parcel for System feature profile", + "operationId": "EditNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ntpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ntp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/ntp/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/sdwan/system/ntp/put/request_schema.json#/propertyNames/examples/example_1" + }, + "ntp_parcel_put1": { + "$ref": "schema/profileparcel/sdwan/system/ntp/put/request_schema.json#/propertyNames/examples/ntp_parcel_put1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Ntp Profile Parcel for System feature profile", + "operationId": "DeleteNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ntpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/omp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Omp Profile Parcels for System feature profile", + "operationId": "GetOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Omp Profile Parcel for System feature profile", + "operationId": "CreateOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Omp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/omp/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_omp_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/omp/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_omp_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Omp Profile Parcel by parcelId for System feature profile", + "operationId": "GetOmpProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ompId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Omp Profile Parcel for System feature profile", + "operationId": "EditOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ompId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Omp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/omp/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_System_omp_parcel1": { + "$ref": "schema/profileparcel/sdwan/system/omp/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_omp_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Omp Profile Parcel for System feature profile", + "operationId": "DeleteOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ompId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/snmp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Snmp Profile Parcels for System feature profile", + "operationId": "GetSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Snmp Profile Parcel for System feature profile", + "operationId": "CreateSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Snmp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/snmp/post/request_schema.json" + }, + "examples": { + "SNMPParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/system/snmp/post/request_schema.json#/propertyNames/examples/SNMPParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Snmp Profile Parcel by parcelId for System feature profile", + "operationId": "GetSnmpProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "snmpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Snmp Profile Parcel for System feature profile", + "operationId": "EditSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "snmpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Snmp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/system/snmp/put/request_schema.json" + }, + "examples": { + "SNMPParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/system/snmp/put/request_schema.json#/propertyNames/examples/SNMPParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Snmp Profile Parcel for System feature profile", + "operationId": "DeleteSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "snmpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-write" + } + }, + "/v1/feature-profile/sdwan/transport": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanTransportFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Transport Feature Profile", + "operationId": "CreateSdwanTransportFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-write" + } + }, + "/v1/feature-profile/sdwan/transport/cellular-controller/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport CellularController Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportCellularControllerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/cellular-profile/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport CellularProfile Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportCellularProfileParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport ManagementVpn InterfaceEthernet Schema by Schema Type", + "operationId": "GetSdwanTransportManagementVpnInterfaceEthernetParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/management/vpn/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport ManagementVpn Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportManagementVpnParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/routing/bgp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport RoutingBgp Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportRoutingBgpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/tracker/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport Tracker Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportTrackerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport WanVpn CellularInterface Schema by Schema Type", + "operationId": "GetSdwanTransportWanVpnCellularInterfaceParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport WanVpn InterfaceEthernet Schema by Schema Type", + "operationId": "GetSdwanTransportWanVpnInterfaceEthernetParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/wan/vpn/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport WanVpn Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportWanVpnParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport Feature Profile with transportId", + "operationId": "GetSdwanTransportFeatureProfileByProfileId", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Transport Feature Profile", + "operationId": "EditSdwanTransportFeatureProfile", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/request_schema.json" + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + "$ref": "schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/featureprofile/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanTransportFeatureProfile", + "parameters": [ + { + "name": "transportId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Controller Profile Parcels for Transport feature profile", + "operationId": "GetCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Cellular Controller Profile Parcel for Transport feature profile", + "operationId": "CreateCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Controller Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-controller/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_CellularController_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-controller/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularController_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Controller Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetCellularControllerProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Cellular Controller Profile Parcel for Transport feature profile", + "operationId": "EditCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Controller Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-controller/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_CellularController_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-controller/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularController_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Cellular Controller Profile Parcel for Transport feature profile", + "operationId": "DeleteCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get CellularController associated Cellular Profile Parcels for transport feature profile", + "operationId": "GetCellularControllerAssociatedCellularProfileParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a cellularcontroller parcel with a cellularprofile Parcel for transport feature profile", + "operationId": "CreateCellularControllerAndCellularProfileParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Cellular Controller Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get CellularController parcel associated CellularProfile Parcel by cellularProfileId for transport feature profile", + "operationId": "GetCellularControllerAssociatedCellularProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Cellular Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a CellularController parcel and a CellularProfile Parcel association for transport feature profile", + "operationId": "EditCellularControllerAndCellularProfileParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Cellular Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a CellularController parcel and a CellularProfile Parcel association for transport feature profile", + "operationId": "DeleteCellularControllerAndCellularProfileAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Cellular Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Profile Profile Parcels for Transport feature profile", + "operationId": "GetCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Cellular Profile Profile Parcel for Transport feature profile", + "operationId": "CreateCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-profile/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_CellularProfile_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-profile/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularProfile_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Profile Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetCellularProfileProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Cellular Profile Profile Parcel for Transport feature profile", + "operationId": "EditCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-profile/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_CellularProfile_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/cellular-profile/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularProfile_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Cellular Profile Profile Parcel for Transport feature profile", + "operationId": "DeleteCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Management Vpn Profile Parcels for Transport feature profile", + "operationId": "GetManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Management Vpn Profile Parcel for Transport feature profile", + "operationId": "CreateManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_Management_Vpn_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Management_Vpn_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Management Vpn Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetManagementVpnProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Management Vpn Profile Parcel for Transport feature profile", + "operationId": "EditManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_Management_Vpn_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Management_Vpn_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Management Vpn Profile Parcel for Transport feature profile", + "operationId": "DeleteManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceEthernet Parcels for transport ManagementVpn Parcel", + "operationId": "GetInterfaceEthernetParcelsForTransportManagementVpn", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a ManagementVpn InterfaceEthernet parcel for transport feature profile", + "operationId": "CreateManagementVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/post/request_schema.json" + }, + "examples": { + "TransportManagementVpnInterfaceEthernetParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/post/request_schema.json#/propertyNames/examples/TransportManagementVpnInterfaceEthernetParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get ManagementVpn InterfaceEthernet Parcel by ethernetId for transport feature profile", + "operationId": "GetManagementVpnInterfaceEthernetParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a ManagementVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "EditManagementVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/put/request_schema.json" + }, + "examples": { + "TransportManagementVpnInterfaceEthernetParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/put/request_schema.json#/propertyNames/examples/TransportManagementVpnInterfaceEthernetParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a ManagementVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "DeleteManagementVpnInterfaceEthernetForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcels for Transport feature profile", + "operationId": "GetRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Routing Bgp Profile Parcel for Transport feature profile", + "operationId": "CreateRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/routing/bgp/post/request_schema.json" + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/routing/bgp/post/request_schema.json#/propertyNames/examples/ServiceBgpParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetRoutingBgpProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Routing Bgp Profile Parcel for Transport feature profile", + "operationId": "EditRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/routing/bgp/put/request_schema.json" + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/routing/bgp/put/request_schema.json#/propertyNames/examples/ServiceBgpParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Routing Bgp Profile Parcel for Transport feature profile", + "operationId": "DeleteRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/tracker": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Tracker Profile Parcels for Transport feature profile", + "operationId": "GetTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Tracker Profile Parcel for Transport feature profile", + "operationId": "CreateTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/tracker/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_Tracker_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/tracker/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Tracker_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Tracker Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetTrackerProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Tracker Profile Parcel for Transport feature profile", + "operationId": "EditTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/tracker/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_Tracker_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/tracker/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Tracker_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Tracker Profile Parcel for Transport feature profile", + "operationId": "DeleteTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wan Vpn Profile Parcels for Transport feature profile", + "operationId": "GetWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Wan Vpn Profile Parcel for Transport feature profile", + "operationId": "CreateWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/post/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_Wan_Vpn_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Wan_Vpn_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wan Vpn Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetWanVpnProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Wan Vpn Profile Parcel for Transport feature profile", + "operationId": "EditWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/put/request_schema.json" + }, + "examples": { + "Cedge_CG1_Transport_Wan_Vpn_parcel1": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Wan_Vpn_parcel1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Wan Vpn Profile Parcel for Transport feature profile", + "operationId": "DeleteWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Interface Cellular Parcels for transport Wan Vpn Parcel", + "operationId": "GetInterfaceCellularParcelsForTransportWanVpn", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a wanvpn Cellular interface Parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceCellularParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "WanVpn Interface Cellular Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/post/request_schema.json" + }, + "examples": { + "TransportWanVpnInterfaceCellularParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/post/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceCellularParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "parcelId": { + "description": "parcelId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceCellular associated Tracker Parcels for transport feature profile", + "operationId": "GetWanVpnInterfaceCellularAssociatedTrackerParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-read" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceCellular associated Tracker Parcel by trackerId for transport feature profile", + "operationId": "GetWanVpnInterfaceCellularAssociatedTrackerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpnInterfaceCellular parcel and a Tracker Parcel association for transport feature profile", + "operationId": "EditWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpnInterfaceCellular and a Tracker Parcel association for transport feature profile", + "operationId": "DeleteWanVpnInterfaceCellularAndTrackerAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get wanvpn Cellular interface Parcel by intfId for transport feature profile", + "operationId": "GetWanVpnInterfaceCellularParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "intfId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a wanvpn Cellular Interface Parcel for transport feature profile", + "operationId": "EditWanVpnInterfaceCellularParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "intfId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "WanVpn Cellular Interface Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/put/request_schema.json" + }, + "examples": { + "TransportWanVpnInterfaceCellularParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/put/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceCellularParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "parcelId": { + "description": "parcelId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a wanvpn Cellular interface Parcel for transport feature profile", + "operationId": "DeleteWanVpnInterfaceCellularForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "intfId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceEthernet Parcels for transport WanVpn Parcel", + "operationId": "GetInterfaceEthernetParcelsForTransportWanVpn", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a WanVpn InterfaceEthernet parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/post/request_schema.json" + }, + "examples": { + "TransportWanVpnInterfaceEthernetParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/post/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceEthernetParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "WanVpn Interface Ethernet Parcel For Transport Feature Profile": { + "description": "WanVpn Interface Ethernet Parcel For Transport Feature Profile", + "value": { + "data": { + "shutdown": { + "optionType": "global", + "value": false + }, + "interfaceName": { + "optionType": "variable", + "variableName": "{{wan_int_0}}" + }, + "description": { + "optionType": "global", + "value": "WAN Interface - Internet" + }, + "blockNonSourceIp": { + "optionType": "default", + "value": false + }, + "autoDetectBandwidth": { + "optionType": "default", + "value": false + }, + "tunnelInterface": { + "optionType": "global", + "value": true + }, + "tunnel": { + "perTunnelQos": { + "optionType": "default", + "value": false + }, + "color": { + "optionType": "default", + "value": "mpls" + }, + "restrict": { + "optionType": "default", + "value": false + }, + "group": { + "optionType": "default" + }, + "border": { + "optionType": "default", + "value": false + }, + "maxControlConnections": { + "optionType": "default" + }, + "vBondAsStunServer": { + "optionType": "default", + "value": false + }, + "excludeControllerGroupList": { + "optionType": "default" + }, + "vManageConnectionPreference": { + "optionType": "default", + "value": 5 + }, + "portHop": { + "optionType": "default", + "value": true + }, + "lowBandwidthLink": { + "optionType": "default", + "value": false + }, + "tunnelTcpMss": { + "optionType": "default" + }, + "clearDontFragment": { + "optionType": "default", + "value": false + }, + "ctsSgtPropagation": { + "optionType": "default", + "value": false + }, + "networkBroadcast": { + "optionType": "default", + "value": false + } + }, + "allowService": { + "all": { + "optionType": "default", + "value": false + }, + "bgp": { + "optionType": "default", + "value": false + }, + "dhcp": { + "optionType": "default", + "value": true + }, + "ntp": { + "optionType": "default", + "value": true + }, + "ssh": { + "optionType": "default", + "value": true + }, + "dns": { + "optionType": "default", + "value": true + }, + "icmp": { + "optionType": "default", + "value": true + }, + "https": { + "optionType": "default", + "value": true + }, + "ospf": { + "optionType": "default", + "value": false + }, + "stun": { + "optionType": "default", + "value": false + }, + "snmp": { + "optionType": "default", + "value": false + }, + "netconf": { + "optionType": "default", + "value": false + }, + "bfd": { + "optionType": "default", + "value": false + } + }, + "nat": { + "optionType": "default", + "value": false + }, + "intfIpAddress": { + "static": { + "staticIpV4AddressPrimary": { + "ipAddress": { + "optionType": "global", + "value": "3.3.3.3" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + "staticIpV4AddressSecondary": [ + { + "ipAddress": { + "optionType": "global", + "value": "1.1.1.1" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + { + "ipAddress": { + "optionType": "global", + "value": "2.2.2.2" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + } + ] + } + }, + "dhcpHelper": { + "optionType": "global", + "value": [ + "1.2.3.4" + ] + }, + "intfIpV6Address": { + "static": { + "primaryIpV6Address": { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.1/24" + } + } + } + }, + "natIpv6": { + "optionType": "global", + "value": true + }, + "natAttributesIpv6": { + "nat64": { + "optionType": "global", + "value": false + }, + "nat66": { + "optionType": "global", + "value": true + }, + "staticNat66": [ + { + "sourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.5/24" + }, + "translatedSourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.6/24" + }, + "sourceVpnId": { + "optionType": "global", + "value": 0 + } + } + ] + }, + "encapsulation": [ + { + "encap": { + "optionType": "global", + "value": "ipsec" + }, + "weight": { + "optionType": "default", + "value": 1 + }, + "preference": { + "optionType": "default" + } + } + ] + }, + "name": "Internet", + "description": "Internet" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpn InterfaceEthernet Parcel by ethernetId for transport feature profile", + "operationId": "GetWanVpnInterfaceEthernetParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "EditWanVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/put/request_schema.json" + }, + "examples": { + "TransportWanVpnInterfaceEthernetParcelGlobalDefault": { + "$ref": "schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/put/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceEthernetParcelGlobalDefault" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "DeleteWanVpnInterfaceEthernetForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceEthernet associated Tracker Parcels for transport feature profile", + "operationId": "GetWanVpnInterfaceEthernetAssociatedTrackerParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceEthernet associated Tracker Parcel by trackerId for transport feature profile", + "operationId": "GetWanVpnInterfaceEthernetAssociatedTrackerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpnInterfaceEthernet parcel and a Tracker Parcel association for transport feature profile", + "operationId": "EditWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpnInterfaceEthernet and a Tracker Parcel association for transport feature profile", + "operationId": "DeleteWanVpnInterfaceEthernetAndTrackerAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpn associated Routing Bgp Parcels for transport feature profile", + "operationId": "GetWanVpnAssociatedRoutingBgpParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a wanvpn parcel with a routingbgp Parcel for transport feature profile", + "operationId": "CreateWanVpnAndRoutingBgpParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Wan Vpn Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpn parcel associated RoutingBgp Parcel by bgpId for transport feature profile", + "operationId": "GetWanVpnAssociatedRoutingBgpParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile", + "operationId": "EditWanVpnAndRoutingBgpParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/put/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile", + "operationId": "DeleteWanVpnAndRoutingBgpAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a WanVpnInterfaceCellular parcel with a Tracker Parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a WanVpnInterfaceEthernet parcel with a Tracker Parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel Id", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/request_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "schema/profileparcel/common/post/response_schema.json" + }, + "examples": { + "example_1": { + "$ref": "schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write" + } + }, + "/webex/datacenter": { + "post": { + "tags": [ + "System - Cloud Service Webex" + ], + "description": "TEMP-Insert webex data center details manually for test setup", + "operationId": "getWebexDataCenters", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": { + "config": { + "version": "1.0.0", + "revision": "20210412.b444544", + "items": [ + { + "region": { + "name": "eu-central-2", + "id": 11 + }, + "prefixes": { + "owned": [ + "23.89.96.0/20", + "170.72.0.0/21", + "170.72.8.0/21" + ] + } + }, + { + "region": { + "name": "ap-east-1", + "id": 22 + }, + "prefixes": { + "owned": [ + "114.29.200.0/23" + ] + } + } + ] + }, + "ETag": "vmanagemockwebexetag" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "System - Cloud Service" + ], + "description": "Delete webex data center data in DB", + "operationId": "deleteWebexDataCenters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/webex/datacenter/sync": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "TEMP-Update webex data center data in DB with data from Webex API", + "operationId": "updateWebexDataCenters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/webex/datacenter/syncstatus": { + "get": { + "tags": [ + "System - Cloud Service Webex" + ], + "description": "Get webex data center sync status from DB", + "operationId": "getWebexDataCentersSyncStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "System - Cloud Service" + ], + "description": "Set webex data center sync needed to false", + "operationId": "setWebexDataCentersSyncStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/workflow": { + "get": { + "tags": [ + "Workflow - Management" + ], + "description": "List all workflows for the given tenant", + "operationId": "getWorkflows", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Workflow type", + "schema": { + "type": "string" + } + }, + { + "name": "id", + "in": "query", + "description": "Workflow id", + "schema": { + "type": "string" + } + }, + { + "name": "group-id", + "in": "query", + "description": "group id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Workflows": { + "description": "Workflows", + "value": { + "workflows": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-read,Workflows-write" + }, + "put": { + "tags": [ + "Workflow - Management" + ], + "description": "Saves the workflow", + "operationId": "saveWorkflow", + "requestBody": { + "description": "Request to save already created workflow with given user context", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Workflow": { + "description": "Workflow", + "value": { + "id": "3f4aa8c0-1342-4a7d-846d-a9b209925d29", + "type": "ux_user_workflow", + "userContext": { + "key1": "value1" + }, + "activities": { + "activity-1": { + "type": "ux_user_workflow", + "userContext": { + "key1": "value1" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write" + }, + "post": { + "tags": [ + "Workflow - Management" + ], + "description": "Creates a workflow in the system", + "operationId": "createWorkflow", + "requestBody": { + "description": "Request to create workflow with given user context", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Workflow": { + "description": "Workflow", + "value": { + "type": "ux_user_workflow", + "userContext": { + "key1": "value1" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write" + }, + "delete": { + "tags": [ + "Workflow - Management" + ], + "description": "Deletes the workflow", + "operationId": "deleteWorkflow", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Workflow id", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request to delete the workflow", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write" + } + } + }, + "components": { + "schemas": { + "AckUplodFile": { + "type": "object", + "properties": { + "data": { + "type": "string", + "format": "binary" + } + } + }, + "AdvancedRadioSetting": { + "type": "object", + "properties": { + "channelPowerSettings": { + "$ref": "#/components/schemas/ChannelPowerSettings" + }, + "countryRegionSettings": { + "$ref": "#/components/schemas/CountryRegionSettings" + } + } + }, + "ApiReKeyDevice": { + "type": "object", + "properties": { + "deviceId": { + "type": "string" + } + } + }, + "ApiReKeyDeviceList": { + "type": "object", + "properties": { + "deviceList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiReKeyDevice" + } + } + } + }, + "AwsIamCredentials": { + "type": "object", + "properties": { + "externalId": { + "type": "string" + }, + "roleArn": { + "type": "string" + } + } + }, + "AwsKeyCredentials": { + "type": "object", + "properties": { + "apiKey": { + "type": "string" + }, + "secretKey": { + "type": "string" + } + } + }, + "AzureCredentials": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "cloudTenantId": { + "type": "string" + }, + "secretKey": { + "type": "string" + }, + "subscriptionId": { + "type": "string" + } + } + }, + "Banner": { + "type": "object", + "properties": { + "loginMessage": { + "type": "string" + }, + "motd": { + "type": "string" + } + } + }, + "Bfd": { + "type": "object", + "properties": { + "bfdTimerOnTransportTunnels": { + "$ref": "#/components/schemas/BfdTimerOnTransportTunnels" + }, + "dscpForBfdPackets": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pollInterval": { + "type": "integer", + "format": "int32" + } + } + }, + "BfdTimerOnTransportTunnels": { + "type": "object", + "properties": { + "bizInternetTimer": { + "$ref": "#/components/schemas/BizInternetTimer" + }, + "lteTimer": { + "$ref": "#/components/schemas/LteTimer" + }, + "mplsTimer": { + "$ref": "#/components/schemas/MplsTimer" + }, + "publicInternetTimer": { + "$ref": "#/components/schemas/PublicInternetTimer" + } + } + }, + "BizInternetTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "Cellular": { + "required": [ + "name", + "primarySlot", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "simSlot0": { + "$ref": "#/components/schemas/SimSlotConfig" + }, + "simSlot1": { + "$ref": "#/components/schemas/SimSlotConfig" + }, + "primarySlot": { + "maximum": 1, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "wanConfig": { + "pattern": "(^Active$|^Standby$)", + "type": "string" + } + } + } + ] + }, + "CellularProfile": { + "type": "object", + "properties": { + "apn": { + "type": "string" + }, + "authMethod": { + "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", + "type": "string" + }, + "id": { + "maximum": 16, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "password": { + "type": "string" + }, + "pdnType": { + "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", + "type": "string" + }, + "userName": { + "type": "string" + } + } + }, + "CertificateStates": { + "type": "object", + "properties": { + "certificateTypes": { + "type": "string" + } + }, + "description": "This is valid Certificate States " + }, + "CertificateValidity": { + "type": "object", + "properties": { + "certificateValidity": { + "type": "string" + } + }, + "description": "This is Certificate Validity " + }, + "ChannelPowerSettings": { + "type": "object", + "properties": { + "radioBand2Dot4Ghz": { + "$ref": "#/components/schemas/RadioBandSetting_2_4G" + }, + "radioBand5Ghz": { + "$ref": "#/components/schemas/RadioBandSetting_5G" + } + } + }, + "ConfigGroup": { + "required": [ + "name", + "solution", + "state", + "version" + ], + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "User who last created this.", + "readOnly": true + }, + "createdOn": { + "type": "integer", + "description": "Timestamp of creation", + "format": "int64", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the Config Group.", + "example": "Config group for west coast retail stores" + }, + "devices": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "description": "System generated unique identifier of the Config Group in UUID format.", + "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" + }, + "lastUpdatedBy": { + "type": "string", + "description": "User who last updated this.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "integer", + "description": "Timestamp of last update", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the Config Group. Must be unique.", + "example": "West coast retail stores" + }, + "numberOfDevices": { + "type": "integer", + "format": "int64" + }, + "numberOfDevicesUpToDate": { + "type": "integer", + "format": "int64" + }, + "profiles": { + "type": "array", + "description": "List of devices UUIDs associated with this config group", + "example": "West coast retail store devices", + "items": { + "$ref": "#/components/schemas/FeatureProfile" + } + }, + "solution": { + "type": "string", + "description": "Specify one of the device platform solution", + "example": "Mobility", + "enum": [ + "mobility", + "sdwan", + "common" + ] + }, + "source": { + "type": "string", + "description": "Source of config-group", + "example": "retail_workflow" + }, + "state": { + "type": "string", + "description": "Config Group Deployment state", + "example": "Config Group Deployment state.Initial state Deployed " + }, + "version": { + "type": "integer", + "description": "Config Group Version Flag", + "format": "int64" + } + } + }, + "ConnectToNtpServer": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string" + }, + "vpn": { + "type": "string" + } + } + }, + "ControlStatus": { + "type": "object", + "properties": { + "controlDown": { + "type": "integer", + "format": "int32" + }, + "controlUp": { + "type": "integer", + "format": "int32" + }, + "partial": { + "type": "integer", + "format": "int32" + } + } + }, + "CorporateWifi": { + "type": "object", + "properties": { + "corporateWlan": { + "type": "boolean" + }, + "radiusServer": { + "$ref": "#/components/schemas/RadiusServer" + }, + "securityAuthType": { + "pattern": "(WPA2-PSK_AES|WPA2-Enterprise)", + "type": "string" + }, + "ssid": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "visibility": { + "type": "boolean" + }, + "wpaPskKey": { + "type": "string" + } + } + }, + "CountryRegionSettings": { + "type": "object", + "properties": { + "countryRegion": { + "type": "string" + }, + "regulatoryDomain": { + "pattern": "(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)", + "type": "string" + } + } + }, + "CreateDeviceParams": { + "type": "object", + "properties": { + "deviceIP": { + "type": "string" + }, + "generateCSR": { + "type": "boolean" + }, + "password": { + "type": "string" + }, + "personality": { + "type": "string" + }, + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "CreateTenantModel": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "getvBondAddress": { + "type": "string" + }, + "getvSmarts": { + "type": "array", + "items": { + "type": "string" + } + }, + "idpMetadata": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "oldIdpMetadata": { + "type": "string" + }, + "orgName": { + "type": "string" + }, + "spMetadata": { + "type": "string" + }, + "subDomain": { + "type": "string" + }, + "wanEdgeForecast": { + "type": "string" + } + } + }, + "DHCPPool": { + "required": [ + "leaseTimeDay", + "leaseTimeHour", + "leaseTimeMin", + "poolNetwork" + ], + "type": "object", + "properties": { + "leaseTimeDay": { + "maximum": 365, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "leaseTimeHour": { + "maximum": 23, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "leaseTimeMin": { + "maximum": 59, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "poolNetwork": { + "type": "string" + } + } + }, + "DataCenter": { + "type": "object", + "properties": { + "dcPersonality": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Node" + } + }, + "mgmtIPAddress": { + "type": "string" + }, + "name": { + "type": "string" + }, + "nmsPersonality": { + "type": "string" + }, + "password": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "DataCenterRegistration": { + "type": "object", + "properties": { + "clusterEncKey": { + "type": "string" + }, + "clusterEnvKey": { + "type": "string", + "writeOnly": true + }, + "dataCenters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataCenter" + } + }, + "disasterRecoverySettings": { + "$ref": "#/components/schemas/DisasterRecoverySettings" + }, + "host": { + "$ref": "#/components/schemas/Host" + }, + "vbonds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Node" + } + }, + "vmanageRootCA": { + "type": "string" + } + } + }, + "DeleteTenantBulkModel": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "tenantIdList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DeleteTenantModel": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + } + }, + "Device": { + "type": "object", + "properties": { + "deviceType": { + "type": "string" + }, + "systemIp": { + "type": "string" + }, + "uuid": { + "type": "string" + } + }, + "description": "API model encapsulating device information" + }, + "DeviceHealthDetails": { + "type": "object", + "properties": { + "bfd_sessions": { + "type": "integer", + "format": "int32" + }, + "bfd_sessions_up": { + "type": "integer", + "format": "int32" + }, + "board_serial_number": { + "type": "string" + }, + "chassis_number": { + "type": "string" + }, + "connected_vmanages": { + "type": "array", + "items": { + "type": "string" + } + }, + "controlConnectionsToVsmat": { + "$ref": "#/components/schemas/DeviceHealthDetails" + }, + "control_connections": { + "type": "integer", + "format": "int32" + }, + "control_connections_up": { + "type": "integer", + "format": "int32" + }, + "cpu_load": { + "type": "number", + "format": "double" + }, + "device_groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "device_model": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "expected_vsmart_connections": { + "type": "integer", + "format": "int32" + }, + "has_geo_data": { + "type": "boolean" + }, + "health": { + "type": "string", + "enum": [ + "red", + "yellow", + "green" + ] + }, + "latitude": { + "type": "string" + }, + "local_system_ip": { + "type": "string" + }, + "location": { + "type": "string" + }, + "longitude": { + "type": "string" + }, + "memory_utilization": { + "type": "number", + "format": "double" + }, + "name": { + "type": "string" + }, + "omp_peers": { + "type": "integer", + "format": "int64" + }, + "omp_peers_up": { + "type": "integer", + "format": "int64" + }, + "personality": { + "type": "string" + }, + "qoe": { + "type": "integer", + "format": "int32" + }, + "reachability": { + "type": "string" + }, + "site_id": { + "type": "string" + }, + "software_version": { + "type": "string" + }, + "system_ip": { + "type": "string" + }, + "uptime_date": { + "type": "integer", + "format": "int64" + }, + "uuid": { + "type": "string" + }, + "vpn_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "vsmart_control_connections": { + "type": "integer", + "format": "int32" + } + } + }, + "DeviceIP": { + "type": "object", + "properties": { + "deviceIp": { + "type": "string" + } + }, + "description": "This is the valid DeviceIP" + }, + "DeviceModel": { + "type": "object", + "properties": { + "deviceModel": { + "type": "string" + } + }, + "description": "This is the valid DeviceModel " + }, + "DeviceType": { + "type": "object", + "properties": { + "deviceType": { + "type": "string" + } + }, + "description": "This is valid device type " + }, + "DeviceUuid": { + "type": "object", + "properties": { + "deviceUuid": { + "type": "string" + } + }, + "description": "This is valid DeviceUuid" + }, + "DevicesHealth": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceHealthDetails" + } + }, + "header": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "total_devices": { + "type": "integer", + "format": "int32" + } + } + }, + "DevicesHealthOverview": { + "type": "object", + "properties": { + "fair": { + "type": "integer", + "format": "int32" + }, + "good": { + "type": "integer", + "format": "int32" + }, + "poor": { + "type": "integer", + "format": "int32" + } + } + }, + "DisasterRecoverySettings": { + "type": "object", + "properties": { + "delayThreshold": { + "type": "integer", + "format": "int32" + }, + "drPaused": { + "type": "boolean" + }, + "ignoredIndexes": { + "type": "array", + "items": { + "type": "string" + } + }, + "interval": { + "type": "integer", + "format": "int32" + }, + "intervalModified": { + "type": "boolean" + }, + "pauseDR": { + "$ref": "#/components/schemas/DisasterRecoverySettings" + }, + "pauseReplication": { + "type": "boolean" + }, + "startTime": { + "type": "string" + } + } + }, + "DomainDetail": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "resolvedIp": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EntityOwnershipInfo": { + "type": "object", + "properties": { + "bucket": { + "type": "string" + }, + "entityName": { + "type": "string" + }, + "owner": { + "type": "string" + } + } + }, + "EquinixCredentials": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + } + } + }, + "EquinixLocationInfo": { + "type": "object", + "properties": { + "eqBillingAccountInfoList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiCloudEdgeBillingAccountInfo" + } + }, + "eqNEInfo": { + "$ref": "#/components/schemas/EquinixNEInfo" + }, + "metroCode": { + "type": "string" + }, + "metroName": { + "type": "string" + }, + "networkRegion": { + "type": "string" + }, + "siteCode": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "EquinixNEInfo": { + "type": "object", + "properties": { + "imageNameList": { + "type": "array", + "items": { + "type": "string" + } + }, + "productSizeList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EquinixPartnerPort": { + "type": "object", + "properties": { + "authorizationKey": { + "type": "string" + }, + "companyUid": { + "type": "string" + }, + "connectType": { + "type": "string" + }, + "productUid": { + "type": "string" + }, + "speed": { + "type": "string" + }, + "vxcId": { + "type": "string" + }, + "vxcPermitted": { + "type": "boolean" + } + } + }, + "Ethernet": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "ethernetInterfaceList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EthernetInterface" + } + } + } + } + ] + }, + "EthernetInterface": { + "type": "object", + "properties": { + "adminState": { + "pattern": "(enabled|disabled)", + "type": "string" + }, + "corporateLan": { + "type": "boolean" + }, + "interfaceName": { + "type": "string" + }, + "ipAssignment": { + "pattern": "(dynamic|static)", + "type": "string" + }, + "portType": { + "pattern": "(LAN|WAN)", + "type": "string" + }, + "staticIpAddress": { + "type": "string" + }, + "staticIpAddressSubnetMask": { + "type": "string" + }, + "staticRouteIp": { + "type": "string" + }, + "wanConfiguration": { + "pattern": "(Active)", + "type": "string" + } + } + }, + "EventName": { + "type": "object", + "properties": { + "eventName": { + "type": "string" + } + }, + "description": "This is valid eventName" + }, + "FeatureProfile": { + "required": [ + "name", + "solution", + "type" + ], + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "User who last created this.", + "readOnly": true + }, + "createdOn": { + "type": "integer", + "description": "Timestamp of creation", + "format": "int64", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the feature Profile.", + "example": "Profile file description" + }, + "id": { + "type": "string", + "description": "System generated unique identifier of the feature profile in UUID format.", + "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" + }, + "lastUpdatedBy": { + "type": "string", + "description": "User who last updated this.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "integer", + "description": "Timestamp of last update", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the feature Profile. Must be unique.", + "example": "system feature profile" + }, + "solution": { + "type": "string", + "description": "Solution of the feature Profile.", + "example": "sdwan" + }, + "type": { + "type": "string", + "description": "Type of the feature Profile.", + "example": "system" + } + }, + "description": "List of devices UUIDs associated with this config group", + "example": "West coast retail store devices" + }, + "GcpCredentials": { + "type": "object", + "properties": { + "client_email": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "cloudTenantId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "privateKeyData": { + "type": "string" + }, + "private_key": { + "type": "string" + }, + "private_key_id": { + "type": "string" + }, + "project_id": { + "type": "string" + } + } + }, + "GlobalSettings": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "basicName": { + "type": "string" + }, + "basicDescription": { + "type": "string" + }, + "ntpServer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectToNtpServer" + } + }, + "systems": { + "$ref": "#/components/schemas/Systems" + }, + "banner": { + "$ref": "#/components/schemas/Banner" + }, + "loginAccessToRouter": { + "$ref": "#/components/schemas/LoginAccessToRouter" + }, + "bfd": { + "$ref": "#/components/schemas/Bfd" + }, + "omp": { + "$ref": "#/components/schemas/OMP" + }, + "ipSecSecurity": { + "$ref": "#/components/schemas/IpSecSecurity" + }, + "loggingSystemMessages": { + "$ref": "#/components/schemas/LoggingSystemMessages" + } + } + } + ] + }, + "GroupId": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + } + }, + "description": "This is the valid GroupId" + }, + "GuestWifi": { + "type": "object", + "properties": { + "securityAuthType": { + "pattern": "(OPEN|WPA2-PSK_AES)", + "type": "string" + }, + "ssid": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "visibility": { + "type": "boolean" + }, + "wpaPskKey": { + "type": "string" + } + } + }, + "Header": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HeaderElement" + } + }, + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "HeaderElement": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "parameterCount": { + "type": "integer", + "format": "int32" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NameValuePair" + } + }, + "value": { + "type": "string" + } + } + }, + "Host": { + "type": "object", + "properties": { + "dataCenterName": { + "type": "string" + }, + "dcPersonality": { + "type": "string" + }, + "ifname": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "name": { + "type": "string" + }, + "serialno": { + "type": "string" + } + } + }, + "IkePhase": { + "required": [ + "cipherSuite" + ], + "type": "object", + "properties": { + "cipherSuite": { + "pattern": "(aes128-cbc-sha1|aes256-cbc-sha1|aes128-cbc-sha2|aes256-cbc-sha2)", + "type": "string" + }, + "diffeHellmanGroup": { + "pattern": "(14|15|16|19|20|21)", + "type": "string" + }, + "ikeVersion": { + "maximum": 2, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "rekeyTimer": { + "maximum": 1209600, + "minimum": 300, + "type": "integer", + "format": "int32" + } + } + }, + "IpSecPolicy": { + "required": [ + "ikePhase1", + "ikePhase2CipherSuite" + ], + "type": "object", + "properties": { + "ikePhase1": { + "$ref": "#/components/schemas/IkePhase" + }, + "ikePhase2CipherSuite": { + "pattern": "(aes128-sha1|aes256-cbc-sha1|aes256-gcm|null-sha|aes256-cbc-sha256|aes256-cbc-sha384|aes256-cbc-sha512)", + "type": "string" + }, + "preset": { + "type": "string" + } + } + }, + "IpSecSecurity": { + "type": "object", + "properties": { + "authenticationType": { + "pattern": "(ah-sha1-hmac|sha1-hmac)", + "type": "string" + }, + "ipSecPairwiseKeying": { + "type": "string" + }, + "rekeyTime": { + "type": "integer", + "format": "int32" + }, + "replayWindow": { + "type": "integer", + "format": "int32" + } + } + }, + "LicenseUplodFile": { + "type": "object", + "properties": { + "data": { + "type": "string" + }, + "name": { + "type": "string", + "format": "binary" + } + } + }, + "LoggingSystemMessages": { + "type": "object", + "properties": { + "maxFileSize": { + "type": "integer", + "format": "int32" + }, + "priority": { + "type": "string" + }, + "rotations": { + "type": "integer", + "format": "int32" + } + } + }, + "LoginAccessToRouter": { + "type": "object", + "properties": { + "authenticationOrder": { + "type": "string" + }, + "localPassword": { + "type": "string" + }, + "localUser": { + "type": "string" + } + } + }, + "LteTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "MegaportCredentials": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "MegaportLocationInfo": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "country": { + "type": "string" + }, + "liveDate": { + "type": "string" + }, + "market": { + "type": "string" + }, + "metroName": { + "type": "string" + }, + "mpMVEInfo": { + "$ref": "#/components/schemas/MegaportMVEInfo" + }, + "networkRegion": { + "type": "string" + }, + "siteCode": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "MegaportMVEInfo": { + "type": "object", + "properties": { + "imageNameList": { + "type": "array", + "items": { + "type": "string" + } + }, + "productSizeList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MegaportPartnerPort": { + "type": "object", + "properties": { + "authorizationKey": { + "type": "string" + }, + "companyUid": { + "type": "string" + }, + "connectType": { + "type": "string" + }, + "productUid": { + "type": "string" + }, + "speed": { + "type": "string" + }, + "vxcId": { + "type": "string" + }, + "vxcPermitted": { + "type": "boolean" + } + } + }, + "MplsTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "MultiCloudAccountInfo": { + "type": "object", + "properties": { + "accountCredentials": { + "type": "string" + }, + "accountId": { + "type": "string" + }, + "accountName": { + "type": "string" + }, + "awsCloudGatewayWithTvpcEnabled": { + "type": "boolean" + }, + "awsIamCredentials": { + "$ref": "#/components/schemas/AwsIamCredentials" + }, + "awsKeyCredentials": { + "$ref": "#/components/schemas/AwsKeyCredentials" + }, + "azO365Enabled": { + "type": "boolean" + }, + "azureCredentials": { + "$ref": "#/components/schemas/AzureCredentials" + }, + "clientEmail": { + "type": "string" + }, + "cloudGatewayEnabled": { + "type": "boolean" + }, + "cloudType": { + "type": "string" + }, + "credType": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gcpBillingId": { + "type": "string" + }, + "gcpCredentials": { + "$ref": "#/components/schemas/GcpCredentials" + }, + "hostVpcEnabled": { + "type": "boolean" + }, + "orgName": { + "type": "string" + }, + "privateKeyId": { + "type": "string" + }, + "regionList": { + "type": "array", + "items": { + "type": "string" + } + }, + "serviceDiscoveryEnabled": { + "type": "boolean" + }, + "vnetEnabled": { + "type": "boolean" + } + } + }, + "MultiCloudEdgeAccountInfo": { + "type": "object", + "properties": { + "accountCredentials": { + "type": "string" + }, + "credType": { + "type": "string" + }, + "description": { + "type": "string" + }, + "edgeAccountId": { + "type": "string" + }, + "edgeAccountName": { + "type": "string" + }, + "edgeBillingAccountInfo": { + "$ref": "#/components/schemas/MultiCloudEdgeBillingAccountInfo" + }, + "edgeLocationInfoList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiCloudEdgeLocationInfo" + } + }, + "edgePartnerPortsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiCloudEdgePartnerPort" + } + }, + "edgeType": { + "type": "string" + }, + "equinixCredentials": { + "$ref": "#/components/schemas/EquinixCredentials" + }, + "megaportCredentials": { + "$ref": "#/components/schemas/MegaportCredentials" + }, + "orgName": { + "type": "string" + }, + "regionList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MultiCloudEdgeBillingAccountInfo": { + "type": "object", + "properties": { + "edgeBillingAccountId": { + "type": "string" + }, + "edgeBillingAccountName": { + "type": "string" + }, + "edgeType": { + "type": "string" + } + } + }, + "MultiCloudEdgeLocationInfo": { + "type": "object", + "properties": { + "edgeType": { + "type": "string" + }, + "eqLocationInfo": { + "$ref": "#/components/schemas/EquinixLocationInfo" + }, + "locationId": { + "type": "string" + }, + "locationName": { + "type": "string" + }, + "mpLocationInfo": { + "$ref": "#/components/schemas/MegaportLocationInfo" + } + } + }, + "MultiCloudEdgePartnerPort": { + "type": "object", + "properties": { + "cloudType": { + "type": "string" + }, + "edgeType": { + "type": "string" + }, + "eqPartnerPort": { + "$ref": "#/components/schemas/EquinixPartnerPort" + }, + "locationId": { + "type": "string" + }, + "mpPartnerPort": { + "$ref": "#/components/schemas/MegaportPartnerPort" + }, + "name": { + "type": "string" + } + } + }, + "NATRule": { + "required": [ + "description", + "inPort", + "insideIp", + "interface", + "outPort", + "protocol" + ], + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "inPort": { + "maximum": 65535, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "insideIp": { + "type": "string" + }, + "interface": { + "type": "string" + }, + "outPort": { + "maximum": 65535, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "protocol": { + "pattern": "^udp$|^tcp$|^icmp$", + "type": "string" + } + } + }, + "NameValuePair": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "NetworkProtocol": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "DHCPPool": { + "$ref": "#/components/schemas/DHCPPool" + }, + "DNSSettings": { + "type": "string" + }, + "NTPSettings": { + "maxItems": 4, + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "NATRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NATRule" + } + }, + "NTPInherit": { + "type": "boolean" + } + } + } + ] + }, + "Node": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "name": { + "type": "string" + }, + "password": { + "type": "string" + }, + "serialno": { + "type": "string" + }, + "status": { + "type": "string" + }, + "username": { + "type": "string" + }, + "uuid": { + "type": "string" + } + } + }, + "NwpiDomainMonitor": { + "type": "object", + "properties": { + "clientIp": { + "type": "string" + }, + "deviceToDomainId": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/UuidToDomainId" + } + }, + "domainAppGrp": { + "type": "string" + }, + "domainAppVis": { + "type": "string" + }, + "domainList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDetail" + } + }, + "traceId": { + "type": "string" + } + } + }, + "OMP": { + "type": "object", + "properties": { + "advertisementInterval": { + "type": "integer", + "format": "int32" + }, + "advertisements": { + "pattern": "(IPv4|BGP|OSPF|Connected|Static)", + "type": "string" + }, + "ecmpLimit": { + "type": "integer", + "format": "int32" + }, + "eorTimer": { + "type": "integer", + "format": "int32" + }, + "gracefulRestart": { + "type": "integer", + "format": "int32" + }, + "holdTime": { + "type": "integer", + "format": "int32" + }, + "pathsAdvertisedPerPrefix": { + "type": "integer", + "format": "int32" + } + } + }, + "OnDemandQueueEntry": { + "type": "object", + "properties": { + "complete": { + "type": "boolean" + }, + "completionTime": { + "type": "integer", + "format": "int64" + }, + "creationTime": { + "type": "integer", + "format": "int64" + }, + "data_type": { + "type": "string", + "enum": [ + "DPI", + "ConnectionEvents" + ] + }, + "device_id": { + "type": "string" + }, + "end_time": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "startProcessingTime": { + "type": "integer", + "format": "int64" + }, + "start_time": { + "type": "integer", + "format": "int64" + }, + "status": { + "type": "string", + "enum": [ + "QUEUED", + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "tenant_id": { + "type": "string" + }, + "time_period": { + "type": "string", + "enum": [ + "LAST_N_HOURS", + "CUSTOM" + ] + }, + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "PartnerType": { + "type": "object", + "properties": { + "partnerType": { + "type": "string", + "enum": [ + "aci", + "dnac", + "wcm", + "mdp" + ] + } + }, + "description": "This is valid Partner Type", + "example": "dnac" + }, + "PolicyRule": { + "type": "object", + "properties": { + "action": { + "pattern": "(drop|pass)", + "type": "string" + }, + "destIp": { + "type": "string" + }, + "destPort": { + "type": "integer", + "format": "int32" + }, + "protocolType": { + "type": "array", + "items": { + "type": "string" + } + }, + "sourceIp": { + "type": "string" + }, + "sourcePort": { + "type": "integer", + "format": "int32" + } + } + }, + "ProfileParcel": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "User who last created this.", + "readOnly": true + }, + "createdOn": { + "type": "integer", + "description": "Timestamp of creation", + "format": "int64", + "readOnly": true + }, + "id": { + "type": "string", + "description": "System generated unique identifier of the Profile Parcel in UUID format.", + "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" + }, + "lastUpdatedBy": { + "type": "string", + "description": "User who last updated this.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "integer", + "description": "Timestamp of last update", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the Profile Parcel. Must be unique.", + "example": "Wifi profile Parcel" + }, + "type": { + "type": "string", + "description": "type", + "example": "wifi", + "enum": [ + "cellular", + "wifi", + "ethernet", + "globalSettings", + "networkProtocol", + "securityPolicy", + "vpn" + ] + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Variable" + } + } + }, + "discriminator": { + "propertyName": "type" + } + }, + "PropertyDefinition": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "samples": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string" + } + } + }, + "PublicInternetTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "QueueEntries": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OnDemandQueueEntry" + } + } + } + }, + "QueueProperties": { + "type": "object", + "properties": { + "current_size": { + "type": "integer", + "format": "int32" + }, + "max_size": { + "type": "integer", + "format": "int32" + }, + "tenant_current_size": { + "type": "integer", + "format": "int32" + }, + "tenant_max_size": { + "type": "integer", + "format": "int32" + } + } + }, + "RadioBandSetting_2_4G": { + "type": "object", + "properties": { + "band": { + "pattern": "(RADIO_2_DOT_4_GHZ)", + "type": "string" + }, + "channel": { + "pattern": "(auto|1|2|3|4|5|6|7|8|9|10|11)", + "type": "string" + }, + "channelWidth": { + "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ)", + "type": "string" + }, + "transmitPower": { + "pattern": "(auto|1|2|3|4|5|6|7)", + "type": "string" + } + } + }, + "RadioBandSetting_5G": { + "type": "object", + "properties": { + "band": { + "pattern": "(RADIO_5_GHZ)", + "type": "string" + }, + "channel": { + "pattern": "(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)", + "type": "string" + }, + "channelWidth": { + "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)", + "type": "string" + }, + "transmitPower": { + "pattern": "(auto|1|2|3|4|5|6|7)", + "type": "string" + } + } + }, + "RadiusServer": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "secret": { + "type": "string" + } + } + }, + "ResourceGroup": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "deviceIPs": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "deviceIps": { + "uniqueItems": true, + "type": "array", + "writeOnly": true, + "items": { + "type": "string" + } + }, + "id": { + "type": "object" + }, + "mgmtSytemIpsMap": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "siteIds": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "uuidSytemIpsMap": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SSIDConfig": { + "type": "object", + "properties": { + "qosSettings": { + "pattern": "(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)", + "type": "string" + }, + "securityAuthType": { + "pattern": "(OPEN|WPA2-PSK_AES)", + "type": "string" + }, + "ssid": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "visibility": { + "type": "boolean" + }, + "wpaPskKey": { + "type": "string" + } + } + }, + "SchemaDefinition": { + "type": "object", + "properties": { + "countOfUniqueuVertexAndEdgeObjectsCreated": { + "type": "integer", + "format": "int32" + }, + "countOfVertexAndEdgesRegisteredWithDeviceDataManager": { + "type": "integer", + "format": "int32" + }, + "vertexDefinitionsForDataCollection": { + "type": "array", + "items": { + "type": "string" + } + }, + "vertexDefinitionsFoundInDBWithData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VertexDefinition" + } + }, + "vertexDefinitionsFoundInDBWithoutData": { + "type": "array", + "items": { + "type": "string" + } + }, + "vertexDefinitionsNotFoundInDB": { + "type": "array", + "items": { + "type": "string" + } + }, + "vertexDefinitionsNotRegisteredWithDeviceDataManager": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SecurityPolicy": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "policyName": { + "type": "string" + }, + "defaultAction": { + "pattern": "(drop|pass)", + "type": "string" + }, + "policyRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + ] + }, + "SimSlotConfig": { + "required": [ + "attachProfileId", + "profileList", + "slotNumber" + ], + "type": "object", + "properties": { + "attachProfileId": { + "maximum": 16, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "carrierName": { + "type": "string" + }, + "dataProfileIdList": { + "maxItems": 16, + "minItems": 1, + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "profileList": { + "maxItems": 16, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/CellularProfile" + } + }, + "slotNumber": { + "maximum": 1, + "minimum": 0, + "type": "integer", + "format": "int32" + } + } + }, + "SiteHealth": { + "type": "object", + "properties": { + "fullConnectivity": { + "type": "integer", + "format": "int32" + }, + "noConnectivity": { + "type": "integer", + "format": "int32" + }, + "partialConnectivity": { + "type": "integer", + "format": "int32" + } + } + }, + "SiteToSiteVpn": { + "required": [ + "localInterface", + "localPrivateSubnet", + "preSharedSecret", + "remotePrivateSubnets", + "remotePublicIp" + ], + "type": "object", + "properties": { + "localInterface": { + "pattern": "(^Cellular1/0$|^GigabitEthernet0/0$)", + "type": "string" + }, + "localPrivateSubnet": { + "type": "string" + }, + "name": { + "type": "string" + }, + "preSharedSecret": { + "type": "string" + }, + "remotePrivateSubnets": { + "type": "string" + }, + "remotePublicIp": { + "type": "string" + }, + "tunnelDnsAddress": { + "type": "string" + } + } + }, + "SmartAccountModel": { + "type": "object", + "properties": { + "env": { + "type": "string" + }, + "organization_name": { + "type": "string" + }, + "password": { + "type": "string" + }, + "username": { + "type": "string" + }, + "validity_string": { + "type": "string" + } + } + }, + "SoftwareUploadFile": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + }, + "file": { + "type": "string", + "format": "binary" + } + } + }, + "StatisticsProcessingCounters": { + "type": "object", + "properties": { + "counters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatsTypeProcessingCounters" + } + } + } + }, + "StatsTypeProcessingCounters": { + "type": "object", + "properties": { + "compressed_size": { + "type": "integer", + "format": "int64" + }, + "files_number": { + "type": "integer", + "format": "int64" + }, + "processing_time": { + "type": "integer", + "format": "int64" + }, + "records_number": { + "type": "integer", + "format": "int64" + }, + "stats_type": { + "type": "string" + }, + "uncompressed_size": { + "type": "integer", + "format": "int64" + } + } + }, + "Systems": { + "type": "object", + "properties": { + "consoleBaudRate": { + "type": "string" + }, + "description": { + "type": "string" + }, + "deviceGroup": { + "type": "string" + }, + "gpsLatitude": { + "type": "string" + }, + "gpsLongitude": { + "type": "string" + }, + "hostName": { + "type": "string" + }, + "location": { + "type": "string" + }, + "onDemandTunnel": { + "type": "string" + }, + "onDemandTunnelIdleTimeout": { + "type": "integer", + "format": "int32" + }, + "portHopping": { + "type": "string" + }, + "portOffset": { + "type": "integer", + "format": "int32" + }, + "siteId": { + "type": "string" + }, + "systemIp": { + "type": "string" + }, + "timeZone": { + "type": "string" + } + } + }, + "TagRestfulResource": { + "type": "object", + "properties": { + "allGroups": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + }, + "TenantStatus": { + "type": "object", + "properties": { + "controlStatus": { + "$ref": "#/components/schemas/ControlStatus" + }, + "getvEdgeHealth": { + "$ref": "#/components/schemas/VEdgeHealth" + }, + "getvSmartStatus": { + "$ref": "#/components/schemas/VSmartStatus" + }, + "siteHealth": { + "$ref": "#/components/schemas/SiteHealth" + }, + "tenantId": { + "type": "string" + }, + "tenantName": { + "type": "string" + } + } + }, + "TenantStatusListModel": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TenantStatus" + } + }, + "header": { + "$ref": "#/components/schemas/Header" + } + } + }, + "ThreadPoolDefinition": { + "type": "object", + "properties": { + "consumerClass": { + "type": "string" + }, + "consumerMethod": { + "type": "string" + }, + "threadPoolName": { + "type": "string" + }, + "threadPoolSize": { + "type": "integer", + "format": "int32" + } + } + }, + "ThreadPoolsDefinition": { + "type": "object", + "properties": { + "threadPools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ThreadPoolDefinition" + } + }, + "totalThreadCount": { + "type": "integer", + "format": "int32" + } + } + }, + "UpdateTenantModel": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "getvBondAddress": { + "type": "string" + }, + "getvSmarts": { + "type": "array", + "items": { + "type": "string" + } + }, + "idpMetadata": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "oldIdpMetadata": { + "type": "string" + }, + "spMetadata": { + "type": "string" + }, + "subDomain": { + "type": "string" + }, + "wanEdgeForecast": { + "type": "string" + } + } + }, + "UpdateTenantvSmartModel": { + "type": "object", + "properties": { + "destvSmartUuid": { + "type": "string" + }, + "srcvSmartUuid": { + "type": "string" + } + } + }, + "Uuid": { + "type": "object", + "properties": { + "uuid": { + "type": "string" + } + }, + "description": "This is valid uuid" + }, + "UuidToDomainId": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UuidToDomainIdMapping" + } + } + } + }, + "UuidToDomainIdMapping": { + "type": "object", + "properties": { + "domainId": { + "type": "integer", + "format": "int32" + }, + "uuid": { + "type": "string" + } + } + }, + "VEdgeBootstrapConfig": { + "type": "object", + "properties": { + "bootstrapConfigType": { + "type": "string" + }, + "uuid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VEdgeHealth": { + "type": "object", + "properties": { + "error": { + "type": "integer", + "format": "int32" + }, + "normal": { + "type": "integer", + "format": "int32" + }, + "warning": { + "type": "integer", + "format": "int32" + } + } + }, + "VPNID": { + "type": "object", + "properties": { + "vpn": { + "type": "string" + } + }, + "description": "This is the valid list of VPN-IDs" + }, + "VResourceGroupNameModel": { + "type": "object", + "properties": { + "VResourceGroupName": { + "type": "string" + } + } + }, + "VSmartStatus": { + "type": "object", + "properties": { + "down": { + "type": "integer", + "format": "int32" + }, + "up": { + "type": "integer", + "format": "int32" + } + } + }, + "Variable": { + "required": [ + "jsonPath", + "varName" + ], + "type": "object", + "properties": { + "jsonPath": { + "type": "string" + }, + "varName": { + "type": "string" + } + } + }, + "VertexDefinition": { + "type": "object", + "properties": { + "inEdges": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "outEdges": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyDefinition" + } + } + } + }, + "Vpn": { + "required": [ + "name", + "siteToSiteVpn", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "siteToSiteVpn": { + "$ref": "#/components/schemas/SiteToSiteVpn" + }, + "ipSecPolicy": { + "$ref": "#/components/schemas/IpSecPolicy" + } + } + } + ] + }, + "WanSpec": { + "required": [ + "accountId", + "cloudRegion", + "mappedBranches", + "resourceGroup", + "vpn" + ], + "type": "object", + "properties": { + "accountId": { + "type": "string", + "format": "uuid" + }, + "cloudRegion": { + "type": "string" + }, + "mappedBranches": { + "type": "string" + }, + "resourceGroup": { + "type": "string" + }, + "vpn": { + "type": "string" + }, + "wanId": { + "type": "string", + "format": "uuid" + } + } + }, + "Wifi": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "ssidConfigList": { + "maxItems": 14, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SSIDConfig" + } + }, + "guestWifi": { + "$ref": "#/components/schemas/GuestWifi" + }, + "corporateWifi": { + "$ref": "#/components/schemas/CorporateWifi" + }, + "advancedRadioSetting": { + "$ref": "#/components/schemas/AdvancedRadioSetting" + } + } + } + ] + }, + "uploadHSECAuthFile": { + "type": "object", + "properties": { + "data": { + "type": "string", + "format": "binary" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi-spec/vmanageapi_209_edited.json b/openapi-spec/vmanageapi_209_edited.json new file mode 100644 index 0000000..e0407db --- /dev/null +++ b/openapi-spec/vmanageapi_209_edited.json @@ -0,0 +1,225232 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Cisco SD-WAN vManage API", + "description": "The vManage API exposes the functionality of operations maintaining devices and the overlay network", + "contact": { + "email": "vmanage@cisco.com" + }, + "license": { + "name": "Commercial License", + "url": "https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html" + }, + "version": "2.0.0" + }, + "servers": [ + { + "url": "/dataservice" + } + ], + "paths": { + "/admin/cologroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get COLO groups", + "operationId": "getColoGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Colocation groups": { + "description": "Colocation groups", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Add COLO group", + "operationId": "createColoGroup", + "requestBody": { + "description": "Colocation group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Colocation group": { + "description": "Colocation group", + "value": { + "rbacRequired": true, + "userGroupName": "usergrp1", + "name": "cologrp1", + "description": "Colocation Group One" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/cologroup/{id}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update COLO group", + "operationId": "editColoGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Colocation group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Colocation group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Colocation group": { + "description": "Colocation group", + "value": { + "rbacRequired": true, + "userGroupName": "usergrp1", + "name": "cologrp2", + "description": "Colocation Group Two", + "coloGroupId": "f02e27c3-b30b-4425-93a3-e0c0207f8c23" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete COLO group", + "operationId": "deleteColoGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Colocation group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/resourcegroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get all groups", + "operationId": "resourceGroup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceGroup" + } + }, + "examples": { + "Group": { + "description": "Group", + "value": "[ {\"name\": \"west\", \"desc\": \"US - West coast\", \"siteIds\": [100, 110, 120]}, {\"name\": \"east\", \"desc\": \"US - East coast\"}, \"siteIds\": [300, 310, 320] ]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Create a group", + "operationId": "resourceGroup_4", + "requestBody": { + "description": "Create a group", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceGroup" + }, + "examples": { + "Group": { + "description": "Group", + "value": { + "name": "west", + "desc": "US - West coast", + "siteIds": [ + 110, + 120, + 130 + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/resourcegroup/switch": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Global netadmin switches to a different resource group view", + "operationId": "resourceGroup_1", + "requestBody": { + "description": "Global netadmin switches to a different resource group view", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "switchGroupsDetails": { + "description": "switchGroupsDetails", + "value": { + "resourceGroupName": "west" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VResourceGroupName model": { + "description": "VResourceGroupName model", + "value": "{\n \u201cVResourceGroupName\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/resourcegroup/{groupId}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update a group", + "operationId": "resourceGroup_2", + "parameters": [ + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update group description", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceGroup" + }, + "examples": { + "Group": { + "description": "Group", + "value": { + "name": "west", + "desc": "US - West coast", + "siteIds": [ + 110, + 120, + 130 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete a group", + "operationId": "resourceGroup_3", + "parameters": [ + { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get all users", + "operationId": "findUsers", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "User": { + "description": "User", + "value": [] + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Create a user", + "operationId": "createUser", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": "{\n \"group\":[\n \"demogrp\"\n ],\n \"description\":\"Demo User\",\n \"userName\":\"demouser\",\n \"password\":\"password\"\n \"locale\":\"en_US\"\n \"resGroupName\":\"global\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/activeSessions": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get active sessions", + "operationId": "getActiveSessions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "All active sessions for this tenant (except for the requesting session)": { + "description": "All active sessions for this tenant (except for the requesting session)", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read" + } + }, + "/admin/user/admin/password": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update admin default password", + "operationId": "updateAdminPassword", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/admin/user/password/validate": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Validate user password", + "operationId": "validatePassword", + "requestBody": { + "description": "User password", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User password": { + "description": "User password", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read" + } + }, + "/admin/user/password/{userName}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update user password", + "operationId": "updatePassword", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "User name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/profile/locale": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update profile locale", + "operationId": "updateProfileLocale", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/profile/password": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update profile password", + "operationId": "updateProfilePassword", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/removeSessions": { + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Remove sessions", + "operationId": "removeSessions", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of sessions": { + "description": "List of sessions", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/reset": { + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Unlock a user", + "operationId": "resetUser", + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/user/resourceGroupName": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get the name of the resource group associated with the current logged in user", + "operationId": "resourceGroupName", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "resourceGroupDetails": { + "description": "resourceGroupDetails", + "value": { + "resourceGroupName": "global", + "effectiveResourceGroupName": "west" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/role": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Check whether a user has admin role", + "operationId": "findUserRole", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User has admin role": { + "description": "User has admin role", + "value": { "isAdmin": true } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write,Device Monitoring-read,Device Monitoring-write,System-read,System-write" + } + }, + "/admin/user/userAuthType": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Find user authentication type, whether it is SAML enabled", + "operationId": "findUserAuthType", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User authentication type": { + "description": "User authentication type", + "value": "{userAuthType: SAML}" + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/admin/user/{userName}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update user", + "operationId": "updateUser", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "User name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "User", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": { + "userName": "demouser", + "password": "newpasswd" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete user", + "operationId": "deleteUser", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "User name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/usergroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get all user groups", + "operationId": "findUserGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "User groups": { + "description": "User groups", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Create user group", + "operationId": "createUserGroup", + "requestBody": { + "description": "User group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User group": { + "description": "User group", + "value": { + "groupName": "demogrp", + "tasks": [ + { + "feature": "Interface", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Routing", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Security", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "System", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Policy", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Alarms", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Audit Log", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Device Monitoring", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "RBAC VPN", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Certificates", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Device Inventory", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Template Configuration", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Template Deploy", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Policy Configuration", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Security Policy Configuration", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Policy Deploy", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Cloud OnRamp", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Software Upgrade", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Device Reboot", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Manage Users", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Tools", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Settings", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Cluster", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Colocation", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "vAnalytics", + "read": true, + "enabled": true, + "write": true + }, + { + "feature": "Events", + "read": true, + "enabled": true, + "write": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/usergroup/definition": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get user groups in a grid table", + "operationId": "createGroupGridColumns", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User group in grid table": { + "description": "User group in grid table", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + } + }, + "/admin/usergroup/keyvalue": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get user groups as key value map", + "operationId": "findUserGroupsAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Map of user groups": { + "description": "Map of user groups", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-read,Manage Users-write" + } + }, + "/admin/usergroup/{userGroupId}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update user group", + "operationId": "updateUserGroup", + "parameters": [ + { + "name": "userGroupId", + "in": "path", + "description": "User group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "User group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User group": { + "description": "User group", + "value": { + "groupName": "demogrp", + "tasks": [ + { + "feature": "Policy", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Routing", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Security", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Interface", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "System", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Alarms", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Audit Log", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Certificates", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Cloud OnRamp", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Cluster", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Colocation", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Device Inventory", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Device Monitoring", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Device Reboot", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Events", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Manage Users", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Policy Configuration", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Policy Deploy", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "RBAC VPN", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Security Policy Configuration", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Settings", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Software Upgrade", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Template Configuration", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Template Deploy", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "Tools", + "enabled": true, + "read": true, + "write": false + }, + { + "feature": "vAnalytics", + "enabled": true, + "read": true, + "write": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete user group", + "operationId": "deleteUserGroup", + "parameters": [ + { + "name": "userGroupId", + "in": "path", + "description": "User group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Manage Users-write" + } + }, + "/admin/vpngroup": { + "get": { + "tags": [ + "Administration - User and Group" + ], + "description": "Get VPN groups", + "operationId": "getVpnGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN groups": { + "description": "VPN groups", + "value": { + "data": [ + { + "name": "VPNGroup", + "vpnGroupId": "34bb9532-60bd-464b-bb35-393f7bac5e56", + "description": "Sample", + "owner": "admin", + "lastUpdated": 1590190679126, + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb" + ], + "hasRbacGroup": true, + "userGroupName": "demo" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-read,RBAC VPN-write" + }, + "post": { + "tags": [ + "Administration - User and Group" + ], + "description": "Add VPN group", + "operationId": "createVpnGroup", + "requestBody": { + "description": "VPN group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPN group": { + "description": "VPN group", + "value": { + "rbacRequired": true, + "userGroupName": "demo", + "name": "VPNGroup", + "description": "Sample", + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-write" + } + }, + "/admin/vpngroup/{id}": { + "put": { + "tags": [ + "Administration - User and Group" + ], + "description": "Update VPN group", + "operationId": "editVpnGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "VPN group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "VPN group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPN group": { + "description": "VPN group", + "value": { + "rbacRequired": true, + "userGroupName": "demo", + "name": "VPNGroup", + "description": "Sample", + "vpnGroupId": "34bb9532-60bd-464b-bb35-393f7bac5e56", + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb", + "64b30b74-08e2-4b4b-81ca-d019c7e452d5" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-write" + }, + "delete": { + "tags": [ + "Administration - User and Group" + ], + "description": "Delete VPN group", + "operationId": "deleteVpnGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "VPN group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-write" + } + }, + "/alarms": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarms for last 30min if vManage query is not specified", + "operationId": "getAlarms", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "suppressed": false, + "devices": [ + { + "system-ip": "172.16.255.201" + } + ], + "eventname": "security-root-cert-chain-installed", + "type": "security-root-cert-chain-installed", + "rulename": "security-root-cert-chain-installed", + "component": "Security", + "entry_time": 1636914912376, + "statcycletime": 1636914906000, + "message": "Root cert chain installed", + "severity": "Critical", + "severity_number": 1, + "uuid": "b28d5637-d966-4898-a103-7e7e8d595b50", + "values": [ + { + "system-ip": "172.16.255.201", + "host-name": "vm201" + } + ], + "rule_name_display": "Root_Cert_Chain_Installed", + "receive_time": 1636914906044, + "values_short_display": [ + { + "host-name": "vm201", + "system-ip": "172.16.255.201" + } + ], + "system_ip": "172.16.255.201", + "acknowledged": false, + "active": true, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "id": "eS27H30BnC2wznhMXd52" + } + ], + "pageInfo": { + "startTime": "1636914912376", + "endTime": "1636656222308", + "count": 1 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets lists of alarms along with the raw alarm data of each.", + "operationId": "getRawAlarmData", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Alarm query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm query string": { + "description": "Alarm query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "suppressed": false, + "devices": [ + { + "system-ip": "172.16.255.201" + } + ], + "eventname": "security-root-cert-chain-installed", + "type": "security-root-cert-chain-installed", + "rulename": "security-root-cert-chain-installed", + "component": "Security", + "entry_time": 1636914912376, + "statcycletime": 1636914906000, + "message": "Root cert chain installed", + "severity": "Critical", + "severity_number": 1, + "uuid": "b28d5637-d966-4898-a103-7e7e8d595b50", + "values": [ + { + "system-ip": "172.16.255.201", + "host-name": "vm201" + } + ], + "rule_name_display": "Root_Cert_Chain_Installed", + "receive_time": 1636914906044, + "values_short_display": [ + { + "host-name": "vm201", + "system-ip": "172.16.255.201" + } + ], + "system_ip": "172.16.255.201", + "acknowledged": false, + "active": true, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "id": "eS27H30BnC2wznhMXd52" + } + ], + "pageInfo": { + "startTime": "1636914912376", + "endTime": "1636656222308", + "count": 1 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/aggregation": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets aggregated list of alarms along with the raw alarm data of each aggregation", + "operationId": "getAlarmAggregationData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "entry_time", + "type": "date", + "value": [ + "24" + ], + "operator": "last_n_hours" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "severity", + "order": "asc", + "sequence": 1 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + } + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated alarms with its raw data": { + "description": "Aggregated alarms with its raw data", + "value": { + "data": [ + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Critical" + }, + { + "entry_time": 1640655000000, + "count": 2, + "severity": "Major" + }, + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Medium" + }, + { + "entry_time": 1640655000000, + "count": 4, + "severity": "Minor" + }, + { + "entry_time": 1640656800000, + "count": 5, + "severity": "Critical" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets aggregated list of alarms along with the raw alarm data of each aggregation", + "operationId": "getPostAlarmAggregationData", + "requestBody": { + "description": "Input query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Input query": { + "description": "Input query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "entry_time", + "type": "date", + "value": [ + "24" + ], + "operator": "last_n_hours" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "severity", + "order": "asc", + "sequence": 1 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated alarms with its raw data": { + "description": "Aggregated alarms with its raw data", + "value": { + "data": [ + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Critical" + }, + { + "entry_time": 1640655000000, + "count": 2, + "severity": "Major" + }, + { + "entry_time": 1640655000000, + "count": 1, + "severity": "Medium" + }, + { + "entry_time": 1640655000000, + "count": 4, + "severity": "Minor" + }, + { + "entry_time": 1640656800000, + "count": 5, + "severity": "Critical" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/clear": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Clears specific stale alarm", + "operationId": "clearStaleAlarm", + "requestBody": { + "description": "alarm_uuid", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "alarm_uuid": { + "description": "alarm_uuid", + "value": { + "alarm_uuid": "29f9bf31-0fbe-4114-b8f0-e6234699485c" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/count": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get count of the alarms which are active and acknowledged by the user", + "operationId": "getNonViewedActiveAlarmsCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm count": { + "description": "Alarm count", + "value": { + "header": { + "generatedOn": 1636687449660 + }, + "data": [ + { + "count": 86, + "cleared_count": 173 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/disabled": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "List all disabled alarms", + "operationId": "listDisabledAlarm", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Enable/Disable a specific alarm", + "operationId": "disableEnableAlarm", + "parameters": [ + { + "name": "eventName", + "in": "query", + "description": "Event name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "disable", + "in": "query", + "description": "Disable", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "time", + "in": "query", + "description": "time in hours [1, 72], -1 means infinite", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "alarm config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "alarms": { + "description": "alarms", + "value": "{\n \"eventName\":\"bfd\",\n \"disable\":true,\n \"time\":2,\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/doccount": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get response count of a query", + "operationId": "getCount_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_1", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/dump": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "dump correlation engine server data", + "operationId": "dumpCorrelationEngineData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "dump correlation engine server data": { + "description": "dump correlation engine server data", + "value": { + "Message": "Successfully dump data in log file" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/fields": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/link-state-alarm": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get configuration for link-state alarm", + "operationId": "getLinkStateAlarmConfig", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Enable/Disable a specific link-state alarm", + "operationId": "enableDisableLinkStateAlarm", + "parameters": [ + { + "name": "linkName", + "in": "query", + "description": "Link name (bgp, ospf)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enable", + "in": "query", + "description": "Enable", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "description": "alarm config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "alarms": { + "description": "alarms", + "value": "{\n \"linkName\":\"bgp\",\n \"enable\":true,\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/markallasviewed": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Mark all larms as acknowledged by the user", + "operationId": "markAllAlarmsAsViewed", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Query filter, possible value are \"active\" \"cleared\"", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/markviewed": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Mark alarms as acknowledged by the user", + "operationId": "markAlarmsAsViewed", + "requestBody": { + "description": "List of alarms", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of alarms": { + "description": "List of alarms", + "value": { + "uuid": [ + "29f9bf31-0fbe-4114-b8f0-e6234699485c" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "count": 73, + "cleared_count": 20 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/master": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get master manager state", + "operationId": "getMasterManagerState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "manager state": { + "description": "manager state", + "value": { + "master-ip": "10.105.0.202", + "AlarmEvent0": "10.105.0.202", + "AlarmEvent9": "10.105.0.200", + "AlarmEvent10": "10.105.0.201", + "AlarmEvent6": "10.105.0.201", + "AlarmEvent5": "10.105.0.202", + "AlarmEvent8": "10.105.0.200", + "AlarmEvent7": "10.105.0.202", + "AlarmEventGlobal": "10.105.0.201", + "AlarmEvent2": "10.105.0.200", + "AlarmEvent1": "10.105.0.200", + "AlarmEvent4": "10.105.0.202", + "AlarmEvent3": "10.105.0.201" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/notviewed": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarms which are active and acknowledged by the user", + "operationId": "getNonViewedAlarms", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "entry_time": 1636621017025, + "cleared_time": 1636621609835, + "severity": "Critical", + "rule_name_display": "Control_Node_Down", + "possible_causes": [ + "Trying to determine possible root causes" + ], + "suppressed": false, + "component": "Control", + "acknowledged": false, + "values_short_display": [ + { + "host-name": "vm1", + "system-ip": "172.16.255.11" + } + ], + "devices": [ + { + "system-ip": "172.16.255.11" + } + ], + "severity_number": 1, + "values": [ + { + "site-id": "100", + "host-name": "vm1", + "system-ip": "172.16.255.11" + } + ], + "active": false, + "message": "All Control connections for the node are down", + "type": "node_down", + "cleared_by": "d7041fe3-cb51-4f5c-9d51-26a6108a01a4", + "tenant": "default", + "uuid": "386dca30-101e-45a5-92f9-4f31f5a48a2e" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/page": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get paginated alarm raw data", + "operationId": "getStatBulkAlarmRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + } + }, + { + "name": "scrollId", + "in": "query", + "description": "Query offset", + "required": true, + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Query size", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "severity": "Critical", + "component": "Security", + "message": "Root cert chain installed", + "id": "B-FwAHIB_JLsavez9r7z" + }, + { + "severity": "Medium", + "component": "VPN", + "message": "The interface oper-state changed to up", + "id": "w-FLAHIB_JLsavezubKl" + } + ], + "pageInfo": { + "startTime": "", + "endTime": "", + "count": 2 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get paginated alarm raw data", + "operationId": "getPostStatBulkAlarmRawData", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "Query offset", + "required": true, + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Query size", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Alarm query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm query string": { + "description": "Alarm query string", + "value": { + "query": { + "field": "active", + "type": "boolean", + "value": [ + "true" + ], + "operator": "equal" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarms": { + "description": "Alarms", + "value": { + "data": [ + { + "severity": "Critical", + "component": "Security", + "message": "Root cert chain installed", + "id": "B-FwAHIB_JLsavez9r7z" + }, + { + "severity": "Medium", + "component": "VPN", + "message": "The interface oper-state changed to up", + "id": "w-FLAHIB_JLsavezubKl" + } + ], + "pageInfo": { + "startTime": "", + "endTime": "", + "count": 2 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/purgefrequency": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Set alarm purge timer", + "operationId": "setPeriodicPurgeTimer", + "parameters": [ + { + "name": "interval", + "in": "query", + "description": "Purge interval", + "schema": { + "type": "string" + } + }, + { + "name": "activeTime", + "in": "query", + "description": "Purge activeTime", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm purge setting": { + "description": "Alarm purge setting", + "value": { + "interval": 60000, + "activeTime": 60000 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/query/fields": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/query/input": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get query configuration", + "operationId": "createAlarmQueryConfig", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm query configuration": { + "description": "Alarm query configuration", + "value": { + "timeOptions": [ + { + "enableDateFields": false, + "value": "Last 24 hours", + "key": "last_24_hours" + }, + { + "enableDateFields": true, + "value": "Custom", + "key": "custom" + } + ], + "component": [ + { + "value": "System", + "key": "system" + }, + { + "value": "Control", + "key": "control" + }, + { + "value": "Interface", + "key": "interface" + } + ], + "severityOptions": [ + { + "value": "Critical", + "key": "critical" + }, + { + "value": "Major", + "key": "major" + }, + { + "value": "Minor", + "key": "minor" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/reset": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Reset correlation engine data", + "operationId": "correlAntiEntropy", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": { + "Message": "Successfully reset correlation engine data" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/restart": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Restart correlation engine", + "operationId": "restartCorrelationEngine", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": { + "Message": "Successfully restarted correlation engine" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/rulenamedisplay/keyvalue": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets alarm type as key value pair", + "operationId": "getAlarmTypesAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm types": { + "description": "Alarm types", + "value": { + "header": { + "generatedOn": 1637230423454 + }, + "data": [ + { + "value": "BFD Node Up", + "key": "BFD_Node_Up" + }, + { + "value": "BFD Between Sites Down", + "key": "BFD_Between_Sites_Down" + }, + { + "value": "Disk Write Speed", + "key": "Disk_Write_Speed" + }, + { + "value": "System-IP Change", + "key": "System-IP_Change" + }, + { + "value": "ZBFW Session Maximum", + "key": "ZBFW_Session_Maximum" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/severity": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm by severity", + "operationId": "getAlarmsBySeverity", + "parameters": [ + { + "name": "severity-level", + "in": "query", + "description": "Alarm severity", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "major", + "minor", + "medium", + "critical" + ] + }, + "enum": [ + "major", + "minor", + "medium", + "critical" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm": { + "description": "Alarm", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/severity/summary": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm severity histogram", + "operationId": "getAlarmSeverityCustomHistogram", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Alarm histogram query string", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm histogram": { + "description": "Alarm histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/severitymappings": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Gets alarm severity mappings", + "operationId": "getAlarmSeverityMappings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm severity map": { + "description": "Alarm severity map", + "value": [ + { + "associatedAlarms": [ + { + "value": "System IP Reuse", + "key": "System_IP_Reuse" + }, + { + "value": "OMP All Vsmarts Down", + "key": "OMP_All_Vsmarts_Down" + }, + { + "value": "ZBFW Session Maximum", + "key": "ZBFW_Session_Maximum" + } + ], + "value": "Minor", + "key": "Minor" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/starttracking/{testName}": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Start tracking events", + "operationId": "startTracking", + "parameters": [ + { + "name": "testName", + "in": "path", + "description": "test name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/stats": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm statistics", + "operationId": "getStats", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm statistics": { + "description": "Alarm statistics", + "value": { + "Correlation Engine": { + "Added Events": 16819 + }, + "Correlation DB Manipulator": { + "Link Update Events": { + "Discarded Events": 0, + "Total": 0, + "Processed Events": 0 + }, + "Other Events": { + "Discarded Events": 0, + "Total": 16817, + "Processed Events": 16817 + } + }, + "Link Update Correlator": {} + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/stoptracking/{testName}": { + "post": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Stop tracking events", + "operationId": "stopTracking", + "parameters": [ + { + "name": "testName", + "in": "path", + "description": "test name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/topic": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get device topic state", + "operationId": "getDeviceTopic", + "parameters": [ + { + "name": "ip", + "in": "query", + "description": "Query topic", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + }, + "example": "172.16.255.14" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "device topic state": { + "description": "device topic state", + "value": [ + { + "model_sk": "None", + "state_description": "All daemons up", + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.22", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "0", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vmanage", + "uuid": "c36658b0-71cc-48ba-a806-6e6e476ebf22", + "lastupdated": 1636958286777, + "platform": "x86_64", + "state": "green", + "host-name": "vm12", + "uptime-date": 1635906180000, + "latitude": "37.666684", + "system-ip": "172.16.255.22", + "personality": "vmanage", + "status": "normal", + "board-serial": "12345963", + "validity": "valid", + "certificate-validity": "Valid", + "max-controllers": "0", + "device-model": "vmanage", + "deviceId": "172.16.255.22", + "layoutLevel": 1, + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + }, + { + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.20", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "1", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vsmart", + "uuid": "fbafb4a5-5a98-4587-8e6e-b34debb8f9e8", + "lastupdated": 1636958307799, + "platform": "x86_64", + "host-name": "vm10", + "uptime-date": 1635855000000, + "latitude": "37.666684", + "system-ip": "172.16.255.20", + "personality": "vsmart", + "status": "normal", + "board-serial": "12345961", + "validity": "valid", + "certificate-validity": "Valid", + "device-model": "vsmart", + "deviceId": "172.16.255.20", + "layoutLevel": 2, + "ompPeers": "6", + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/alarms/uuid/{alarm_uuid}": { + "get": { + "tags": [ + "Monitoring - Alarms Details" + ], + "description": "Get alarm detail", + "operationId": "getAlarmDetails", + "parameters": [ + { + "name": "alarm_uuid", + "in": "path", + "description": "Alarm Id", + "required": true, + "schema": { + "type": "string", + "default": "b28d5637-d966-4898-a103-7e7e8d595b50" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Alarm detail": { + "description": "Alarm detail", + "value": [ + { + "model_sk": "None", + "state_description": "All daemons up", + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.22", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "0", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vmanage", + "uuid": "c36658b0-71cc-48ba-a806-6e6e476ebf22", + "lastupdated": 1637137519265, + "platform": "x86_64", + "state": "green", + "host-name": "vm12", + "uptime-date": 1635906180000, + "latitude": "37.666684", + "system-ip": "172.16.255.22", + "personality": "vmanage", + "status": "normal", + "board-serial": "12345963", + "validity": "valid", + "certificate-validity": "Valid", + "max-controllers": "0", + "device-model": "vmanage", + "deviceId": "172.16.255.22", + "layoutLevel": 1, + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get stat raw data", + "operationId": "getStatDataRawAuditLogData", + "parameters": [ + { + "name": "inputQuery", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data with post action", + "operationId": "getRawPropertyData", + "requestBody": { + "description": "Query filter for getting stat raw data", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/aggregation": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data aggregated", + "operationId": "getPropertyAggregationData", + "parameters": [ + { + "name": "inputQuery", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data aggregated with post action", + "operationId": "getPostPropertyAggregationData", + "requestBody": { + "description": "Query filter for getting stat raw data", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/doccount": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get response count of a query", + "operationId": "getCount", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get response count of a query", + "operationId": "getCountPost", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog/fields": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog/page": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data in bulk", + "operationId": "getStatBulkRawPropertyData", + "parameters": [ + { + "name": "inputQuery", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "scrollId", + "in": "query", + "description": "Offset of the query result", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "size of the query result", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + }, + "post": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get raw property data in bulk with post action", + "operationId": "getPostStatBulkRawPropertyData", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "Offset of the query result", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "Size of the query result", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Query filter for getting stat raw data", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Raw property data": { + "description": "Raw property data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/query/fields": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/auditlog/severity": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get audit logs for last 3 hours", + "operationId": "generateAuditLog", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Audit log": { + "description": "Audit log", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/auditlog/severity/summary": { + "get": { + "tags": [ + "Administration - Audit Log" + ], + "description": "Get audit log severity histogram", + "operationId": "getAuditSeverityCustomHistogram", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Audit log severity histogram": { + "description": "Audit log severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Audit Log-read,Audit Log-write" + } + }, + "/backup/backupinfo": { + "delete": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Delete all or a specific backup file stored in vManage", + "operationId": "deleteSchduledBackup", + "parameters": [ + { + "name": "taskId", + "in": "query", + "description": "task id", + "schema": { + "type": "string" + } + }, + { + "name": "backupInfoId", + "in": "query", + "description": "Local Backup Info Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Deleted file list": { + "description": "Deleted file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/backupinfo/{localBackupInfoId}": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Get a localBackupInfo record by localBackupInfoId", + "operationId": "getLocalBackupInfo", + "parameters": [ + { + "name": "localBackupInfoId", + "in": "path", + "description": "localBackupInfo Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get LocalBackupInfo ": { + "description": "Get LocalBackupInfo ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/download/{path}": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Download a Backup File that is already stored in vManage", + "operationId": "downloadBackupFile", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "File path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file stream": { + "description": "Backup file stream" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/export": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Trigger a backup of configuration database and statstics database and store it in vManage", + "operationId": "exportBackup", + "requestBody": { + "description": "backup request information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/backup/list": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "List all backup files of a tenant stored in vManage", + "operationId": "listBackup", + "parameters": [ + { + "name": "size", + "in": "query", + "description": "size", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file list": { + "description": "Backup file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/certificate/certdetails": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get cert details", + "operationId": "getCertDetails", + "requestBody": { + "description": "parse cert", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate": { + "description": "Certificate", + "value": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE---- " + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read" + } + }, + "/certificate/csr/details": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get CSR detail view", + "operationId": "getCSRViewRightMenus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR detail": { + "description": "CSR detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/device/details": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get device detail view", + "operationId": "getDeviceViewRightMenus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device detail": { + "description": "Device detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/device/invalidate": { + "post": { + "tags": [ + "Configuration - Device Connectivity" + ], + "description": "invalidate the device", + "operationId": "invalidateDevice", + "requestBody": { + "description": "vEdge device info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device info": { + "description": "vEdge device info", + "value": { + "chassisNumber": "C8K-979f05bd-7568-470e-ab16-fd9957809e13", + "deviceIp": "172.16.255.16" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/device/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vEdge list", + "operationId": "getDevicesList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge list": { + "description": "vEdge list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/device/stage": { + "post": { + "tags": [ + "Configuration - Device Connectivity" + ], + "description": "Stop data traffic to device", + "operationId": "stageDevice", + "requestBody": { + "description": "vEdge device info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device info": { + "description": "vEdge device info", + "value": { + "chassisNumber": "C8K-979f05bd-7568-470e-ab16-fd9957809e13", + "deviceIp": "172.16.255.16" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/forcesync/rootCert": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Force sync root certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "forceSyncRootCert", + "requestBody": { + "description": "Singed certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Singed certificate": { + "description": "Singed certificate" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/generate/csr": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "generateCSR", + "requestBody": { + "description": "CSR request for device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/generate/enterprise/csr/vedge": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "generateEnterpriseCSR", + "requestBody": { + "description": "CSR request for hardware device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request", + "value": { + "deviceUUID": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": { + "id": "0a8db9bd-790e-44d2-ad84-6ceabf63c1c5" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/generate/wanedge/csr": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "generateEdgeDeviceCSR", + "requestBody": { + "description": "CSR request for device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request", + "value": { + "deviceUUID": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/install/signedCert": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Install singed certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "installCertificate", + "requestBody": { + "description": "Singed certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Singed certificate": { + "description": "Singed certificate" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/jks": { + "put": { + "tags": [ + "Certificate Management - Device" + ], + "description": "update JKS


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "updateJks", + "requestBody": { + "description": "Update JKS", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "JKS": { + "description": "JKS", + "value": "binary format of JKS" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/list/status": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "get certificate", + "operationId": "getListStatus", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/mthub/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vSmart list", + "operationId": "setvSmartList_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/record": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate chain", + "operationId": "getCertificateData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate chain": { + "description": "Certificate chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write,dca" + } + }, + "/certificate/reset/rsa": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Register CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "resetRSA", + "requestBody": { + "description": "CSR request for vEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR for vEdge": { + "description": "CSR for vEdge", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/revoke/enterprise/certificate": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Revoking enterprise CSR for hardware vEdge


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "decommissionEnterpriseCSRForVedge", + "requestBody": { + "description": "Revoking CSR for hardware vEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoking CSR request": { + "description": "Revoking CSR request", + "value": { + "uuid": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": {} + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/rootcertchains": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get root cert chain", + "operationId": "getRootCertChains", + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Action", + "required": true, + "schema": { + "type": "string", + "enum": [ + "get", + "verify" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read" + }, + "put": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save root cert chain


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "saveRootCertChain", + "requestBody": { + "description": "Save root cert chain", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Save root cert chain": { + "description": "Save root cert chain", + "value": { + "RootCertChain": [ + { + "Certificate": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----\n" + }, + { + "Certificate": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----\n" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/rootcertificate": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get device root certificate detail view", + "operationId": "getRootCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device root certificate detail": { + "description": "Device root certificate detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/certificate/save/vedge/list": { + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vEdge device list", + "operationId": "saveVEdgeList", + "requestBody": { + "description": "vEdge device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device list": { + "description": "vEdge device list", + "value": [ + { + "chasisNumber": "71001c48-fdcf-4ac0-aaf3-ca4a20386a18", + "serialNumber": "f0b1985ba82e4c4889c225c59ca9a878", + "validity": "staging" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": { + "id": "0a8db9bd-790e-44d2-ad84-6ceabf63c1c5" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/stats/detail": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate detail", + "operationId": "getCertificateDetail", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate stats detail": { + "description": "Certificate stats detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/stats/summary": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate expiration status", + "operationId": "getCertificateStats", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate status view": { + "description": "Certificate status view", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/certificate/syncvbond": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "sync vManage UUID to all vBond", + "operationId": "syncvBond", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device root certificate detail": { + "description": "Device root certificate detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/certificate/tokengeneratedlist": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get cEdge list with tokengenerated list", + "operationId": "getcEdgeList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge list": { + "description": "vEdge list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vedge": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get Installed Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getInstalledCert", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vedge/csr": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vEdge CSR Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getvEdgeCSR", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "CSR certificate": { + "description": "CSR certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vedge/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vEdge list", + "operationId": "getvEdgeList", + "parameters": [ + { + "name": "model", + "in": "query", + "description": "Device model", + "schema": { + "type": "string", + "enum": [ + "vedge-cloud", + "vedge-1000", + "vedge-2000", + "vedge-100", + "vedge-ISR1100-4G", + "vedge-ISR1100-4GLTE", + "vedge-ISR1100X-4G", + "vedge-ISR1100-6G", + "vedge-ISR1100X-6G", + "vedge-100-B", + "vedge-100-WM", + "vedge-100-M", + "vEdge-5000", + "vedge-CSR-1000v", + "vedge-IR-1101", + "vedge-IR-1821", + "vedge-IR-1831", + "vedge-IR-1833", + "vedge-IR-1835", + "vedge-IR-8140H", + "vedge-IR-8140H-P", + "vedge-IR-8340", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-IR-1101", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-ISR-4221X", + "vedge-ISR-4431", + "vedge-ISR-4451-X", + "vedge-ASR-1001-HX", + "vedge-ASR-1002-X", + "vedge-ASR-1002-HX", + "vedge-ASR-1006-X", + "vedge-C1111-8P", + "vedge-C1121X-8P", + "vedge-C1111X-8P", + "vedge-C1111-8PLTELAW", + "vedge-C1111-8PLTEEA", + "vedge-C1121-8PLTEPW", + "vedge-C1111-8PLTELA", + "vedge-C1117-4PLTEEA", + "vedge-C1126X-8PLTEP", + "vedge-C1127X-8PLTEP", + "vedge-C1127X-8PMLTEP", + "vedge-C1127-8PMLTEP", + "vedge-C1117-4PLTELA", + "vedge-ISRv", + "vedge-C8000V", + "vedge-ASR-1001-X", + "vedge-C1111-4P", + "vedge-C1101-4P", + "vedge-C1101-4PLTEP", + "vedge-C8500-12X4QC", + "vedge-C8500-20X6C", + "vedge-C8500-12X", + "vedge-C8500L-8S4X", + "vedge-C1111-8PW", + "vedge-C1111-8PLTEEAW", + "vedge-C1111-4PLTEEA", + "vedge-C1101-4PLTEPW", + "vedge-C1109-4PLTE2PW", + "vedge-C1109-4PLTE2P", + "vedge-C1121X-8PLTEP", + "vedge-C1161X-8PLTEP", + "vedge-C1113-8PMLTEEA", + "vedge-C1111-4PLTELA,vedge-C1116-4P", + "vedge-C1116-4PLTEEA", + "vedge-C1117-4P", + "vedge-C1117-4PM", + "vedge-C1117-4PMLTEEA", + "vsmart", + "vmanage", + "vbond", + "vedge-ISR-4461", + "vedge-C8300-1N1S-4T2X", + "vedge-C8300-1N1S-6T", + "vedge-C1161X-8P", + "vedge-C8300-2N2S-4T2X", + "vedge-C8300-2N2S-6T", + "vedge-C8200-1N-4T", + "vedge-C8200L-1N-4T", + "vedge-C1161-8P", + "vedge-C1126-8PLTEP", + "vedge-C1127-8PLTEP", + "vedge-C1121-4P", + "vedge-C1121-4PLTEP", + "vedge-C1128-8PLTEP", + "vedge-C1121X-8PLTEPW", + "vedge-C1121-8PLTEP", + "vedge-C1121-8P", + "vedge-C1161-8PLTEP", + "vedge-C1113-8PLTEEA", + "vedge-C1113-8PLTEW", + "vedge-C1111-4PW", + "vedge-C1112-8P", + "vedge-C1112-8PLTEEA", + "vedge-C1112-8PLTEEAWE", + "vedge-C1112-8PWE", + "vedge-C1113-8P", + "vedge-C1113-8PLTEEAW", + "vedge-C1113-8PLTELA", + "vedge-C1113-8PLTELAWZ", + "vedge-C1113-8PM", + "vedge-C1113-8PMWE", + "vedge-C1113-8PW", + "vedge-C1116-4PLTEEAWE", + "vedge-C1131-8PW", + "vedge-C1131X-8PW", + "vedge-C1131-8PLTEPW", + "vedge-C1131X-8PLTEPW", + "vedge-C1116-4PWE", + "vedge-C1117-4PLTEEAW", + "vedge-C1117-4PLTELAWZ", + "vedge-C1117-4PMLTEEAWE", + "vedge-C1117-4PMWE", + "vedge-C1117-4PW", + "vedge-C1118-8P", + "vedge-C1109-2PLTEGB", + "vedge-C1109-2PLTEUS", + "vedge-C1109-2PLTEVZ" + ] + } + }, + { + "name": "state", + "in": "query", + "description": "Device state", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge list": { + "description": "vEdge list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vEdge list", + "operationId": "setvEdgeList", + "requestBody": { + "description": "vEdge device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge device list": { + "description": "vEdge device list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/view": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get certificate UI view", + "operationId": "getView", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device certificate view": { + "description": "Device certificate view", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/certificate/vmanage/selfsignedcert": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "get self signed certificate", + "operationId": "getSelfSignedCert", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Self signed certificate": { + "description": "Self signed certificate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read" + } + }, + "/certificate/vsmart/list": { + "get": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Get vSmart list


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getvSmartList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vSmart list": { + "description": "vSmart list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Save vSmart list", + "operationId": "setvSmartList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/certificate/{uuid}": { + "delete": { + "tags": [ + "Certificate Management - Device" + ], + "description": "Invalidate device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "deleteConfiguration", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "replaceController", + "in": "query", + "description": "Replace a vSmart in Multi-tenant setup with a new vSmart", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "deviceId", + "in": "query", + "description": "uuid of new vSmart", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Id": { + "description": "Request Id", + "value": "{id: uuid}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/cloudservices/accesstoken": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "operationId": "getAccessTokenforDevice", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/cloudservices/app/webex": { + "put": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Day N- Update Webex App", + "operationId": "enableWebex_1", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Add Webex App", + "operationId": "enableWebex", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + }, + "delete": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "deleteWebexPrefixLists", + "operationId": "deleteWebexPrefixLists", + "requestBody": { + "description": "TMP-Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/cloudservices/authtoken": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get Azure token", + "operationId": "getAzureToken", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry state": { + "description": "Telemetry state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/connect": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Telemetry Opt In", + "operationId": "connect", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry Opt In": { + "description": "Telemetry Opt In", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/credentials": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service credentials", + "operationId": "getCloudCredentials", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service credentials": { + "description": "Cloud service credentials", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + }, + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service settings", + "operationId": "addCloudCredentials", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service setting": { + "description": "Cloud service setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca,CXP-write,default" + } + }, + "/cloudservices/devicecode": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get Azure device code", + "operationId": "getDeviceCode", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry state": { + "description": "Telemetry state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/m365/preferredpath": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getO365PreferredPathFromVAnalytics", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/cloudservices/staging": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Check if testbed or production", + "operationId": "isStaging", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Environment": { + "description": "Environment", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/cloudservices/telemetry": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get Telemetry state", + "operationId": "getTelemetryState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry state": { + "description": "Telemetry state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/telemetry/optin": { + "put": { + "tags": [ + "System - Cloud Service" + ], + "description": "Telemetry Opt In", + "operationId": "optIn", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry Opt In": { + "description": "Telemetry Opt In", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "CXP-read,CXP-write,default" + } + }, + "/cloudservices/telemetry/optout": { + "delete": { + "tags": [ + "System - Cloud Service" + ], + "description": "Telemetry Opt Out", + "operationId": "optOut", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Telemetry Opt Out": { + "description": "Telemetry Opt Out", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,CXP-read,CXP-write,default," + } + }, + "/clusterManagement/clusterLocked": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Check whether cluster is locked


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "checkIfClusterLocked", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster lock": { + "description": "Cluster lock", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/clusterworkflow/version": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getClusterWorkflowVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "clusterV2Enabled": { + "description": "clusterV2Enabled", + "value": "True" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/configure": { + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Configure vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "configureVmanage", + "requestBody": { + "description": "vManage server config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage server config": { + "description": "vManage server config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/connectedDevices/{vmanageIP}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get connected device for vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getConnectedDevices", + "parameters": [ + { + "name": "vmanageIP", + "in": "path", + "description": "vManage IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/health/details": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "healthDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster health check detail": { + "description": "Cluster health check detail", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/health/status": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "healthStatusInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster health status info": { + "description": "Cluster health status info", + "value": {} + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/health/summary": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get cluster health check summary


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "healthSummary", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Flag to enable cached result", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster health check summary": { + "description": "Cluster health check summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/iplist/{vmanageID}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get configured IP addresses


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getConfiguredIPList", + "parameters": [ + { + "name": "vmanageID", + "in": "path", + "description": "vManage Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vManage IP list": { + "description": "vManage IP list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/isready": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Is cluster ready


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "isClusterReady", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster state": { + "description": "Cluster state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/list": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "listVmanages", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vManage server": { + "description": "vManage server", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/nodeProperties": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get properties of vManage being added to cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "nodeProperties", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage cluster properties": { + "description": "vManage cluster properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/remove": { + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Remove vManage from cluster


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "removeVmanage", + "requestBody": { + "description": "vManage server info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage server info": { + "description": "vManage server info", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/replicateAndRebalance": { + "put": { + "tags": [ + "Cluster Management" + ], + "description": "Initiate replication and rebalance of kafka topics


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "performReplicationAndRebalanceOfKafkaPartitions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Kafka topics rebalance status": { + "description": "Kafka topics rebalance status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/setup": { + "put": { + "tags": [ + "Cluster Management" + ], + "description": "Update vManage cluster info


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editVmanage", + "requestBody": { + "description": "vManage cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage cluster config": { + "description": "vManage cluster config", + "value": "{\n \"vmanageID\":\"0\",\n \"deviceIP\u201d:\u201d10.0.1.38\u201d,\n \"username\":\"admin\",\n \"password\u201d:\u201dpassword\u201d,\n \"persona\":\"COMPUTE_AND_DATA\",\n \"services\":{\n \"container-manager\":{\n \"server\":false\n }\n }\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Add vManage to cluster", + "operationId": "addVmanage", + "requestBody": { + "description": "vManage cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage cluster config": { + "description": "vManage cluster config", + "value": { + "deviceIP": "10.0.1.200", + "username": "admin", + "password": "password", + "genCSR": false, + "persona": "COMPUTE_AND_DATA", + "services": { + "container-manager": { + "server": false + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/tenancy/mode": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get vManage tenancy mode


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenancyMode", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage tenancy mode": { + "description": "vManage tenancy mode", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Update vManage tenancy mode", + "operationId": "setTenancyMode", + "requestBody": { + "description": "Tenancy mode setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenancy mode": { + "description": "Tenancy mode", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/tenantList": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get tenant list


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantsList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Tenant": { + "description": "Tenant", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/userCreds": { + "post": { + "tags": [ + "Cluster Management" + ], + "description": "Add or update user credentials for cluster operations


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "addOrUpdateUserCredentials", + "requestBody": { + "description": "User credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User credential": { + "description": "User credential", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/vManage/details/{vmanageIP}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get vManage detail


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getVManageDetails", + "parameters": [ + { + "name": "vmanageIP", + "in": "path", + "description": "vManage IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage detail": { + "description": "vManage detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/clusterManagement/{tenantId}/connectedDevices/{vmanageIP}": { + "get": { + "tags": [ + "Cluster Management" + ], + "description": "Get connected device for vManage for a tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getConnectedDevicesPerTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vmanageIP", + "in": "path", + "description": "vManage IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/colocation/cluster": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get details of all existing Clusters", + "operationId": "getCloudDockClusterDetail", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Clouddock cluster": { + "description": "Clouddock cluster", + "value": { + "data": [ + { + "managementMask": "31", + "ccmIpAddress": "1.1.1.1/31", + "ccmdeviceName": "ccm-Cluster1", + "activeState": "INCOMPLETE", + "maxHaNetNumber": 1, + "description": "Description for Cluster1", + "serviceChainVlanPool": "100", + "clusterId": "b1201e77-3987-480e-b0d3-a2c972e59a33", + "ipPoolName": "Cluster1_ResourcePool", + "lastUpdated": 1590354925245, + "@rid": 3268, + "systemIpPool": "1.1.1.1", + "vnfNetworkPool": "1.1.1.1", + "clusterName": "Cluster1", + "clusterState": "INACTIVE", + "updatedBy": "admin", + "IpPoolDescription": "Description for Cluster1_ResourcePool", + "activeStateInternal": "INCOMPLETE", + "ccmdeviceTemplateId": "037a8893-3f35-4305-90a1-da9a30159586", + "vnfMgmtPool": "1.1.1.1", + "subnetMask": "255.255.255.254", + "managementGateway": "1.1.1.1", + "serviceChainCount": "0", + "designStatus": "IN_PROGRESS", + "siteId": "100", + "cspQueue": ",,", + "location": "us-west-1", + "csp": [ + { + "name": "CSP_Cluster13", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster11", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster12", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + } + ], + "switch": [ + { + "name": "Switch1", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + }, + { + "name": "Switch2", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + } + ], + "template": [ + { + "templateType": "clouddock_aaa", + "templateMinVersion": "15.0.0", + "deviceType": [ + "vedge-nfvis-CSP2100" + ], + "lastUpdatedBy": "admin", + "editedTemplateDefinition": "{\"authentication\":{\"users\":{\"user\":{\"vipType\":\"constant\",\"vipValue\":[{\"name\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"admin\"},\"password\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81\"},\"password-scrypt\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c\"},\"role\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"administrators\"}}],\"vipObjectType\":\"tree\",\"vipPrimaryKey\":[\"name\"]}}}}", + "templateDefinition": "{\"authentication\":{\"users\":{\"user\":{\"vipType\":\"constant\",\"vipValue\":[{\"name\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"admin\"},\"password\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81\"},\"password-scrypt\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c\"},\"role\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"administrators\"}}],\"vipObjectType\":\"tree\",\"vipPrimaryKey\":[\"name\"]}}}}", + "attachedMastersCount": 0, + "templateId": "30be9f2a-6188-4657-9286-fa993eb87cf2", + "configType": "xml", + "createdOn": 1590354925752, + "feature": "cloud-dock", + "factoryDefault": false, + "templateName": "Cluster1_Credentials", + "createdBy": "admin", + "devicesAttached": 0, + "templateDescription": "Description for Cluster1_Credentials", + "lastUpdatedOn": 1590354925752 + } + ], + "device_up": "0", + "device_down": "0", + "vnf_up": "0", + "vnf_down": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + }, + "put": { + "tags": [ + "Colocation" + ], + "description": "Update a existing cluster", + "operationId": "updateCloudDockCluster", + "requestBody": { + "description": "Cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster config": { + "description": "Cluster config", + "value": { + "cloudDockCluster": { + "clusterName": "Cluster1", + "ccmIpAddress": "1.1.1.1/31", + "siteId": "100", + "description": "Description for Cluster1", + "location": "us-west-1", + "isActiveCSPAdd": false, + "csp": [ + { + "name": "CSP_Cluster13", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster11", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + }, + { + "name": "CSP_Cluster12", + "isCCMHosted": false, + "type": "csp", + "uuid": "", + "deviceStatus": "DOWN" + } + ], + "switch": [ + { + "name": "Switch1", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + }, + { + "name": "Switch2", + "type": "switch", + "uuid": "", + "deviceStatus": "--" + } + ], + "setting": [ + { + "templateName": "Cluster1_Credentials", + "templateDescription": "Description for Cluster1_Credentials", + "templateType": "clouddock_aaa", + "templateMinVersion": "15.0.0", + "templateDefinition": { + "authentication": { + "users": { + "user": { + "vipType": "constant", + "vipValue": [ + { + "name": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "admin" + }, + "password": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81" + }, + "password-scrypt": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c" + }, + "role": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "administrators" + } + } + ], + "vipObjectType": "tree", + "vipPrimaryKey": [ + "name" + ] + } + } + } + }, + "transitionInProgress": false, + "deviceType": [ + "vedge-nfvis-CSP2100" + ], + "deviceModels": [ + { + "name": "vedge-nfvis-CSP2100", + "displayName": "vedge-nfvis-CSP2100-X1", + "deviceType": "vedge", + "isCliSupported": false, + "isCiscoDeviceModel": true + } + ], + "feature": "cloud-dock", + "lastUpdatedBy": "admin", + "editedTemplateDefinition": { + "authentication": { + "users": { + "user": { + "vipType": "constant", + "vipValue": [ + { + "name": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "admin" + }, + "password": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81" + }, + "password-scrypt": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c" + }, + "role": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "administrators" + } + } + ], + "vipObjectType": "tree", + "vipPrimaryKey": [ + "name" + ] + } + } + } + }, + "attachedMastersCount": 0, + "templateId": "30be9f2a-6188-4657-9286-fa993eb87cf2", + "configType": "xml", + "createdOn": 1590354925752, + "factoryDefault": false, + "createdBy": "admin", + "devicesAttached": 0, + "lastUpdatedOn": 1590354925752 + } + ], + "resourcePool": { + "ipPoolName": "Cluster1_ResourcePool", + "IpPoolDescription": "Description for Cluster1_ResourcePool", + "serviceChainVlanPool": "200", + "vnfMgmtPool": "1.1.1.1", + "vnfNetworkPool": "1.1.1.1", + "managementGateway": "1.1.1.1", + "managementMask": "31", + "systemIpPool": "1.1.1.1", + "ccmIpAddress": "1.1.1.1/31" + }, + "clusterId": "b1201e77-3987-480e-b0d3-a2c972e59a33" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + }, + "post": { + "tags": [ + "Colocation" + ], + "description": "Add a new cluster", + "operationId": "createCloudDockCluster", + "requestBody": { + "description": "Cluster config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster config": { + "description": "Cluster config", + "value": { + "cloudDockCluster": { + "clusterName": "Cluster1", + "siteId": "100", + "description": "Description for Cluster1", + "location": "us-west-1", + "isActiveCSPAdd": false, + "csp": [ + { + "name": "CSP_Cluster11", + "uuid": "" + }, + { + "name": "CSP_Cluster12", + "uuid": "" + }, + { + "name": "CSP_Cluster13", + "uuid": "" + } + ], + "switch": [ + { + "name": "Switch1", + "uuid": "" + }, + { + "name": "Switch2", + "uuid": "" + } + ], + "setting": [ + { + "templateName": "Cluster1_Credentials", + "templateDescription": "Description for Cluster1_Credentials", + "templateType": "clouddock_aaa", + "templateMinVersion": "15.0.0", + "templateDefinition": { + "authentication": { + "users": { + "user": { + "vipType": "constant", + "vipValue": [ + { + "name": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "admin" + }, + "password": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81" + }, + "password-scrypt": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c" + }, + "role": { + "vipObjectType": "object", + "vipType": "constant", + "vipValue": "administrators" + } + } + ], + "vipObjectType": "tree", + "vipPrimaryKey": [ + "name" + ] + } + } + } + }, + "transitionInProgress": true, + "deviceType": [ + "vedge-nfvis-CSP2100" + ], + "deviceModels": [ + { + "name": "vedge-nfvis-CSP2100", + "displayName": "vedge-nfvis-CSP2100-X1", + "deviceType": "vedge", + "isCliSupported": false, + "isCiscoDeviceModel": true + } + ], + "feature": "cloudDock", + "factoryDefault": false + } + ], + "resourcePool": { + "ipPoolName": "Cluster1_ResourcePool", + "IpPoolDescription": "Description for Cluster1_ResourcePool", + "serviceChainVlanPool": "100", + "vnfMgmtPool": "1.1.1.1", + "vnfNetworkPool": "1.1.1.1", + "managementGateway": "1.1.1.1", + "managementMask": "31", + "systemIpPool": "1.1.1.1", + "ccmIpAddress": "1.1.1.1/31" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/activate": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Activate a cluster", + "operationId": "acitvateCloudDockCluster", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster detail": { + "description": "Cluster detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/activateClusterDummy": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Activate dummp cluster", + "operationId": "dummyccm", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/cluster/activateClusterDummyState": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Activate cluster in a state", + "operationId": "dummycspState", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "Cluster state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/cluster/attached/csp": { + "put": { + "tags": [ + "Colocation" + ], + "description": "Update attached csp to cluster", + "operationId": "updateCspToCluster", + "requestBody": { + "description": "CSP config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSP config": { + "description": "CSP config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/config": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Clouddock cluster preview", + "operationId": "CloudDockClusterPreview", + "parameters": [ + { + "name": "serialNumber", + "in": "query", + "description": "Serial number", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Cluster detail": { + "description": "Cluster detail" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/deactivate": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Deactivate clouddock cluster", + "operationId": "deAcitvateCloudDockCluster", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/id": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get cluster by Id", + "operationId": "getCloudDockClusterDetailById", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Clouddock cluster detail": { + "description": "Clouddock cluster detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/cluster/rma": { + "post": { + "tags": [ + "Colocation" + ], + "description": "RMA operation for CSP device", + "operationId": "rmaCloudDockCsp", + "parameters": [ + { + "name": "clusterName", + "in": "query", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSP info": { + "description": "CSP info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/cluster/{clustername}": { + "delete": { + "tags": [ + "Colocation" + ], + "description": "Delete cluster by name", + "operationId": "deleteCloudDockClusterByName", + "parameters": [ + { + "name": "clustername", + "in": "path", + "description": "Cluster name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write" + } + }, + "/colocation/monitor/cluster": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of ids of existing clusters", + "operationId": "getClusterDetailsByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cluster detail": { + "description": "Cluster detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/cluster/config": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of devices of clusters", + "operationId": "getClusterConfigByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cluster details": { + "description": "Cluster details", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/cluster/portView": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of port mappings in the cluster", + "operationId": "getClusterPortMappingByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cluster port mapping": { + "description": "Cluster port mapping", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/device": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List details for Device", + "operationId": "getDeviceDetailByDeviceId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device detail": { + "description": "Device detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/device/system": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all connected VNF to a device", + "operationId": "getSystemStatusByDeviceId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/device/vnf": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all VNF attached with Device", + "operationId": "getvnfByDeviceId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/networkfunction/listmap": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Retrieve network function listing", + "operationId": "listNetworkFunctionMap", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Network functions": { + "description": "Network functions", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,Colocation User Service Group-read" + } + }, + "/colocation/monitor/pnf": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all PNF by cluster Id", + "operationId": "getpnfDetails", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/pnf/configuration": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List configuration of PNF", + "operationId": "getPNFConfig", + "parameters": [ + { + "name": "pnfSerialNumber", + "in": "query", + "description": "PNF serial number", + "schema": { + "type": "string" + } + }, + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF detail": { + "description": "VNF detail", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/servicechain": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all service chain or service chains by Id", + "operationId": "getServiceChainDetails", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + }, + { + "name": "userGroupName", + "in": "query", + "description": "UserGroup Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/servicegroup": { + "get": { + "tags": [ + "Colocation" + ], + "description": "List all attached serviceGroups to cluster", + "operationId": "getServiceGroupByClusterId", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Service group": { + "description": "Service group", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/monitor/vnf": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Provide details of all existing VNF", + "operationId": "getvnfDetails", + "parameters": [ + { + "name": "clusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + }, + { + "name": "userGroupName", + "in": "query", + "description": "UserGroup Name", + "schema": { + "type": "string" + } + }, + { + "name": "vnfName", + "in": "query", + "description": "VNF Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VNF details": { + "description": "VNF details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/action": { + "post": { + "tags": [ + "Colocation" + ], + "description": "VNF action", + "operationId": "vnfActions", + "parameters": [ + { + "name": "vmName", + "in": "query", + "description": "VM Name", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + }, + { + "name": "action", + "in": "query", + "description": "Action", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/alarms": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get event detail of VNF", + "operationId": "getVNFEventsCountDetail", + "parameters": [ + { + "name": "user_group", + "in": "query", + "description": "user group name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/alarms/count": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get event detail of VNF", + "operationId": "getVNFAlarmCount", + "parameters": [ + { + "name": "user_group", + "in": "query", + "description": "user group name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/events": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get event detail of VNF", + "operationId": "getVNFEventsDetail", + "parameters": [ + { + "name": "vnfName", + "in": "query", + "description": "VNF name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/monitor/vnf/interface": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get interface detail of VNF", + "operationId": "getVNFInterfaceDetail", + "parameters": [ + { + "name": "vnfName", + "in": "query", + "description": "VNF name", + "schema": { + "type": "string" + } + }, + { + "name": "deviceIp", + "in": "query", + "description": "Device IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceClass", + "in": "query", + "description": "Device class", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VNF": { + "description": "VNF", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/servicechain/attach": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Attach service chain to cluster", + "operationId": "attachServiceChain", + "requestBody": { + "description": "Attach service chain request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attach service chain request": { + "description": "Attach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/autoattach": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Attach service chain to cluster", + "operationId": "attachServiceChain_1", + "requestBody": { + "description": "Attach service chain request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attach service chain request": { + "description": "Attach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/cancel": { + "post": { + "tags": [ + "Colocation" + ], + "description": "Cancel button to cancel configuring devices", + "operationId": "cancelButton", + "requestBody": { + "description": "Cancel configuring devices", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attach service chain request": { + "description": "Attach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/detach": { + "put": { + "tags": [ + "Colocation" + ], + "description": "Detach service chain", + "operationId": "detachServiceChain", + "requestBody": { + "description": "Detach service chain request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detach service chain request": { + "description": "Detach service chain request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicechain/edge/devices": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get edge devices", + "operationId": "getEdgeDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices list": { + "description": "Devices list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write,default" + } + }, + "/colocation/servicechain/edge/pnfdevices": { + "get": { + "tags": [ + "Colocation" + ], + "description": "Get PNF edge devices", + "operationId": "getpnfDevices", + "parameters": [ + { + "name": "pnfDeviceType", + "in": "query", + "description": "PNF device type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PNF devices list": { + "description": "PNF devices list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation-write,default" + } + }, + "/colocation/servicegroup": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get service chain by name", + "operationId": "getServiceChain", + "parameters": [ + { + "name": "serviceGroupName", + "in": "query", + "description": "Service group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + }, + "put": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Update service group", + "operationId": "updateServiceGroupCluster", + "requestBody": { + "description": "Service group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service group": { + "description": "Service group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + }, + "post": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Add new service group", + "operationId": "createServiceGroupCluster", + "requestBody": { + "description": "Service group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service group": { + "description": "Service group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/colocation/servicegroup/attached": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get service chains in cluster", + "operationId": "getServiceGroupInCluster", + "parameters": [ + { + "name": "ClusterId", + "in": "query", + "description": "Cluster Id", + "schema": { + "type": "string" + } + }, + { + "name": "UserGroupName", + "in": "query", + "description": "UserGroup Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read,Colocation User Service Group-read" + } + }, + "/colocation/servicegroup/servicechain/default": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get default service chains", + "operationId": "getDefaultChain", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service chain": { + "description": "Service chain", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/servicegroup/servicechains": { + "get": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Get all service chains", + "operationId": "getAvailableChains", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Service chains": { + "description": "Service chains", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-read" + } + }, + "/colocation/servicegroup/{name}": { + "delete": { + "tags": [ + "Colocation - Service Group" + ], + "description": "Delete service group", + "operationId": "deleteServiceGroupCluster", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Service group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,Colocation-write" + } + }, + "/container-manager/activate/{containerName}": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Activate container on remote host", + "operationId": "activateContainerOnRemoteHost", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "url", + "in": "query", + "description": "Container image URL", + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + }, + { + "name": "checksum", + "in": "query", + "description": "Container image checksum", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/container-manager/deactivate/{containerName}": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Deactivate container on remote host", + "operationId": "deActivateContainer", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/container-manager/doesValidImageExist/{containerName}": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Get container image checksum", + "operationId": "doesValidImageExist", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Container image checksum": { + "description": "Container image checksum", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "admin" + } + }, + "/container-manager/inspect/{containerName}": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Get container inspect data", + "operationId": "getContainerInspectData", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Container inspect data": { + "description": "Container inspect data" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/container-manager/settings/{containerName}": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Get container settings", + "operationId": "getContainerSettings", + "parameters": [ + { + "name": "containerName", + "in": "path", + "description": "Container name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hostIp", + "in": "query", + "description": "Container host IP", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Container settings": { + "description": "Container settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/data/device/state/{state_data_type}": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device state data", + "operationId": "generateDeviceStateData", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startId", + "in": "query", + "description": "Start Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "Count", + "schema": { + "type": "string", + "default": "1000" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "State data": { + "description": "State data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/state/{state_data_type}/fields": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device state data fileds", + "operationId": "generateDeviceStateDataFields", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "State data fileds": { + "description": "State data fileds", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/state/{state_data_type}/query": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device state data fileds", + "operationId": "generateDeviceStateDataWithQueryString", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "State data": { + "description": "State data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/statistics": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get statistics types", + "operationId": "getStatisticsType", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics type": { + "description": "Statistics type", + "value": [ + "interfacestatistics", + "eioltestatistics", + "sulstatistics", + "qosstatistics", + "devicesystemstatusstatistics", + "bridgemacstatistics", + "dpistatistics", + "approutestatsstatistics", + "wlanclientinfostatistics", + "flowlogstatistics", + "urlf", + "fwall", + "vnfstatistics", + "umbrella", + "apphostingstatistics", + "utddaqioxstatistics", + "ipsalert", + "aggregatedappsdpistatistics", + "bridgeinterfacestatistics", + "artstatistics", + "trackerstatistics", + "cloudxstatistics", + "deviceevents", + "sleofflinereport", + "alarm", + "auditlog", + "deviceconfiguration", + "nwpi", + "nwpiflowraw", + "speedtest" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/statistics/alarm/active": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get active alarms", + "operationId": "getActiveAlarms", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "SrollId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startDate", + "in": "query", + "description": "Start date", + "schema": { + "type": "string" + } + }, + { + "name": "endDate", + "in": "query", + "description": "End date", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "description": "count", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "timeZone", + "in": "query", + "description": "Time zone", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Active alarms": { + "description": "Active alarms", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/data/device/statistics/{state_data_type}": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get device statistics data", + "operationId": "generateDeviceStatisticsData", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scrollId", + "in": "query", + "description": "Scroll Id", + "schema": { + "type": "string" + } + }, + { + "name": "startDate", + "in": "query", + "description": "Start date", + "schema": { + "type": "string" + } + }, + { + "name": "endDate", + "in": "query", + "description": "End date", + "schema": { + "type": "string" + } + }, + { + "name": "count", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timeZone", + "in": "query", + "description": "Time zone", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics data": { + "description": "Statistics data", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" + } + }, + "/data/device/statistics/{state_data_type}/doccount": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get response count of a query", + "operationId": "getCountWithStateDataType", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type(example:object)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startDate", + "in": "query", + "description": "Start date (example:2021-1-1T00:00:00)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "endDate", + "in": "query", + "description": "End date (example:2021-12-1T00:00:00)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "timeZone", + "in": "query", + "description": "Time zone (example:UTC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Response count": { + "description": "Response count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/data/device/statistics/{state_data_type}/fields": { + "get": { + "tags": [ + "Monitoring - Device Statistics Details" + ], + "description": "Get statistics fields and types", + "operationId": "getStatDataFieldsByStateDataType", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "State data type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics field and type": { + "description": "Statistics field and type", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/dca/analytics": { + "put": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get statistics data", + "operationId": "createStats", + "requestBody": { + "description": "Stats query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query": { + "description": "Stats query", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats data": { + "description": "Stats data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/analytics/all": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get all statistics setting data", + "operationId": "getAllStatsDataDCA", + "requestBody": { + "description": "Stats setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats index status": { + "description": "Stats index status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service settings", + "operationId": "getCloudSettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service setting": { + "description": "Cloud service setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + } + }, + "/dca/cloudservices/accesstoken": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA access token", + "operationId": "getAccessToken", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA access token": { + "description": "DCA access token", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Set DCA access token", + "operationId": "storeAccessToken", + "requestBody": { + "description": "DCA access token", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA access token": { + "description": "DCA access token", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/alarm": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Generate DCA alarms", + "operationId": "generateAlarm", + "requestBody": { + "description": "DCA alarm message", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA alarm message": { + "description": "DCA alarm message", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/idtoken": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA Id token", + "operationId": "getIdToken", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA Id token": { + "description": "DCA Id token", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Set DCA Id token", + "operationId": "storeIdToken", + "requestBody": { + "description": "DCA Id token", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA Id token": { + "description": "DCA Id token", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/otp": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get cloud service OTP value", + "operationId": "getOTP", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service OTP value": { + "description": "Cloud service OTP value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + }, + "put": { + "tags": [ + "System - Cloud Service" + ], + "description": "Update cloud service OTP value", + "operationId": "updatetOTP", + "requestBody": { + "description": "Cloud service OTP value", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service OTP value": { + "description": "Cloud service OTP value", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + } + }, + "/dca/cloudservices/telemetry": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA telemetry settings", + "operationId": "getTelemetrySettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA telemetry settings": { + "description": "DCA telemetry settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/cloudservices/vanalytics": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "Get session from DCS for vAnalytics", + "operationId": "getvAnalytics", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud service OTP value": { + "description": "Cloud service OTP value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "dca" + } + }, + "/dca/data/device/state/{state_data_type}": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device state data", + "operationId": "generateDCADeviceStateData", + "parameters": [ + { + "name": "state_data_type", + "in": "path", + "description": "Device state data", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device state": { + "description": "Device state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/data/device/statistics/{stats_data_type}": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device statistics data", + "operationId": "generateDCADeviceStatisticsData", + "parameters": [ + { + "name": "stats_data_type", + "in": "path", + "description": "Device statistics data", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device statistics": { + "description": "Device statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/dcatenantowners": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA tenant owners", + "operationId": "getDCATenantOwners", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA service owner": { + "description": "DCA service owner", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/device": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get all devices", + "operationId": "listAllDevicesDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device lists": { + "description": "Device lists", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/device/crashlog/details": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get crash log", + "operationId": "getCrashLogs", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crash logs": { + "description": "Crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/device/crashlog/synced": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device crash log", + "operationId": "getCrashLogsSynced", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crash logs": { + "description": "Crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/settings/configuration/cloudservices/dca": { + "get": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get DCA cloud service configuration", + "operationId": "getCloudServicesConfigurationDCA", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DCA cloud service configuration": { + "description": "DCA cloud service configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/settings/configuration/{type}/dca": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Create analytics config data", + "operationId": "createDCAAnalyticsDataFile", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Data type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "analytics", + "callHome" + ] + } + } + ], + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Analytics config data": { + "description": "Analytics config data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/statistics/settings/status": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get statistics setting status", + "operationId": "getStatsDBIndexStatus", + "requestBody": { + "description": "Stats setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats index status": { + "description": "Stats index status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/system/device": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get device details", + "operationId": "getDevicesDetailsDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device details": { + "description": "Device details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/device/config/attachedconfig": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get attached config to device", + "operationId": "getDCAAttachedConfigToDevice", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attached config to device": { + "description": "Attached config to device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/definition/approute": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get template policy definitions", + "operationId": "getTemplatePolicyDefinitionsDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template policy definition": { + "description": "Template policy definition", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/list/vpn": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get VPN details", + "operationId": "getVPNListsDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN": { + "description": "VPN", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/vedge": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get vEdge template list", + "operationId": "getVedgeTemplateListDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vEdge template": { + "description": "vEdge template", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/dca/template/policy/vsmart": { + "post": { + "tags": [ + "Data Collection Agent" + ], + "description": "Get vSmart template list", + "operationId": "getVsmartTemplateListDCA", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart template": { + "description": "vSmart template", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "List all devices", + "operationId": "listAllDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of devices": { + "description": "List of devices", + "value": { + "header": { + "generatedOn": 1635153515143, + "viewKeys": { + "uniqueKey": [ + "system-ip" + ], + "preferenceKey": "grid-DeviceMultitenant" + }, + "columns": [ + { + "title": "Hostname", + "property": "host-name", + "display": "iconAndText", + "iconProperty": "device-type", + "hideable": false, + "icon": [ + { + "key": "vmanage", + "value": "images/vmanage_table.png" + }, + { + "key": "vedge", + "value": "images/vedge_table.png" + }, + { + "key": "vedge-vbond", + "value": "images/vedge-vbond_table.png" + }, + { + "key": "vsmart", + "value": "images/vsmart_table.png" + }, + { + "key": "vbond", + "value": "images/vbond_table.png" + } + ], + "width": 150, + "dataType": "string" + }, + { + "title": "Connected vManage", + "property": "connectedVManages", + "visible": true, + "width": 500, + "dataType": "array" + } + ], + "fields": [ + { + "property": "host-name", + "dataType": "string", + "display": "iconAndText" + }, + { + "property": "state", + "dataType": "string", + "display": "iconAndToolTip" + } + ] + }, + "data": [ + { + "deviceId": "169.254.10.1", + "system-ip": "169.254.10.1", + "host-name": "vm200", + "reachability": "reachable", + "status": "normal", + "personality": "vmanage", + "device-type": "vmanage", + "timezone": "UTC", + "device-groups": [ + "No groups" + ], + "lastupdated": 1634627015139, + "domain-id": "0", + "board-serial": "12345704", + "certificate-validity": "Valid", + "max-controllers": "0", + "uuid": "96af574a-eadd-4b6a-97bf-d5c1e98f40f2", + "controlConnections": "9", + "device-model": "vmanage", + "version": "20.8.999-1397", + "connectedVManages": [ + "169.254.10.1" + ], + "site-id": "200", + "latitude": "37.666684", + "longitude": "-122.777023", + "isDeviceGeoData": false, + "platform": "x86_64", + "uptime-date": 1634626320000, + "statusOrder": 4, + "device-os": "next", + "validity": "valid", + "state": "green", + "state_description": "All daemons up", + "model_sku": "None", + "local-system-ip": "172.16.255.200", + "total_cpu_count": "8", + "testbed_mode": true, + "layoutLevel": 1 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/aaa/servers": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get AAA servers from device (Real Time)", + "operationId": "getAAAservers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AAA servers": { + "description": "AAA servers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/aaa/users": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get AAA users from device (Real Time)", + "operationId": "getAAAUsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AAA users": { + "description": "AAA users" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/acl/matchcounter": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get ACL match counters from device (Real Time)", + "operationId": "getACLMatchCounterUsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL match counters": { + "description": "ACL match counters", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/action/cancel": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Cancel tasks", + "operationId": "processCancelTask", + "requestBody": { + "description": "Cancel task payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cancel task request": { + "description": "Cancel task request", + "value": "{ \n \"action\":\"cancel\",\n \"devices\":[ \n { \n \"deviceIP\":\"172.16.255.11\",\n \"deviceId\":\"6ace13f8-fded-4669-994a-a100b84b14dd\",\n \"transactionId\":\"image_download-9ebdbd1d-68ea-4238-90e5-29788f09fa75%b2c48cd3-f464-48cd-990c-d122134941d6%3600000\",\n },\n { \n \"deviceIP\":\"172.16.255.21\",\n \"deviceId\":\"bedf3db0-c9c9-439d-b5fe-0edf09c2f33f\",\n \"transactionId\":\"image_download-9ebdbd1d-68ea-4238-90e5-29788f09fa75%b2c48cd3-f464-48cd-990c-d122134941d6%3600000\",\n }\n ],\n \"deviceType\":\"vedge\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/changepartition": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get change partition information", + "operationId": "generateChangePartitionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process change partition operation", + "operationId": "processChangePartition", + "requestBody": { + "description": "Device change partition request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device change partition request": { + "description": "Device change partition request", + "value": { + "action": "changepartition", + "devices": [ + { + "version": "20.3.0", + "deviceIP": "172.16.51.1", + "deviceId": "52fe5cd3-ec3d-4141-92e4-0c31d0e0347a" + }, + { + "version": "20.3.0", + "deviceIP": "172.16.51.2", + "deviceId": "4d4507df-29b4-4f68-9129-36cfa4528847" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "change_partition-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/deactivate": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get deactivate partition information", + "operationId": "generateDeactivateInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process deactivate operation for smu image", + "operationId": "processDeactivateSmu", + "requestBody": { + "description": "Device smu image deactivate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device deactivate request": { + "description": "Device deactivate request", + "value": { + "action": "deactivate", + "devices": [ + { + "version": "20.3.0", + "deviceIP": "172.16.51.1", + "deviceId": "52fe5cd3-ec3d-4141-92e4-0c31d0e0347a" + }, + { + "version": "20.3.0", + "deviceIP": "172.16.51.2", + "deviceId": "4d4507df-29b4-4f68-9129-36cfa4528847" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "deactivate-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/defaultpartition": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process marking default partition operation", + "operationId": "processDefaultPartition", + "requestBody": { + "description": "Marking default partition request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Marking default partition request": { + "description": "Marking default partition request", + "value": { + "action": "defaultpartition", + "devices": [ + { + "version": "99.99.999-2499", + "deviceIP": "172.16.255.16", + "deviceId": "13cf949c-9192-4c5d-8096-12c41fbd366d" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "default_partition-01112017T159951140" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/filter/vpn": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get filter VPN list", + "operationId": "createFilterVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Filter VPN list": { + "description": "Filter VPN list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,RBAC VPN-read" + } + }, + "/device/action/firmware": { + "get": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Get list of firmware images in the repository", + "operationId": "getFirmwareImages", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Upload firmware image package", + "operationId": "processFirmwareImage", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/activate": { + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Activate firmware on device", + "operationId": "activateFirmwareImage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/devices": { + "get": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Get list of devices that support firmware upgrade", + "operationId": "getDevicesFWUpgrade", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + } + }, + "/device/action/firmware/install": { + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Install firmware on device", + "operationId": "installFirmwareImage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/remove": { + "post": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Remove firmware on device", + "operationId": "removeFirmwareImage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/firmware/{versionId}": { + "get": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Get firmware image details for a given version", + "operationId": "getFirmwareImageDetails", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Firmware image version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "delete": { + "tags": [ + "Configuration - Device Firmware Update" + ], + "description": "Delete firmware image package", + "operationId": "deleteFirmwareImage", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Firmware image version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/image-download": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Intitate image download on the given device.", + "operationId": "initiateImageDownload", + "requestBody": { + "description": "Image download request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Image download request": { + "description": "Image download request", + "value": "{ \n \"action\":\"image-download\",\n \"input\": { \n \"data\": [,\n { \n \"family\":\"c8000v\",\n \"remoteServerId\":\"59ced1b4-cc8d-4d2d-b5e2-da00ba1e5a72\",\n \"version\":\"9dc17146-3c25-407c-8da7-4635e0e451f1\",\n }\n ]\n },\n \"devices\":[\n { \n \"deviceIP\":\"172.16.255.14\",\n \"deviceId\":\"2f876a33-9944-450a-91ee-f1f80eb68348\"\n \"version\":\"13cf949c-9192-4c5d-8096-12c41fbd366d\",\n }\n ],\n \"deviceType\":\"vedge\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "default_partition-01112017T159951140" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/image-remove": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process remove software image operation", + "operationId": "processRemoveSoftwareImage", + "requestBody": { + "description": "Device remove software image request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device remove software image request": { + "description": "Device remove software image request", + "value": { + "action": "image-remove", + "devices": [ + { + "deviceIP": "172.16.255.11", + "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd", + "image": [ + "viptela-20.4.2-x86_64.tar.gz", + "viptela-20.6.1-x86_64.tar.gz" + ] + }, + { + "deviceIP": "172.16.255.21", + "deviceId": "bedf3db0-c9c9-439d-b5fe-0edf09c2f33f", + "image": [ + "isr4300-ucmk9.17.03.02.SPA.bin" + ] + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/install": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Generate install info", + "operationId": "generateInstallInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device install list": { + "description": "Device install list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an installation operation", + "operationId": "processInstall", + "requestBody": { + "description": "Installation payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Installation Operation": { + "description": "Installation Operation", + "value": { + "action": "install", + "input": { + "vEdgeVPN": 0, + "vSmartVPN": 0, + "version": "16.2.0", + "versionType": "vmanage", + "reboot": false, + "sync": true + }, + "devices": [ + { + "deviceIP": "172.16.255.14", + "deviceId": "2f876a33-9944-450a-91ee-f1f80eb68348" + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "software_install-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/install/devices/{deviceType}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get list of installed devices", + "operationId": "generateDeviceList", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceType" + } + }, + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/GroupId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,vmanage-http-stream" + } + }, + "/device/action/list": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get device action list", + "operationId": "generateDeviceActionList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device action list": { + "description": "Device action list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/lxcactivate": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an activation operation", + "operationId": "processLxcActivate", + "requestBody": { + "description": "Activation request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Activation Operation": { + "description": "Activation Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcdelete": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a delete operation", + "operationId": "processLxcDelete", + "requestBody": { + "description": "Delete request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete Operation": { + "description": "Delete Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcinstall": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an installation operation", + "operationId": "processLxcInstall", + "requestBody": { + "description": "Installation request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Installation Operation": { + "description": "Installation Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcreload": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a reload operation", + "operationId": "processLxcReload", + "requestBody": { + "description": "Reload request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reload Operation": { + "description": "Reload Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcreset": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a reset operation", + "operationId": "processLxcReset", + "requestBody": { + "description": "Reset request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reset Operation": { + "description": "Reset Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/lxcupgrade": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an upgrade operation", + "operationId": "processLxcUpgrade", + "requestBody": { + "description": "Upgrade request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Upgrade Operation": { + "description": "Upgrade Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/reboot": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get device reboot information", + "operationId": "generateRebootInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Reboot-read,Device Reboot-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process a reboot operation", + "operationId": "processReboot", + "requestBody": { + "description": "Device reboot request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reboot request": { + "description": "Device reboot request", + "value": { + "action": "reboot", + "deviceType": "vedge", + "devices": [ + { + "deviceIP": "172.16.255.11", + "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "reboot-01232017T154359940" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Reboot-write" + } + }, + "/device/action/reboot/devices/{deviceType}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get list of rebooted devices", + "operationId": "generateRebootDeviceList", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceType" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/GroupId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Reboot-read,Device Reboot-write" + } + }, + "/device/action/rediscover": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get rediscover operation information", + "operationId": "generateRediscoverInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-read,Tools-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Rediscover device", + "operationId": "reDiscoverDevices", + "requestBody": { + "description": "Rediscover device request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Rediscover device request": { + "description": "Rediscover device request", + "value": { + "action": "rediscover", + "devices": [ + { + "deviceId": "CSR-940ad679-a16a-48ea-9920-16278597d98e", + "deviceIP": "10.3.0.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-write,Tools-write" + } + }, + "/device/action/rediscoverall": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Rediscover all devices", + "operationId": "reDiscoverAllDevice", + "requestBody": { + "description": "Rediscover device request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Rediscover device request": { + "description": "Rediscover device request", + "value": { + "action": "rediscover", + "devices": [ + { + "deviceId": "CSR-940ad679-a16a-48ea-9920-16278597d98e", + "deviceIP": "10.3.0.1" + }, + { + "deviceId": "CSR-04ed104b-86bb-4cb3-bd2b-a0d0991f6872", + "deviceIP": "10.3.0.2" + }, + { + "deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de", + "deviceIP": "10.1.0.1" + }, + { + "deviceId": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35", + "deviceIP": "10.1.0.2" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-write,Tools-write" + } + }, + "/device/action/remote-server": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get list of remote servers", + "operationId": "getRemoteServerList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote Server List": { + "description": "Remote Server List", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "post": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Add a new remote server entry.", + "operationId": "addRemoteServer", + "requestBody": { + "description": "Request payload for a new remote server entry.", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add a new remote server entry.": { + "description": "Add a new remote server entry.", + "value": "{ \n \"remoteServerName\":\"Server1\", \n \"remoteServerUrl\":\"1.1.1.1\"\n \"remoteServerProtocol\":\"FTP\"\n \"remoteServerPort\":21\n \"remoteServerVPN\":0\n \"remoteServerUser\":\"admin\"\n \"remoteServerPassword\":\"admin\"\n \"imageLocationPrefix\":\"/home/admin/\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/remote-server/{id}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get remote server for the specified ID", + "operationId": "getRemoteServerById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Remote Server ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote Server": { + "description": "Remote Server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + }, + "put": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Update remote server for the specified ID", + "operationId": "updateRemoteServer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Remote Server ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Update an existing new remote server entry.": { + "description": "Update an existing new remote server entry.", + "value": "{ \n \"remoteServerName\":\"Server1\", \n \"remoteServerLocation\":\"1.1.1.1\"\n \"remoteServerProtocol\":\"FTP\"\n \"remoteServerPort\":21\n \"remoteServerVPN\":0\n \"remoteServerUser\":\"admin\"\n \"remoteServerPassword\":\"admin\"\n \"imageLocationPrefix\":\"/home/admin/\"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + }, + "delete": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Delete remote server for the specified ID", + "operationId": "deleteRemoteServer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Remote Server ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote Server": { + "description": "Remote Server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/removepartition": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get remove partition information", + "operationId": "generateRemovePartitionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process remove partition operation", + "operationId": "processRemovePartition", + "requestBody": { + "description": "Device remove partition request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device remove partition request": { + "description": "Device remove partition request", + "value": { + "action": "removepartition", + "devices": [ + { + "deviceIP": "172.16.255.11", + "deviceId": "6ace13f8-fded-4669-994a-a100b84b14dd", + "version": [ + "20.1.1", + "20.3.1" + ] + }, + { + "deviceIP": "172.16.255.21", + "deviceId": "bedf3db0-c9c9-439d-b5fe-0edf09c2f33f", + "version": [ + "20.1.1" + ] + } + ], + "deviceType": "vedge" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/security/amp/apikey/{uuid}": { + "delete": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process amp api key deletion operation", + "operationId": "processDeleteAmpApiKey", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Uuid", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AMP API key deletion request": { + "description": "AMP API key deletion request", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/security/amp/rekey": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process amp api re-key operation", + "operationId": "processAmpApiReKey", + "requestBody": { + "description": "AMP API re-key request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "AMP API re-key request": { + "description": "AMP API re-key request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/security/apikey/{uuid}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get API key from device", + "operationId": "testApiKey", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "API key": { + "description": "API key", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read" + } + }, + "/device/action/security/devices/{policyType}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get list of devices by security policy type", + "operationId": "generateSecurityDevicesList", + "parameters": [ + { + "name": "policyType", + "in": "path", + "description": "Policy type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "zoneBasedFW", + "intrusionPrevention", + "urlFiltering", + "advancedMalwareProtection", + "dnsSecurity", + "sslDecryption" + ] + } + }, + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/GroupId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,Settings-read,Security-read,Security-read,Security-write" + } + }, + "/device/action/software": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get software images", + "operationId": "findSoftwareImages", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software image URL": { + "description": "Software image URL", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "post": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Create software image URL", + "operationId": "createImageURL", + "requestBody": { + "description": "Create software image request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Create software image request": { + "description": "Create software image request", + "value": { + "versionName": "16.1.2", + "versionURL": "ftp://1.1.1.1/builds/16.1/" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/imageProperties/{versionId}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get Image Properties", + "operationId": "getImageProperties", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Image properties": { + "description": "Image properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/images": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get software images", + "operationId": "findSoftwareImagesWithFilters", + "parameters": [ + { + "name": "imageType", + "in": "query", + "description": "Image type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vnfType", + "in": "query", + "description": "VNF type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software image URL": { + "description": "Software image URL", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/package": { + "post": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Install software package", + "operationId": "installPkg", + "requestBody": { + "description": "File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/SoftwareUploadFile" + }, + "examples": { + "File": { + "description": "File" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "415": { + "description": "Unsupported Media Type" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/custom/file/{uuid}": { + "get": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Get bootstrap file contents", + "operationId": "getFileContents", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "File uuid", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "File content": { + "description": "File content", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + }, + "put": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Edit bootstrap file", + "operationId": "editConfigFile", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "File uuid", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Bootstrap file", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Bootstrap file": { + "description": "Bootstrap file", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Bootstrap file": { + "description": "Bootstrap file", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/custom/uploads/{type}": { + "post": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Upload virtual image/bootstrap file", + "operationId": "uploadImageFile", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Upload file type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "image", + "file" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "File content": { + "description": "File content", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/custom/vnfPackage": { + "post": { + "tags": [ + "Configuration - Device Software Package" + ], + "description": "Create VNF custom package", + "operationId": "createVnfPackage", + "requestBody": { + "description": "Custom package", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Custom package": { + "description": "Custom package", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "File content": { + "description": "File content", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/imageCount": { + "get": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Number of software image presented in vManage repository", + "operationId": "getUploadImagesCount", + "parameters": [ + { + "name": "imageType", + "in": "query", + "description": "Image type", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "default": "software" + } + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/package/{fileName}": { + "get": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Download software package file", + "operationId": "downloadPackageFile", + "parameters": [ + { + "name": "fileName", + "in": "path", + "description": "Pakcage file name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "imageType", + "in": "query", + "description": "Image type", + "required": true, + "schema": { + "type": "string", + "default": "software" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/package/{imageType}": { + "post": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Install software image package", + "operationId": "processSoftwareImage", + "parameters": [ + { + "name": "imageType", + "in": "path", + "description": "Image type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/SoftwareUploadFile" + }, + "examples": { + "File": { + "description": "File" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "415": { + "description": "Unsupported Media Type" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/package/{versionId}/metadata": { + "get": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Update Package Metadata", + "operationId": "getImageMetadata", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Image ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Device Software Update" + ], + "description": "Update Package Metadata", + "operationId": "editImageMetadata", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Image ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/action/software/pnfproperties/{pnfType}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get PNF Properties", + "operationId": "getPnfProperties", + "parameters": [ + { + "name": "pnfType", + "in": "path", + "description": "PNF type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PNF properties": { + "description": "PNF properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/remoteserver/{versionId}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get Image Remote Server Details", + "operationId": "getImageRemoteServer", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Remote Server Details": { + "description": "Remote Server Details", + "value": { + "remoteServers": [ + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e03", + "ImageRelativePath": "/images" + }, + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e14", + "ImageRelativePath": "/images/virtualImages" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + }, + "put": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Update Image Remote Server Details", + "operationId": "editImageRemoteServer", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Image ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update image remote server details", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update image remote server details": { + "description": "Update image remote server details", + "value": { + "remoteServers": [ + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e03", + "ImageRelativePath": "/images" + }, + { + "remoteServerId": "6d22e7fb-335c-4f93-a756-f2d5fa815e14", + "ImageRelativePath": "/images/virtualImages" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/vedge/version": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get vEdge software version", + "operationId": "findVEdgeSoftwareVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge software version": { + "description": "vEdge software version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/version": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get software version", + "operationId": "findSoftwareVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Software version": { + "description": "Software version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/vnfproperties/{versionId}": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get VNF Properties", + "operationId": "getVnfProperties", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VNF properties": { + "description": "VNF properties", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/software/ztp/version": { + "get": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Get ZTP software version", + "operationId": "findZtpSoftwareVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP software version": { + "description": "ZTP software version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/software/{versionId}": { + "put": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Update software image URL", + "operationId": "updateImageURL", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update software image request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update software image request": { + "description": "Update software image request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + }, + "delete": { + "tags": [ + "Configuration - Software Actions" + ], + "description": "Delete software image URL", + "operationId": "deleteImageURL", + "parameters": [ + { + "name": "versionId", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/device/action/startmonitor": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Triggers global monitoring thread", + "operationId": "triggerPendingTasksMonitoring", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status": { + "put": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Update device action status.", + "operationId": "updateDeviceActionStatus", + "requestBody": { + "description": "Update device action status", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update device action status": { + "description": "Update device action status", + "value": "{ \n \"transactionId\":\"software_install-2dfee040-d927-4d32-8a74-242a6d6d7916%C8K-30c039e8-415d-4e4f-8f70-a537aa71708a\",\n \"status\":\"in_progress\",\n \"statusMessage\": [ \n { \n \"type\":\"download-complete\",\n \"detail\":\"Image download complete.\"\n }\n }" + } + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/device/action/status/cancel/{processId}": { + "post": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Bulk cancel task status", + "operationId": "cancelPendingTasks", + "parameters": [ + { + "name": "processId", + "in": "path", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/clean": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Delete task and status vertex", + "operationId": "cleanStatus", + "parameters": [ + { + "name": "cleanStatus", + "in": "query", + "description": "Clear status flag", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "admin" + } + }, + "/device/action/status/clear": { + "delete": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Delete status of action", + "operationId": "deleteStatus", + "parameters": [ + { + "name": "processId", + "in": "query", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/preupgrade/check": { + "put": { + "tags": [ + "Configuration - Pre upgrade check status" + ], + "description": "Update pre upgrade check status", + "operationId": "updatePreUpgradeCheckStatus", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/tasks": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Find running tasks", + "operationId": "findRunningTasks", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Running tasks": { + "description": "Running tasks", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/status/tasks/activeCount": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Get active task count", + "operationId": "getActiveTaskCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Active task count": { + "description": "Active task count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write,default" + } + }, + "/device/action/status/tasks/clean": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Delete task and status vertex", + "operationId": "getCleanStatus", + "parameters": [ + { + "name": "processId", + "in": "query", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/device/action/status/{actionName}": { + "get": { + "tags": [ + "Configuration - Dashboard Status" + ], + "description": "Find status of action", + "operationId": "findStatus", + "parameters": [ + { + "name": "actionName", + "in": "path", + "description": "Action name", + "required": true, + "schema": { + "type": "string" + }, + "example": "push_feature_template_configuration-01232017T154359940" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action status": { + "description": "Action status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/test/ioxconfig/{deviceIP}": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "testIoxConfig", + "operationId": "testIoxConfig", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/action/uniquevpnlist": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Create unique VPN list", + "operationId": "createUniqueVPNList", + "requestBody": { + "description": "Device IPs", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device IPs": { + "description": "Device IPs", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Unique VPN list": { + "description": "Unique VPN list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-read" + } + }, + "/device/action/vnfinstall": { + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process an installation operation", + "operationId": "processVnfInstall", + "requestBody": { + "description": "Installation request payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Installation Operation": { + "description": "Installation Operation", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Software Upgrade-write" + } + }, + "/device/action/vpn": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Create VPN list", + "operationId": "createVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN list": { + "description": "VPN list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/action/ztp/upgrade": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get ZTP upgrade configuration", + "operationId": "getZTPUpgradeConfig", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade config": { + "description": "ZTP upgrade config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process ZTP upgrade configuration", + "operationId": "processZTPUpgradeConfig", + "requestBody": { + "description": "ZTP upgrade config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade config": { + "description": "ZTP upgrade config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/device/action/ztp/upgrade/setting": { + "get": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Get ZTP upgrade configuration setting", + "operationId": "getZTPUpgradeConfigSetting", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade config setting": { + "description": "ZTP upgrade config setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Device Actions" + ], + "description": "Process ZTP upgrade configuration setting", + "operationId": "processZTPUpgradeConfigSetting", + "requestBody": { + "description": "ZTP upgrade setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ZTP upgrade setting": { + "description": "ZTP upgrade setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/device/app-hosting/attached-devices": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting attached device from device", + "operationId": "getAppHostingAttachedDevices", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting attached device": { + "description": "App hosting attached device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/details": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting details from device", + "operationId": "getAppHostingDetails", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting details": { + "description": "App hosting details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/guest-routes": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting guest routes from device", + "operationId": "getAppHostingGuestRoutes", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting guest routes": { + "description": "App hosting guest routes", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/network-interfaces": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting network interface from device", + "operationId": "getAppHostingNetworkDevices", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting network interface": { + "description": "App hosting network interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/network-utilization": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting network utilization from device", + "operationId": "getAppHostingNetworkUtils", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting network utilization": { + "description": "App hosting network utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/processes": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting processes from device", + "operationId": "getAppHostingProcesses", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting processes utilization": { + "description": "App hosting processes utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/storage-utilization": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting storage utilization from device", + "operationId": "getAppHostingStorageUtils", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting storage utilization": { + "description": "App hosting storage utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-hosting/utilization": { + "get": { + "tags": [ + "Real-Time Monitoring - App Hosting" + ], + "description": "Get App hosting utilization from device", + "operationId": "getAppHostingUtilization", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App hosting utilization": { + "description": "App hosting utilization", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/app-route/sla-class": { + "get": { + "tags": [ + "Real-Time Monitoring - Application-Aware Route" + ], + "description": "Get SLA class list from device (Real Time)", + "operationId": "createAppRouteSlaClassList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SLA class": { + "description": "SLA class", + "value": { + "data": [ + { + "app-probe-class": "None", + "loss": 0, + "fallback-best-tunnel": "None", + "jitter": 0, + "vdevice-dataKey": "169.254.10.10-0", + "vdevice-name": "169.254.10.10", + "latency": 0, + "name": "__all_tunnels__", + "index": 0, + "lastupdated": 1642576726463, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/app-route/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Application-Aware Route" + ], + "description": "Get application-aware routing statistics from device (Real Time)", + "operationId": "createAppRouteStatisticsList", + "parameters": [ + { + "name": "remote-system-ip", + "in": "query", + "description": "Remote system IP", + "schema": { + "type": "string" + } + }, + { + "name": "local-color", + "in": "query", + "description": "Local color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "remote-color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application-aware routing statistics": { + "description": "Application-aware routing statistics", + "value": { + "data": [ + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.2.2", + "tx-data-pkts": "0", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "dst-port": "12426", + "remote-color": "default", + "remote-system-ip": "172.16.254.1", + "fallback-sla-class-index": "None", + "mean-latency": 0, + "total-packets": "600", + "loss": "0", + "mean-jitter": 0, + "average-latency": "0", + "index": "3", + "sla-class-index": "0", + "vdevice-host-name": "vm3", + "local-color": "default", + "app-probe-class": "None", + "mean-loss": 0, + "vdevice-dataKey": "169.254.10.10-3", + "proto": "ipsec", + "lastupdated": 1642577794383, + "average-jitter": "0", + "rx-data-pkts": "0" + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.2.2", + "tx-data-pkts": "0", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "dst-port": "12426", + "remote-color": "default", + "remote-system-ip": "172.16.254.1", + "fallback-sla-class-index": "None", + "mean-latency": 0, + "total-packets": "600", + "loss": "0", + "mean-jitter": 0, + "average-latency": "0", + "index": "4", + "sla-class-index": "0", + "vdevice-host-name": "vm3", + "local-color": "default", + "app-probe-class": "None", + "mean-loss": 0, + "vdevice-dataKey": "169.254.10.10-4", + "proto": "ipsec", + "lastupdated": 1642577794385, + "average-jitter": "0", + "rx-data-pkts": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/app/log/flow-count": { + "get": { + "tags": [ + "Real-Time Monitoring - App Logs" + ], + "description": "Get App log flows count from device (Real Time)", + "operationId": "getAppLogFlowCount", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App log flows count": { + "description": "App log flows count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/app/log/flows": { + "get": { + "tags": [ + "Real-Time Monitoring - App Logs" + ], + "description": "Get App log flows from device (Real Time)", + "operationId": "getAppLogFlows", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App log flows": { + "description": "App log flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/appqoe/active-flow-id": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Active flow Id details from device", + "operationId": "createAppqoeActiveFlowIdDetails", + "parameters": [ + { + "name": "flow-id", + "in": "query", + "description": "Flow Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Active FlowId details": { + "description": "Appqoe Flow Active FlowId details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/appqoe/appqoe-hput-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Hput Statistics from device", + "operationId": "getAppqoeHputStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Hput Statistics": { + "description": "Appqoe Hput Statistics", + "value": { + "data": [ + { + "hs-sch-delay20us": "2569563", + "hs-time-node-dealloc": "10730115", + "uhs-callout-drain": "0", + "uhs-stop-cancel": "0", + "hs-exp-list-process": "237791", + "hs-curr-node-null": "0", + "hs-sch-delay200us": "4110", + "hs-sch-delay10000us": "6741", + "uhs-callout-unlock": "0", + "uhs-add": "1624643", + "uhs-rst-sbt-drain": "0", + "hs-timer-deleted": "0", + "hs-sch-delay300us": "1809", + "uhs-stop-del-cancel": "0", + "hs-sch-delay400us": "1541", + "uhs-add-fail": "0", + "hs-sch-delay1000000us": "0", + "hs-sch-delay1000us": "1069", + "uhs-stop-no-pending": "4", + "hs-timer-del-failed": "0", + "hs-expired-send-sig": "224059", + "uhs-stop-nodrain": "0", + "hs-sch-delay500us": "1444", + "hs-sch-delay30us": "198079", + "hs-timer-alloc": "10730124", + "hs-time-node-added": "10713486", + "uhs-stop": "4", + "uhs-callout-lock": "0", + "uhs-raw-add": "9105481", + "hs-ktimer-start": "17812503", + "hs-sch-delay600us": "1463", + "hs-ktimer-cb": "10475629", + "uhs-rst-sbt-del": "0", + "hs-expired-list-alloc": "237791", + "hs-sch-delay700us": "1417", + "hs-timer-cb": "10730115", + "uhs-callout": "1624635", + "uhs-raw-cb": "9105480", + "hs-timer-add-req": "10730124", + "vdevice-name": "169.254.10.12", + "uhs-rst-sbt-req": "1624643", + "hs-sch-delay40us": "27818", + "hs-timer-dealloc": "10730115", + "uhs-callout-done": "1624635", + "hs-time-node-deleted": "10713477", + "hs-sch-delay100000us": "2", + "uhs-callout-not-pending": "0", + "uhs-raw-add-failed": "0", + "hs-timer-del-req": "0", + "hs-pending-list-process": "224059", + "uhs-rst-sbt-add": "1624643", + "uhs-callout-cancel": "0", + "hs-sch-delay800us": "1334", + "hs-sch-delay10us": "7627736", + "hs-expired-list-dealloc": "237791", + "hs-min-sch-delay": "4330", + "uhs-callout-call": "1624635", + "uhs-callout-del": "0", + "uhs-rst-sbt-cancel": "0", + "vdevice-host-name": "vm5", + "hs-sch-delay900us": "1186", + "hs-time-node-alloc": "10730124", + "hs-time-node-exist": "0", + "hs-sch-delay50us": "13812", + "uhs-stop-drain": "0", + "uhs-stop-del": "0", + "hs-time-node-expired": "1642", + "vdevice-dataKey": "169.254.10.12", + "hs-curr-node-ts-not-valid": "0", + "hs-timer-added": "10493918", + "hs-sch-delay100us": "16505", + "uihs-nr-hpts-cpu": "0", + "hs-timer-add-expired": "236206", + "hs-max-sch-delay": "36715506", + "lastupdated": 1644996827424, + "hs-ktimer-stop": "17812503" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-nat-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Nat Statistics from device", + "operationId": "getAppqoeNatStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Nat Statistics": { + "description": "Appqoe Nat Statistics", + "value": { + "data": [ + { + "port-alloc-fail": "0", + "port-free-succ": "0", + "port-free-fail": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "alloc-fail": "0", + "lastupdated": 1644997117219, + "dup-entries": "0", + "vdevice-host-name": "vm5", + "port-alloc-succ": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-rm-resource": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Resource Manager resources from device", + "operationId": "getAppqoeRmResources", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Resource Manager resources": { + "description": "Appqoe Resource Manager resources", + "value": { + "data": [ + { + "ssl-max-sess": "40000", + "avail-sys-mem": "2411556", + "dre-mem-per-sess": "0", + "ssl-used-sess": "0", + "vdevice-name": "169.254.10.12", + "rm-global-health-flag": "status-green", + "rm-tcp-sess-flag": "status-green", + "dre-used-sess": "0", + "tcp-max-sess": "40000", + "http-mem-per-sess": "0", + "vdevice-host-name": "vm5", + "rm-svc-mem-flag": "status-green", + "vdevice-dataKey": "169.254.10.12", + "per-used-serv-mem": "0", + "used-serv-mem": "0", + "http-max-sess": "0", + "tcp-used-sess": "0", + "ssl-mem-per-sess": "50", + "tcp-mem-per-sess": "64", + "lastupdated": 1644997246553, + "http-used-sess": "0", + "max-serv-mem": "1205778", + "dre-max-sess": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-rm-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe RM Statistics from device", + "operationId": "getAppqoeRMStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe RM Statistics": { + "description": "Appqoe RM Statistics", + "value": { + "data": [ + { + "port-alloc-fail": "0", + "port-free-succ": "0", + "port-free-fail": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "alloc-fail": "0", + "lastupdated": 1644997491529, + "dup-entries": "0", + "vdevice-host-name": "vm5", + "port-alloc-succ": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-services-status": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Services Status from device", + "operationId": "getAppqoeServicesStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Services Status": { + "description": "Appqoe Services Status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "service": "appqoe-service-tcpopt", + "load-percentage": "0", + "lastupdated": 1644998907908, + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "service": "appqoe-service-ssl", + "load-percentage": "0", + "lastupdated": 1644998907908, + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "load-status": "appqoe-service-status-red", + "vdevice-name": "169.254.10.12", + "service": "appqoe-service-dreopt", + "lastupdated": 1644998907908, + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-sppi-pipe-resource": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Sppi Pipe Stats from device", + "operationId": "getAppqoeSppiPipeStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Sppi Pipe Statistics": { + "description": "Appqoe Sppi Pipe Statistics", + "value": { + "data": [ + { + "p-invalid-mtu": "0", + "p-disconnect": "0", + "p-in-use": "0", + "p-invalid-queue-id": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "channel-num": "0", + "lastupdated": 1644997573992, + "p-ifindex-error": "0", + "vdevice-host-name": "vm5", + "p-sock-error": "0" + }, + { + "p-invalid-mtu": "0", + "p-disconnect": "0", + "p-in-use": "0", + "p-invalid-queue-id": "0", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "channel-num": "1", + "lastupdated": 1644997573993, + "p-ifindex-error": "0", + "vdevice-host-name": "vm5", + "p-sock-error": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/appqoe-sppi-queue-resource": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Sppi Queue Stats from device", + "operationId": "getAppqoeSppiQueueStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Sppi Queue Statistics": { + "description": "Appqoe Sppi Queue Statistics", + "value": { + "data": [ + { + "pkt-send-failed": "0", + "vdevice-name": "169.254.10.12", + "poll-error": "0", + "tpkt-version-error": "0", + "mmap-error": "0", + "truncated": "0", + "no-pkt-buf": "0", + "pkt-available": "0", + "invalid-ring": "0", + "vdevice-host-name": "vm5", + "in-use": "0", + "no-dev": "0", + "pkt-read-failed": "0", + "invalid-mode": "0", + "vdevice-dataKey": "169.254.10.12", + "nomem": "0", + "no-iov-buf": "0", + "not-init": "0", + "sock-error": "0", + "pkt": "8", + "channel-num": "0", + "lastupdated": 1644998764198, + "invalid-size": "0", + "pkt-losing": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/cluster-summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Cluster Summary from device", + "operationId": "getAppqoeClusterSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Cluster Summary": { + "description": "Appqoe Cluster Summary", + "value": { + "data": [ + { + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "load-percentage": "0", + "system-ip": "172.16.254.4", + "sng-name": "SNG-APPQOE", + "site-id": "5", + "vdevice-host-name": "vm5", + "lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.2", + "error-message": "-", + "service": "appqoe-service-tcpopt", + "lastupdated": 1644995623537, + "device-mode": "device-mode-integrated-service-node", + "status": "sn-status-green" + }, + { + "load-status": "appqoe-service-status-green", + "vdevice-name": "169.254.10.12", + "load-percentage": "0", + "system-ip": "172.16.254.4", + "sng-name": "SNG-APPQOE", + "site-id": "5", + "vdevice-host-name": "vm5", + "lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.2", + "error-message": "-", + "service": "appqoe-service-ssl", + "lastupdated": 1644995623537, + "device-mode": "device-mode-integrated-service-node", + "status": "sn-status-green" + }, + { + "load-status": "appqoe-service-status-red", + "vdevice-name": "169.254.10.12", + "system-ip": "172.16.254.4", + "sng-name": "SNG-APPQOE", + "site-id": "5", + "vdevice-host-name": "vm5", + "lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.2", + "error-message": "-", + "service": "appqoe-service-dreopt", + "lastupdated": 1644995623537, + "device-mode": "device-mode-integrated-service-node", + "status": "sn-status-green" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/error-recent": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe error recent from device", + "operationId": "getAppqoeErrorRecent", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Error Recent": { + "description": "Appqoe Error Recent", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-res-tcp-used-sess", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-res-ssl-used-sess", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-health-yellow", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-health-green", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-tcp-sess-alloc", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-tcp-sess-free", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-ssl-sess-alloc", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-rm-ssl-sess-free", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-tcp-tot-conn", + "vdevice-host-name": "vm5" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "stat-current": "0", + "stat-60s": "0", + "lastupdated": 1644995930359, + "stat-30s": "0", + "label": "appqoe-stat-tcp-tot-flow-create", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/expired-flow-id": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Expired flow Id details from device", + "operationId": "createAppqoeFlowIdExpiredDetails", + "parameters": [ + { + "name": "flow-id", + "in": "query", + "description": "Flow Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Expired flow Id details": { + "description": "Appqoe Expired flow Id details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/appqoe/flow-closed-error": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe flow closed error from device", + "operationId": "getAppqoeFlowClosedError", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Closed Error": { + "description": "Appqoe Flow Closed Error", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/flow-expired": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe expired from device", + "operationId": "getAppqoeExpired", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Expired List": { + "description": "Appqoe Flow Expired List", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/appqoe/service-controllers": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe service controllers from device", + "operationId": "getAppqoeServiceControllers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Service Controllers": { + "description": "Appqoe Service Controllers", + "value": { + "data": [ + { + "sn-lan-ip": "192.168.2.2", + "vdevice-dataKey": "169.254.10.12-192.168.2.1", + "vdevice-name": "169.254.10.12", + "sc-lan-ip": "192.168.2.1", + "system-ip": "172.16.254.4", + "lastupdated": 1644996521181, + "site-id": "5", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe status from device", + "operationId": "getAppqoeStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Status": { + "description": "Appqoe Status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-sslproxy", + "err-tag": "appqoe-err-ca-tp-cfg", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-yellow" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-tcpproxy", + "err-tag": "appqoe-err-undef", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-green" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-sc", + "err-tag": "appqoe-err-undef", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-green" + }, + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "module": "appqoe-module-rm", + "err-tag": "appqoe-err-undef", + "appqoe-status": "appqoe-status-yellow", + "lastupdated": 1644996370984, + "vdevice-host-name": "vm5", + "status": "appqoe-status-green" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/appqoe/vpn-id": { + "get": { + "tags": [ + "Real-Time Monitoring - Appqoe" + ], + "description": "Get Appqoe Active vpn Id details from device", + "operationId": "createAppqoeVpnIdList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "client-ip", + "in": "query", + "description": "Client Ip", + "schema": { + "type": "string" + } + }, + { + "name": "server-ip", + "in": "query", + "description": "Server Ip", + "schema": { + "type": "string" + } + }, + { + "name": "server-port", + "in": "query", + "description": "Server-Port", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Appqoe Flow Active VpnId List": { + "description": "Appqoe Flow Active VpnId List", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/arp": { + "get": { + "tags": [ + "Real-Time Monitoring - ARP" + ], + "description": "Get ARP interfaces from device (Real Time)", + "operationId": "getARPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ARP interface": { + "description": "ARP interface", + "value": { + "data": [ + { + "if-name": "ge0/1", + "idle-timer": "0:00:10:36", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "10.101.254.254", + "lastupdated": 1642578468257, + "state": "dynamic", + "vpn-id": "0", + "uptime-date": 1642160280000, + "vdevice-host-name": "vm3", + "mac": "52:54:00:7a:da:f8", + "uptime": "4:20:09:23" + }, + { + "if-name": "eth0", + "vdevice-dataKey": "169.254.10.10-512-eth0", + "vdevice-name": "169.254.10.10", + "ip": "10.0.1.3", + "lastupdated": 1642578468257, + "state": "static", + "vpn-id": "512", + "uptime-date": 1642154760000, + "vdevice-host-name": "vm3", + "mac": "00:50:56:00:01:03", + "uptime": "4:21:41:16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/bfd/history": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get BFD session history from device (Real Time)", + "operationId": "createBFDHistoryList", + "parameters": [ + { + "name": "system-ip", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD session history": { + "description": "BFD session history", + "value": { + "data": [ + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "default", + "tx-pkts": 3856, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187218000, + "system-ip": "172.16.254.1", + "index": 8, + "dst-port": 12386, + "del": 0, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-8-2022-01-14T19:06:58+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:58+0000", + "state": "down", + "rx-pkts": 3855 + }, + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "default", + "tx-pkts": 6, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187218000, + "system-ip": "172.16.254.1", + "index": 9, + "dst-port": 12386, + "del": 1, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-9-2022-01-14T19:06:58+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:58+0000", + "state": "down", + "rx-pkts": 6 + }, + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "biz-internet", + "tx-pkts": 0, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187219000, + "system-ip": "172.16.254.1", + "index": 6, + "dst-port": 12406, + "del": 0, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-6-2022-01-14T19:06:59+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:59+0000", + "state": "down", + "rx-pkts": 0 + }, + { + "dst-ip": "10.101.2.2", + "src-ip": "10.101.3.3", + "color": "biz-internet", + "tx-pkts": 6, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642187219000, + "system-ip": "172.16.254.1", + "index": 7, + "dst-port": 12406, + "del": 0, + "site-id": 2, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-7-2022-01-14T19:06:59+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T19:06:59+0000", + "state": "up", + "rx-pkts": 6 + }, + { + "dst-ip": "10.102.5.5", + "src-ip": "10.101.3.3", + "color": "default", + "tx-pkts": 95431, + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "time-date": 1642577832000, + "system-ip": "172.16.254.4", + "index": 8, + "dst-port": 12386, + "del": 0, + "site-id": 5, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-8-2022-01-19T07:37:12+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-19T07:37:12+0000", + "state": "down", + "rx-pkts": 95426 + }, + { + "dst-ip": "10.102.16.16", + "src-ip": "10.102.3.3", + "color": "lte", + "tx-pkts": 0, + "vdevice-name": "169.254.10.10", + "src-port": 12366, + "time-date": 1642163442000, + "system-ip": "172.16.254.16", + "index": 6, + "dst-port": 12366, + "del": 0, + "site-id": 16, + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-6-2022-01-14T12:30:42+0000", + "proto": "ipsec", + "lastupdated": 1642581869106, + "time": "2022-01-14T12:30:42+0000", + "state": "down", + "rx-pkts": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/links": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get list of BFD connections", + "operationId": "createBFDLinkList", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Device state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD connections": { + "description": "BFD connections", + "value": { + "data": [ + { + "linkKey": "172.16.255.14:lte - 172.16.255.16:lte", + "linkKeyDisplay": "172.16.255.14 (lte) - 172.16.255.16 (lte)", + "asystem-ip": "172.16.255.16", + "bhost-name": "vm4", + "lastupdated": "1642494861369", + "bsite-id": "400", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.14", + "ahost-name": "vm6", + "adeviceId": "172.16.255.16", + "asite-id": "600", + "bsystem-ip": "172.16.255.14" + }, + { + "linkKey": "172.16.255.11:lte - 172.16.255.16:lte", + "linkKeyDisplay": "172.16.255.11 (lte) - 172.16.255.16 (lte)", + "asystem-ip": "172.16.255.16", + "bhost-name": "vm1", + "lastupdated": "1642663041881", + "bsite-id": "100", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.11", + "ahost-name": "vm6", + "adeviceId": "172.16.255.16", + "asite-id": "600", + "bsystem-ip": "172.16.255.11" + }, + { + "linkKey": "172.16.255.16:lte - 172.16.255.21:lte", + "linkKeyDisplay": "172.16.255.16 (lte) - 172.16.255.21 (lte)", + "asystem-ip": "172.16.255.16", + "bhost-name": "vm11", + "lastupdated": "1642494861369", + "bsite-id": "100", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.21", + "ahost-name": "vm6", + "adeviceId": "172.16.255.16", + "asite-id": "600", + "bsystem-ip": "172.16.255.21" + }, + { + "linkKey": "172.16.255.15:lte - 172.16.255.16:lte", + "linkKeyDisplay": "172.16.255.15 (lte) - 172.16.255.16 (lte)", + "asystem-ip": "172.16.255.15", + "bhost-name": "vm6", + "lastupdated": "1642975004139", + "bsite-id": "600", + "color1": "lte", + "bpersonality": "vedge", + "state": "up", + "color2": "lte", + "apersonality": "vedge", + "bdeviceId": "172.16.255.16", + "ahost-name": "vm5", + "adeviceId": "172.16.255.15", + "asite-id": "500", + "bsystem-ip": "172.16.255.16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/bfd/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get list of BFD sessions from vManage (Real Time)", + "operationId": "createBFDSessions", + "parameters": [ + { + "name": "system-ip", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-color", + "in": "query", + "description": "Source color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "region-type", + "in": "query", + "description": "Region type", + "schema": { + "type": "string", + "enum": [ + "core", + "access" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD sessions": { + "description": "BFD sessions", + "value": { + "data": [ + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.2.2", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.1", + "dst-port": 12426, + "site-id": 2, + "transitions": 1, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:14:04:10", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.1-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642532640000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.101.4.4", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.3", + "dst-port": 12386, + "site-id": 4, + "transitions": 1, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:14:04:10", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.3-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642532640000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.102.5.5", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.4", + "dst-port": 12386, + "site-id": 5, + "transitions": 3, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:01:31:46", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.4-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642577820000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.102.6.6", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.5", + "dst-port": 12386, + "site-id": 6, + "transitions": 2, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:01:36:07", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.5-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642577520000 + }, + { + "src-ip": "10.101.3.3", + "dst-ip": "10.102.16.16", + "color": "default", + "vdevice-name": "169.254.10.10", + "src-port": 12346, + "system-ip": "172.16.254.16", + "dst-port": 12386, + "site-id": 16, + "transitions": 1, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:14:04:10", + "detect-multiplier": "7", + "vdevice-dataKey": "169.254.10.10-default-172.16.254.16-default-ipsec", + "proto": "ipsec", + "lastupdated": 1642583341666, + "state": "up", + "tx-interval": 1000, + "uptime-date": 1642532640000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/sites/detail": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get detailed BFD site details", + "operationId": "getBFDSiteStateDetail", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD site detail: state=siteup": { + "description": "BFD site detail: state=siteup", + "value": { + "data": [ + { + "bfdSessions": "5", + "site-id": "4", + "device-type": "vedge", + "uuid": "4125a7b2-65cd-43c5-a393-cba53ebcdc00", + "lastupdated": 1648413952287, + "reachability": "reachable", + "device-model": "vedge-cloud", + "version": "20.3.4-542", + "system-ip": "169.254.10.11", + "uptime-date": 1646298000000, + "controlConnections": "3", + "host-name": "vm4", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.3", + "board-serial": "12345709" + }, + { + "bfdSessions": "5", + "site-id": "16", + "device-type": "vedge", + "uuid": "CSR-aec2123c-f20b-4876-b9ac-ae1dba561fb5", + "lastupdated": 1648416356665, + "reachability": "reachable", + "device-model": "vedge-CSR-1000v", + "version": "17.03.06.0.6691", + "system-ip": "169.254.10.14", + "uptime-date": 1647300780000, + "controlConnections": "3", + "host-name": "vm16", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.16", + "board-serial": "1234570F" + }, + { + "bfdSessions": "5", + "site-id": "5", + "device-type": "vedge", + "uuid": "C8K-d721a892-1cc1-4a30-9d17-98387348e2d4", + "lastupdated": 1648418760239, + "reachability": "reachable", + "device-model": "vedge-C8000V", + "version": "17.06.03.0.3496", + "system-ip": "169.254.10.12", + "uptime-date": 1646298240000, + "controlConnections": "3", + "host-name": "vm5", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.4", + "board-serial": "1234570A" + }, + { + "bfdSessions": "5", + "site-id": "2", + "device-type": "vedge", + "uuid": "f713e867-4376-45f1-8ecf-7c5fbe2be2f8", + "lastupdated": 1648453581214, + "reachability": "reachable", + "device-model": "vedge-cloud", + "version": "20.8.0-218", + "system-ip": "169.254.10.9", + "uptime-date": 1648060560000, + "controlConnections": "3", + "host-name": "vm2", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.1", + "board-serial": "12345707" + }, + { + "bfdSessions": "5", + "site-id": "6", + "device-type": "vedge", + "uuid": "C8K-47924f4e-0029-4693-a3df-986cb132437f", + "lastupdated": 1648413353813, + "reachability": "reachable", + "device-model": "vedge-C8000V", + "version": "17.08.01.0.1034", + "system-ip": "169.254.10.13", + "uptime-date": 1646298240000, + "controlConnections": "3", + "host-name": "vm6", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.254.5", + "board-serial": "1234570B" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "RBAC VPN-read,RBAC VPN-write" + } + }, + "/device/bfd/sites/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get BFD site summary", + "operationId": "getBFDSitesSummary", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Flag for caching", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "Filter VPN", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD site summary": { + "description": "BFD site summary", + "value": { + "data": [ + { + "count": 6, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "Full WAN Connectivity", + "status": "up", + "message": "6 Full WAN Connectivity", + "detailsURL": "/dataservice/device/bfd/sites/detail?state=siteup", + "count": 6 + }, + { + "name": "Partial WAN Connectivity", + "status": "warning", + "message": "0 Partial WAN Connectivity", + "detailsURL": "/dataservice/device/bfd/sites/detail?state=sitepartial", + "count": 0 + }, + { + "name": "No WAN Connectivity", + "status": "down", + "message": "0 No WAN Connectivity", + "detailsURL": "/dataservice/device/bfd/sites/detail?state=sitedown", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,System-read,System-write" + } + }, + "/device/bfd/state/device": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD state summary", + "operationId": "getDeviceBFDStateSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD state summary": { + "description": "BFD state summary", + "value": { + "data": [ + { + "site-id": 400, + "color": "lte", + "vmanage-system-ip": "172.16.255.11", + "local-color": "lte", + "local-if-desc": "", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.14-lte-ipsec", + "tx-interval": 1000, + "vdevice-host-name": "vm1", + "transitions": 0, + "proto": "ipsec", + "lastupdated": 1642663028239, + "state": "up", + "uptime-date": 1642663020000, + "dst-port": 12366, + "system-ip": "172.16.255.14", + "dst-ip": "10.1.14.14", + "remote-if-desc": "", + "createTimeStamp": 1642494963368, + "src-port": 12347, + "vdevice-name": "172.16.255.11", + "@rid": 936, + "detect-multiplier": "7", + "src-ip": "10.0.5.11", + "local-remote-ifname": "ge0/2-ge0/4" + }, + { + "site-id": 600, + "color": "lte", + "vmanage-system-ip": "172.16.255.11", + "local-color": "lte", + "local-if-desc": "", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.16-lte-ipsec", + "tx-interval": 1000, + "vdevice-host-name": "vm1", + "transitions": 0, + "proto": "ipsec", + "lastupdated": 1642663028239, + "state": "up", + "uptime-date": 1642663020000, + "dst-port": 12366, + "system-ip": "172.16.255.16", + "dst-ip": "10.1.16.16", + "remote-if-desc": "", + "createTimeStamp": 1642494971424, + "src-port": 12347, + "vdevice-name": "172.16.255.11", + "@rid": 947, + "detect-multiplier": "7", + "src-ip": "10.0.5.11", + "local-remote-ifname": "ge0/2-GigabitEthernet1" + }, + { + "site-id": 500, + "color": "lte", + "vmanage-system-ip": "172.16.255.11", + "local-color": "lte", + "local-if-desc": "", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.15-lte-ipsec", + "tx-interval": 1000, + "vdevice-host-name": "vm1", + "transitions": 0, + "proto": "ipsec", + "lastupdated": 1642663028239, + "state": "up", + "uptime-date": 1642663020000, + "dst-port": 12346, + "system-ip": "172.16.255.15", + "dst-ip": "10.1.15.15", + "remote-if-desc": "", + "createTimeStamp": 1642657637570, + "src-port": 12347, + "vdevice-name": "172.16.255.11", + "@rid": 1004, + "detect-multiplier": "7", + "src-ip": "10.0.5.11", + "local-remote-ifname": "ge0/2-GigabitEthernet1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,System-read,System-write" + } + }, + "/device/bfd/state/device/tloc": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD state summary with tloc color", + "operationId": "getDeviceBFDStateSummaryTloc", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD state summary with tloc": { + "description": "BFD state summary with tloc", + "value": { + "data": [ + { + "local-color": [ + "lte", + "dia" + ], + "color": [ + "lte", + "dia" + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/device/bfd/state/device/tlocInterfaceMap": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device tloc color to Intf Mapping Relationship", + "operationId": "getDeviceTlocToIntfList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device tloc to intf mapping relationships": { + "description": "Device tloc to intf mapping relationships", + "value": { + "intfList": { + "private1": "GigabitEthernet1", + "mpls": "GigabitEthernet2" + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/device/bfd/status": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD status", + "operationId": "getDeviceBFDStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD status": { + "description": "BFD status", + "value": { + "data": [ + { + "count": 0, + "statusList": [ + { + "status": "up", + "count": 0, + "name": "up", + "color": "b0e276", + "detailsURL": "/dataservice/device/bfd/links?state=up", + "detailView": "dialog", + "icon": "images/connection/connection-network-up.png" + }, + { + "status": "down", + "count": 0, + "name": "down", + "color": "fa7c7d", + "detailsURL": "/dataservice/device/bfd/links?state=down", + "detailView": "dialog", + "icon": "images/connection/connection-network-down.png" + } + ], + "name": "BFD", + "image": "images/bfd.png", + "detailsURL": "/dataservice/device/bfd/links", + "type": "bfd", + "detailView": "dialog" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/bfd/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get BFD summary from device (Real Time)", + "operationId": "createBFDSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD summary": { + "description": "BFD summary", + "value": { + "data": [ + { + "bfd-sessions-max": "22", + "vdevice-dataKey": "169.254.10.10", + "bfd-sessions-flap": "111", + "vdevice-name": "169.254.10.10", + "bfd-sessions-up": "5", + "lastupdated": 1642641879344, + "bfd-sessions-total": "5", + "poll-interval": "600000", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/summary/device": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get device BFD status summary", + "operationId": "getDeviceBFDStatusSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BFD status summary": { + "description": "BFD status summary", + "value": { + "header": { + "generatedOn": 1646894919672, + "title": "DataConnections" + }, + "data": [ + { + "name": "DataConnection", + "count": 3, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "up", + "message": "3up", + "detailsURL": "/dataservice/device/bfd/sessions?deviceId=172.16.255.11&state=up", + "count": 3 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/bfd/synced/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get list of BFD sessions from vManage synchronously", + "operationId": "createSyncedBFDSession", + "parameters": [ + { + "name": "system-ip", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Remote color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-color", + "in": "query", + "description": "Source color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BFD sessions": { + "description": "BFD sessions", + "value": { + "data": [ + { + "src-ip": "10.0.5.11", + "dst-ip": "10.1.14.14", + "color": "lte", + "vdevice-name": "172.16.255.11", + "src-port": 12347, + "createTimeStamp": 1646804370042, + "system-ip": "172.16.255.14", + "dst-port": 12366, + "site-id": 400, + "transitions": 0, + "vdevice-host-name": "vm1", + "local-color": "lte", + "detect-multiplier": "7", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.14-lte-ipsec", + "@rid": 1050, + "vmanage-system-ip": "172.16.255.11", + "proto": "ipsec", + "lastupdated": 1646893777827, + "tx-interval": 1000, + "state": "up", + "uptime-date": 1646893680000 + }, + { + "src-ip": "10.0.5.11", + "dst-ip": "10.1.15.15", + "color": "lte", + "vdevice-name": "172.16.255.11", + "src-port": 12347, + "createTimeStamp": 1646804372038, + "system-ip": "172.16.255.15", + "dst-port": 12366, + "site-id": 500, + "transitions": 0, + "vdevice-host-name": "vm1", + "local-color": "lte", + "detect-multiplier": "7", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.15-lte-ipsec", + "@rid": 1057, + "vmanage-system-ip": "172.16.255.11", + "proto": "ipsec", + "lastupdated": 1646893777827, + "tx-interval": 1000, + "state": "up", + "uptime-date": 1646893680000 + }, + { + "src-ip": "10.0.5.11", + "dst-ip": "10.1.16.16", + "color": "lte", + "vdevice-name": "172.16.255.11", + "src-port": 12347, + "createTimeStamp": 1646804374521, + "system-ip": "172.16.255.16", + "dst-port": 12366, + "site-id": 600, + "transitions": 0, + "vdevice-host-name": "vm1", + "local-color": "lte", + "detect-multiplier": "7", + "vdevice-dataKey": "172.16.255.11-lte-172.16.255.16-lte-ipsec", + "@rid": 1060, + "vmanage-system-ip": "172.16.255.11", + "proto": "ipsec", + "lastupdated": 1646893777827, + "tx-interval": 1000, + "state": "up", + "uptime-date": 1646893680000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bfd/tloc": { + "get": { + "tags": [ + "Real-Time Monitoring - BFD" + ], + "description": "Get TLOC summary from device (Real Time)", + "operationId": "createTLOCSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TLOC summary": { + "description": "TLOC summary", + "value": { + "data": [ + { + "sessions-flap": 90, + "if-name": "ge0/1", + "sessions-total": 5, + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642641739756, + "encap": "ipsec", + "sessions-up": 5, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/bgp/neighbors": { + "get": { + "tags": [ + "Real-Time Monitoring - BGP" + ], + "description": "Get BGP neighbors list (Real Time)", + "operationId": "createBGPNeighborsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "peer-addr", + "in": "query", + "description": "Peer address", + "schema": { + "type": "string" + } + }, + { + "name": "as", + "in": "query", + "description": "AS number", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BGP neighbors list": { + "description": "BGP neighbors list", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "afi": "ipv4-unicast", + "vpn-id": 10, + "vdevice-host-name": "vm3", + "peer-addr": "20.20.20.20", + "as": 200, + "vdevice-dataKey": "169.254.10.10-10-20.20.20.20", + "msg-rcvd": 0, + "outQ": 0, + "afi-id": 0, + "lastupdated": 1642657118366, + "msg-sent": 0, + "state": "active" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/bgp/routes": { + "get": { + "tags": [ + "Real-Time Monitoring - BGP" + ], + "description": "Get BGP routes list (Real Time)", + "operationId": "createBGPRoutesList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "nexthop", + "in": "query", + "description": "Next hop", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "BGP routes list": { + "description": "BGP routes list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.15", + "prefix": "10.20.24.0/24", + "origin": "origin-incomplete", + "as-path": "10007", + "weight": "0", + "vpn-id": "1", + "vdevice-host-name": "vm5", + "nexthop": "10.20.24.17", + "afi-safi": "vpnv4-unicast", + "path-id": "0", + "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-10.20.24.0/24", + "metric": "0", + "local-pref": "100", + "lastupdated": 1646989331657, + "path-status": "valid" + }, + { + "vdevice-name": "172.16.255.15", + "prefix": "10.20.24.0/24", + "origin": "origin-incomplete", + "weight": "32768", + "vpn-id": "1", + "vdevice-host-name": "vm5", + "nexthop": "0.0.0.0", + "afi-safi": "vpnv4-unicast", + "path-id": "0", + "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-10.20.24.0/24", + "metric": "0", + "local-pref": "100", + "lastupdated": 1646989331694, + "path-status": "bestpathvalid" + }, + { + "vdevice-name": "172.16.255.15", + "prefix": "172.16.255.117/32", + "origin": "origin-incomplete", + "as-path": "10007", + "weight": "0", + "vpn-id": "1", + "vdevice-host-name": "vm5", + "nexthop": "10.20.24.17", + "afi-safi": "vpnv4-unicast", + "path-id": "0", + "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-172.16.255.117/32", + "metric": "0", + "local-pref": "100", + "lastupdated": 1646989331735, + "path-status": "bestpathvalid" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/bgp/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - BGP" + ], + "description": "Get BGP summary (Real Time)", + "operationId": "createBGPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "BGP summary": { + "description": "BGP summary", + "value": { + "data": [ + { + "local-site-of-origin": "SoO:0:3", + "vdevice-dataKey": "169.254.10.10-10", + "bgp-router-identifier": "172.16.254.2", + "peer-memory": "4816", + "vdevice-name": "169.254.10.10", + "rib-memory": "0", + "lastupdated": 1642657523957, + "total-peers": "1", + "vpn-id": 10, + "vdevice-host-name": "vm3", + "rib-entries": "0", + "local-as": "100" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/blockSync": { + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Set collection manager block set flag", + "operationId": "setBlockSync", + "parameters": [ + { + "name": "blockSync", + "in": "query", + "description": "Block sync flag", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/bridge/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - Bridge" + ], + "description": "Get device bridge interface list (Real Time)", + "operationId": "getBridgeInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bridge interface": { + "description": "Device bridge interface", + "value": { + "data": [ + { + "ifindex": "13", + "vdevice-name": "10.0.0.121", + "oper-status": "up", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/0", + "admin-status": "up", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/0", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "14", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/1", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/1", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "15", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/2", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/2", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "16", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/3", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/3", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + }, + { + "ifindex": "17", + "vdevice-name": "10.0.0.121", + "oper-status": "down", + "vdevice-host-name": "ISR4451-X", + "mtu": "1500", + "if-name": "GigabitEthernet0/3/4", + "admin-status": "down", + "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/4", + "vlan": "1", + "native-vlan": "true", + "lastupdated": 1650883014316, + "bridge-id": "1", + "encap-type": "vlan" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/bridge/mac": { + "get": { + "tags": [ + "Real-Time Monitoring - Bridge" + ], + "description": "Get device bridge interface MAC (Real Time)", + "operationId": "getBridgeInterfaceMac", + "parameters": [ + { + "name": "bridge-id", + "in": "query", + "description": "Bridge ID", + "schema": { + "type": "string" + } + }, + { + "name": "if-name", + "in": "query", + "description": "Interface name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "mac-address", + "in": "query", + "description": "MAC address", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bridge interface MAC": { + "description": "Device bridge interface MAC", + "value": { + "data": [ + { + "if-name": "Ethernet-Internal2/0/0", + "mac-address": "58:bc:27:6d:c3:09", + "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-58:bc:27:6d:c3:09", + "vlan": "1", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1", + "interface": "GigabitEthernet0/3/0", + "type": "bridge-mac-type-dynamic", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "mac-address": "a4:4c:11:9e:03:d7", + "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:03:d7", + "vlan": "1", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1", + "interface": "GigabitEthernet0/3/0", + "type": "bridge-mac-type-dynamic", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "mac-address": "a4:4c:11:9e:1d:cc", + "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:1d:cc", + "vlan": "1", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1", + "type": "bridge-mac-type-static", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "vdevice-dataKey": "10.0.0.121-1002-Ethernet-Internal2/0/0-", + "vlan": "1002", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1002", + "vdevice-host-name": "ISR4451-X" + }, + { + "if-name": "Ethernet-Internal2/0/0", + "vdevice-dataKey": "10.0.0.121-1003-Ethernet-Internal2/0/0-", + "vlan": "1003", + "vdevice-name": "10.0.0.121", + "lastupdated": 1650882797794, + "bridge-id": "1003", + "vdevice-host-name": "ISR4451-X" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/bridge/table": { + "get": { + "tags": [ + "Real-Time Monitoring - Bridge" + ], + "description": "Get device bridge interface table (Real Time)", + "operationId": "getBridgeInterfaceTable", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bridge interface": { + "description": "Device bridge interface", + "value": { + "data": [ + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 4, + "routing-interface": "Vlan1", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1", + "vlan": "1", + "tx-octets": "0", + "tx-packets": "0", + "name": "default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1002", + "vlan": "1002", + "tx-octets": "0", + "tx-packets": "0", + "name": "fddi-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1002", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1003", + "vlan": "1003", + "tx-octets": "0", + "tx-packets": "0", + "name": "token-ring-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1003", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1004", + "vlan": "1004", + "tx-octets": "0", + "tx-packets": "0", + "name": "fddinet-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1004", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + }, + { + "flood-packets": "0", + "max-macs": 1024, + "move": 0, + "vdevice-name": "10.0.0.121", + "learn": 0, + "age-time": 300, + "rx-packets": "0", + "rx-routed-packets": "0", + "num-macs": 0, + "routing-interface": "null", + "vdevice-host-name": "ISR4451-X", + "vdevice-dataKey": "10.0.0.121-1005", + "vlan": "1005", + "tx-octets": "0", + "tx-packets": "0", + "name": "trnet-default", + "rx-octets": "0", + "lastupdated": 1650882963285, + "bridge-id": "1005", + "flood-octets": "0", + "tx-routed-packets": "0", + "age": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/connection": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular connection list from device", + "operationId": "createCellularConnectionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular connection list": { + "description": "Cellular connection list", + "value": [ + { + "lastupdated": 1649242617635, + "cellular-interface": "Cellular0/1/0", + "active-profile": "1", + "cellular-packet-status": "packet-session-status-active", + "rx-packets": "20905", + "rx-bytes": "10301", + "tx-packets": "20905", + "tx-bytes": "10301", + "ipv4-addr": "29.29.29.105", + "ipv4-dns-pri": "8.0.0.8", + "ipv4-dns-sec": "4.4.4.4", + "ipv6-addr": "2001:a0:c::1a", + "ipv6-dns-pri": "2400:da00::6666", + "ipv6-dns-sec": "2400:da00::6666", + "scope": "scope", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/hardware": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular hardware list from device", + "operationId": "createHardwareList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular hardware list": { + "description": "Cellular hardware list", + "value": [ + { + "lastupdated": 1649242617635, + "cellular-interface": "Cellular0/1/0", + "cellular-firmware-build-time": "1649242617635", + "cellular-firmware-version": "1.0", + "cellular-hardware-version": "1.0", + "cellular-device-model": "HMOD1", + "cellular-imsi": "HUID1", + "cellular-imei": "imei", + "cellular-iccid": "iccid", + "cellular-msisdn": "msisdn", + "cellular-fsn": "fsn", + "cellular-modem-status": "active", + "cellular-modem-temperature": "16c", + "cellular-pri-skuid": "skuid", + "cellular-pri-version": "2.0", + "cellular-carrier": "carrier", + "cellular-oem-pri-version": "2.0", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/modem": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular modem list from device", + "operationId": "createModemList", + "parameters": [ + { + "name": "policyId", + "in": "query", + "description": "Policy IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular modem list": { + "description": "Cellular modem list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "model": "model", + "fw-version": "1.0", + "fw-date": "2022-04-18", + "fw-time": "1649242617635", + "fw-pkg-ver": "1.2", + "fw-pkg-carrier": "carrier", + "fw-pkg-pri": "pri", + "fw-pkg-subver": "subver", + "hw-version": "1.5", + "modem-status": "active", + "temperature": "16c", + "imsi": "imsi", + "imei": "imei", + "iccid": "iccid", + "msisdn": "msisdn", + "esn": "esn", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/network": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular network list from device", + "operationId": "createNetworkList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular network list": { + "description": "Cellular network list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "reg-status": "status", + "roam-status": "status", + "domain-status": "status", + "mcc": "mcc", + "mnc": "mnc", + "nw-name": "name", + "emm-state": "state", + "emm-substate": "good", + "emm-connstate": "good", + "cellid": "cellid", + "tac": "tac", + "sid": "sid", + "nid": "nid", + "bid": "bid", + "lac": "lac", + "psc": "psc", + "bsic": "bsic", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/profiles": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular profile list from device", + "operationId": "createProfileList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular profile list": { + "description": "Cellular profile list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "profile-id": "123", + "pdn-type": "type", + "apn": "apn", + "name": "name", + "auth": "auth", + "ip-addr": "172.16.255.15", + "primary-dns": "8.8.8.8", + "secondary-dns": "4.4.4.4", + "user-name": "uname", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/radio": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular radio list from device", + "operationId": "createRadioList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular radio list": { + "description": "Cellular radio list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "band": 123, + "bandwidth": 1000.2, + "tx-channel": 1, + "rx-channel": 2, + "rssi": 1, + "rsrp": 2, + "rsrp-comment": "comment", + "rsrq": 4, + "rsrq-comment": "comment", + "snr": 3.4, + "snr-comment": "comment", + "ecio": "ecio", + "sinr": "sinr", + "io": "io", + "mode": "mode", + "band-class": "band class", + "channel": "unam123e", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular session list from device", + "operationId": "createSessionsList", + "parameters": [ + { + "name": "if-name", + "in": "query", + "description": "Interface name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "ipv4-dns-pri", + "in": "query", + "description": "DNS primary IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular session list": { + "description": "Cellular session list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "session-id": "123", + "data-bearer": "bearer", + "dormancy-state": "state", + "active-profile": 1, + "rx-packets": 18, + "rx-drops": 15, + "rx-errors": 888, + "rx-overflows": 444, + "rx-octets": 235, + "tx-packets": 234, + "tx-drops": 234, + "tx-errors": 123, + "tx-overflows": 123, + "tx-octets": 123, + "ipv4-addr": "172.16.255.15", + "ipv4-mask": "255.255.255.0", + "ipv4-gw": "192.168.0.1", + "ipv4-dns-pri": "8.8.8.8", + "ipv4-dns-sec": "4.4.4.4", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellular/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular" + ], + "description": "Get cellular status list from device", + "operationId": "getCellularStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cellular status list": { + "description": "Cellular status list", + "value": [ + { + "lastupdated": 1649242617635, + "if-name": "Cellular0/1/0", + "modem-status": "status", + "sim-status": "status", + "signal-strength": "12", + "network-status": "health", + "last-seen-error": "last error", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/cellularEiolte/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Connection Service" + ], + "description": "Get cellular connection info from device", + "operationId": "getEiolteConnectionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular connection info": { + "description": "cellular connection info", + "value": [ + { + "vdevice-name": "172.16.255.111", + "rx-errors": 0, + "cellular-interface-name": "Cellular 1/0", + "tx-errors": 0, + "sec-dns-ipv4-addr": "0.0.0.0", + "pri-dns-ipv4-addr": "8.8.8.8", + "tx-ofl": 0, + "connectivity": "Attach and Data", + "ipv4-address": "192.168.3.2", + "rx-ofl": 0, + "rx-pkts": 42067, + "apn": "internet", + "ipv6-prefix-length": "0", + "tx-pkts": 36604, + "ipv4-gateway-addr": "192.168.3.1", + "session-status": "Connected", + "pri-dns-ipv6-addr": "::", + "sec-dns-ipv6-addr": "::", + "vdevice-host-name": "CellularGateway", + "tx-drops": 0, + "rx-drops": 0, + "vdevice-dataKey": "172.16.255.111-1-1-", + "profile-id": 1, + "modem-index": "1", + "tx-bytes": 10145490, + "lastupdated": 1649249750021, + "ipv6-gw-prefix-length": "0", + "ipv6-gw-prefix": "::", + "rx-bytes": 8887213, + "ipv6-prefix": "::" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/hardware": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Hardware Service " + ], + "description": "Get cellular hardware info from device", + "operationId": "getEiolteHardwareInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular hardware info": { + "description": "cellular hardware info", + "value": [ + { + "ICCID": "8952530306500032705", + "FSN": "4H0222009903AG", + "host-manufacturer": "Cisco Systems, Inc.", + "vdevice-name": "172.16.255.111", + "PRI-SKU-ID": "1104567", + "Modem-Status": "MODEM_STATE_DNS_ACQUIRED", + "cellular-interface-name": "Cellular 1/0", + "Firmware-Version": "SWIX55C_03.07.00.00 fef145 jenkins", + "host-software-version": "N/A", + "IMEI": "351735110100118", + "Model-ID": "EM9190", + "vdevice-host-name": "CellularGateway", + "vdevice-dataKey": "172.16.255.111-1-", + "Modem-Temperature": 33, + "PRI-Version": "030.018_000", + "IMSI": "001010123456063", + "OEM-PRI-Version": "001.021", + "modem-index": "1", + "Host-Firmware-Version": "SWIX55C_03.07.00.00 fef145 jenkins", + "lastupdated": 1649250029516, + "Carrier": "GENERIC", + "host-id": "N/A", + "host-model": "N/A" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/ipsec/interface/counters": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular AON Ipsec Interface " + ], + "description": "Get cellular ipsec interface info from device", + "operationId": "getAONIpsecInterfaceCountersInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular info": { + "description": "cellular info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/ipsec/interface/session": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular AON Ipsec Interface " + ], + "description": "Get cellular ipsec interface info from device", + "operationId": "getAONIpsecInterfaceSessionnfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular info": { + "description": "cellular info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/network": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Network Service" + ], + "description": "Get cellular network info from device", + "operationId": "getEiolteNetworkInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular network info": { + "description": "cellular network info", + "value": [ + { + "Network-Selection-Mode": "Automatic", + "MNC": 1, + "vdevice-name": "172.16.255.111", + "cellular-interface-name": "Cellular 1/0", + "MCC": 1, + "vdevice-host-name": "CellularGateway", + "MTU": 1500, + "System-Time": "Thu Mar 24 3:6:0 2022", + "PS-State": "Attached", + "Roaming-Status": "Home", + "RRC-Connection-State": "RRC Connected", + "vdevice-dataKey": "172.16.255.111-1-", + "Network": "Test PLMN 1-1", + "EMM-State": "Registered", + "TAC": 1, + "Cell-ID": 27447297, + "modem-index": "1", + "lastupdated": 1649250149676, + "Current-Service": "Packet switched", + "Current-Service-status": "Normal", + "EMM-Sub-State": "Normal-Service" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/radio": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Connection Service" + ], + "description": "Get cellular radio info from device", + "operationId": "getEiolteRadioInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular radio info": { + "description": "cellular radio info", + "value": [ + { + "Current-ENDC-RSRQ": "-11 dB", + "Current-ENDC-RSRP": "-71 dBm", + "vdevice-name": "172.16.255.111", + "LTE-Bandwidth": "20 MHz", + "cellular-interface-name": "Cellular 1/0", + "Offline-Reason": "Unknown", + "LTE-Rx-Channel-Number": 18300, + "Measured-ENDC-SINR": "36.0 dB", + "ENDC-active-downlink-channel": "632628", + "Low-Power-Reason": "Unknown", + "ENDC-active-band": "78", + "SNR": "30.0 dB", + "ENDC-Physical-CellId": "500", + "LTE-Band": 1, + "RSRP": "-60 dBm", + "Radio-Status": "online", + "ENDC-active-uplink-channel": "632628", + "RSRQ": "-7 dB", + "LTE-Tx-Channel-Number": 300, + "vdevice-host-name": "CellularGateway", + "RSSI": "-33 dBm", + "vdevice-dataKey": "172.16.255.111-1-", + "PCI": 1, + "ENDC-bandwidth": "50 MHz", + "modem-index": "1", + "lastupdated": 1649250251234, + "RAT-Selected": "LTE" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cellularEiolte/sim": { + "get": { + "tags": [ + "Real-Time Monitoring - Cellular EIOLTE Sim Service" + ], + "description": "Get cellular sim info from device", + "operationId": "getEiolteSimInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Ip address, example:172.16.255.111", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cellular sim info": { + "description": "cellular sim info", + "value": [ + { + "active-sim": 0, + "vdevice-dataKey": "172.16.255.111-1-", + "vdevice-name": "172.16.255.111", + "cellular-interface-name": "Cellular 1/0", + "sim-status-slot-0": "Present", + "modem-index": "1", + "sim-status-slot-1": "Not Present", + "lastupdated": 1649250373414, + "vdevice-host-name": "CellularGateway" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,System-read" + } + }, + "/device/cflowd/application/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get Cflowd DPI query field JSON", + "operationId": "getCflowdDPIDeviceFieldJSON", + "parameters": [ + { + "name": "isDeviceDashBoard", + "in": "query", + "description": "Flag whether it is device dashboard request", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI query field in JSON": { + "description": "DPI query field in JSON", + "value": { + "header": {}, + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + } + ] + }, + { + "property": "vpn_id", + "name": "VPN", + "isRequired": true, + "multiSelect": false, + "dataType": "int", + "fieldData": { + "type": "url", + "url": "dataservice/device/action/vpn" + } + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "isHidden": true, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/collector": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd collector list from device", + "operationId": "createCflowdCollectorList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cflowd collector list": { + "description": "Cflowd collector list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/device/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get CflowdvDPI query field JSON", + "operationId": "getCflowdDPIFieldJSON", + "parameters": [ + { + "name": "isDeviceDashBoard", + "in": "query", + "description": "Flag whether it is device dashboard request", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI query field in JSON": { + "description": "DPI query field in JSON", + "value": [ + { + "name": "Event Time", + "dataType": "date", + "isRequired": true, + "property": "entry_time", + "options": [ + { + "enableDateFields": false, + "value": "Last 24 hours", + "key": "last_24_hours", + "number": "24" + }, + { + "enableDateFields": false, + "value": "Last 12 hours", + "key": "last_12_hours", + "number": "12" + }, + { + "enableDateFields": false, + "value": "Last 6 hours", + "key": "last_6_hours", + "number": "6" + }, + { + "enableDateFields": false, + "value": "Last 3 hours", + "key": "last_3_hours", + "number": "3" + }, + { + "enableDateFields": false, + "value": "Last 1 hour", + "key": "last_1_hour", + "number": "1" + }, + { + "enableDateFields": false, + "value": "Last 7 days", + "key": "last_168_hours", + "number": "168" + } + ], + "fieldData": { + "type": "dateList" + } + }, + { + "dataType": "string", + "isRequired": true, + "property": "dest_ip", + "multiSelect": false, + "name": "Destination Ip" + }, + { + "dataType": "long", + "isRequired": true, + "property": "dest_port", + "multiSelect": false, + "name": "Destination port" + }, + { + "name": "Device name", + "dataType": "string", + "isRequired": true, + "multiSelect": false, + "property": "vdevice_name", + "isHidden": true + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/flows": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get list of cflowd flows from device", + "operationId": "createCflowCollectorList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "src-ip", + "in": "query", + "description": "Source IP", + "schema": { + "type": "string" + } + }, + { + "name": "dest-ip", + "in": "query", + "description": "Destination IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cflowd flows list": { + "description": "Cflowd flows list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/flows-count": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd flow count from device", + "operationId": "createCflowdFlowsCountList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "src-ip", + "in": "query", + "description": "Source IP", + "schema": { + "type": "string" + } + }, + { + "name": "dest-ip", + "in": "query", + "description": "Destination IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cflowd flow count": { + "description": "Cflowd flow count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/cache-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF cache stats from device", + "operationId": "getFnFCacheStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF cache stats": { + "description": "FnF cache stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/export-client-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF export client stats from device", + "operationId": "getFnFExportClientStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF export client stats": { + "description": "FnF export client stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/export-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF export stats from device", + "operationId": "getFnFExportStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF export stats": { + "description": "FnF export stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/flow-monitor": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF from device", + "operationId": "getFnf", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF": { + "description": "FnF", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/fnf/monitor-stats": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get FnF monitor stats from device", + "operationId": "getFnFMonitorStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FnF monitor stats": { + "description": "FnF monitor stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/statistics": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd statistics from device", + "operationId": "createCflowdStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cflowd statistics": { + "description": "Cflowd statistics", + "value": [ + { + "model_sk": "None", + "state_description": "All daemons up", + "site-id": "200", + "version": "20.7.999-1133", + "local-system-ip": "172.16.255.22", + "timezone": "UTC", + "controlConnections": "7", + "domain-id": "0", + "total_cpu_count": "2", + "device-groups": [ + "No groups" + ], + "device-type": "vmanage", + "uuid": "b9944bb0-b10b-427a-8fb4-5d3b51eec679", + "lastupdated": 1639105319291, + "platform": "x86_64", + "state": "green", + "host-name": "vm12", + "uptime-date": 1638953400000, + "latitude": "37.666684", + "system-ip": "172.16.255.22", + "personality": "vmanage", + "status": "normal", + "board-serial": "12345963", + "validity": "valid", + "certificate-validity": "Valid", + "max-controllers": "0", + "device-model": "vmanage", + "deviceId": "172.16.255.22", + "layoutLevel": 1, + "testbed_mode": true, + "device-os": "next", + "isDeviceGeoData": false, + "connectedVManages": [ + "172.16.255.22" + ], + "longitude": "-122.777023", + "reachability": "reachable", + "statusOrder": 4 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cflowd/template": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get cflowd template from device", + "operationId": "createCflowdTemplate", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cflowd template": { + "description": "Cflowd template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/cfm/mp/database": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp database from device", + "operationId": "getMpDatabase", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp database": { + "description": "Mp database", + "value": { + "data": [ + { + "defect": "defect-none", + "flag": "rmep-flag-none", + "vdevice-dataKey": "172.16.255.11", + "vdevice-name": "172.16.255.11", + "level": "7", + "service": "UNINET_VERLEANDROVALLE-17_5005", + "domain": "UNINET", + "local-mep-id": "1562", + "lastupdated": 1648692601592, + "remote-mep-id": "1561", + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cfm/mp/local/mep": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp local mep from device", + "operationId": "getMpLocalMep", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "Domain Name", + "schema": { + "type": "string" + } + }, + { + "name": "service", + "in": "query", + "description": "Service Name", + "schema": { + "type": "string" + } + }, + { + "name": "mep-id", + "in": "query", + "description": "MEP ID", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp local mep": { + "description": "Mp local mep", + "value": { + "data": [ + { + "svc-type": "cfm-svc-bd-vlan", + "offload-success": "false", + "vdevice-name": "172.16.255.11", + "level": "7", + "offload": "false", + "ccm-mode": "ccm-mode-multicast", + "dir": "mep-direction-down", + "vdevice-host-name": "vm1", + "svc-inst": "0", + "mep-id": "1562", + "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562", + "vlan": "112", + "port": "GigabitEthernet3", + "evc-name": "UNINET_VERLEANDROVALLE-17_5005", + "service": "UNINET_VERLEANDROVALLE-17_5005", + "ccm-state": "ccm-enabled", + "domain": "UNINET", + "lastupdated": 1648692897652, + "mac-addr": "52:54:00:fb:57:42" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cfm/mp/local/mip": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp local mip from device", + "operationId": "getMpLocalMip", + "parameters": [ + { + "name": "level", + "in": "query", + "description": "Level", + "schema": { + "type": "number" + } + }, + { + "name": "port", + "in": "query", + "description": "Port", + "schema": { + "type": "string" + } + }, + { + "name": "svc-inst", + "in": "query", + "description": "Service Instance", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp local mip": { + "description": "Mp local mip", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cfm/mp/remotemep": { + "get": { + "tags": [ + "Real-Time Monitoring - CFM" + ], + "description": "Get mp remote mep from device", + "operationId": "getMpRemoteMep", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "Domain Name", + "schema": { + "type": "string" + } + }, + { + "name": "service", + "in": "query", + "description": "Service Name", + "schema": { + "type": "string" + } + }, + { + "name": "local-mep-id", + "in": "query", + "description": "Local MEP ID", + "schema": { + "type": "number" + } + }, + { + "name": "remote-mep-id", + "in": "query", + "description": "Remote MEP ID", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Mp remote mep": { + "description": "Mp remote mep", + "value": { + "data": [ + { + "svc-type": "cfm-svc-bd-vlan", + "vdevice-name": "172.16.255.11", + "level": "7", + "remote-mep-id": "1561", + "if-status": "if-status-up", + "vdevice-host-name": "vm1", + "port-status": "port-status-up", + "svc-inst": "0", + "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562-1561", + "vlan": "112", + "evc-name": "UNINET_VERLEANDROVALLE-17_5005", + "service": "UNINET_VERLEANDROVALLE-17_5005", + "rdi": "false", + "domain": "UNINET", + "up-time": "2022-03-31T02:24:16.459+00:00", + "local-mep-id": "1562", + "lastupdated": 1648693001718, + "mac-addr": "52:54:00:aa:65:ba", + "ingress-if": "GigabitEthernet3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/cloudx/application/detail": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress applications from device (Real Time)", + "operationId": "createApplicationsDetailList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress applications detail": { + "description": "Cloudexpress applications detail", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress applications from device (Real Time)", + "operationId": "createApplicationsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress applications": { + "description": "Cloudexpress applications", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/gatewayexits": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress gateway exits from device (Real Time)", + "operationId": "createGatewayExitsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress gateway exits": { + "description": "Cloudexpress gateway exits", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/loadbalance": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress load balance applications from device (Real Time)", + "operationId": "createLbApplicationsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress load-balance applications-lb": { + "description": "Cloudexpress load-balance applications-lb", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/cloudx/localexits": { + "get": { + "tags": [ + "Real-Time Monitoring - CloudExpress" + ], + "description": "Get list of cloudexpress local exits from device (Real Time)", + "operationId": "createLocalExitsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudexpress local exits": { + "description": "Cloudexpress local exits", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/config": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device running configuration", + "operationId": "getDeviceRunningConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Device running configuration": { + "description": "Device running configuration" + } + } + }, + "text/xml": { + "schema": { + "type": "string" + }, + "examples": { + "Device running configuration": { + "description": "Device running configuration" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/config/html": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device running configuration in HTML format", + "operationId": "getDeviceRunningConfigHTML", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/html": { + "schema": { + "type": "string" + }, + "examples": { + "Device running configuration": { + "description": "Device running configuration" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true + } + }, + "/device/configuration/commit-list": { + "get": { + "tags": [ + "Real-Time Monitoring - Commit List" + ], + "description": "Get device commit list", + "operationId": "getDeviceConfigurationCommitList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device commit list": { + "description": "Device commit list", + "value": { + "data": [ + { + "time-stamp": "2022-03-1006:53:10", + "vdevice-dataKey": "172.16.255.11-0-10032", + "vdevice-name": "172.16.255.11", + "client": "system", + "lastupdated": 1646900329409, + "sn": "0", + "id": "10032", + "user": "system-vdaemon", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:48:02", + "vdevice-dataKey": "172.16.255.11-1-10031", + "vdevice-name": "172.16.255.11", + "client": "netconf", + "lastupdated": 1646900329409, + "sn": "1", + "id": "10031", + "user": "vmanage-admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:47:42", + "vdevice-dataKey": "172.16.255.11-2-10030", + "vdevice-name": "172.16.255.11", + "client": "cli", + "lastupdated": 1646900329409, + "sn": "2", + "id": "10030", + "user": "admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:28:31", + "vdevice-dataKey": "172.16.255.11-3-10026", + "vdevice-name": "172.16.255.11", + "client": "system", + "lastupdated": 1646900329409, + "sn": "3", + "id": "10026", + "user": "system-vdaemon", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:23:22", + "vdevice-dataKey": "172.16.255.11-4-10025", + "vdevice-name": "172.16.255.11", + "client": "netconf", + "lastupdated": 1646900329409, + "sn": "4", + "id": "10025", + "user": "vmanage-admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1006:02:22", + "vdevice-dataKey": "172.16.255.11-5-10024", + "vdevice-name": "172.16.255.11", + "client": "netconf", + "lastupdated": 1646900329409, + "sn": "5", + "id": "10024", + "user": "vmanage-admin", + "vdevice-host-name": "vm1" + }, + { + "time-stamp": "2022-03-1005:56:46", + "vdevice-dataKey": "172.16.255.11-6-10023", + "vdevice-name": "172.16.255.11", + "client": "system", + "lastupdated": 1646900329409, + "sn": "6", + "id": "10023", + "user": "system-vdaemon", + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/control/affinity/config": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get affinity config from device (Real Time)", + "operationId": "getAffinityConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Affinity config": { + "description": "Affinity config", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10--0", + "vdevice-name": "169.254.10.10", + "affc-ccl": "0(2)Y", + "affc-equil": "Yes", + "affc-ecl": "0(2)", + "affc-index": "0", + "lastupdated": 1642746599493, + "affc-interface": "ge0/1", + "affc-last-resort": "No", + "vdevice-host-name": "vm3", + "affc-ervc": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/affinity/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get affinity status from device (Real Time)", + "operationId": "getAffinityStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Affinity status": { + "description": "Affinity status", + "value": { + "data": [ + { + "affs-acc": "172.16.253.129(0),172.16.255.130(0)", + "vdevice-dataKey": "169.254.10.10--0", + "vdevice-name": "169.254.10.10", + "affs-index": "0", + "lastupdated": 1642746754330, + "vdevice-host-name": "vm3", + "affs-interface": "ge0/1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list from device (Real Time)", + "operationId": "createRealTimeConnectionList", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "domain-id": 1, + "instance": 0, + "vdevice-name": "169.254.10.10", + "behind-proxy": "No", + "system-ip": "172.16.253.129", + "remote-color": "default", + "site-id": 129, + "private-port": 12346, + "controller-group-id": 0, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:05:55:35", + "peer-type": "vsmart", + "v-org-name": "vIPtela Inc Regression", + "protocol": "dtls", + "vdevice-dataKey": "169.254.10.10-0-default-172.16.253.129-default", + "public-ip": "10.103.129.129", + "public-port": 12346, + "lastupdated": 1642727162594, + "state": "up", + "private-ip": "10.103.129.129", + "uptime-date": 1642705800000 + }, + { + "domain-id": 1, + "instance": 0, + "vdevice-name": "169.254.10.10", + "behind-proxy": "No", + "system-ip": "172.16.255.130", + "remote-color": "default", + "site-id": 130, + "private-port": 12346, + "controller-group-id": 0, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:05:55:35", + "peer-type": "vsmart", + "v-org-name": "vIPtela Inc Regression", + "protocol": "dtls", + "vdevice-dataKey": "169.254.10.10-0-default-172.16.255.130-default", + "public-ip": "10.103.130.130", + "public-port": 12346, + "lastupdated": 1642727162594, + "state": "up", + "private-ip": "10.103.130.130", + "uptime-date": 1642705800000 + }, + { + "domain-id": 0, + "instance": 0, + "vdevice-name": "169.254.10.10", + "behind-proxy": "No", + "system-ip": "169.254.10.3", + "remote-color": "default", + "site-id": 202, + "private-port": 12346, + "controller-group-id": 0, + "vdevice-host-name": "vm3", + "local-color": "default", + "uptime": "0:05:55:35", + "peer-type": "vmanage", + "v-org-name": "vIPtela Inc Regression", + "protocol": "dtls", + "vdevice-dataKey": "169.254.10.10-0-default-169.254.10.3-default", + "public-ip": "10.103.202.202", + "public-port": 12346, + "lastupdated": 1642727162594, + "state": "up", + "private-ip": "10.103.202.202", + "uptime-date": 1642705800000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/control/connectionshistory": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections history list from device (Real Time)", + "operationId": "createConnectionHistoryListRealTime", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "0.0.0.0", + "remote-color": "default", + "site-id": 0, + "uuid": "d7e88eac-250c-4189-bc66-747615452ad9", + "peer-type": "vbond", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.135.135", + "local_enum-desc": "Disconnect vBond after register reply.", + "domain-id": 0, + "rep-count": 0, + "index": 0, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "default", + "downtime": "2022-01-20T19:10:43+0000", + "vdevice-dataKey": "169.254.10.10-0-0-2022-01-20T19:10:43+0000", + "public-ip": "10.103.135.135", + "downtime-date": 1642705843000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISCVBD" + }, + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "169.254.10.3", + "remote-color": "default", + "site-id": 202, + "uuid": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", + "peer-type": "vmanage", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.202.202", + "local_enum-desc": "TLOC Disabled.", + "domain-id": 0, + "rep-count": 0, + "index": 1, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "biz-internet", + "downtime": "2022-01-20T19:10:24+0000", + "vdevice-dataKey": "169.254.10.10-0-1-2022-01-20T19:10:24+0000", + "public-ip": "10.103.202.202", + "downtime-date": 1642705824000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISTLOC" + }, + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "172.16.255.130", + "remote-color": "default", + "site-id": 130, + "uuid": "fca7532b-9366-466a-a8f9-79922392917b", + "peer-type": "vsmart", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.130.130", + "local_enum-desc": "TLOC Disabled.", + "domain-id": 1, + "rep-count": 0, + "index": 2, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "biz-internet", + "downtime": "2022-01-20T19:10:24+0000", + "vdevice-dataKey": "169.254.10.10-0-2-2022-01-20T19:10:24+0000", + "public-ip": "10.103.130.130", + "downtime-date": 1642705824000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISTLOC" + }, + { + "instance": 0, + "vdevice-name": "169.254.10.10", + "remote_enum-desc": "No Error.", + "system-ip": "169.254.10.3", + "remote-color": "default", + "site-id": 202, + "uuid": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", + "peer-type": "vmanage", + "protocol": "dtls", + "state": "tear_down", + "private-ip": "10.103.202.202", + "local_enum-desc": "TLOC Disabled.", + "domain-id": 0, + "rep-count": 0, + "index": 5, + "private-port": 12346, + "vdevice-host-name": "vm3", + "local-color": "default", + "downtime": "2022-01-20T19:09:22+0000", + "vdevice-dataKey": "169.254.10.10-0-5-2022-01-20T19:09:22+0000", + "public-ip": "10.103.202.202", + "downtime-date": 1642705762000, + "remote_enum": "NOERR", + "public-port": 12346, + "lastupdated": 1642727714927, + "local_enum": "DISTLOC" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/connectionsinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list from device (Real Time)", + "operationId": "createRealTimeConnectionList_1", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11---", + "vdevice-name": "172.16.255.11", + "rate": "Per-Control Connection Rate: 300 pps", + "lastupdated": 1646962973344, + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/control/count": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get number of vedges and vsmart device in different control states", + "operationId": "getTotalCountForDeviceStates", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Device State cached", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device state count": { + "description": "Device state count", + "value": { + "data": [ + { + "name": "ControlStatus", + "count": 7, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "Controlup", + "status": "up", + "message": "devicesup", + "detailsURL": "/dataservice/device/control/networksummary?state=up", + "count": 7 + }, + { + "name": "Partial", + "status": "warning", + "message": "devicesdown", + "detailsURL": "/dataservice/device/control/networksummary?state=partial", + "count": 0 + }, + { + "name": "Controldown", + "status": "error", + "message": "devicesdown", + "detailsURL": "/dataservice/device/control/networksummary?state=down", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/links": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list", + "operationId": "createLinkList", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Device State", + "required": true, + "schema": { + "type": "string", + "example": "up" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "state": "up", + "color1": "default", + "color2": "default", + "lastupdated": "1646912547015", + "linkKey": "172.16.255.19:default-172.16.255.26:default", + "linkKeyDisplay": "172.16.255.19(default)-172.16.255.26(default)", + "adeviceId": "172.16.255.26", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.26", + "bsystem-ip": "172.16.255.19", + "asite-id": "--", + "bsite-id": "100", + "ahost-name": "vm16", + "bhost-name": "vm9", + "apersonality": "vbond", + "bpersonality": "vsmart" + }, + { + "state": "up", + "color1": "default", + "color2": "default", + "lastupdated": "1646912512113", + "linkKey": "172.16.255.20:default-172.16.255.26:default", + "linkKeyDisplay": "172.16.255.20(default)-172.16.255.26(default)", + "adeviceId": "172.16.255.26", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.26", + "bsystem-ip": "172.16.255.20", + "asite-id": "--", + "bsite-id": "200", + "ahost-name": "vm16", + "bhost-name": "vm10", + "apersonality": "vbond", + "bpersonality": "vsmart" + }, + { + "state": "up", + "color1": "default", + "color2": "default", + "lastupdated": "1646912347752", + "linkKey": "172.16.255.22:default-172.16.255.26:default", + "linkKeyDisplay": "172.16.255.22(default)-172.16.255.26(default)", + "adeviceId": "172.16.255.26", + "bdeviceId": "172.16.255.22", + "asystem-ip": "172.16.255.26", + "bsystem-ip": "172.16.255.22", + "asite-id": "--", + "bsite-id": "200", + "ahost-name": "vm16", + "bhost-name": "vm12", + "apersonality": "vbond", + "bpersonality": "vmanage" + }, + { + "state": "up", + "color1": "lte", + "color2": "default", + "lastupdated": "1646912547013", + "linkKey": "172.16.255.14:lte-172.16.255.19:default", + "linkKeyDisplay": "172.16.255.14(lte)-172.16.255.19(default)", + "adeviceId": "172.16.255.14", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.14", + "bsystem-ip": "172.16.255.19", + "asite-id": "400", + "bsite-id": "100", + "ahost-name": "vm4", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "color1": "lte", + "color2": "default", + "lastupdated": "1646912512112", + "linkKey": "172.16.255.14:lte-172.16.255.20:default", + "linkKeyDisplay": "172.16.255.14(lte)-172.16.255.20(default)", + "adeviceId": "172.16.255.14", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.14", + "bsystem-ip": "172.16.255.20", + "asite-id": "400", + "bsite-id": "200", + "ahost-name": "vm4", + "bhost-name": "vm10", + "apersonality": "vedge", + "bpersonality": "vsmart" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/localproperties": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get local properties list (Real Time)", + "operationId": "createLocalPropertiesListListRealTIme", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Local properties list": { + "description": "Local properties list", + "value": { + "data": [ + { + "certificate-not-valid-before": "Jan 26 07:37:47 2022 GMT", + "site-id": "100", + "protocol": "dtls", + "root-ca-chain-status": "Installed", + "certificate-not-valid-after": "Jan 26 07:37:47 2023 GMT", + "dns-name": "vbond", + "vdevice-host-name": "vm1", + "port-hopped": "TRUE", + "device-role": "edge-router", + "certificate-status": "Installed", + "device-type": "vedge", + "uuid": "a555e577-d513-4768-a695-93574a15f5cc", + "sp-organization-name": "vIPtela Inc Regression", + "lastupdated": 1643348428058, + "region-id-set": "N/A", + "keygen-interval": "1:00:00:00", + "domain-id": "1", + "time-since-port-hop": "1:21:43:52", + "system-ip": "172.16.255.11", + "board-serial": "12346580", + "certificate-validity": "Valid", + "max-controllers": "0", + "tls-port": "0", + "organization-name": "vIPtela Inc Regression", + "vdevice-name": "172.16.255.11", + "vsmart-list-version": "0", + "number-vbond-peers": "0", + "vdevice-dataKey": "172.16.255.11", + "token": "Invalid", + "number-active-wan-interfaces": "1", + "register-interval": "0:00:00:30", + "retry-interval": "0:00:00:15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/networksummary": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get list of unreachable devices", + "operationId": "networkSummary", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Device State", + "schema": { + "type": "string", + "example": "up" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "list of unreachable devices": { + "description": "list of unreachable devices", + "value": { + "data": [ + { + "device-model": "vedge-cloud", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.21", + "system-ip": "172.16.255.21", + "host-name": "vm11", + "site-id": "100", + "version": "20.9.999-1766", + "uuid": "2b57ef1a-5eb2-4d8d-8676-cce19b56b26b", + "board-serial": "12345962", + "bfdSessions": "3", + "device-type": "vedge", + "lastupdated": 1646917368708, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646908860000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vedge-cloud", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.11", + "system-ip": "172.16.255.11", + "host-name": "vm1", + "site-id": "100", + "version": "20.9.999-1766", + "uuid": "84d1ab4e-0cbf-4369-a290-08fafeb80f95", + "board-serial": "12345974", + "bfdSessions": "3", + "device-type": "vedge", + "lastupdated": 1646967284462, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646909100000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vsmart", + "ompPeers": "6", + "number-vsmart-peers": 1, + "local-system-ip": "172.16.255.19", + "system-ip": "172.16.255.19", + "host-name": "vm9", + "site-id": "100", + "version": "20.9.999-1766", + "uuid": "9abd3af9-9087-497d-8b99-8fd0a7baa3f2", + "board-serial": "12345967", + "device-type": "vsmart", + "lastupdated": 1646967277159, + "reachability": "reachable", + "controlConnections": "9", + "uptime-date": 1646908920000, + "controlConnectionsToVsmarts": "1" + }, + { + "device-model": "vsmart", + "ompPeers": "6", + "number-vsmart-peers": 1, + "local-system-ip": "172.16.255.20", + "system-ip": "172.16.255.20", + "host-name": "vm10", + "site-id": "200", + "version": "20.9.999-1766", + "uuid": "43ba3223-9df7-4cc9-a059-a12e5382d79d", + "board-serial": "12345961", + "device-type": "vsmart", + "lastupdated": 1646967275863, + "reachability": "reachable", + "controlConnections": "9", + "uptime-date": 1646908860000, + "controlConnectionsToVsmarts": "1" + }, + { + "device-model": "vedge-cloud", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.14", + "system-ip": "172.16.255.14", + "host-name": "vm4", + "site-id": "400", + "version": "20.9.999-1766", + "uuid": "a66335c5-451f-4b93-a752-4116d688f347", + "board-serial": "12345970", + "bfdSessions": "4", + "device-type": "vedge", + "lastupdated": 1646967282559, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646908980000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vedge-C8000V", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.15", + "system-ip": "172.16.255.15", + "host-name": "vm5", + "site-id": "500", + "version": "17.09.01.0.154453", + "uuid": "C8K-8bda7a5d-6b75-47ec-a658-b30ca54e30eb", + "board-serial": "12345703", + "bfdSessions": "4", + "device-type": "vedge", + "lastupdated": 1646967275462, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646909400000, + "controlConnectionsToVsmarts": "2" + }, + { + "device-model": "vedge-C8000V", + "ompPeers": "2", + "number-vsmart-peers": 2, + "local-system-ip": "172.16.255.16", + "system-ip": "172.16.255.16", + "host-name": "vm6", + "site-id": "600", + "version": "17.09.01.0.154453", + "uuid": "C8K-46aa4ddc-7468-45c2-9144-2d60c2f553f3", + "board-serial": "12345702", + "bfdSessions": "4", + "device-type": "vedge", + "lastupdated": 1646967277103, + "reachability": "reachable", + "controlConnections": "3", + "uptime-date": 1646909400000, + "controlConnectionsToVsmarts": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connection statistics from device (Real Time)", + "operationId": "getConnectionStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection statistics": { + "description": "Connection statistics", + "value": { + "data": [ + { + "rx_challenge": "14", + "challenge_failures": "0", + "vdevice-name": "169.254.10.10", + "tx_dtls_handshake": "21", + "tx_register_replies": "0", + "rx_challenge_ack": "14", + "tx_octets": "24918292", + "rx_registers": "0", + "tx_dtls_handshake_failures": "7", + "tx_vmanage_to_peer": "0", + "tx_pkts": "330231", + "tx_blocked": "0", + "tx_dtls_handshake_done": "14", + "rx_octets": "50924456", + "tx_error": "0", + "bid_failures_needing_reset": "0", + "rx_error": "0", + "rx_dtls_handshake_done": "0", + "tx_challenge_ack_error": "0", + "rx_challenge_resp": "0", + "tx_challenge_error": "0", + "tx_challenge_resp_error": "0", + "tx_register_to_vmanage": "4", + "tx_challenge": "0", + "rx_connects": "0", + "tx_registers": "15", + "rx_pkts": "347847", + "tx_connects": "0", + "tx_challenge_gen_error": "0", + "rx_register_to_vmanage": "0", + "vdevice-host-name": "vm3", + "tx_hello": "212412", + "tx_challenge_ack": "0", + "rx_hello": "212399", + "tx_challenge_resp": "14", + "rx_dtls_handshake": "0", + "vdevice-dataKey": "169.254.10.10", + "lastupdated": 1642730071268, + "rx_dtls_handshake_failures": "0", + "rx_register_replies": "15", + "rx_vmanage_to_peer": "4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get local device status", + "operationId": "getLocalDeviceStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Local device status": { + "description": "Local device status", + "value": { + "data": [ + { + "type": "control", + "name": "Control", + "image": "images/control.png", + "count": 0, + "detailView": "dialog", + "detailsURL": "/dataservice/device/control/links", + "statusList": [ + { + "status": "up", + "icon": "images/connection/connection-network-up.png", + "color": "b0e276", + "name": "up", + "detailView": "dialog", + "detailsURL": "/dataservice/device/control/links?state=up", + "count": 0 + }, + { + "status": "down", + "icon": "images/connection/connection-network-down.png", + "color": "fa7c7d", + "name": "down", + "detailView": "dialog", + "detailsURL": "/dataservice/device/control/links?state=down", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections summary from device (Real Time)", + "operationId": "createConnectionsSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections summary": { + "description": "Connections summary", + "value": { + "data": [ + { + "instance": 0, + "vdevice-dataKey": "172.16.255.14-0", + "vdevice-name": "172.16.255.14", + "vmanage_counts": 1, + "lastupdated": 1588603863504, + "vsmart_counts": 2, + "vbond_counts": 0, + "vdevice-host-name": "vm4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/summary/device": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get device control status summary", + "operationId": "getDeviceControlStatusSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device control status summary": { + "description": "Device control status summary", + "value": { + "data": [ + { + "name": "ControlConnection", + "count": 3, + "detailsURL": "", + "status": "error", + "statusList": [ + { + "name": "up", + "message": "3up", + "detailsURL": "/dataservice/device/control/connection?deviceId=172.16.255.11&state=up", + "count": 3 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/control/synced/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get connections list from vManage", + "operationId": "createSyncedConnectionList", + "parameters": [ + { + "name": "peer-type", + "in": "query", + "description": "Peer type", + "schema": { + "type": "string", + "enum": [ + "vedge", + "vsmart", + "vmanage", + "vbond" + ] + } + }, + { + "name": "system-ip", + "in": "query", + "description": "Peer system IP", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connections list": { + "description": "Connections list", + "value": { + "data": [ + { + "instance": 0, + "vdevice-name": "172.16.255.11", + "system-ip": "172.16.255.19", + "remote-color": "default", + "site-id": 100, + "controller-group-id": 0, + "peer-type": "vsmart", + "shared-region-id-set": "N/A", + "protocol": "dtls", + "@rid": 1060, + "state": "up", + "private-ip": "10.0.5.19", + "domain-id": 1, + "behind-proxy": "No", + "createTimeStamp": 1646912557634, + "private-port": 12455, + "vdevice-host-name": "vm1", + "local-color": "lte", + "v-org-name": "vIPtelaIncRegression", + "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.19-default", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.5.19", + "public-port": 12455, + "lastupdated": 1646967283468, + "uptime-date": 1646967180000 + }, + { + "instance": 0, + "vdevice-name": "172.16.255.11", + "system-ip": "172.16.255.20", + "remote-color": "default", + "site-id": 200, + "controller-group-id": 0, + "peer-type": "vsmart", + "shared-region-id-set": "N/A", + "protocol": "dtls", + "@rid": 1063, + "state": "up", + "private-ip": "10.0.12.20", + "domain-id": 1, + "behind-proxy": "No", + "createTimeStamp": 1646912560801, + "private-port": 12456, + "vdevice-host-name": "vm1", + "local-color": "lte", + "v-org-name": "vIPtelaIncRegression", + "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.20-default", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.12.20", + "public-port": 12456, + "lastupdated": 1646967283468, + "uptime-date": 1646967180000 + }, + { + "instance": 0, + "vdevice-name": "172.16.255.11", + "system-ip": "172.16.255.22", + "remote-color": "default", + "site-id": 200, + "controller-group-id": 0, + "peer-type": "vmanage", + "protocol": "dtls", + "@rid": 1068, + "state": "up", + "private-ip": "10.0.12.22", + "domain-id": 0, + "behind-proxy": "No", + "createTimeStamp": 1646912562214, + "private-port": 12446, + "vdevice-host-name": "vm1", + "local-color": "lte", + "v-org-name": "vIPtelaIncRegression", + "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.22-default", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.12.22", + "public-port": 12446, + "lastupdated": 1646967283468, + "uptime-date": 1646967180000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/control/synced/localproperties": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get local properties list", + "operationId": "createLocalPropertiesSyncedList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Local properties list": { + "description": "Local properties list", + "value": { + "data": [ + { + "retry-interval": "0:00:00:16", + "vdevice-name": "172.16.255.11", + "device-role": "edge-router", + "tls-port": "0", + "max-controllers": "0", + "system-ip": "172.16.255.11", + "certificate-not-valid-before": "Mar1011:16:192022GMT", + "site-id": "100", + "certificate-not-valid-after": "Mar1011:16:192023GMT", + "uuid": "84d1ab4e-0cbf-4369-a290-08fafeb80f95", + "number-active-wan-interfaces": "1", + "protocol": "dtls", + "board-serial": "12345974", + "vsmart-list-version": "0", + "@rid": 1071, + "certificate-status": "Installed", + "device-type": "vedge", + "port-hopped": "TRUE", + "organization-name": "vIPtelaIncRegression", + "domain-id": "1", + "root-ca-chain-status": "Installed", + "dns-name": "vbond", + "createTimeStamp": 1646912563392, + "sp-organization-name": "vIPtelaIncRegression", + "vdevice-host-name": "vm1", + "register-interval": "0:00:00:30", + "token": "Invalid", + "keygen-interval": "1:00:00:00", + "vdevice-dataKey": "172.16.255.11", + "certificate-validity": "Valid", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1646963388706, + "number-vbond-peers": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/synced/waninterface": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get WAN interface list", + "operationId": "createWanInterfaceSyncedList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "WAN interface list": { + "description": "WAN interface list", + "value": { + "data": [ + { + "instance": 0, + "low-bandwidth-link": "No", + "color": "lte", + "vdevice-name": "172.16.255.11", + "nat-type": "N", + "admin-state": "up", + "interface": "ge0/2", + "restrict-str": "no", + "@rid": 1077, + "private-ipv6": "::", + "private-ip": "10.0.5.11", + "per-wan-max-controllers": 2, + "num-vsmarts": 2, + "num-vmanages": 1, + "preference": "0", + "createTimeStamp": 1646912567192, + "weight": 1, + "index": 0, + "private-port": 12407, + "vdevice-host-name": "vm1", + "vbond-as-stun-server": "no", + "control-str": "yes", + "carrier": "default", + "last-resort": "No", + "vdevice-dataKey": "172.16.255.11-0-0", + "vmanage-connection-preference": "5", + "vmanage-system-ip": "172.16.255.11", + "public-ip": "10.0.5.11", + "operation-state": "up", + "public-port": 12407, + "region-id": "Default", + "lastupdated": 1646967283812, + "wan-port-hopped": "TRUE" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/validdevices": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get vmanage valid device list (Real Time)", + "operationId": "createValidDevicesListRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "data": [ + { + "chassis-number": "00D132A6-F3D2-40BA-862B-A6D1A83EFAEA", + "vdevice-dataKey": "172.16.255.22-00D132A6-F3D2-40BA-862B-A6D1A83EFAEA-12346574", + "vdevice-name": "172.16.255.22", + "serial-number": "12346574", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F", + "vdevice-dataKey": "172.16.255.22-C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F-12345703", + "vdevice-name": "172.16.255.22", + "serial-number": "12345703", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7", + "vdevice-dataKey": "172.16.255.22-C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7-12345705", + "vdevice-name": "172.16.255.22", + "serial-number": "12345705", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-A9DF16AA-14C2-4B60-8D65-05957111879E", + "vdevice-dataKey": "172.16.255.22-C8K-A9DF16AA-14C2-4B60-8D65-05957111879E-12345967", + "vdevice-name": "172.16.255.22", + "serial-number": "12345967", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + }, + { + "chassis-number": "C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A", + "vdevice-dataKey": "172.16.255.22-C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A-12345707", + "vdevice-name": "172.16.255.22", + "serial-number": "12345707", + "lastupdated": 1649645323938, + "vdevice-host-name": "vm12" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/validvmanageid": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get valid vManage from device (Real Time)", + "operationId": "getValidVManageIdRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage": { + "description": "vManage", + "value": { + "data": [ + { + "chassis-number": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642746085123, + "vdevice-host-name": "vm3" + }, + { + "chassis-number": "59ddeeef-24ad-4bd3-9e55-f9760b640970", + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642746085123, + "vdevice-host-name": "vm3" + }, + { + "chassis-number": "c0fd955c-7e0d-4b90-9626-55684f69a899", + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1642746085123, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/validvsmarts": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get valid vSmart list from device (Real Time)", + "operationId": "createValidVSmartsListRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart list": { + "description": "vSmart list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-12345701", + "vdevice-name": "169.254.10.10", + "serial-number": "12345701", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345702", + "vdevice-name": "169.254.10.10", + "serial-number": "12345702", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345703", + "vdevice-name": "169.254.10.10", + "serial-number": "12345703", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345704", + "vdevice-name": "169.254.10.10", + "serial-number": "12345704", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345705", + "vdevice-name": "169.254.10.10", + "serial-number": "12345705", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-12345706", + "vdevice-name": "169.254.10.10", + "serial-number": "12345706", + "lastupdated": 1642743541771, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/waninterface": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get WAN interface list (Real Time)", + "operationId": "createWanInterfaceListList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "WAN interface list": { + "description": "WAN interface list", + "value": { + "data": [ + { + "instance": 0, + "low-bandwidth-link": "No", + "color": "default", + "vdevice-name": "169.254.10.10", + "nat-type": "N", + "admin-state": "up", + "interface": "ge0/1", + "restrict-str": "no", + "private-ipv6": "::", + "private-ip": "10.101.3.3", + "per-wan-max-controllers": 2, + "num-vsmarts": 2, + "num-vmanages": 1, + "preference": "0", + "wan-time-since-port-hop": "0:11:14:02", + "spi-change": "0:00:45:59", + "index": 0, + "weight": 1, + "private-port": 12386, + "last-conn-time": "0:11:13:42", + "vbond-as-stun-server": "no", + "vdevice-host-name": "vm3", + "control-str": "yes", + "carrier": "default", + "vmanage-connection-preference": "5", + "last-resort": "No", + "vdevice-dataKey": "169.254.10.10-0-0", + "public-ip": "10.101.3.3", + "operation-state": "up", + "public-port": 12386, + "lastupdated": 1642746267569, + "last-conn-time-date": 1642705800000, + "wan-port-hopped": "TRUE" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/control/waninterface/color": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Control" + ], + "description": "Get port hop colors", + "operationId": "getPortHopColor", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device port hop colors": { + "description": "Device port hop colors", + "value": { + "data": [ + { + "color": "lte" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/counters": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device counters", + "operationId": "getDeviceCounters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device counters": { + "description": "Device counters", + "value": { + "header": { + "generatedOn": 1635392499184 + }, + "data": [ + { + "system-ip": "169.254.10.1", + "number-vsmart-control-connections": 3, + "expectedControlConnections": 3, + "rebootCount": 3, + "crashCount": 0 + }, + { + "system-ip": "169.254.10.2", + "number-vsmart-control-connections": 3, + "expectedControlConnections": 3, + "rebootCount": 0, + "crashCount": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/crashlog": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash logs from device", + "operationId": "getDeviceCrashLogs", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device crash logs": { + "description": "Device crash logs", + "value": { + "data": [ + { + "core-time": "Tue Feb 15 04:14:38 UTC 2022", + "vdevice-dataKey": "169.254.10.12-0", + "vdevice-name": "169.254.10.12", + "index": 0, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_19219_20220215-041430-UTC.core.gz", + "core-time-date": 1644898478000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 04:15:24 UTC 2022", + "vdevice-dataKey": "169.254.10.12-1", + "vdevice-name": "169.254.10.12", + "index": 1, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_19539_20220215-041515-UTC.core.gz", + "core-time-date": 1644898524000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 05:55:04 UTC 2022", + "vdevice-dataKey": "169.254.10.12-2", + "vdevice-name": "169.254.10.12", + "index": 2, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_30530_20220215-055452-UTC.core.gz", + "core-time-date": 1644904504000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 05:55:50 UTC 2022", + "vdevice-dataKey": "169.254.10.12-3", + "vdevice-name": "169.254.10.12", + "index": 3, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_31380_20220215-055542-UTC.core.gz", + "core-time-date": 1644904550000, + "vdevice-host-name": "vm5" + }, + { + "core-time": "Tue Feb 15 06:21:52 UTC 2022", + "vdevice-dataKey": "169.254.10.12-4", + "vdevice-name": "169.254.10.12", + "index": 4, + "lastupdated": 1645064726542, + "core-filename": "vm5_htx_26426_20220215-062140-UTC.core.gz", + "core-time-date": 1644906112000, + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/crashlog/details": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash logs for all device", + "operationId": "getAllDeviceCrashLogs", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device crash logs": { + "description": "Device crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/crashlog/log": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash info from device", + "operationId": "getDeviceCrashInformation", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "filename", + "in": "query", + "description": "Crash file name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Device crash info": { + "description": "Device crash info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/crashlog/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Crash Log" + ], + "description": "Get device crash logs synchronously from device", + "operationId": "getDeviceCrashLogsSynced", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device crash logs": { + "description": "Device crash logs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade-read,Software Upgrade-write" + } + }, + "/device/csp/containers/container": { + "get": { + "tags": [ + "Real-Time Monitoring - Container Lifecycle" + ], + "description": "Get device container from device (Real Time)", + "operationId": "createDeviceContainersInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "device container": { + "description": "device container", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/pnic": { + "get": { + "tags": [ + "Real-Time Monitoring - RBAC" + ], + "description": "Get pnic interfaces from device", + "operationId": "getPnicStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PNIC interfaces": { + "description": "PNIC interfaces", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/csp/pnic/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - RBAC" + ], + "description": "Get pnic stats from device", + "operationId": "getPNICStatsFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PNIC stats": { + "description": "PNIC stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/csp/rbac": { + "get": { + "tags": [ + "Real-Time Monitoring - RBAC" + ], + "description": "Get RBAC interfaces from device", + "operationId": "getRBACInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device RBAC interface": { + "description": "Device RBAC interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/csp/resources/cpu-info/allocation": { + "get": { + "tags": [ + "Real-Time Monitoring - NetworkHub Resources" + ], + "description": "Get NetworkHub CPU allocation info from device", + "operationId": "getAllocationInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NetworkHub CPU allocation info": { + "description": "NetworkHub CPU allocation info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/csp/resources/cpu-info/cpus": { + "get": { + "tags": [ + "Real-Time Monitoring - NetworkHub Resources" + ], + "description": "Get NetworkHub CPU info from device", + "operationId": "getCPUInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NetworkHub CPU info": { + "description": "NetworkHub CPU info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/csp/resources/cpu-info/vnfs": { + "get": { + "tags": [ + "Real-Time Monitoring - NetworkHub Resources" + ], + "description": "Get NetworkHub CPU VNF info from device", + "operationId": "getVNFInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NetworkHub CPU VNF info": { + "description": "NetworkHub CPU VNF info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/csp/system/native": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system native settings from device", + "operationId": "createDeviceSystemSettingNativeInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system native settings": { + "description": "Device system native settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/system/processlist": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system process list from device", + "operationId": "createDeviceSystemProcessList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system process list": { + "description": "Device system process list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/system/settings": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system settings from device", + "operationId": "createDeviceSystemSetting", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system settings": { + "description": "Device system settings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/csp/system/status": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system status from device", + "operationId": "createDeviceSystemStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system status": { + "description": "Device system status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/ctsPac": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec PAC information from device", + "operationId": "getCtsPac", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec PAC information": { + "description": "TrustSec PAC information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/devicestatus": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get devices status per type", + "operationId": "getDeviceOnlyStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device status per type list": { + "description": "Device status per type list", + "value": { + "header": { + "generatedOn": 1635296479960 + }, + "data": [ + { + "type": "vSmart", + "name": "vSmart", + "image": "images/vsmart.png", + "count": 3, + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart", + "statusList": [ + { + "status": "error", + "name": "Error", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=error", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "warning", + "name": "Warning", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=warning", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + }, + { + "status": "normal", + "name": "Normal", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=normal", + "color": "b0e276", + "icon": "images/device/device-normal.png", + "count": 3 + }, + { + "status": "new", + "name": "Discovered device", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=new", + "color": "7c8afa", + "icon": "images/device/device-new.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/dhcp/client": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCP client from device (Real Time)", + "operationId": "getDHCPClient", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DHCP client": { + "description": "DHCP client", + "value": { + "data": [ + { + "lease-server-addr": "10.0.1.1", + "state": "dhcp-client-state-bound", + "if-name": "GigabitEthernet1", + "dns-address-secondary": "0.0.0.0", + "subnet-mask": "255.255.255.0", + "client-addr": "10.0.1.5", + "lease-remaining": "3143", + "gateway-addr": "0.0.0.0", + "dns-address": "10.0.1.1", + "vdevice-dataKey": "169.254.10.12-Mgmt-intf-GigabitEthernet1", + "vrf-name": "Mgmt-intf", + "lastupdated": 1643101911868, + "vdevice-host-name": "vm5", + "vdevice-name": "169.254.10.12", + "lease-time": "3600" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dhcp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCP interfaces from device (Real Time)", + "operationId": "getDHCPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DHCP interfaces": { + "description": "DHCP interfaces", + "value": { + "data": [ + { + "server": "10.0.1.1", + "vdevice-dataKey": "169.254.10.10-512-eth0", + "lease-time": "0:01:00:00", + "vdevice-name": "169.254.10.10", + "ifname": "eth0", + "acquired-ip": "10.0.1.3/24", + "dns": "10.0.1.1", + "lastupdated": 1643013783968, + "time-remaining": "0:00:31:25", + "state": "bound", + "vpn-id": "512", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dhcp/server": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCP server from device (Real Time)", + "operationId": "getDHCPServer", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DHCP server": { + "description": "DHCP server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dhcpv6/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - DHCP" + ], + "description": "Get DHCPv6 interfaces from device", + "operationId": "getDHCPv6Interface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device DHCP v6 interface": { + "description": "Device DHCP v6 interface", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-512-eth0", + "vdevice-name": "169.254.10.10", + "ifname": "eth0", + "lastupdated": 1646099652315, + "state": "init", + "vpn-id": "512", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dot1x/clients": { + "get": { + "tags": [ + "Real-Time Monitoring - DOT1x" + ], + "description": "Get DOT1x client from device (Real Time)", + "operationId": "getWLANDOT1xClients", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DOT1x client": { + "description": "DOT1x client", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dot1x/interfaces": { + "get": { + "tags": [ + "Real-Time Monitoring - DOT1x" + ], + "description": "Get DOT1x interface from device (Real Time)", + "operationId": "getWLANDOT1xInterfaces", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DOT1x interface": { + "description": "DOT1x interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dot1x/radius": { + "get": { + "tags": [ + "Real-Time Monitoring - DOT1x" + ], + "description": "Get DOT1x Radius from device (Real Time)", + "operationId": "getDOT1xRadius", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DOT1x Radius": { + "description": "DOT1x Radius", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/downloadedImages": { + "get": { + "tags": [ + "Configuration - Downloaded Images" + ], + "description": "Get images list from device", + "operationId": "createSoftwareList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-", + "vdevice-name": "169.254.10.10", + "lastupdated": 1644801887912, + "downloadedImages": "[]", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/dpi/application-mapping": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI supported application list from device", + "operationId": "getSupportedApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI supported application list": { + "description": "DPI supported application list", + "value": { + "data": [ + { + "name": "an", + "family": "network-service", + "familyShort": "network_service", + "longname": "ActiveNetworks", + "appId": "861" + }, + { + "name": "bb", + "family": "network-management", + "familyShort": "network_management", + "longname": "Systemsandnetworkmonitoringtool", + "appId": "50333632" + }, + { + "name": "fc", + "family": "network-service", + "familyShort": "network_service", + "longname": "FibreChannel", + "appId": "16777349" + }, + { + "name": "il", + "family": "network-service", + "familyShort": "network_service", + "longname": "InternalLinkTransportProtocol", + "appId": "16777256" + }, + { + "name": "ns", + "family": "network-service", + "familyShort": "network_service", + "longname": "NetworkSystems", + "appId": "50332408" + }, + { + "name": "sm", + "family": "network-service", + "familyShort": "network_service", + "longname": "SM", + "appId": "16777338" + }, + { + "name": "st", + "family": "network-service", + "familyShort": "network_service", + "longname": "Stream", + "appId": "16777221" + }, + { + "name": "3pc", + "family": "network-service", + "familyShort": "network_service", + "longname": "ThirdPartyConnectProtocol", + "appId": "16777250" + }, + { + "name": "acp", + "family": "network-service", + "familyShort": "network_service", + "longname": "AeolonCoreProtocol", + "appId": "50332247" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/application/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI query field from device", + "operationId": "getDPIDeviceFieldJSON", + "parameters": [ + { + "name": "isDeviceDashBoard", + "in": "query", + "description": "Flag whether is device dashboard request", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI query field": { + "description": "DPI query field", + "value": { + "data": [ + { + "isRequired": true, + "fieldData": { + "type": "dateList" + }, + "dataType": "date", + "property": "entry_time", + "name": "EventTime", + "options": [ + { + "enableDateFields": false, + "number": "24", + "value": "Last24hours", + "key": "last_24_hours" + }, + { + "enableDateFields": false, + "number": "12", + "value": "Last12hours", + "key": "last_12_hours" + }, + { + "enableDateFields": false, + "number": "6", + "value": "Last6hours", + "key": "last_6_hours" + }, + { + "enableDateFields": false, + "number": "3", + "value": "Last3hours", + "key": "last_3_hours" + }, + { + "enableDateFields": false, + "number": "1", + "value": "Last1hour", + "key": "last_1_hour" + }, + { + "enableDateFields": false, + "number": "168", + "value": "Last7days", + "key": "last_168_hours" + } + ] + }, + { + "isRequired": true, + "fieldData": { + "type": "url", + "url": "dataservice/device/action/vpn" + }, + "dataType": "int", + "property": "vpn_id", + "name": "VPN", + "multiSelect": false + }, + { + "isRequired": true, + "dataType": "string", + "property": "vdevice_name", + "name": "Devicename", + "multiSelect": false, + "isHidden": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI applications from device (Real Time)", + "operationId": "createDPICollectorList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dpi/common/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI common application list from device", + "operationId": "getCommonApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI common application list": { + "description": "DPI common application list", + "value": { + "data": [ + { + "name": "3com-amp3", + "familyShort": "network-service", + "longname": "3ComAMP3", + "family": "NetworkService", + "qosmosName": "3com-amp3", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "3com-tsmux", + "familyShort": "network-service", + "longname": "3ComTSMUX", + "family": "NetworkService", + "qosmosName": "3com-tsmux", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "3pc", + "familyShort": "network-service", + "longname": "ThirdPartyConnect", + "family": "NetworkService", + "qosmosName": "3pc", + "qosmosFamily": "network_service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "4chan", + "familyShort": "web", + "longname": "4CHAN", + "family": "Web", + "qosmosName": "4chan", + "qosmosFamily": "web", + "trafficClass": "transactional-data", + "businessRelevance": "business-irrelevant" + }, + { + "name": "58-city", + "familyShort": "web", + "longname": "58City", + "family": "Web", + "qosmosName": "58com", + "qosmosFamily": "web", + "trafficClass": "transactional-data", + "businessRelevance": "business-irrelevant" + }, + { + "name": "914c/g", + "familyShort": "terminal", + "longname": "TexasInstruments914Terminal", + "family": "Terminal", + "qosmosName": "914c/g", + "qosmosFamily": "terminal", + "trafficClass": "ops-admin-mgmt", + "businessRelevance": "business-relevant" + }, + { + "name": "9pfs", + "familyShort": "network-service", + "longname": "9P", + "family": "NetworkService", + "qosmosName": "9p", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + }, + { + "name": "abc-news", + "familyShort": "web", + "longname": "ABCNews", + "family": "Web", + "qosmosName": "abcnews", + "qosmosFamily": "web", + "trafficClass": "transactional-data", + "businessRelevance": "business-irrelevant" + }, + { + "name": "acap", + "familyShort": "network-management", + "longname": "ApplicationConfigurationAccessProtocol", + "family": "NetworkManagement", + "qosmosName": "acap", + "qosmosFamily": "network-management", + "trafficClass": "ops-admin-mgmt", + "businessRelevance": "business-relevant" + }, + { + "name": "acas", + "familyShort": "network-service", + "longname": "ACAServices", + "family": "NetworkService", + "qosmosName": "acas", + "qosmosFamily": "network-service", + "trafficClass": "bulk-data", + "businessRelevance": "default" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/device/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI field from device", + "operationId": "getDPIFieldJSON", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI field": { + "description": "DPI field", + "value": { + "data": [ + { + "property": "entry_time", + "name": "EventTime", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_24_hours", + "value": "Last24hours", + "number": "24", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last12hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last6hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last3hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_1_hour", + "value": "Last1hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_168_hours", + "value": "Last7days", + "number": "168", + "enableDateFields": false + } + ] + }, + { + "property": "application", + "name": "Application", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/devicedetails/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI detailed field from device", + "operationId": "getDPIDeviceDetailsFieldJSON", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI detailed field": { + "description": "DPI detailed field", + "value": { + "data": [ + { + "property": "entry_time", + "name": "EventTime", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_24_hours", + "value": "Last24hours", + "number": "24", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last12hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last6hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last3hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_1_hour", + "value": "Last1hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_168_hours", + "value": "Last7days", + "number": "168", + "enableDateFields": false + } + ] + }, + { + "property": "application", + "name": "Application", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + }, + { + "property": "vdevice_name", + "name": "Devicename", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/flows": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI flow list from device (Real Time)", + "operationId": "createDPIFlowsList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "src-ip", + "in": "query", + "description": "Source IP", + "schema": { + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI flows": { + "description": "DPI flows", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dpi/qosmos-static/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI QoSMos static application list", + "operationId": "getQosmosStaticApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI QoSMos static application list": { + "description": "DPI QoSMos static application list", + "value": { + "data": [ + { + "name": "9p", + "family": "FileServer", + "familyShort": "file_server", + "longname": "Plan9FilesystemProtocol", + "appId": "3430" + }, + { + "name": "ah", + "family": "NetworkService", + "familyShort": "network_service", + "longname": "AuthenticationHeader", + "appId": "720" + }, + { + "name": "dr", + "family": "Web", + "familyShort": "web", + "longname": "Dr.dk", + "appId": "2043" + }, + { + "name": "dv", + "family": "Web", + "familyShort": "web", + "longname": "DV.is", + "appId": "1861" + }, + { + "name": "hs", + "family": "Web", + "familyShort": "web", + "longname": "Hs.fi(HelsinginSanomat)", + "appId": "2097" + }, + { + "name": "il", + "family": "NetworkService", + "familyShort": "network_service", + "longname": "InternetLink(Transportprotocol)", + "appId": "637" + }, + { + "name": "ip", + "family": "NetworkService", + "familyShort": "network_service", + "longname": "InternetProtocol", + "appId": "81" + }, + { + "name": "ja", + "family": "Web", + "familyShort": "web", + "longname": "Ja.is", + "appId": "1897" + }, + { + "name": "mk", + "family": "Web", + "familyShort": "web", + "longname": "Mk.co.kr", + "appId": "1213" + }, + { + "name": "mq", + "family": "ApplicationService", + "familyShort": "application_service", + "longname": "IBMWebsphereMQ", + "appId": "312" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/dpi/qosmos/applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI QoSMos application list from device", + "operationId": "getQosmosApplicationList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI QoSMos application list": { + "description": "DPI QoSMos application list", + "value": { + "data": [ + { + "name": "an", + "family": "network-service", + "familyShort": "network_service", + "longname": "ActiveNetworks", + "appId": "861" + }, + { + "name": "bna", + "family": "network-service", + "familyShort": "network_service", + "longname": "BNA", + "appId": "803" + }, + { + "name": "box", + "family": "web", + "familyShort": "web", + "longname": "Box", + "appId": "1074" + }, + { + "name": "dls", + "family": "network-service", + "familyShort": "network_service", + "longname": "DirectoryLocationService", + "appId": "1078" + }, + { + "name": "dmp", + "family": "audio-video", + "familyShort": "audio_video", + "longname": "CiscoDigitalMediaPlayer", + "appId": "1422" + }, + { + "name": "apple-location-services", + "family": "application-service", + "familyShort": "application_service", + "longname": "AppleLocationServices", + "appId": "294" + }, + { + "name": "apple-push-notification", + "family": "application-service", + "familyShort": "application_service", + "longname": "ApplePushNotificationService", + "appId": "1169" + }, + { + "name": "sixtofour-ipv6-tunneled", + "family": "network-service", + "familyShort": "network_service", + "longname": "SixtofourIPv6Tunneled", + "appId": "1223" + }, + { + "name": "internet-audio-streaming", + "family": "instant-messaging", + "familyShort": "instant_messaging", + "longname": "InternetAudioStreamingWebApps", + "appId": "1514" + }, + { + "name": "internet-video-streaming", + "family": "web", + "familyShort": "web", + "longname": "InternetVideoStreamingWebApps", + "appId": "1513" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/device/dpi/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get DPI summary from device (Real Time)", + "operationId": "createDPISummaryRealTime", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": { + "data": [ + { + "flows-expired": "0", + "vdevice-dataKey": "169.254.10.10", + "flows-created": "0", + "vdevice-name": "169.254.10.10", + "current-flows": "0", + "peak-rate": "0", + "current-rate": "0", + "lastupdated": 1643014386555, + "vdevice-host-name": "vm3", + "status": "disable", + "peak-flows": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dpi/supported-applications": { + "get": { + "tags": [ + "Real-Time Monitoring - DPI" + ], + "description": "Get supported applications from device (Real Time)", + "operationId": "createDPIStatistics", + "parameters": [ + { + "name": "application", + "in": "query", + "description": "Application", + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": { + "data": [ + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-an", + "application": "an", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Active Networks", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-management", + "vdevice-dataKey": "169.254.10.10-bb", + "application": "bb", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_management", + "application-long-name": "Systems and network monitoring tool", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-fc", + "application": "fc", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Fibre Channel", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-il", + "application": "il", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Internal Link Transport Protocol", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-ns", + "application": "ns", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Network Systems", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-sm", + "application": "sm", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "SM", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-st", + "application": "st", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Stream", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-3pc", + "application": "3pc", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Third Party Connect Protocol", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "network-service", + "vdevice-dataKey": "169.254.10.10-acp", + "application": "acp", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "network_service", + "application-long-name": "Aeolon Core Protocol", + "vdevice-host-name": "vm3" + }, + { + "family-long-name": "erp", + "vdevice-dataKey": "169.254.10.10-adp", + "application": "adp", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643014674675, + "family": "erp", + "application-long-name": "Automatic Data Processing", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/dre/auto-bypass-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE auto-bypass statistics", + "operationId": "getDreAutoBypassStats", + "parameters": [ + { + "name": "appqoe-dre-auto-bypass-server-ip", + "in": "query", + "description": "Server IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "appqoe-dre-auto-bypass-port", + "in": "query", + "description": "Port", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Auto-Bypass Stats": { + "description": "DRE Auto-Bypass Stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dre/dre-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE statistics", + "operationId": "getDreStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Stats": { + "description": "DRE Stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dre/dre-status": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE status", + "operationId": "getDreStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Status": { + "description": "DRE Status", + "value": { + "data": [ + { + "lastupdated": 1645775163290, + "appqoe-dre-status-health-status": "dre-status-disabled", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dre/peer-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - DRE" + ], + "description": "Get DRE peer statistics", + "operationId": "getDrePeerStats", + "parameters": [ + { + "name": "appqoe-dre-stats-peer-system-ip", + "in": "query", + "description": "System IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "appqoe-dre-stats-peer-peer-no", + "in": "query", + "description": "Peer Number", + "schema": { + "type": "number" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DRE Peer Stats": { + "description": "DRE Peer Stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" + } + }, + "/device/dualStaticRouteTracker": { + "get": { + "tags": [ + "Real-Time Monitoring - Dual Static Route Tracker Service" + ], + "description": "Get dual static route tracker info from device", + "operationId": "getDualStaticRouteTrackerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Dual static route tracker info": { + "description": "Dual static route tracker info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/eigrp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - EIGRP" + ], + "description": "Get EIGRP interface list from device (Real Time)", + "operationId": "createEIGRPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "EIGRP interface list": { + "description": "EIGRP interface list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/eigrp/route": { + "get": { + "tags": [ + "Real-Time Monitoring - EIGRP" + ], + "description": "Get EIGRP route from device (Real Time)", + "operationId": "createEIGRPRoute", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "EIGRP route": { + "description": "EIGRP route", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/eigrp/topology": { + "get": { + "tags": [ + "Real-Time Monitoring - EIGRP" + ], + "description": "Get EIGRP topology info from device (Real Time)", + "operationId": "createEIGRPTopology", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "EIGRP topology info": { + "description": "EIGRP topology info", + "value": { + "data": [ + { + "vdevice-host-name": "vm5", + "vdevice-dataKey": "172.16.255.15-0----", + "vdevice-name": "172.16.255.15", + "topo-id": "0", + "lastupdated": 1649307997571 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/enableSDAVC/{deviceIP}/{enable}": { + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Enable/Disable SDAVC on device", + "operationId": "enableSDAVCOnDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enable", + "in": "path", + "description": "Enable/Disable flag", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/endpointTracker": { + "get": { + "tags": [ + "Real-Time Monitoring - Endpoint Tracker Service" + ], + "description": "Get endpoint tracker info from device", + "operationId": "getEndpointTrackerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Endpoint tracker info": { + "description": "Endpoint tracker info", + "value": { + "data": [ + { + "record-name": "test", + "if-name": "GigabitEthernet1", + "lastupdated": 1650794336441, + "actual-delay": "4294967295", + "vdevice-dataKey": "172.16.255.15-vm5-GigabitEthernet1", + "state": "tracker-if-state-down", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/endpointTrackerGroup": { + "get": { + "tags": [ + "Real-Time Monitoring - Endpoint Tracker Group Service" + ], + "description": "Get endpoint tracker group info from device", + "operationId": "getEndpointTrackerGroupInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Endpoint tracker group info": { + "description": "Endpoint tracker group info", + "value": { + "data": [ + { + "oper": "tracker-group-oper-and", + "name": "tracker1", + "vdevice-dataKey": "172.16.255.15-vm5-tracker3_tracker-group", + "elem-state": "tracker-if-state-down", + "lastupdated": 1650866884165, + "actual-delay": "4294967295", + "group-name": "tracker3", + "group-state": "tracker-if-state-down", + "attach-point-name": "tracker3_tracker-group", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "oper": "tracker-group-oper-and", + "name": "tracker2", + "vdevice-dataKey": "172.16.255.15-vm5-tracker3_tracker-group", + "elem-state": "tracker-if-state-down", + "lastupdated": 1650866884165, + "actual-delay": "4294967295", + "group-name": "tracker3", + "group-state": "tracker-if-state-down", + "attach-point-name": "tracker3_tracker-group", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/environmentData": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Environment Data information from device", + "operationId": "getEnvironmentData", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec environment data information": { + "description": "TrustSec environment data information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/environmentData/radiusServer": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Environment Data Radius Server list from device", + "operationId": "getRadiusServer", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec environment data radius server list information": { + "description": "TrustSec environment data radius server list information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/featurelist": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Feature List" + ], + "description": "Get feature lists from device (Real Time)", + "operationId": "getFeatureList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature lists": { + "description": "Feature lists", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11-statistics-collection-1.0", + "vdevice-name": "172.16.255.11", + "name": "statistics-collection", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-confirm-1.0", + "vdevice-name": "172.16.255.11", + "name": "upgrade-confirm", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-vmanage-mode-2.0", + "vdevice-name": "172.16.255.11", + "name": "vmanage-mode", + "lastupdated": 1647222469375, + "version": "2.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-dpi-statistics-2.0", + "vdevice-name": "172.16.255.11", + "name": "dpi-statistics", + "lastupdated": 1647222469375, + "version": "2.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-cert-serial-hashing-1.0", + "vdevice-name": "172.16.255.11", + "name": "cert-serial-hashing", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-1.0", + "vdevice-name": "172.16.255.11", + "name": "upgrade", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-cert-serial-version-1.0", + "vdevice-name": "172.16.255.11", + "name": "cert-serial-version", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-vbond-standalone-1.0", + "vdevice-name": "172.16.255.11", + "name": "vbond-standalone", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-tools-2.0", + "vdevice-name": "172.16.255.11", + "name": "tools", + "lastupdated": 1647222469375, + "version": "2.0", + "vdevice-host-name": "vm1" + }, + { + "vdevice-dataKey": "172.16.255.11-admin-tech-options-1.0", + "vdevice-name": "172.16.255.11", + "name": "admin-tech-options", + "lastupdated": 1647222469375, + "version": "1.0", + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/featurelist/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Device Feature List" + ], + "description": "Get feature lists synchronously from device", + "operationId": "getSyncedFeatureList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature lists": { + "description": "Feature lists", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11-statistics-collection-1.0", + "@rid": 632, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912241600, + "name": "statistics-collection", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-confirm-1.0", + "@rid": 639, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912243273, + "name": "upgrade-confirm", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + }, + { + "vdevice-dataKey": "172.16.255.11-vmanage-mode-2.0", + "@rid": 646, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912247190, + "name": "vmanage-mode", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "2.0" + }, + { + "vdevice-dataKey": "172.16.255.11-dpi-statistics-2.0", + "@rid": 654, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912250128, + "name": "dpi-statistics", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "2.0" + }, + { + "vdevice-dataKey": "172.16.255.11-cert-serial-hashing-1.0", + "@rid": 662, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912255235, + "name": "cert-serial-hashing", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + }, + { + "vdevice-dataKey": "172.16.255.11-upgrade-1.0", + "@rid": 669, + "vdevice-name": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "createTimeStamp": 1646912260609, + "name": "upgrade", + "lastupdated": 1646912240766, + "vdevice-host-name": "vm1", + "version": "1.0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/geofence/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Geo-fencing" + ], + "description": "Get Geo-fencing Status from device", + "operationId": "getGeofenceStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Geo-fencing Status": { + "description": "Geo-fencing Status", + "value": { + "data": [ + { + "geofence-config-status": "Geofencing-Disabled", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "lastupdated": 1645089720394, + "current-location-status": "Location-Invalid", + "current-device-location-timestamp": "2022-02-15T06:39:22+00:00", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/alarms": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware alarm list from device", + "operationId": "createAlarmList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware alarm list": { + "description": "Hardware alarm list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/environment": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware environment list from device", + "operationId": "createEnvironmentList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware environment list": { + "description": "Hardware environment list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-Interface module-0", + "vdevice-name": "169.254.10.10", + "hw-class": "PIM", + "hw-item": "Interface module", + "hw-dev-index": 0, + "lastupdated": 1643076101789, + "vdevice-host-name": "vm3", + "measurement": "Present: yes; Powered On: no; Fault: no", + "status": "Down" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/errors": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware error list from device", + "operationId": "createErrorAlarmList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware error list": { + "description": "Hardware error list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/inventory": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware inventory list from device", + "operationId": "createInventoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware inventory list": { + "description": "Hardware inventory list", + "value": { + "data": [ + { + "hw-type": "Chassis", + "vdevice-dataKey": "169.254.10.10-Chassis-0", + "vdevice-name": "169.254.10.10", + "hw-dev-index": 0, + "serial-number": "sim", + "part-number": "vEdge-Cloud", + "lastupdated": 1643076350328, + "version": "1.0", + "vdevice-host-name": "vm3", + "hw-description": "vEdge-Cloud" + }, + { + "hw-type": "PIM", + "vdevice-dataKey": "169.254.10.10-PIM-0", + "vdevice-name": "169.254.10.10", + "hw-dev-index": 0, + "serial-number": "None", + "part-number": "ge-8", + "lastupdated": 1643076350328, + "version": "None", + "vdevice-host-name": "vm3", + "hw-description": "Max 8 x 1GE VM ports" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/status/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware status summary from device", + "operationId": "createStatusSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware status summary": { + "description": "Hardware status summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/synced/alarms": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware alarm list synchronously from device", + "operationId": "createSyncedAlarmList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware alarm list": { + "description": "Hardware alarm list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/synced/environment": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware environment list synchronously from device", + "operationId": "createSyncedEnvironmentList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware environment list": { + "description": "Hardware environment list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "hw-dev-index": 0, + "createTimeStamp": 1647316012518, + "vdevice-host-name": "vm1", + "measurement": "Present:yes;PoweredOn:no;Fault:no", + "vdevice-dataKey": "172.16.255.11-Interfacemodule-0", + "@rid": 1156, + "hw-item": "Interfacemodule", + "hw-class": "PIM", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647316012314, + "status": "Down" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/synced/inventory": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware inventory list synchronously from device", + "operationId": "createSyncedInventoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware inventory list": { + "description": "Hardware inventory list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "serial-number": "sim", + "hw-dev-index": 0, + "createTimeStamp": 1647316018898, + "version": "1.0", + "vdevice-host-name": "vm1", + "hw-description": "vEdge-Cloud", + "hw-type": "Chassis", + "vdevice-dataKey": "172.16.255.11-Chassis-0", + "@rid": 1163, + "vmanage-system-ip": "172.16.255.11", + "part-number": "vEdge-Cloud", + "lastupdated": 1647316017498 + }, + { + "vdevice-name": "172.16.255.11", + "serial-number": "None", + "hw-dev-index": 0, + "createTimeStamp": 1647316036497, + "version": "None", + "vdevice-host-name": "vm1", + "hw-description": "Max8x1GEVMports", + "hw-type": "PIM", + "vdevice-dataKey": "172.16.255.11-PIM-0", + "@rid": 1169, + "vmanage-system-ip": "172.16.255.11", + "part-number": "ge-8", + "lastupdated": 1647316017498 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/system": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware system data list from device", + "operationId": "createSystemList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware system data list": { + "description": "Hardware system data list", + "value": [ + { + "last-reboot-reason": "reload", + "software-version": "Cisco IOS Software [Cupertino], Virtual XE Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Experimental Version 17.8.20211216:090342 [BLD_POLARIS_DEV_LATEST_20211216_061759:/nobackup/mcpre/s2c-build-ws 101]\nCopyright (c) 1986-2021 by Cisco Systems, Inc.\nCompiled Thu 16-Dec-21 01:03 by mcpre", + "lastupdated": 1643186341301, + "vdevice-dataKey": "172.16.255.15-2022-01-26T08:40:53.165+00:00-2022-01-26T08:37:03+00:00", + "boot-time": "2022-01-26T08:37:03+00:00", + "rommon-version": "IOS-XE ROMMON", + "current-time": "2022-01-26T08:40:53.165+00:00", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardware/threshold": { + "get": { + "tags": [ + "Real-Time Monitoring - Hardware" + ], + "description": "Get hardware temperature list from device", + "operationId": "createTempThresholdList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Hardware temperature list": { + "description": "Hardware temperature list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/hardwarehealth/detail": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get hardware health details for device", + "operationId": "getHardwareHealthDetails", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "Device state", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device hardware health details": { + "description": "Device hardware health details", + "value": { + "data": [ + { + "bfdSessions": "3", + "memUsageDisplay": "52.0", + "site-id": "100", + "device-type": "vedge", + "version": "20.7.999-1133", + "hardwareState": "normal", + "uptime-date": 1635324240000, + "uuid": "63e8518c-e76f-4d5f-a4c7-28ffb669526b", + "lastupdated": 1635371851165, + "reachability": "reachable", + "device-model": "vedge-cloud", + "host-name": "vm11", + "local-system-ip": "172.16.255.21", + "cpuLoadDisplay": "39.27", + "controlConnections": "3", + "board-serial": "12346568", + "number-vsmart-peers": 2, + "system-ip": "172.16.255.21", + "ompPeers": "2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/hardwarehealth/summary": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get hardware health summary for device", + "operationId": "getHardwareHealthSummary", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Status cached", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device hardware health": { + "description": "Device hardware health", + "value": { + "data": [ + { + "count": 5, + "status": "error", + "statusList": [ + { + "status": "up", + "count": 5, + "message": "5 {normal=5, warning=0, error=0}", + "name": "normal", + "detailsURL": "/dataservice/device/hardwarehealth/detail?state=normal" + }, + { + "status": "warning", + "count": 0, + "message": "0 {normal=5, warning=0, error=0}", + "name": "warning", + "detailsURL": "/dataservice/device/hardwarehealth/detail?state=warning" + }, + { + "status": "down", + "count": 0, + "message": "0 {normal=5, warning=0, error=0}", + "name": "error", + "detailsURL": "/dataservice/device/hardwarehealth/detail?state=error" + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/history": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_20", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/aggregation": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_19", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/device/history/app-agg/aggregation": { + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_19", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/device/history/config": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get device config history", + "operationId": "getLastThousandConfigList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config history": { + "description": "Device config history", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/config/diff/list": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get diff of two configs", + "operationId": "getConfigDiff", + "parameters": [ + { + "name": "config_id1", + "in": "query", + "description": "Config Id one", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "config_id2", + "in": "query", + "description": "Config Id two", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/config/{config_id}": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get device config", + "operationId": "getDeviceConfig", + "parameters": [ + { + "name": "config_id", + "in": "path", + "description": "Config Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/csv": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/doccount": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get response count of a query", + "operationId": "getCount_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_22", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/history/fields": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/history/page": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_20", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/history/query/fields": { + "get": { + "tags": [ + "Configuration - Device Config History" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/igmp/groups": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP neighbor list from device", + "operationId": "createIGMPGroupsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IGMP neighbor": { + "description": "IGMP neighbor", + "value": { + "data": [ + { + "if-name": "ge0/0", + "v1-members-present": "false", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643076514019, + "state": "members-present", + "vpn-id": "10", + "event": "init-event", + "vdevice-host-name": "vm3", + "group": "225.225.0.1", + "uptime": "0:06:38:43" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/igmp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP interface list from device", + "operationId": "createIGMPInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IGMP interface": { + "description": "IGMP interface", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "if-addr": "100.100.3.101/24", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "querier": "true", + "querier-ip": "100.100.3.101", + "if-name": "ge0/0", + "vdevice-dataKey": "169.254.10.10-10-ge0/0", + "group-count": 1, + "query-interval": "0:00:00:51", + "lastupdated": 1643076670382, + "state": "querier", + "event": "init-event" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/igmp/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP statistics list from device", + "operationId": "createIGMPStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IGMP statistics": { + "description": "IGMP statistics", + "value": { + "data": [ + { + "rx_group_query": 0, + "vdevice-name": "169.254.10.10", + "tx_group_query": 0, + "vpn-id": "10", + "rx_v2_report": 0, + "rx_unknown": 0, + "vdevice-host-name": "vm3", + "rx_v1_report": 0, + "rx_leave": 0, + "tx_general_query": 194, + "vdevice-dataKey": "169.254.10.10", + "rx_general_query": 0, + "tx_error": 0, + "lastupdated": 1643076824172, + "rx_error": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/igmp/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - IGMP" + ], + "description": "Get IGMP summary from device", + "operationId": "createIGMPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IGMP summary": { + "description": "IGMP summary", + "value": { + "data": [ + { + "last-member-query-response-time": "3", + "querier-timeout": "255", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "query-interval": "125", + "query-response-time": "10", + "lastupdated": 1643076984762, + "version": "2", + "last-member-query-count": "2", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get device interfaces", + "operationId": "getDeviceInterface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 18, + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 13, + "ifname": "ge0/1", + "rx-pps": 14, + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 2, + "allow-service": "dhcp dns icmp https", + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 6544375, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 48131, + "tx-drops": 2, + "uptime": "4:20:14:13", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.101.3.3/16", + "hwaddr": "52:54:00:a1:4f:47", + "speed-mbps": "1000", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "tx-octets": 1238809794, + "tx-packets": 6404951, + "rx-octets": 1209186254, + "rx-kbps": 19, + "lastupdated": 1643077714908, + "port-type": "transport", + "uptime-date": 1642659240000, + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/1", + "rx-pps": 0, + "af-type": "ipv6", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ipv6-admin-status": "Up", + "ifindex": 2, + "allow-service": "dhcp dns icmp https", + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 3644, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "uptime": "4:20:14:13", + "ipv6-address": "-", + "hwaddr": "52:54:00:a1:4f:47", + "speed-mbps": "1000", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "tx-octets": 9140, + "tx-packets": 128, + "rx-octets": 405455, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "transport", + "uptime-date": 1642659240000, + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Down", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/2", + "rx-pps": 0, + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Down", + "ifindex": 3, + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 0, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "ipv6-address": "-", + "hwaddr": "52:54:00:39:5a:01", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "tx-octets": 0, + "tx-packets": 0, + "rx-octets": 0, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "service", + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Down", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/2", + "rx-pps": 0, + "af-type": "ipv6", + "shaping-rate": 0, + "if-oper-status": "Down", + "ipv6-admin-status": "Up", + "ifindex": 3, + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 0, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "ipv6-address": "-", + "hwaddr": "52:54:00:39:5a:01", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "tx-octets": 0, + "tx-packets": 0, + "rx-octets": 0, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "service", + "encap-type": "null" + }, + { + "vdevice-name": "169.254.10.10", + "rx-errors": 0, + "tx-kbps": 0, + "if-admin-status": "Down", + "tcp-mss-adjust": "1416", + "tx-errors": 0, + "tx-pps": 0, + "ifname": "ge0/3", + "rx-pps": 0, + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Down", + "ifindex": 4, + "if-tracker-status": "NA", + "num-flaps": "0", + "rx-packets": 0, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "mtu": "1500", + "rx-drops": 0, + "tx-drops": 0, + "ipv6-address": "-", + "hwaddr": "52:54:00:2d:a0:f5", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "tx-octets": 0, + "tx-packets": 0, + "rx-octets": 0, + "rx-kbps": 0, + "lastupdated": 1643077714908, + "port-type": "service", + "encap-type": "null" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/arp_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface ARP statistics", + "operationId": "getDeviceInterfaceARPStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ARP statistics": { + "description": "ARP statistics", + "value": { + "data": [ + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "45746", + "rx-arp-requests": "296", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "12281", + "ip-address": "-", + "tx-arp-replies": "304", + "tx-no-arp-drops": "2", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "rx-arp-replies": "12281", + "ifname": "ge0/1", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "lastupdated": 1643077098782, + "arp-add-fails": "1" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "1", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "rx-arp-replies": "0", + "ifname": "ge0/1", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "0", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "rx-arp-replies": "0", + "ifname": "ge0/2", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "0", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "rx-arp-replies": "0", + "ifname": "ge0/2", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + }, + { + "tx-arp-rate-limit-drops": "0", + "rx-arp-rate-limit-drops": "0", + "vdevice-name": "169.254.10.10", + "rx-arp-non-local-drops": "0", + "rx-arp-requests": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "rx-arp-reply-drops": "0", + "ipv6-address": "-", + "tx-arp-requests": "0", + "ip-address": "-", + "tx-arp-replies": "0", + "tx-no-arp-drops": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "rx-arp-replies": "0", + "ifname": "ge0/3", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "lastupdated": 1643077098782, + "arp-add-fails": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/error_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface error stats", + "operationId": "getDeviceInterfaceErrorStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Error stats": { + "description": "Error stats", + "value": { + "data": [ + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "2078", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "2", + "ifname": "ge0/1", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "arp-add-fails": "1", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "46027", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/1", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/2", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/2", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv6", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + }, + { + "tx-icmp-policer-drops": "0", + "rx-arp-rate-limit-drops": "0", + "tx-icmp-mirrored-drops": "0", + "vdevice-name": "169.254.10.10", + "cpu-policer-drops": "0", + "interface-disabled": "0", + "rx-arp-reply-drops": "0", + "tx-no-arp-drops": "0", + "ifname": "ge0/3", + "split-horizon-drops": "0", + "tx-arp-request-fail": "0", + "af-type": "ipv4", + "arp-add-fails": "0", + "rx-policer-remark": "0", + "mirror-drops": "0", + "tx-arp-rate-limit-drops": "0", + "rx-ip-ttl-expired": "0", + "rx-arp-non-local-drops": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-", + "rx-policer-drops": "0", + "bad-label": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "route-lookup-fail": "0", + "lastupdated": 1643079662907, + "rx-non-ip-drops": "0", + "filter-drops": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/ipv6Stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface IPv6 stats", + "operationId": "getDeviceInterfaceIpv6Stats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface IPv6 stats": { + "description": "Interface IPv6 stats", + "value": { + "data": [ + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet1", + "lastupdated": 1645602691945, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet2", + "lastupdated": 1645602691945, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet3", + "lastupdated": 1645602691946, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet4", + "lastupdated": 1645602691946, + "out-error-pkts": "0" + }, + { + "in-forwarded-pkts": "0", + "vdevice-name": "169.254.10.12", + "out-pkts": "0", + "in-forwarded-octets": "0", + "in-discarded-pkts": "0", + "out-forwarded-octets": "0", + "in-error-pkts": "0", + "vdevice-host-name": "vm5", + "in-pkts": "0", + "out-forwarded-pkts": "0", + "out-octets": "0", + "out-discarded-pkts": "0", + "in-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "name": "GigabitEthernet5", + "lastupdated": 1645602691946, + "out-error-pkts": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/pkt_size": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface packet size", + "operationId": "getDeviceInterfacePktSizes", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface packet size": { + "description": "Interface packet size", + "value": { + "data": [ + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "num-flaps": "0", + "af-type": "ipv4", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "num-flaps": "0", + "af-type": "ipv6", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "num-flaps": "0", + "af-type": "ipv4", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "num-flaps": "0", + "af-type": "ipv6", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/3", + "num-flaps": "0", + "af-type": "ipv4", + "lastupdated": 1643080426479, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/port_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface port stats", + "operationId": "getDeviceInterfacePortStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface port stats": { + "description": "Interface port stats", + "value": { + "data": [ + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "af-type": "ipv4", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "af-type": "ipv6", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "af-type": "ipv4", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + }, + { + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "af-type": "ipv6", + "lastupdated": 1643080839352, + "vpn-id": "0", + "vdevice-host-name": "vm3", + "ipv6-address": "-" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/qosStats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface QOS stats", + "operationId": "getDeviceInterfaceQosStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface QOS stats": { + "description": "Interface QOS stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/queue_stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface queue stats", + "operationId": "getDeviceInterfaceQueueStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface queue stats": { + "description": "Interface queue stats", + "value": { + "data": [ + { + "qnum": "0", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "vpn-id": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-0", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "af-type": "ipv4", + "tx-bytes": "0", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "2", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-2", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "3", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-3", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "4", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-4", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + }, + { + "qnum": "5", + "max-depth": "0", + "queued-packets": "0", + "vdevice-name": "169.254.10.10", + "avg-queue": "0", + "red-drop-packets": "0", + "queued-bytes": "0", + "tail-drop-bytes": "0", + "vpn-id": "0", + "vdevice-host-name": "vm3", + "red-drop-bytes": "0", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-5", + "ifname": "ge0/1", + "tx-packets": "0", + "queue-pps": "0", + "tx-bytes": "0", + "af-type": "ipv4", + "lastupdated": 1643081385319, + "queue-depth": "0", + "queue-drop-pps": "0", + "tail-drop-packets": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/serial": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get serial interface", + "operationId": "getDeviceSerialInterface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get interface stats", + "operationId": "getDeviceInterfaceStats", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface stats": { + "description": "Interface stats", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "rx-packets": "6634251", + "rx-errors": "0", + "tx-kbps": "18", + "tx-errors": "0", + "tx-pps": "13", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "48776", + "tx-drops": "2", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", + "ifname": "ge0/1", + "rx-pps": "13", + "tx-octets": "1255701145", + "tx-packets": "6493413", + "af-type": "ipv4", + "rx-octets": "1225652937", + "rx-kbps": "19", + "lastupdated": 1643083561267 + }, + { + "vdevice-name": "169.254.10.10", + "rx-packets": "3694", + "rx-errors": "0", + "tx-kbps": "0", + "tx-errors": "0", + "tx-pps": "0", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "0", + "tx-drops": "0", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", + "ifname": "ge0/1", + "rx-pps": "0", + "tx-octets": "9280", + "tx-packets": "130", + "af-type": "ipv6", + "rx-octets": "411008", + "rx-kbps": "0", + "lastupdated": 1643083561267 + }, + { + "vdevice-name": "169.254.10.10", + "rx-packets": "0", + "rx-errors": "0", + "tx-kbps": "0", + "tx-errors": "0", + "tx-pps": "0", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "0", + "tx-drops": "0", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", + "ifname": "ge0/2", + "rx-pps": "0", + "tx-octets": "0", + "tx-packets": "0", + "af-type": "ipv4", + "rx-octets": "0", + "rx-kbps": "0", + "lastupdated": 1643083561267 + }, + { + "vdevice-name": "169.254.10.10", + "rx-packets": "0", + "rx-errors": "0", + "tx-kbps": "0", + "tx-errors": "0", + "tx-pps": "0", + "vpn-id": "0", + "dot1x-rx-pkts": "0", + "vdevice-host-name": "vm3", + "rx-drops": "0", + "tx-drops": "0", + "ipv6-address": "-", + "dot1x-tx-pkts": "0", + "ip-address": "-", + "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", + "ifname": "ge0/2", + "rx-pps": "0", + "tx-octets": "0", + "tx-packets": "0", + "af-type": "ipv6", + "rx-octets": "0", + "rx-kbps": "0", + "lastupdated": 1643083561267 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get device interfaces synchronously", + "operationId": "getSyncedDeviceInterface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "af-type", + "in": "query", + "description": "AF Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ipv4", + "ipv6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "@rid": 855, + "ifname": "ge0/1", + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 2, + "if-tracker-status": "NA", + "createTimeStamp": 1647315879734, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.0.26.11/24", + "hwaddr": "52:54:00:db:d9:1b", + "speed-mbps": "1000", + "vdevice-dataKey": "172.16.255.11-0-ge0/1-ipv4", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315879722, + "port-type": "service", + "encap-type": "null" + }, + { + "vdevice-name": "172.16.255.11", + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "@rid": 869, + "ifname": "ge0/2", + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 3, + "allow-service": "dhcpdnsicmphttps", + "if-tracker-status": "NA", + "createTimeStamp": 1647315880679, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.0.5.11/24", + "hwaddr": "52:54:00:5b:92:ab", + "speed-mbps": "1000", + "vdevice-dataKey": "172.16.255.11-0-ge0/2-ipv4", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315879722, + "port-type": "transport", + "encap-type": "null" + }, + { + "ifindex": 4, + "vdevice-name": "172.16.255.11", + "if-tracker-status": "NA", + "if-admin-status": "Down", + "createTimeStamp": 1647315881312, + "tcp-mss-adjust": "1416", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "hwaddr": "52:54:00:36:5b:37", + "ip-address": "-", + "vdevice-dataKey": "172.16.255.11-0-ge0/3-ipv4", + "@rid": 883, + "ifname": "ge0/3", + "vmanage-system-ip": "172.16.255.11", + "af-type": "ipv4", + "lastupdated": 1647315879722, + "shaping-rate": 0, + "port-type": "service", + "if-oper-status": "Down", + "encap-type": "null" + }, + { + "vdevice-name": "172.16.255.11", + "if-admin-status": "Up", + "duplex": "full", + "tcp-mss-adjust": "1416", + "@rid": 897, + "ifname": "ge0/4", + "af-type": "ipv4", + "shaping-rate": 0, + "if-oper-status": "Up", + "auto-neg": "false", + "ifindex": 5, + "if-tracker-status": "NA", + "createTimeStamp": 1647315882880, + "secondary-address": "", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "secondary": "false", + "ip-address": "10.0.7.11/24", + "hwaddr": "52:54:00:67:74:f1", + "speed-mbps": "1000", + "vdevice-dataKey": "172.16.255.11-0-ge0/4-ipv4", + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315879722, + "port-type": "service", + "encap-type": "null" + }, + { + "ifindex": 6, + "vdevice-name": "172.16.255.11", + "if-tracker-status": "NA", + "if-admin-status": "Down", + "createTimeStamp": 1647315883461, + "tcp-mss-adjust": "1416", + "vpn-id": "0", + "vdevice-host-name": "vm1", + "mtu": "1500", + "ipv6-address": "-", + "hwaddr": "52:54:00:0f:c2:a7", + "ip-address": "-", + "vdevice-dataKey": "172.16.255.11-0-ge0/5-ipv4", + "@rid": 908, + "ifname": "ge0/5", + "vmanage-system-ip": "172.16.255.11", + "af-type": "ipv4", + "lastupdated": 1647315879722, + "shaping-rate": 0, + "port-type": "service", + "if-oper-status": "Down", + "encap-type": "null" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/interface/trustsec": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get policy filter memory usage from device", + "operationId": "trustsec", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy filter memory usage": { + "description": "Policy filter memory usage", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/interface/vpn": { + "get": { + "tags": [ + "Real-Time Monitoring - Interface" + ], + "description": "Get device interfaces per VPN", + "operationId": "generateDeviceInterfaceVPN", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "data": [ + { + "index": 0, + "vpnId": "0", + "ifname": "ge0/1" + }, + { + "index": 1, + "vpnId": "0", + "ifname": "ge0/2" + }, + { + "index": 2, + "vpnId": "0", + "ifname": "ge0/3" + }, + { + "index": 3, + "vpnId": "0", + "ifname": "ge0/4" + }, + { + "index": 4, + "vpnId": "0", + "ifname": "ge0/5" + }, + { + "index": 5, + "vpnId": "0", + "ifname": "ge0/6" + }, + { + "index": 6, + "vpnId": "0", + "ifname": "ge0/7" + }, + { + "index": 7, + "vpnId": "0", + "ifname": "system" + }, + { + "index": 8, + "vpnId": "1", + "ifname": "ge0/0" + }, + { + "index": 9, + "vpnId": "512", + "ifname": "eth0" + }, + { + "index": 10, + "vpnId": "65528", + "ifname": "loopback65528" + }, + { + "index": 11, + "vpnId": "65530", + "ifname": "loopback65530" + }, + { + "index": 12, + "vpnId": "65530", + "ifname": "loopback65531" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/ip/fib": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get FIB list from device (Real Time)", + "operationId": "createFibList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "address-family", + "in": "query", + "description": "Address family", + "schema": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "tloc", + "in": "query", + "description": "tloc IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FIB list": { + "description": "FIB list", + "value": { + "data": [ + { + "nexthop-address": "10.0.5.13", + "vdevice-dataKey": "172.16.255.21-0-0.0.0.0/0", + "vdevice-name": "172.16.255.21", + "prefix": "0.0.0.0/0", + "lastupdated": 1649641392351, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.5.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.5.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.5.21/32", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.5.21/32", + "lastupdated": 1649641392351, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.100.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.100.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/7", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-10.0.100.21/32", + "vdevice-name": "172.16.255.21", + "prefix": "10.0.100.21/32", + "lastupdated": 1649641392351, + "out-ifname": "ge0/7", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-100.0.0.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "100.0.0.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/6", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "vdevice-dataKey": "172.16.255.21-0-100.0.0.11/32", + "vdevice-name": "172.16.255.21", + "prefix": "100.0.0.11/32", + "lastupdated": 1649641392351, + "out-ifname": "ge0/6", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + }, + { + "nexthop-address": "100.0.0.1", + "vdevice-dataKey": "172.16.255.21-0-100.2.0.0/24", + "vdevice-name": "172.16.255.21", + "prefix": "100.2.0.0/24", + "lastupdated": 1649641392351, + "out-ifname": "ge0/6", + "vpn-id": 0, + "vdevice-host-name": "vm11", + "address-family": "ipv4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/ipRoutes": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get ietf routing list from device", + "operationId": "createIetfRoutingList", + "parameters": [ + { + "name": "routing-instance-name", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "address-family", + "in": "query", + "description": "Address family", + "schema": { + "type": "string" + } + }, + { + "name": "outgoing-interface", + "in": "query", + "description": "Outgoing Interface", + "schema": { + "type": "string" + } + }, + { + "name": "source-protocol", + "in": "query", + "description": "Source Protocol", + "schema": { + "type": "string" + } + }, + { + "name": "next-hop-address", + "in": "query", + "description": "Next Hop Address", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ietf routing list": { + "description": "ietf routing list", + "value": { + "data": [ + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "0.0.0.0/0", + "route-source-protocol": "static", + "next-hop-next-hop-address": "10.102.254.254", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "1", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "route-metric": "0", + "lastupdated": 1645080304580 + }, + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "10.101.0.0/16", + "route-source-protocol": "direct", + "next-hop-next-hop-address": "0.0.0.0", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "0", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "next-hop-outgoing-interface": "GigabitEthernet3", + "route-metric": "0", + "lastupdated": 1645080304580 + }, + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "10.101.5.5/32", + "route-source-protocol": "direct", + "next-hop-next-hop-address": "0.0.0.0", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "0", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "next-hop-outgoing-interface": "GigabitEthernet3", + "route-metric": "0", + "lastupdated": 1645080304580 + }, + { + "protocol-type": "direct", + "vdevice-name": "169.254.10.12", + "route-destination-prefix": "10.102.0.0/16", + "route-source-protocol": "direct", + "next-hop-next-hop-address": "0.0.0.0", + "routing-instance-name": "default", + "protocol-name": "0", + "route-route-preference": "0", + "vdevice-host-name": "vm5", + "rib-default-rib": "false", + "rib-address-family": "ipv4", + "vdevice-dataKey": "169.254.10.12--", + "router-id": "0.0.0.0", + "next-hop-outgoing-interface": "GigabitEthernet5", + "route-metric": "0", + "lastupdated": 1645080304580 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/mfiboil": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get IP MFIB OIL list from device (Real Time)", + "operationId": "createIPMfibOilList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP MFIB OIL list": { + "description": "IP MFIB OIL list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/mfibstats": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get IP MFIB statistics list from device (Real Time)", + "operationId": "createIPMfibStatsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP MFIB statistics list": { + "description": "IP MFIB statistics list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/mfibsummary": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get IP MFIB summary list from device (Real Time)", + "operationId": "createIPMfibSummaryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP MFIB summary list": { + "description": "IP MFIB summary list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/filter": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT filter list from device", + "operationId": "createNatFilterList", + "parameters": [ + { + "name": "nat-vpn-id", + "in": "query", + "description": "NAT VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "nat-ifname", + "in": "query", + "description": "NAT interface name", + "schema": { + "type": "string" + } + }, + { + "name": "private-source-address", + "in": "query", + "description": "Private source address", + "schema": { + "type": "string" + } + }, + { + "name": "proto", + "in": "query", + "description": "Protocol", + "schema": { + "type": "string", + "enum": [ + "icm", + "tcp", + "udp" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT filter list": { + "description": "NAT filter list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT interface list from device (Real Time)", + "operationId": "createNatInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT interface list": { + "description": "NAT interface list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/interfacestatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT interface statistics list from device", + "operationId": "createNatInterfaceStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT interface statistics list": { + "description": "NAT interface statistics list", + "value": [ + { + "out2in-drops": 0, + "in2out-drops": 0, + "vdevice-dataKey": "172.16.255.15-0-0", + "vdevice-host-name": "vm5", + "initialized": 9223372036854775807, + "entry-timeouts": 0, + "pool-stats-drop": "0", + "limit-entry-add-fail": "0", + "outsides": 0, + "packets-punted": "0", + "lastupdated": 1645079319277, + "mapping-stats-drop": "0", + "misses": 0, + "interrupt-switched": 0, + "frag-pak-count": "0", + "statics": 0, + "flows": 0, + "entries": "0", + "vdevice-name": "172.16.255.15", + "hits": 0, + "portlist-req-fail": "0", + "ipalias-add-fail": 0, + "insides": 0, + "statics-sorted": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat/translation": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT translation list from device (Real Time)", + "operationId": "createNatTranslationList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT translation list": { + "description": "NAT translation list", + "value": { + "data": [ + { + "inside-local-addr": "10.1.15.15", + "outside-local-port": "50", + "vdevice-name": "172.16.255.15", + "inside-global-port": "50", + "flags": "0", + "outside-global-port": "50", + "vdevice-host-name": "vm5", + "vrfid": "0", + "protocol": "1", + "outside-local-addr": "10.1.16.16", + "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-50", + "outside-global-addr": "10.1.16.16", + "inside-local-port": "50", + "lastupdated": 1651038839092, + "application-type": "0", + "inside-global-addr": "10.1.15.15" + }, + { + "inside-local-addr": "10.1.15.15", + "outside-local-port": "51", + "vdevice-name": "172.16.255.15", + "inside-global-port": "51", + "flags": "0", + "outside-global-port": "51", + "vdevice-host-name": "vm5", + "vrfid": "0", + "protocol": "1", + "outside-local-addr": "10.1.16.16", + "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-51", + "outside-global-addr": "10.1.16.16", + "inside-local-port": "51", + "lastupdated": 1651038839092, + "application-type": "0", + "inside-global-addr": "10.1.15.15" + }, + { + "inside-local-addr": "10.1.15.15", + "outside-local-port": "49", + "vdevice-name": "172.16.255.15", + "inside-global-port": "49", + "flags": "0", + "outside-global-port": "49", + "vdevice-host-name": "vm5", + "vrfid": "0", + "protocol": "1", + "outside-local-addr": "10.1.16.16", + "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-49", + "outside-global-addr": "10.1.16.16", + "inside-local-port": "49", + "lastupdated": 1651038839092, + "application-type": "0", + "inside-global-addr": "10.1.15.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/nat64/translation": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get NAT64 interface list from device", + "operationId": "createNat64TranslationList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NAT64 interface list": { + "description": "NAT64 interface list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/routetable": { + "get": { + "tags": [ + "Real-Time Monitoring - IP" + ], + "description": "Get route table list from device (Real Time)", + "operationId": "createRouteTableList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "address-family", + "in": "query", + "description": "Address family", + "schema": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "protocol", + "in": "query", + "description": "IP protocol", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Route table list": { + "description": "Route table list", + "value": { + "data": [ + { + "rstatus": "F S", + "protocol": "static", + "vdevice-dataKey": "169.254.10.10-0-0.0.0.0/0", + "vdevice-name": "169.254.10.10", + "prefix": "0.0.0.0/0", + "lastupdated": 1643160579908, + "nexthop-addr": "10.101.254.254", + "vpn-id": 0, + "nexthop-type": "ipv4", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "nexthop-ifname": "ge0/1" + }, + { + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.5.0/24", + "ip": "172.16.254.4", + "encap": "ipsec", + "vpn-id": 10, + "nexthop-label": "1047", + "nexthop-type": "ipv4-indirect", + "vdevice-host-name": "vm3", + "rstatus": "F S", + "protocol": "omp", + "vdevice-dataKey": "169.254.10.10-10-10.0.5.0/24", + "lastupdated": 1643160579908, + "address-family": "ipv4" + }, + { + "rstatus": "F S", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-512-fcff::/120", + "vdevice-name": "169.254.10.10", + "prefix": "fcff::/120", + "lastupdated": 1643160579908, + "vpn-id": 512, + "nexthop-type": "ipv6", + "vdevice-host-name": "vm3", + "address-family": "ipv6", + "nexthop-ifname": "loop0.2" + }, + { + "rstatus": "F S", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-65528-192.168.0.0/24", + "vdevice-name": "169.254.10.10", + "prefix": "192.168.0.0/24", + "lastupdated": 1643160579908, + "vpn-id": 65528, + "nexthop-type": "ipv4", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "nexthop-ifname": "loopback65528" + }, + { + "rstatus": "F S", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-65530-192.168.0.0/24", + "vdevice-name": "169.254.10.10", + "prefix": "192.168.0.0/24", + "lastupdated": 1643160579908, + "vpn-id": 65530, + "nexthop-type": "ipv4", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "nexthop-ifname": "loopback65530" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/v4fib": { + "get": { + "tags": [ + "Real-Time Monitoring - IPv4 FIB" + ], + "description": "Get IPv4 FIB list from device (Real Time)", + "operationId": "createIPv4FibList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "tloc", + "in": "query", + "description": "tloc IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FIB list": { + "description": "FIB list", + "value": { + "data": [ + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-512-10.0.1.0/24", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.1.0/24", + "lastupdated": 1643096072514, + "out-ifname": "eth0", + "vpn-id": 512, + "vdevice-host-name": "vm3" + }, + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-512-10.0.1.3/32", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.1.3/32", + "lastupdated": 1643096072514, + "out-ifname": "eth0", + "vpn-id": 512, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ip/v6fib": { + "get": { + "tags": [ + "Real-Time Monitoring - IPv6 FIB" + ], + "description": "Get IPv6 FIB list from device (Real Time)", + "operationId": "createIPv6FibList", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "prefix", + "in": "query", + "description": "IP prefix", + "schema": { + "type": "string" + } + }, + { + "name": "tloc", + "in": "query", + "description": "tloc IP", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "FIB list": { + "description": "FIB list", + "value": { + "data": [ + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-0-fe80::3274:7d86:eb7f:4a3c/128", + "vdevice-name": "169.254.10.10", + "prefix": "fe80::3274:7d86:eb7f:4a3c/128", + "lastupdated": 1643096311251, + "out-ifname": "vmanage_system", + "vpn-id": 0, + "vdevice-host-name": "vm3" + }, + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-0-fe80::40b8:4592:c183:592c/128", + "vdevice-name": "169.254.10.10", + "prefix": "fe80::40b8:4592:c183:592c/128", + "lastupdated": 1643096311251, + "out-ifname": "system", + "vpn-id": 0, + "vdevice-host-name": "vm3" + }, + { + "path-id": 1, + "vdevice-dataKey": "169.254.10.10-0-fe80::5054:ff:fea1:4f47/128", + "vdevice-name": "169.254.10.10", + "prefix": "fe80::5054:ff:fea1:4f47/128", + "lastupdated": 1643096311251, + "out-ifname": "ge0/1", + "vpn-id": 0, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/ipsec/identity": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get Crypto IPSEC identity entry from device", + "operationId": "createCryptoIpsecIdentity", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crypto IPSEC identity entry": { + "description": "Crypto IPSEC identity entry", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.12", + "local-ident-addr": "10.102.5.5", + "local-endpt-addr": "10.102.5.5", + "remote-ident-protocol": "0", + "interface": "Tunnel5", + "vpn-id": "0", + "vdevice-host-name": "vm5", + "local-ident-mask": "255.255.255.255", + "local-ident-protocol": "0", + "vdevice-dataKey": "169.254.10.12", + "plaintext-mtu": "1438", + "lastupdated": 1644890148156, + "remote-ident-addr": "10.101.3.3", + "remote-endpt-addr": "10.101.3.3", + "remote-ident-mask": "255.255.255.255", + "dh-group": "crypto-dh-grouptype-none" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ike/inbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec IKE inbound connection list from device", + "operationId": "createIkeInboundList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec IKE local inbound connection list": { + "description": "IPsec IKE local inbound connection list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ike/outbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec IKE outbound connection list from device", + "operationId": "createIkeOutboundList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec IKE outbound connection list": { + "description": "IPsec IKE outbound connection list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ike/sessions": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec IKE sessions from device", + "operationId": "createIkeSessions", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec IKE sessions": { + "description": "IPsec IKE sessions", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ikev1": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get Crypto IKEv1 SA entry from device", + "operationId": "createCryptov1LocalSAList", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crypto IKEv1 SA entry": { + "description": "Crypto IKEv1 SA entry", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/ikev2": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get Crypto IKEv2 SA entry from device", + "operationId": "createCryptov2LocalSAList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Crypto IKEv2 SA entry": { + "description": "Crypto IKEv2 SA entry", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/inbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec inbound connection list from device (Real Time)", + "operationId": "createInBoundList", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec inbound connection list": { + "description": "IPsec inbound connection list", + "value": { + "data": [ + { + "dest-ip": "10.101.3.3", + "source-port": 12386, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.1", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.101.2.2", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.3", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.101.4.4", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.4", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.102.5.5", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.5", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.102.6.6", + "remote-tloc-color": "default", + "local-tloc-color": "default" + }, + { + "dest-ip": "10.101.3.3", + "source-port": 12406, + "vdevice-name": "169.254.10.10", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.16", + "negotiated-encryption-algo": "AES-GCM-256", + "dest-port": 12406, + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "local-tloc-address": "172.16.254.2", + "lastupdated": 1643163071849, + "source-ip": "10.102.16.16", + "remote-tloc-color": "default", + "local-tloc-color": "default" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/localsa": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec local SA list from device", + "operationId": "createLocalSAList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec local SA list": { + "description": "IPsec local SA list", + "value": { + "data": [ + { + "tloc-color": "default", + "vdevice-dataKey": "169.254.10.10-172.16.254.2", + "vdevice-name": "169.254.10.10", + "port": 12406, + "tloc-address": "172.16.254.2", + "ipv6": "::", + "ip": "10.101.3.3", + "lastupdated": 1643166514716, + "encrypt-key-hash": "*****386b", + "spi": "286", + "auth-key-hash": "*****386b", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/outbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPsec outbound connection list from device (Real Time)", + "operationId": "createOutBoundList", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IPsec outbound connection list": { + "description": "IPsec outbound connection list", + "value": { + "data": [ + { + "dest-ip": "10.101.2.2", + "integrity-used": "ip-udp-esp", + "source-port": 12426, + "vdevice-name": "169.254.10.10", + "spi": 262, + "auth-key-hash": "*****2450", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.1", + "dest-port": 12386, + "vdevice-dataKey": "169.254.10.10-10.101.3.3", + "tunnel-mtu": 1441, + "lastupdated": 1643334538276, + "source-ip": "10.101.3.3", + "remote-tloc-color": "default", + "encrypt-key-hash": "*****2450" + }, + { + "dest-ip": "10.101.4.4", + "integrity-used": "ip-udp-esp", + "source-port": 12426, + "vdevice-name": "169.254.10.10", + "spi": 289, + "auth-key-hash": "*****3b7e", + "vdevice-host-name": "vm3", + "remote-tloc-address": "172.16.254.3", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-10.101.3.3", + "tunnel-mtu": 1441, + "lastupdated": 1643334538276, + "source-ip": "10.101.3.3", + "remote-tloc-color": "default", + "encrypt-key-hash": "*****3b7e" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/pwk/inbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPSEC pairwise key inbound entry from device", + "operationId": "createIPsecPWKInboundConnections", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPSEC pairwise key inbound entry": { + "description": "IPSEC pairwise key inbound entry", + "value": { + "data": [ + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.1", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066644, + "remote-tloc-color": "lte", + "source-ip": "10.102.2.2", + "local-tloc-color": "default", + "sa-index": "7", + "remote-tloc-index": "32775" + }, + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.1", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066644, + "remote-tloc-color": "3g", + "source-ip": "10.101.2.2", + "local-tloc-color": "default", + "sa-index": "19", + "remote-tloc-index": "32781" + }, + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.2", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066644, + "remote-tloc-color": "lte", + "source-ip": "10.102.3.3", + "local-tloc-color": "default", + "sa-index": "11", + "remote-tloc-index": "32777" + }, + { + "dest-ip": "10.101.5.5", + "local-tloc-index": "32770", + "source-port": "12366", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "is-ah-auth": "true", + "pwk-spi": "0", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "ss-hash": " ", + "remote-tloc-address": "172.16.254.2", + "dest-port": "12346", + "vdevice-dataKey": "169.254.10.12", + "d-key-hash": " ", + "local-tloc-address": "172.16.254.4", + "lastupdated": 1645154066645, + "remote-tloc-color": "3g", + "source-ip": "10.101.3.3", + "local-tloc-color": "default", + "sa-index": "9", + "remote-tloc-index": "32776" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/pwk/localsa": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPSEC pairwise key local SA entry from device", + "operationId": "createIPsecPWKLocalSA", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPSEC pairwise key local SA entry": { + "description": "IPSEC pairwise key local SA entry", + "value": { + "data": [ + { + "tloc-color": "default", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32770", + "ip": "10.101.5.5", + "spi": "262", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "9" + }, + { + "tloc-color": "default", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32770", + "ip": "10.101.5.5", + "spi": "263", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "11" + }, + { + "tloc-color": "3g", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32771", + "ip": "10.102.5.5", + "spi": "262", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "10" + }, + { + "tloc-color": "3g", + "pkey-hash": " ", + "vdevice-name": "169.254.10.12", + "nonce-hash": " ", + "tloc-address": "172.16.254.4", + "tloc-index": "32771", + "ip": "10.102.5.5", + "spi": "263", + "vdevice-host-name": "vm5", + "pkey-id": "0", + "vdevice-dataKey": "169.254.10.12", + "port": "12346", + "lastupdated": 1645153823323, + "sa-index": "12" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipsec/pwk/outbound": { + "get": { + "tags": [ + "Real-Time Monitoring - IPsec" + ], + "description": "Get IPSEC pairwise key outbound entry from device", + "operationId": "createIPsecPWKOutboundConnections", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPSEC pairwise key outbound entry": { + "description": "IPSEC pairwise key outbound entry", + "value": { + "data": [ + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "a600", + "local-tloc-color": "lte", + "dest-ip": "10.0.5.11", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32772", + "lastupdated": 1645156239932, + "sa-index": "183", + "remote-tloc-address": "172.16.255.11", + "tloc-index": "32772", + "dest-port": "12367", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + }, + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "b13e", + "local-tloc-color": "lte", + "dest-ip": "10.0.5.21", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32771", + "lastupdated": 1645156239933, + "sa-index": "182", + "remote-tloc-address": "172.16.255.21", + "tloc-index": "32771", + "dest-port": "12377", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + }, + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "59f1", + "local-tloc-color": "lte", + "dest-ip": "10.1.14.14", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32774", + "lastupdated": 1645156239933, + "sa-index": "184", + "remote-tloc-address": "172.16.255.14", + "tloc-index": "32774", + "dest-port": "12366", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + }, + { + "pkey-id": "0", + "vdevice-dataKey": "172.16.255.15", + "nonce-hash": " ", + "pkey-hash": " ", + "vdevice-host-name": "vm5", + "e-key-hash": "61b6", + "local-tloc-color": "lte", + "dest-ip": "10.1.16.16", + "source-ip": "10.1.15.15", + "remote-tloc-index": "32773", + "lastupdated": 1645156239933, + "sa-index": "181", + "remote-tloc-address": "172.16.255.16", + "tloc-index": "32773", + "dest-port": "12366", + "source-port": "12346", + "local-tloc-index": "32770", + "vdevice-name": "172.16.255.15", + "remote-tloc-color": "lte", + "ss-hash": " ", + "spi": "302", + "local-tloc-address": "172.16.255.15", + "is-ah-auth": "true", + "pwk-spi": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/ipv6/nd6": { + "get": { + "tags": [ + "Real-Time Monitoring - Device" + ], + "description": "Get ipv6 data from device", + "operationId": "getIpv6Data", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IP v6 data": { + "description": "IP v6 data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/keyvalue": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get vEdge inventory as key value (key as systemIp value as hostName)", + "operationId": "getDeviceListAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge inventory": { + "description": "vEdge inventory", + "value": { + "header": { + "generatedOn": 1635297986225 + }, + "data": [ + { + "key": "172.16.255.128", + "value": "vm128 (172.16.255.128)" + }, + { + "key": "172.16.253.129", + "value": "vm129 (172.16.253.129)" + }, + { + "key": "172.16.255.130", + "value": "vm130 (172.16.255.130)" + }, + { + "key": "172.16.253.131", + "value": "vm131 (172.16.253.131)" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/license/evaluation": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license evaluation info from device", + "operationId": "getLicenseEvalInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License evaluation info": { + "description": "License evaluation info", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.14", + "vdevice-name": "169.254.10.14", + "lastupdated": 1646031617468, + "eval-expired": "false", + "eval-in-use": "false", + "time-left": "0", + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/pak": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license pak info from device", + "operationId": "getLicensePAKInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License pak info": { + "description": "License pak info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/privacy": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license privacy info from device", + "operationId": "getLicensePrivacyInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License privacy info": { + "description": "License privacy info", + "value": { + "data": [ + {}, + { + "lastupdated": 1646030987293, + "hostname": "false", + "vdevice-dataKey": "169.254.10.14", + "vdevice-name": "169.254.10.14", + "version": "false", + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/registration": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license registration info from device", + "operationId": "getLicenseRegInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License info": { + "description": "License info", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "always-enabled": "true", + "lastupdated": 1645754331129, + "vdevice-host-name": "vm5", + "smart-enabled": "false" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/udi": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license UDI info from device", + "operationId": "getLicenseUDIInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License UDI info": { + "description": "License UDI info", + "value": { + "data": [ + { + "mac-address": "00:00:00:00:00:00", + "vdevice-dataKey": "169.254.10.14", + "vdevice-name": "169.254.10.14", + "lastupdated": 1646030100474, + "pid": "CSR1000V", + "sn": "9PBHZUBMD18", + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/license/usage": { + "get": { + "tags": [ + "Real-Time Monitoring - License Info" + ], + "description": "Get license usage info from device", + "operationId": "getLicenseUsageInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "License usage info": { + "description": "License usage info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/logging": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get logging from device (Real Time)", + "operationId": "getLoggingFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Logging": { + "description": "Logging", + "value": { + "data": [ + { + "disk_priority": "info", + "disk_filerotate": 10, + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "host_priority": "emerg", + "lastupdated": 1643178776334, + "disk_status": "enabled", + "disk_filename": "vsyslog", + "disk_filesize": 10, + "host_status": "disabled", + "host_vpn_id": 0, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/models": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get all device models supported by the vManage", + "operationId": "listAllDeviceModels", + "parameters": [ + { + "name": "list", + "in": "query", + "description": "List type of device", + "required": true, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device model": { + "description": "Device model", + "value": { + "header": { + "generatedOn": 1635224742597 + }, + "data": [ + { + "name": "vedge-ISR-4461", + "templateClass": "cedge", + "displayName": "ISR4461", + "deviceType": "vedge", + "isCliSupported": true, + "templateSupported": true, + "deviceClass": "cisco-router", + "cpuCountAttribute": { + "enable": true, + "attributeField": "total_cpu_count" + }, + "interfaces": { + "wan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "lan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "mgmt": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "day0": [ + "GigabitEthernet0/0/0" + ] + }, + "onboardCert": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/models/{uuid}": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get device model for the device", + "operationId": "getDeviceModels", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device model": { + "description": "Device model", + "value": { + "name": "vedge-cloud", + "displayName": "vEdge Cloud", + "deviceType": "vedge", + "isCliSupported": true, + "templateSupported": true, + "deviceClass": "viptela-router", + "cpuCountAttribute": { + "enable": true, + "attributeField": "linux_cpu_count" + }, + "onboardCert": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/monitor": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get all monitoring details of the devices", + "operationId": "listAllMonitorDetailsDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitor device details": { + "description": "Monitor device details", + "value": { + "header": { + "generatedOn": 1635227574211, + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-MonitorDeviceDetails" + }, + "columns": [ + { + "title": "Status", + "property": "status", + "display": "icon", + "iconProperty": "status-icon", + "colorProperty": "status-color", + "hideable": false, + "dataType": "string" + }, + { + "title": "Device Type", + "property": "device-type", + "display": "keyvalue", + "keyvalueProperty": "device-type", + "keyvalue": [ + { + "key": "vsmart", + "value": "vSmart" + }, + { + "key": "vbond", + "value": "vBond" + }, + { + "key": "vmanage", + "value": "vManage" + }, + { + "key": "vedge", + "value": "WAN Edge" + } + ], + "dataType": "string" + } + ], + "fields": [ + { + "property": "status", + "dataType": "string", + "display": "icon" + }, + { + "property": "host-name", + "dataType": "string", + "display": "iconAndText" + } + ] + }, + "data": [ + { + "device-model": "vmanage", + "device-type": "vmanage", + "system-ip": "169.254.10.1", + "host-name": "vm200", + "site-id": "200", + "layoutLevel": 1, + "status": "normal" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/multicast/replicator": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get replicator list from device", + "operationId": "createReplicatorList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Replicator list": { + "description": "Replicator list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/multicast/rpf": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get RPF list from device", + "operationId": "createRpfList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "RPF list": { + "description": "RPF list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/multicast/topology": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get topology list from device", + "operationId": "createTopologyList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Topology list": { + "description": "Topology list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/multicast/tunnel": { + "get": { + "tags": [ + "Real-Time Monitoring - Multicast" + ], + "description": "Get PIM tunnel from device", + "operationId": "createPimTunnelList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PIM tunnel": { + "description": "PIM tunnel", + "value": { + "data": [ + { + "tunnel-status": "UP", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "replicator": "no", + "lastupdated": 1643179140806, + "vpn-id": "10", + "vdevice-host-name": "vm3", + "tunnel-address": "172.16.254.1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ndv6": { + "get": { + "tags": [ + "Real-Time Monitoring - IPv6 Neighbours" + ], + "description": "Get IPv6 Neighbors from device (Real Time)", + "operationId": "getIpv6Interface", + "parameters": [ + { + "name": "vpn-id", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "if-name", + "in": "query", + "description": "Interface name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "mac", + "in": "query", + "description": "Mac address", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IPv6 Neighbors": { + "description": "IPv6 Neighbors", + "value": { + "data": [ + { + "if-name": "ge0/1", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "fe80::5054:ff:fea1:4f47", + "lastupdated": 1643172402186, + "state": "static", + "vpn-id": "0", + "uptime-date": 1642659240000, + "vdevice-host-name": "vm3", + "mac": "52:54:00:a1:4f:47", + "uptime": "5:22:32:19" + }, + { + "if-name": "ge0/1", + "idle-timer": "0:00:00:00", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "fe80::5054:ff:fecf:dad8", + "lastupdated": 1643172402186, + "state": "dynamic", + "vpn-id": "0", + "uptime-date": 1643048160000, + "vdevice-host-name": "vm3", + "mac": "52:54:00:cf:da:d8", + "uptime": "1:10:30:01" + }, + { + "if-name": "ge0/1", + "idle-timer": "0:00:00:00", + "vdevice-dataKey": "169.254.10.10-0-ge0/1", + "vdevice-name": "169.254.10.10", + "ip": "fe80::fc54:ff:fea1:4f47", + "lastupdated": 1643172402186, + "state": "dynamic", + "vpn-id": "0", + "uptime-date": 1642670640000, + "vdevice-host-name": "vm3", + "mac": "fe:54:00:a1:4f:47", + "uptime": "5:19:21:53" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/nms/running": { + "get": { + "tags": [ + "Real-Time Monitoring - NMS" + ], + "description": "Get nms running state from device", + "operationId": "getRunning", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Nms running": { + "description": "Nms running", + "value": { + "data": [ + { + "vdevice-host-name": "vm12", + "vdevice-dataKey": "172.16.255.22-true", + "running": "true", + "vdevice-name": "172.16.255.22", + "lastupdated": 1642648535452 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/ntp/associations": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get NTP peer associations list from device (Real Time)", + "operationId": "createAssociationsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "NTP peer associations list": { + "description": "NTP peer associations list", + "value": { + "data": [ + { + "count": 1, + "status": "8011", + "idx": 1, + "last_event": "mobilize", + "vdevice-name": "172.16.255.11", + "associd": "51657", + "auth": "none", + "reachability": "no", + "lastupdated": 1647428253985, + "conf": "yes", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11-1-51657", + "condition": "reject" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/ntp/peer": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get NTP peer list from device (Real Time)", + "operationId": "createPeerList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "NTP peer associations list": { + "description": "NTP peer associations list", + "value": { + "data": [ + { + "index": 1, + "remote": "10.10.10.10", + "reach": "0", + "when": "-", + "lastupdated": 1647576150422, + "st": "16", + "delay": "0.000", + "vdevice-dataKey": "172.16.255.11-1", + "offset": "+0.000", + "vdevice-host-name": "vm1", + "jitter": "0.000", + "poll": "512", + "type": "u", + "refid": ".INIT.", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/ntp/status": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get NTP status list from device (Real Time)", + "operationId": "createNTPStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "NTP peer associations list": { + "description": "NTP peer associations list", + "value": { + "data": [ + { + "sys-poll": "3", + "stratum": "16", + "lastupdated": 1647483667971, + "root-delay": "0.0", + "vdevice-dataKey": "172.16.255.15-3", + "reftime": "1970-01-01T00:00:00+00:00", + "offset": "0.0", + "kod-type": "ntp-ref-init", + "root-disp": "38.5", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/omp/cloudx": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get CloudExpress routes received list", + "operationId": "createOMPCloudXRecv", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudExpress routes received list": { + "description": "CloudExpress routes received list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/links": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP connection list", + "operationId": "createOMPLinkList", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Connection state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OMP connection list": { + "description": "OMP connection list", + "value": { + "data": [ + { + "state": "up", + "lastupdated": "1646804216515", + "linkKey": "172.16.255.16-172.16.255.20", + "adeviceId": "172.16.255.16", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.16", + "bsystem-ip": "172.16.255.20", + "asite-id": "600", + "bsite-id": "200", + "ahost-name": "vm6", + "bhost-name": "vm10", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804204258", + "linkKey": "172.16.255.16-172.16.255.19", + "adeviceId": "172.16.255.16", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.16", + "bsystem-ip": "172.16.255.19", + "asite-id": "600", + "bsite-id": "100", + "ahost-name": "vm6", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804204257", + "linkKey": "172.16.255.15-172.16.255.19", + "adeviceId": "172.16.255.15", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.15", + "bsystem-ip": "172.16.255.19", + "asite-id": "500", + "bsite-id": "100", + "ahost-name": "vm5", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804216515", + "linkKey": "172.16.255.15-172.16.255.20", + "adeviceId": "172.16.255.15", + "bdeviceId": "172.16.255.20", + "asystem-ip": "172.16.255.15", + "bsystem-ip": "172.16.255.20", + "asite-id": "500", + "bsite-id": "200", + "ahost-name": "vm5", + "bhost-name": "vm10", + "apersonality": "vedge", + "bpersonality": "vsmart" + }, + { + "state": "up", + "lastupdated": "1646804204257", + "linkKey": "172.16.255.14-172.16.255.19", + "adeviceId": "172.16.255.14", + "bdeviceId": "172.16.255.19", + "asystem-ip": "172.16.255.14", + "bsystem-ip": "172.16.255.19", + "asite-id": "400", + "bsite-id": "100", + "ahost-name": "vm4", + "bhost-name": "vm9", + "apersonality": "vedge", + "bpersonality": "vsmart" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/omp/mcastautodiscoveradvt": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast autodiscover advertised list", + "operationId": "createOMPMcastAutoDiscoverAdvt", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast autodiscover advertised list": { + "description": "OMP multicast autodiscover advertised list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643180905996, + "source-originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.253.129" + }, + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "lastupdated": 1643180905996, + "source-originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/mcastautodiscoverrecv": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast autodiscover received list", + "operationId": "createOMPMcastAutoDiscoverRecv", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast autodiscover received list": { + "description": "OMP multicast autodiscover received list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "from-peer": "172.16.253.129", + "lastupdated": 1643181632850, + "source-originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C I R" + }, + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "from-peer": "172.16.255.130", + "lastupdated": 1643181632851, + "source-originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C I R" + }, + { + "vdevice-dataKey": "169.254.10.10-ipv4-10", + "vdevice-name": "169.254.10.10", + "from-peer": "0.0.0.0", + "lastupdated": 1643181632852, + "source-originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C Red R" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/mcastroutesadvt": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast routes advertised list", + "operationId": "createOMPMcastRoutesAdvt", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast routes advertised list": { + "description": "OMP multicast routes advertised list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/mcastroutesrecv": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP multicast routes received list", + "operationId": "createOMPMcastRoutesRecv", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP multicast routes received list": { + "description": "OMP multicast routes received list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/peers": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP session list (Real Time)", + "operationId": "createOMPSessionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OP session list": { + "description": "OP session list", + "value": { + "data": [ + { + "domain-id": 1, + "vdevice-name": "169.254.10.10", + "refresh": "supported", + "site-id": 129, + "type": "vsmart", + "vdevice-host-name": "vm3", + "up-time-date": 1643135160000, + "vdevice-dataKey": "169.254.10.10-172.16.253.129-vsmart", + "peer": "172.16.253.129", + "up-time": "0:12:57:30", + "legit": "yes", + "lastupdated": 1643181828115, + "state": "up" + }, + { + "domain-id": 1, + "vdevice-name": "169.254.10.10", + "refresh": "supported", + "site-id": 130, + "type": "vsmart", + "vdevice-host-name": "vm3", + "up-time-date": 1643135160000, + "vdevice-dataKey": "169.254.10.10-172.16.255.130-vsmart", + "peer": "172.16.255.130", + "up-time": "0:12:57:30", + "legit": "yes", + "lastupdated": 1643181828115, + "state": "up" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/routes/advertised": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP advertised routes list (Real Time)", + "operationId": "createAdvertisedRoutesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP advertised routes list": { + "description": "OMP advertised routes list", + "value": { + "data": [ + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.3.0/24", + "ip": "172.16.254.2", + "label": "1069", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "65", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643179668956, + "to-peer": "172.16.253.129" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.3.0/24", + "ip": "172.16.254.2", + "label": "1069", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "65", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643179668956, + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/routes/advertised/ompIpv6": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP advertised routes list (Real Time)", + "operationId": "createAdvertisedRoutesListIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP advertised routes list": { + "description": "OMP advertised routes list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/omp/routes/received": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP received routes list (Real Time)", + "operationId": "createReceivedRoutesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP received routes list": { + "description": "OMP received routes list", + "value": { + "data": [ + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.5.0/24", + "ip": "172.16.254.4", + "from-peer": "172.16.253.129", + "label": "1047", + "encap": "ipsec", + "site-id": "5", + "originator": "172.16.254.4", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "42", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C I R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.5.0/24", + "ip": "172.16.254.4", + "from-peer": "172.16.255.130", + "label": "1047", + "encap": "ipsec", + "site-id": "5", + "originator": "172.16.254.4", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "42", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.16.0/24", + "ip": "172.16.254.16", + "from-peer": "172.16.253.129", + "label": "1014", + "encap": "ipsec", + "site-id": "16", + "originator": "172.16.254.16", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "38", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C I R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "10.0.16.0/24", + "ip": "172.16.254.16", + "from-peer": "172.16.255.130", + "label": "1014", + "encap": "ipsec", + "site-id": "16", + "originator": "172.16.254.16", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "38", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.2.0/24", + "ip": "172.16.254.1", + "from-peer": "172.16.253.129", + "label": "1018", + "encap": "ipsec", + "site-id": "2", + "originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "29", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C I R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.2.0/24", + "ip": "172.16.254.1", + "from-peer": "172.16.255.130", + "label": "1018", + "encap": "ipsec", + "site-id": "2", + "originator": "172.16.254.1", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "29", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041519, + "attribute-type": "installed", + "status": "C R" + }, + { + "overlay-id": "1", + "color": "default", + "vdevice-name": "169.254.10.10", + "prefix": "100.100.3.0/24", + "ip": "172.16.254.2", + "from-peer": "0.0.0.0", + "label": "1069", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "path-id": "65", + "protocol": "connected", + "vdevice-dataKey": "169.254.10.10-10", + "metric": "0", + "lastupdated": 1643182041520, + "attribute-type": "installed", + "status": "C Red R" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/routes/received/ompIpv6": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP received routes list (Real Time)", + "operationId": "createReceivedRoutesListIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP received routes list": { + "description": "OMP received routes list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/omp/services": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP services list", + "operationId": "createOMPServices", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OMP services list": { + "description": "OMP services list", + "value": { + "data": [ + { + "path-id": "65", + "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", + "vdevice-name": "169.254.10.10", + "service": "VPN", + "from-peer": "0.0.0.0", + "lastupdated": 1643250832867, + "originator": "172.16.254.2", + "label": "1077", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "status": "C Red R" + }, + { + "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", + "vdevice-name": "169.254.10.10", + "service": "VPN", + "lastupdated": 1643250832868, + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.253.129" + }, + { + "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", + "vdevice-name": "169.254.10.10", + "service": "VPN", + "lastupdated": 1643250832869, + "originator": "172.16.254.2", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "address-family": "ipv4", + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/status": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get device OMP status", + "operationId": "getDeviceOMPStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device OMP status": { + "description": "Device OMP status", + "value": { + "data": [ + { + "type": "omp", + "name": "OMP", + "image": "images/omp.png", + "count": 0, + "detailView": "dialog", + "detailsURL": "/dataservice/device/omp/links", + "statusList": [ + { + "status": "up", + "icon": "images/connection/connection-network-up.png", + "color": "b0e276", + "name": "up", + "detailView": "dialog", + "detailsURL": "/dataservice/device/omp/links?state=up", + "count": 0 + }, + { + "status": "down", + "icon": "images/connection/connection-network-down.png", + "color": "fa7c7d", + "name": "down", + "detailView": "dialog", + "detailsURL": "/dataservice/device/omp/links?state=down", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/omp/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OMP summary", + "operationId": "createOMPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OMP summary": { + "description": "OMP summary", + "value": { + "data": [ + { + "tlocs-sent": 4, + "policy-sent": 0, + "mcast-routes-sent": 0, + "packets-sent": 81579, + "vdevice-name": "169.254.10.10", + "inform-sent": 14, + "packets-received": 81956, + "routes-received": 18, + "tlocs-received": 22, + "mcast-routes-installed": 0, + "update-sent": 84, + "devicetype": "vedge", + "mcast-routes-received": 0, + "hello-received": 81472, + "alert-sent": 0, + "update-received": 468, + "vsmart-peers": 2, + "operstate": "UP", + "policy-received": 0, + "handshake-received": 2, + "handshake-sent": 2, + "alert-received": 0, + "services-sent": 4, + "vdevice-host-name": "vm3", + "inform-received": 14, + "vdevice-dataKey": "169.254.10.10--", + "tlocs-installed": 10, + "services-installed": 0, + "ompuptime": "9:11:16:34", + "services-received": 2, + "lastupdated": 1645494228477, + "routes-sent": 4, + "hello-sent": 81479, + "routes-installed": 8, + "adminstate": "UP" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/synced/peers": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get OP session list", + "operationId": "createSyncedOMPSessionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OP session list": { + "description": "OP session list", + "value": { + "data": [ + { + "domain-id": 1, + "vdevice-name": "172.16.255.11", + "createTimeStamp": 1646804055895, + "refresh": "supported", + "site-id": 100, + "type": "vsmart", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11-172.16.255.19-vsmart", + "@rid": 568, + "vmanage-system-ip": "172.16.255.11", + "peer": "172.16.255.19", + "legit": "yes", + "lastupdated": 1646804055844, + "region-id": "None", + "state": "up" + }, + { + "domain-id": 1, + "vdevice-name": "172.16.255.11", + "createTimeStamp": 1646804061584, + "refresh": "supported", + "site-id": 200, + "type": "vsmart", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11-172.16.255.20-vsmart", + "@rid": 574, + "vmanage-system-ip": "172.16.255.11", + "peer": "172.16.255.20", + "legit": "yes", + "lastupdated": 1646804055844, + "region-id": "None", + "state": "up" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/tlocs/advertised": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get advertised TLOCs list (Real Time)", + "operationId": "createAdvertisedTlocsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Advertised TLOCs list": { + "description": "Advertised TLOCs list", + "value": { + "data": [ + { + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.2", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "weight": "1", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.3.3", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.3.3", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", + "tloc-private-port": "12406", + "tloc-spi": "286", + "lastupdated": 1643179953349, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4", + "to-peer": "172.16.253.129" + }, + { + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.2", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "weight": "1", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.3.3", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.3.3", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", + "tloc-private-port": "12406", + "tloc-spi": "286", + "lastupdated": 1643179953351, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4", + "to-peer": "172.16.255.130" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/omp/tlocs/received": { + "get": { + "tags": [ + "Real-Time Monitoring - OMP" + ], + "description": "Get received TLOCs list (Real Time)", + "operationId": "createReceivedTlocsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Received TLOCs list": { + "description": "Received TLOCs list", + "value": { + "data": [ + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.1", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.253.129", + "weight": "1", + "encap": "ipsec", + "site-id": "2", + "originator": "172.16.254.1", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.2.2", + "tloc-public-port": "12386", + "tloc-private-ip": "10.101.2.2", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.1", + "tloc-private-port": "12386", + "tloc-spi": "263", + "lastupdated": 1643185163270, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.2", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "0.0.0.0", + "weight": "1", + "encap": "ipsec", + "site-id": "3", + "originator": "172.16.254.2", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.3.3", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.3.3", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", + "tloc-private-port": "12406", + "tloc-spi": "287", + "lastupdated": 1643185163276, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.3", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.255.130", + "weight": "1", + "encap": "ipsec", + "site-id": "4", + "originator": "172.16.254.3", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.101.4.4", + "tloc-public-port": "12406", + "tloc-private-ip": "10.101.4.4", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.3", + "tloc-private-port": "12406", + "tloc-spi": "284", + "lastupdated": 1643185163281, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.4", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.255.130", + "weight": "1", + "encap": "ipsec", + "site-id": "5", + "originator": "172.16.254.4", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.102.5.5", + "tloc-public-port": "12406", + "tloc-private-ip": "10.102.5.5", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.4", + "tloc-private-port": "12406", + "tloc-spi": "288", + "lastupdated": 1643185163286, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.5", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.253.129", + "weight": "1", + "encap": "ipsec", + "site-id": "6", + "originator": "172.16.254.5", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.102.6.6", + "tloc-public-port": "12406", + "tloc-private-ip": "10.102.6.6", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.5", + "tloc-private-port": "12406", + "tloc-spi": "292", + "lastupdated": 1643185163290, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + }, + { + "bfd-status": "up", + "color": "default", + "vdevice-name": "169.254.10.10", + "ip": "172.16.254.16", + "tloc-auth-type": "sha1-hmac ah-sha1-hmac", + "preference": "0", + "from-peer": "172.16.253.129", + "weight": "1", + "encap": "ipsec", + "site-id": "16", + "originator": "172.16.254.16", + "vdevice-host-name": "vm3", + "tloc-public-ip": "10.102.16.16", + "tloc-public-port": "12406", + "tloc-private-ip": "10.102.16.16", + "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.16", + "tloc-private-port": "12406", + "tloc-spi": "287", + "lastupdated": 1643185163295, + "tloc-encrypt-type": "aes256", + "tloc-proto": "0", + "address-family": "ipv4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" + } + }, + "/device/ondemand/local": { + "get": { + "tags": [ + "Real-Time Monitoring - Show On Demand Local" + ], + "description": "Get on-demand local (Real Time)", + "operationId": "getOnDemandLocal", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "On Demand Local list": { + "description": "On Demand Local list", + "value": { + "data": [ + { + "status": "-", + "site-id": "5", + "on-demand": "no", + "lastupdated": 1642667823842, + "idle-timeout-expiry": "10", + "vdevice-dataKey": "169.254.10.12-", + "vdevice-host-name": "vm5", + "vdevice-name": "169.254.10.12", + "system-ip": "172.16.254.4" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ondemand/remote": { + "get": { + "tags": [ + "Real-Time Monitoring - Show On Demand Remote" + ], + "description": "Get on-demand remote (Real Time)", + "operationId": "getOnDemandRemote", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "On Demand Remote list": { + "description": "On Demand Remote list", + "value": { + "data": [ + { + "status": "-", + "site-id": "3", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.2" + }, + { + "status": "-", + "site-id": "4", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.3" + }, + { + "status": "-", + "site-id": "5", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.4" + }, + { + "status": "-", + "site-id": "6", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.5" + }, + { + "status": "-", + "site-id": "16", + "on-demand": "no", + "lastupdated": 1642745561447, + "idle-timeout-expiry": "-", + "vdevice-dataKey": "169.254.10.9-", + "vdevice-host-name": "vm2", + "vdevice-name": "169.254.10.9", + "system-ip": "172.16.254.16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/orchestrator/connections": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get connection list from device", + "operationId": "createConnectionListFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection list": { + "description": "Connection list", + "value": { + "data": [ + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 100, + "local-color": "default", + "uptime": "1:23:51:47", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.19", + "state": "up", + "private-port": 12355, + "public-port": 12355, + "public-ip": "10.0.5.19", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.19", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.19" + }, + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 100, + "local-color": "default", + "uptime": "1:23:51:46", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.19", + "state": "up", + "private-port": 12455, + "public-port": 12455, + "public-ip": "10.0.5.19", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.19", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.19" + }, + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 200, + "local-color": "default", + "uptime": "1:23:51:47", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.20", + "state": "up", + "private-port": 12356, + "public-port": 12356, + "public-ip": "10.0.12.20", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.12.20", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.20" + }, + { + "peer-region-id-set": "N/A", + "domain-id": 1, + "site-id": 200, + "local-color": "default", + "uptime": "1:23:51:46", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.20", + "state": "up", + "private-port": 12456, + "public-port": 12456, + "public-ip": "10.0.12.20", + "uptime-date": 1649589180000, + "peer-type": "vsmart", + "vdevice-host-name": "vm16", + "private-ip": "10.0.12.20", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.20" + }, + { + "domain-id": 0, + "site-id": 200, + "local-color": "default", + "uptime": "1:23:51:45", + "lastupdated": 1649761493102, + "vdevice-dataKey": "172.16.255.26-vmanage-172.16.255.22", + "state": "up", + "private-port": 12346, + "public-port": 12346, + "public-ip": "10.0.12.22", + "uptime-date": 1649589180000, + "peer-type": "vmanage", + "vdevice-host-name": "vm16", + "private-ip": "10.0.12.22", + "vdevice-name": "172.16.255.26", + "system-ip": "172.16.255.22" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/connectionshistory": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get connection history list from device", + "operationId": "createConnectionHistoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection history list": { + "description": "Connection history list", + "value": { + "data": [ + { + "remote-color": "default", + "index": 0, + "site-id": 500, + "public-port": 12386, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "default", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-0-2022-04-10T12:23:23+0000", + "state": "up", + "domain-id": 1, + "private-port": 12386, + "public-ip": "10.1.15.15", + "downtime": "2022-04-10T12:23:23+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.1.15.15", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "default", + "index": 1, + "site-id": 100, + "public-port": 12386, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "default", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-1-2022-04-10T11:48:32+0000", + "state": "up", + "domain-id": 1, + "private-port": 12386, + "public-ip": "10.0.5.11", + "downtime": "2022-04-10T11:48:32+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.11", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "default", + "index": 2, + "site-id": 0, + "public-port": 12387, + "peer-type": "unknown", + "local_enum": "DHSTMO", + "rep-count": 0, + "local-color": "default", + "remote_enum": "NOERR", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-2-2022-04-10T11:48:21+0000", + "state": "connect", + "domain-id": 0, + "private-port": 0, + "public-ip": "10.0.5.11", + "downtime": "2022-04-10T11:48:21+0000", + "vdevice-host-name": "vm16", + "private-ip": "::", + "remote_enum-desc": "NoError.", + "local_enum-desc": "DTLSHandShakeTimeout.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "lte", + "index": 3, + "site-id": 600, + "public-port": 12366, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "lte", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-3-2022-04-10T11:13:44+0000", + "state": "up", + "domain-id": 1, + "private-port": 12366, + "public-ip": "10.1.16.16", + "downtime": "2022-04-10T11:13:44+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.1.16.16", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + }, + { + "remote-color": "lte", + "index": 4, + "site-id": 100, + "public-port": 12377, + "peer-type": "vedge", + "local_enum": "RXTRDWN", + "rep-count": 0, + "local-color": "lte", + "remote_enum": "DISCVBD", + "lastupdated": 1649764706061, + "vdevice-dataKey": "172.16.255.26-4-2022-04-10T11:13:41+0000", + "state": "up", + "domain-id": 1, + "private-port": 12377, + "public-ip": "10.0.5.21", + "downtime": "2022-04-10T11:13:41+0000", + "vdevice-host-name": "vm16", + "private-ip": "10.0.5.21", + "remote_enum-desc": "DisconnectvBondafterregisterreply.", + "local_enum-desc": "ReceivedTeardown.", + "vdevice-name": "172.16.255.26" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/localproperties": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get local properties list from device", + "operationId": "createLocalPropertiesListList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Local properties list": { + "description": "Local properties list", + "value": { + "data": [ + { + "certificate-not-valid-before": "Apr1010:34:032022GMT", + "certificate-status": "Installed", + "protocol": "dtls", + "uuid": "0a3c20df-82d6-43d4-b27f-a67864d35950", + "root-ca-chain-status": "Installed", + "certificate-not-valid-after": "Apr1010:34:032023GMT", + "sp-organization-name": "vIPtelaIncRegression", + "lastupdated": 1649766458903, + "certificate-validity": "Valid", + "vdevice-dataKey": "172.16.255.26", + "vedge-list-version": "0", + "number-active-wan-interfaces": "1", + "system-ip": "172.16.255.26", + "organization-name": "vIPtelaIncRegression", + "vdevice-host-name": "vm16", + "device-type": "vbond", + "vdevice-name": "172.16.255.26", + "vsmart-list-version": "0", + "board-serial": "12346571" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/proxymapping": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get reverse proxy mapping from vbond", + "operationId": "createReverseProxyMappingList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reverse proxy mapping": { + "description": "Reverse proxy mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/orchestrator/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get statistics from device", + "operationId": "getStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics": { + "description": "Statistics", + "value": { + "data": [ + { + "tx_challenge_ack": 13, + "tx_registers": 0, + "rx_pkts": 168816, + "tx_error": 0, + "vdevice-dataKey": "172.16.255.26", + "tx_challenge": 15, + "rx_challenge_ack": 0, + "tx_dtls_handshake_done": 0, + "vdevice-host-name": "vm16", + "tx_dtls_handshake_failures": 0, + "tx_challenge_gen_error": 0, + "rx_connects": 0, + "rx_octets": 42608317, + "rx_registers": 64644, + "lastupdated": 1649768154244, + "rx_challenge_resp": 15, + "tx_register_replies": 64644, + "tx_challenge_ack_error": 0, + "rx_challenge": 0, + "tx_dtls_handshake": 0, + "rx_dtls_handshake_done": 15, + "rx_dtls_handshake_failures": 0, + "rx_error": 0, + "challenge_failures": 2, + "tx_challenge_resp_error": 0, + "vdevice-name": "172.16.255.26", + "tx_blocked": 0, + "tx_connects": 64671, + "tx_octets": 63147501, + "tx_challenge_error": 0, + "rx_register_replies": 0, + "tx_challenge_resp": 0, + "tx_pkts": 242150, + "rx_dtls_handshake": 70 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get connection summary from device", + "operationId": "createConnectionSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connection summary": { + "description": "Connection summary", + "value": { + "data": [ + { + "protocol": "dtls", + "listening_port": 12346, + "listening_ip": "0.0.0.0", + "vsmart_counts": 4, + "vmanage_counts": 2, + "lastupdated": 1649816906161, + "instance": 0, + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-0", + "listening_ipv6": "::", + "vedge_counts": 0, + "vdevice-name": "172.16.255.26" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/validvedges": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get valid device list from device", + "operationId": "createValidDevicesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Valid device list": { + "description": "Valid device list", + "value": { + "data": [ + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-1BFB0237-AFCA-4583-BF0C-BECD124565D6-12346572", + "serial-number": "12346572", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "1BFB0237-AFCA-4583-BF0C-BECD124565D6", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-33418D3F-286E-4256-A7CB-7BF3A70E1ED8-12346570", + "serial-number": "12346570", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "33418D3F-286E-4256-A7CB-7BF3A70E1ED8", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-4D0318BF-472E-4114-B72D-A5E99C5AFAD7-12346580", + "serial-number": "12346580", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "4D0318BF-472E-4114-B72D-A5E99C5AFAD7", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-ADC329CC-701C-42D6-84C6-245F09C25583-12346578", + "serial-number": "12346578", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "ADC329CC-701C-42D6-84C6-245F09C25583", + "vdevice-name": "172.16.255.26" + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E-12346575", + "serial-number": "12346575", + "validity": "valid", + "lastupdated": 1649818236214, + "chassis-number": "C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E", + "vdevice-name": "172.16.255.26" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/validvmanageid": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get valid vManage Id from device", + "operationId": "getValidVManageId", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Valid vManage Id": { + "description": "Valid vManage Id", + "value": { + "data": [ + { + "chassis-number": "a52d3492-755a-4a02-9a3d-8bdf2dc1d241", + "vdevice-dataKey": "172.16.255.26-", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649823209136, + "vdevice-host-name": "vm16" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/orchestrator/validvsmarts": { + "get": { + "tags": [ + "Real-Time Monitoring - Orchestrator" + ], + "description": "Get valid vSmart list from device", + "operationId": "createValidVSmartsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Valid vSmart list": { + "description": "Valid vSmart list", + "value": { + "data": [ + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-12346567", + "serial-number": "12346567", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649824251432 + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-12346569", + "serial-number": "12346569", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649824251432 + }, + { + "vdevice-host-name": "vm16", + "vdevice-dataKey": "172.16.255.26-12346573", + "serial-number": "12346573", + "vdevice-name": "172.16.255.26", + "lastupdated": 1649824251432 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Security-read,Security-write" + } + }, + "/device/ospf/database": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF database list from device (Real Time)", + "operationId": "createOSPFDatabaseList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF database list": { + "description": "OSPF database list", + "value": { + "data": [ + { + "area": 0, + "link-id": "172.16.255.11", + "data": "10.2.2.11", + "vdevice-name": "172.16.255.11", + "link-count": "1", + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.11", + "lsa-type": "router", + "router-link-id": "10.2.2.12", + "router-link-type": "transit", + "sequence": "2147483652", + "vdevice-dataKey": "172.16.255.11-1-0", + "checksum": "50110", + "lastupdated": 1646791144576, + "tos-metric": "10", + "age": "153" + }, + { + "area": 0, + "link-id": "172.16.255.12", + "data": "10.2.2.12", + "vdevice-name": "172.16.255.11", + "link-count": "2", + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.12", + "lsa-type": "router", + "router-link-id": "10.2.2.12", + "router-link-type": "transit", + "sequence": "2147483655", + "vdevice-dataKey": "172.16.255.11-1-0", + "checksum": "52821", + "lastupdated": 1646791144576, + "tos-metric": "10", + "age": "153" + }, + { + "area": 0, + "link-id": "172.16.255.21", + "data": "10.2.3.21", + "vdevice-name": "172.16.255.11", + "link-count": "1", + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.21", + "lsa-type": "router", + "router-link-id": "10.2.3.21", + "router-link-type": "transit", + "sequence": "2147483651", + "vdevice-dataKey": "172.16.255.11-1-0", + "checksum": "8760", + "lastupdated": 1646791144576, + "tos-metric": "10", + "age": "154" + }, + { + "area": 0, + "sequence": "2147483649", + "link-id": "10.2.2.12", + "vdevice-dataKey": "172.16.255.11-1-0", + "vdevice-name": "172.16.255.11", + "checksum": "63980", + "lastupdated": 1646791144576, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.12", + "age": "154", + "lsa-type": "network" + }, + { + "area": 0, + "sequence": "2147483649", + "link-id": "10.2.3.21", + "vdevice-dataKey": "172.16.255.11-1-0", + "vdevice-name": "172.16.255.11", + "checksum": "59106", + "lastupdated": 1646791144576, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.21", + "age": "155", + "lsa-type": "network" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/databaseexternal": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF external database list from device (Real Time)", + "operationId": "createOSPFDatabaseExternal", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF external database list": { + "description": "OSPF external database list", + "value": { + "data": [ + { + "link-id": "10.20.25.0", + "options-flags": "EDN", + "vdevice-name": "172.16.255.11", + "prefix": "10.20.25.0/24", + "metric-type": "type2", + "length": 36, + "flags": 11, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.11", + "forwarding-addr": "0.0.0.0", + "sequence": 2147483650, + "vdevice-dataKey": "172.16.255.11-1-10.20.25.0", + "metric": "16777214", + "checksum": 62048, + "options": 130, + "lastupdated": 1646791949860, + "tag": 0, + "age": 958 + }, + { + "link-id": "10.20.25.0", + "options-flags": "EDN", + "vdevice-name": "172.16.255.11", + "prefix": "10.20.25.0/24", + "metric-type": "type2", + "length": 36, + "flags": 6, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.21", + "forwarding-addr": "0.0.0.0", + "sequence": 2147483650, + "vdevice-dataKey": "172.16.255.11-1-10.20.25.0", + "metric": "16777214", + "checksum": 46738, + "options": 130, + "lastupdated": 1646791949860, + "tag": 0, + "age": 959 + }, + { + "link-id": "172.16.255.112", + "options-flags": "E", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.112/32", + "metric-type": "type2", + "length": 36, + "flags": 6, + "vpn-id": 1, + "vdevice-host-name": "vm1", + "adv-router": "172.16.255.12", + "forwarding-addr": "0.0.0.0", + "sequence": 2147483651, + "vdevice-dataKey": "172.16.255.11-1-172.16.255.112", + "metric": "20", + "checksum": 58083, + "options": 2, + "lastupdated": 1646791949860, + "tag": 0, + "age": 958 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/databasesummary": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF database summary list from device (Real Time)", + "operationId": "createOSPFDatabaseSummaryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF database summary list": { + "description": "OSPF database summary list", + "value": { + "data": [ + { + "vdevice-dataKey": "172.16.255.11-1-0", + "router-lsa": 3, + "total-lsa": 5, + "vdevice-name": "172.16.255.11", + "summary-lsa": 0, + "nssa-lsa": 0, + "network-lsa": 2, + "lastupdated": 1646792331519, + "area-id": 0, + "vpn-id": 1, + "asbr-summary-lsa": 0, + "vdevice-host-name": "vm1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF interface list from device (Real Time)", + "operationId": "createOSPFInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF interface list": { + "description": "OSPF interface list", + "value": { + "data": [ + { + "lastupdated": 1646026461327, + "vdevice-dataKey": "169.254.10.14-0-1--", + "vdevice-name": "169.254.10.14", + "router-id": "0", + "vdevice-host-name": "vm16", + "instance-id": "1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/neighbor": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF neighbor list from device (Real Time)", + "operationId": "createOSPFNeighbors", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF neighbor list": { + "description": "OSPF neighbor list", + "value": { + "data": [ + { + "lastupdated": 1646027273671, + "vdevice-dataKey": "169.254.10.14-0-1---", + "vdevice-name": "169.254.10.14", + "router-id": "0", + "vdevice-host-name": "vm16", + "instance-id": "1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/process": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF process list from device (Real Time)", + "operationId": "createOSPFProcess", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF process list": { + "description": "OSPF process list", + "value": { + "data": [ + { + "ls-ack-sent": "5", + "summary-lsa-checksum": "0", + "vdevice-name": "172.16.255.11", + "spf-max-holdtime": "10000", + "spf-holdtime": "1000", + "number-areas": "1", + "rfc1583-compatible": "true", + "lsa-count": "5", + "external-lsa-checksum": "166869", + "router-id": "172.16.255.11", + "hello-received": "172", + "ignore-down-bit": "false", + "area-id": "0", + "dbd-received": "2", + "network-lsa-checksum": "123086", + "summary-lsa-count": "0", + "router-lsa-count": "3", + "router-lsa-checksum": "111691", + "spf-delay": "200", + "spf-hold-multiplier": "1", + "external-lsa-count": "3", + "ls-ack-received": "5", + "asbr-lsa-count": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "spf-last-exec-time": "1663", + "backbone-area": "true", + "network-lsa-count": "2", + "ls-req-sent": "1", + "asbr-lsa-checksum": "0", + "dbd-sent": "3", + "vdevice-dataKey": "172.16.255.11-1-", + "lsa-refresh-interval": "10", + "ls-upd-received": "12", + "nssa-lsa-count": "0", + "ls-req-received": "1", + "num-full-adj-routers": "1", + "spf-exec-count": "3", + "lastupdated": 1646792665279, + "ls-upd-sent": "8", + "nssa-lsa-checksum": "0", + "hello-sent": "172", + "num-interfaces": "1" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/routes": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF route list from device (Real Time)", + "operationId": "createOSPFRoutesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF route list": { + "description": "OSPF route list", + "value": { + "data": [ + { + "cost": "10", + "dest-type": "router", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.12/32", + "flags": "2", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-router-172.16.255.12/32-0", + "route-type": "router", + "lastupdated": 1646793742274, + "area-id": "0", + "next-hop": "10.2.2.12", + "path-type": "intra-area" + }, + { + "cost": "20", + "dest-type": "router", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.21/32", + "flags": "2", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-router-172.16.255.21/32-0", + "route-type": "router", + "lastupdated": 1646793742276, + "area-id": "0", + "next-hop": "10.2.2.12", + "path-type": "intra-area" + }, + { + "cost": "10", + "dest-type": "network", + "vdevice-name": "172.16.255.11", + "prefix": "10.2.2.0/24", + "flags": "0", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-network-10.2.2.0/24-0", + "route-type": "network", + "lastupdated": 1646793742276, + "area-id": "0", + "next-hop": "0.0.0.0", + "path-type": "intra-area" + }, + { + "cost": "20", + "dest-type": "network", + "vdevice-name": "172.16.255.11", + "prefix": "10.2.3.0/24", + "flags": "0", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-network-10.2.3.0/24-0", + "route-type": "network", + "lastupdated": 1646793742276, + "area-id": "0", + "next-hop": "10.2.2.12", + "path-type": "intra-area" + }, + { + "dest-type": "network", + "vdevice-name": "172.16.255.11", + "prefix": "172.16.255.112/32", + "flags": "78", + "info-id": "0", + "vpn-id": "1", + "vdevice-host-name": "vm1", + "type2-cost": "20", + "if-name": "ge0/0", + "vdevice-dataKey": "172.16.255.11-1-external-172.16.255.112/32-0", + "route-type": "external", + "lastupdated": 1646793742276, + "tag": "0", + "next-hop": "10.2.2.12", + "path-type": "external2" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/v3interface": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF v3 interface list from device (Real Time)", + "operationId": "createOSPFv3Interface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF v3 interface list": { + "description": "OSPF v3 interface list", + "value": { + "data": [ + { + "router-id": "90.90.90.90", + "af": "ospfv3-address-family-ipv4", + "area-id": "300", + "lastupdated": 1649681917917, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300-", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "router-id": "100.100.5.101", + "af": "ospfv3-address-family-ipv6", + "area-id": "300", + "lastupdated": 1649681917917, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300-", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ospf/v3neighbor": { + "get": { + "tags": [ + "Real-Time Monitoring - OSPF" + ], + "description": "Get OSPF v3 neighbor list from device (Real Time)", + "operationId": "createOSPFv3Neighbors", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "OSPF v3 neighbor list": { + "description": "OSPF v3 neighbor list", + "value": { + "data": [ + { + "router-id": "90.90.90.90", + "af": "ospfv3-address-family-ipv4", + "area-id": "300", + "lastupdated": 1649682289885, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300--", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "router-id": "100.100.5.101", + "af": "ospfv3-address-family-ipv6", + "area-id": "300", + "lastupdated": 1649682289885, + "vpn-id": "10", + "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300--", + "process-id": "10", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM interface list from device", + "operationId": "createPIMInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM interface list": { + "description": "PIM interface list", + "value": { + "data": [ + { + "if-name": "ge0/0", + "dr-address": "100.100.3.101", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "if-addr": "100.100.3.101/24", + "neighbor-count": 0, + "hello-interval": 30, + "lastupdated": 1643258686605, + "join-prune-interval": 60, + "vpn-id": "10", + "priority": 1, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/neighbor": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM neighbor list from device", + "operationId": "createPIMNeighborList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM neighbor list": { + "description": "PIM neighbor list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/rp-mapping": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM Rp-mapping list from device", + "operationId": "createPIMRpMappingList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM Rp-mapping list": { + "description": "PIM Rp-mapping list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/pim/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PIM statistics list from device", + "operationId": "createPIMStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PIM statistics list": { + "description": "PIM statistics list", + "value": { + "data": [ + { + "hello-rx": 0, + "unknown-rx": 0, + "vdevice-name": "169.254.10.10", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "bad-rx": 0, + "join-prune-tx": 0, + "vdevice-dataKey": "169.254.10.10", + "join-prune-rx": 0, + "auto-rp-mapping-rx": 0, + "unsupported-rx": 0, + "lastupdated": 1643259067333, + "assert-rx": 0, + "auto-rp-announce-rx": 0, + "assert-tx": 0, + "hello-tx": 1090 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policer": { + "get": { + "tags": [ + "Real-Time Monitoring - Policer" + ], + "description": "Get policed interface list from device", + "operationId": "getPolicedInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policed interface": { + "description": "Policed interface", + "value": { + "data": [ + { + "oos-bytes": "0", + "oos-action": "drop", + "vdevice-dataKey": "169.254.10.10-10", + "vdevice-name": "169.254.10.10", + "rate": 81920, + "oos-pkts": "0", + "name": "TCPOPT_SYN_POLICER", + "index": 10, + "lastupdated": 1643264577448, + "burst": 10240, + "vdevice-host-name": "vm3", + "direction": "in" + }, + { + "oos-bytes": "0", + "oos-action": "drop", + "vdevice-dataKey": "169.254.10.10-11", + "vdevice-name": "169.254.10.10", + "rate": 100000000, + "oos-pkts": "0", + "name": "TCPOPT_DATA_POLICER", + "index": 11, + "lastupdated": 1643264577448, + "burst": 12500000, + "vdevice-host-name": "vm3", + "direction": "in" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistassociations": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list associations from device", + "operationId": "createPolicyAccessListAssociations", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistcounters": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list counter from device", + "operationId": "createPolicyAccessListCounters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list counter": { + "description": "Access list counter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistnames": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list names from device", + "operationId": "createPolicyAccessListNames", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list names": { + "description": "Access list names", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/accesslistpolicers": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list policers from device", + "operationId": "createPolicyAccessListPolicers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list policers": { + "description": "Access list policers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/approutepolicyfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get approute policy filter from device", + "operationId": "createPolicyAppRoutePolicyFilter", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Approute policy filter": { + "description": "Approute policy filter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/datapolicyfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get data policy filters from device", + "operationId": "createPolicDataPolicyFilter", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Data policy filter": { + "description": "Data policy filter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/filtermemoryusage": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get data policy filter memory usage from device", + "operationId": "createPolicyFilterMemoryUsage", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Data policy filter memory usage": { + "description": "Data policy filter memory usage", + "value": { + "data": [ + { + "filter-max": "512", + "vdevice-dataKey": "169.254.10.10-0", + "vdevice-name": "169.254.10.10", + "blocks-used": "0", + "blocks-max": "1048576", + "filter-used": "0", + "lastupdated": 1643266183894, + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/iptouserbindings": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show ip to user binding from Vsmart", + "operationId": "showVsmartIptoUserBinding", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistassociations": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list associations from device", + "operationId": "createPolicyAccessListAssociationsIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistcounters": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list counters from device", + "operationId": "createPolicyAccessListCountersIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list counters": { + "description": "Access list counters", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistnames": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list names from device", + "operationId": "createPolicyAccessListNamesIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list names": { + "description": "Access list names", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/ipv6/accesslistpolicers": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get access list policers from device", + "operationId": "createPolicyAccessListPolicersIpv6", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list policers": { + "description": "Access list policers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/pxgridstatus": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show Pxgrid status From Vsmart", + "operationId": "showVsmartPxGridStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/pxgridusersessions": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show Pxgrid sessions From Vsmart", + "operationId": "showVsmartPxGridUserSessions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/qosmapinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get QoS map information from device", + "operationId": "createPolicQosMapInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "QoS map information": { + "description": "QoS map information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/qosschedulerinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get QoS scheduler information from device", + "operationId": "createPolicQosSchedulerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "QoS scheduler information": { + "description": "QoS scheduler information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/rewriteassociations": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get rewrite associations information from device", + "operationId": "createPolicyRewriteAssociationsInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Rewrite associations information": { + "description": "Rewrite associations information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/userusergroupbindings": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Show User-Usergroup bindings from Vsmart", + "operationId": "showVsmartUserUsergroupBindings", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": [ + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:Employee", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser0" + }, + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:TestUserGroup-1", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser0" + }, + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:Employee", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser1" + }, + { + "omp-update-state": "omp-updated", + "vdevice-dataKey": "172.16.255.19", + "vdevice-name": "172.16.255.19", + "user-groups": "User Identity Groups:TestUserGroup-1", + "lastupdated": 1646677354863, + "vdevice-host-name": "vm9", + "username": "TestUser1" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/vsmart": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "show Sdwan Policy From Vsmart", + "operationId": "showSdwanPolicyFromVsmart", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SDWAN policy from vSmart": { + "description": "SDWAN policy from vSmart", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zbfwdropstatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone drop statistics from device", + "operationId": "getZoneDropStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone drop statistics": { + "description": "Zone drop statistics", + "value": { + "data": [ + { + "l4-tcp-l7-ooo-seg": "0", + "l4-icmp-err-l4-invalid-seq": "0", + "policy-action-drop": "0", + "l4-icmp-err-no-ip-no-icmp": "0", + "l7-type-drop": "0", + "l4-scb-close": "0", + "l4-tcp-invalid-seg-synsent-state": "0", + "l4-tcp-syn-flood-drop": "0", + "l4-icmp-internal-err-no-nat": "0", + "l4-tcp-invalid-seq": "0", + "l7-no-seg": "0", + "no-new-session": "0", + "l4-icmp-internal-err-get-stat-blk-fail": "0", + "syncookie-max-dst": "0", + "insp-internal-err-get-stat-blk-fail": "0", + "l4-invalid-hdr": "0", + "l4-icmp-internal-err-alloc-fail": "0", + "l4-tcp-invalid-seg-pkt-win-overflow": "0", + "no-forwarding-zone": "0", + "l4-icmp-too-many-err-pkts": "0", + "fdb-err": "0", + "no-session": "0", + "insp-dstaddr-lookup-fail": "0", + "l4-session-limit": "0", + "insp-class-action-drop": "0", + "l4-tcp-rst-to-resp": "0", + "l4-tcp-stray-seg": "0", + "not-initiator": "0", + "backpressure": "0", + "l4-tcp-invalid-tcp-initiator": "0", + "l4-icmp-pkt-too-short": "0", + "zone-mismatch": "0", + "l4-tcp-unexpect-tcp-payload": "0", + "l7-no-frag": "0", + "l4-tcp-invalid-seg-pyld-after-fin-send": "0", + "l4-icmp-err-policy-not-present": "0", + "l7-alg-ret-drop": "0", + "l4-tcp-internal-err-synflood-alloc-hostdb-fail": "0", + "insp-classification-fail": "0", + "l4-tcp-invalid-win-scale-option": "0", + "l4-tcp-syn-in-win": "0", + "policy-icmp-action-drop": "0", + "vdevice-name": "169.254.10.12", + "lisp-inner-ipv6-insane": "0", + "l4-tcp-rst-in-win": "0", + "l4-tcp-retrans-invalid-flags": "0", + "catch-all": "0", + "l4-icmp-err-l4-invalid-ack": "0", + "syncookie-trigger": "0", + "l7-unknown-proto": "0", + "l4-tcp-syn-with-data": "0", + "l4-tcp-invalid-seg-pkt-too-old": "0", + "l4-icmp-err-classification-fail": "0", + "l4-icmp-internal-err-dir-not-identified": "0", + "l4-internal-err-undefined-dir": "0", + "insp-policy-not-present": "0", + "syncookie-internal-err-alloc-fail": "0", + "lisp-header-restore-fail": "0", + "l4-tcp-synflood-blackout-drop": "0", + "l4-tcp-invalid-ack-flag": "0", + "insp-pam-lookup-fail": "0", + "l4-icmp-scb-close": "0", + "invalid-zone": "0", + "ha-ar-standby": "0", + "vdevice-host-name": "vm5", + "l4-tcp-invalid-seg-synrcvd-state": "0", + "l4-tcp-invalid-ack-num": "0", + "l7-promote-fail-no-policy": "0", + "l4-too-many-pkts": "0", + "l4-icmp-err-pkts-burst": "0", + "l7-promote-fail-no-zone-pair": "0", + "vdevice-dataKey": "169.254.10.12-0", + "l4-icmp-err-multiple-unreach": "0", + "policy-fragment-drop": "0", + "l4-tcp-invalid-flags": "0", + "lisp-inner-ipv4-insane": "0", + "lastupdated": 1645666649064, + "l4-max-halfsession": "0", + "insp-sess-miss-policy-not-present": "0", + "l4-icmp-pkt-no-ip-hdr": "0", + "insp-policy-misconfigure": "0", + "lisp-inner-pkt-insane": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zbfwstatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone based firewall statistics from device", + "operationId": "getZbfwStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone based firewall statistics": { + "description": "Zone based firewall statistics", + "value": { + "data": [ + { + "no-pair-diff-zone-dropped": "0", + "tcp-retrans-seg": "0", + "flow-add-fail": "0", + "vdevice-name": "169.254.10.10", + "tcp-drop-stray-seg": "0", + "tcp-drop-invalid-seg-pkt-too-old": "0", + "zbf-pkts": "0", + "state-check-fail": "0", + "unsupported-proto": "0", + "no-pair-same-zone-allowed": "0", + "zone-no-zone-inet-denied": "0", + "tcp-drop-invalid-seg-synsent-state": "0", + "max-halfopen-exceeded": "0", + "tcp-drop-invalid-flags": "0", + "tcp-drop-unexpect-tcp-pyld": "0", + "num-flow-entries": "0", + "tcp-ooo-seg": "0", + "tcp-drop-invalid-seg-synrcvd-state": "0", + "tcp-drop-no-syn-in-listen-state": "0", + "tcp-drop-invalid-ack-flag": "0", + "fragments": "0", + "zone-no-zone-dropped": "0", + "no-zone-no-zone-allowed": "0", + "tcp-drop-invalid-ack-num": "0", + "policy-change-dropped": "0", + "tcp-drop-rst-to-resp": "0", + "tcp-drop-syn-with-data": "0", + "tcp-drop-syn-in-win": "0", + "tcp-drop-invalid-dir": "0", + "tcp-drop-invalid-win-scale-option": "0", + "frag-fail": "0", + "tcp-drop-retrans-invalid-flags": "0", + "tcp-drop-internal-invalid-tcp-state": "0", + "tcp-drop-rst-in-win": "0", + "tcp-drop-invalid-seg-pkt-win-overflow": "0", + "vdevice-host-name": "vm3", + "vdevice-dataKey": "169.254.10.10-", + "lastupdated": 1643271305369, + "tcp-drop-invalid-seq": "0", + "zone-no-zone-inet-allowed": "0", + "tcp-drop-invalid-seg-pyld-after-fin-send": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zonepairsessions": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone pair sessions from device", + "operationId": "getZonePairSessions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone pair session": { + "description": "Zone pair session", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zonepairstatistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone pair statistics from device", + "operationId": "getZonePairs", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone pair statistics": { + "description": "Zone pair statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/policy/zonepolicyfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Policy" + ], + "description": "Get zone policy filter from device", + "operationId": "getZonePolicyFilters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone policy filter": { + "description": "Zone policy filter", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/device/ppp/interface": { + "get": { + "tags": [ + "Real-Time Monitoring - PIM" + ], + "description": "Get PPP interface list from device (Real Time)", + "operationId": "createPPPInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PPP interface list": { + "description": "PPP interface list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/pppoe/session": { + "get": { + "tags": [ + "Real-Time Monitoring - PPPoE" + ], + "description": "Get PPPoE session list from device", + "operationId": "createPPPoEInterfaceList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PPPoE session list": { + "description": "PPPoE session list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/pppoe/statistic": { + "get": { + "tags": [ + "Real-Time Monitoring - PPPoE" + ], + "description": "Get PPPoE statistics from device", + "operationId": "createPPPoENeighborList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceIP" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PPPoE statistics": { + "description": "PPPoE statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/queues": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get synchronized queue information, returns information about syncing, queued and stuck devices", + "operationId": "getSyncQueues", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue status": { + "description": "Queue status", + "value": { + "syncing": [], + "queued": [], + "Stuck": {} + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/reachable": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get list of reachable devices", + "operationId": "listReachableDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of reachable devices": { + "description": "List of reachable devices", + "value": { + "header": { + "generatedOn": 1635230853000, + "viewKeys": { + "uniqueKey": [ + "system-ip" + ], + "preferenceKey": "grid-vManage Control Connections Tenant" + }, + "columns": [ + { + "title": "Reachability", + "property": "reachability", + "colorProperty": "reachability", + "color": [ + { + "key": "reachable", + "value": "616161" + }, + { + "key": "unreachable", + "value": "ef5350" + } + ], + "width": 100, + "minWidth": 90, + "dataType": "string" + }, + { + "title": "Hostname", + "property": "host-name", + "display": "iconAndText", + "iconProperty": "device-type", + "hideable": false, + "icon": [ + { + "key": "vmanage", + "value": "images/vmanage_table.png" + }, + { + "key": "vedge", + "value": "images/vedge_table.png" + } + ], + "width": 150, + "dataType": "string" + } + ], + "fields": [ + { + "property": "status", + "dataType": "string", + "display": "icon" + }, + { + "property": "host-name", + "dataType": "string", + "display": "iconAndText" + } + ] + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/reboothistory": { + "get": { + "tags": [ + "Real-Time Monitoring - Reboot History" + ], + "description": "Get device reboot history", + "operationId": "createRebootHistoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reboot history": { + "description": "Device reboot history", + "value": { + "data": [ + { + "reboot_date_time-date": 1642651714000, + "lastupdated": 1642656685355, + "vdevice-dataKey": "172.16.255.11-2022-01-20T04:08:34+00:00", + "reboot_date_time": "2022-01-20T04:08:34+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,dca" + } + }, + "/device/reboothistory/details": { + "get": { + "tags": [ + "Real-Time Monitoring - Reboot History" + ], + "description": "Get detailed reboot history list", + "operationId": "getRebootHistoryDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detailed device reboot history": { + "description": "Detailed device reboot history", + "value": { + "data": [ + { + "reboot_date_time-date": 1642651714000, + "lastupdated": 1642652319187, + "reboot_date_time": "2022-01-20T04:08:34+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + }, + { + "reboot_date_time-date": 1642656388000, + "lastupdated": 1642656695661, + "reboot_date_time": "2022-01-20T05:26:28+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + }, + { + "reboot_date_time-date": 1642657398000, + "lastupdated": 1642657658587, + "reboot_date_time": "2022-01-20T05:43:18+00:00", + "reboot_reason": "reload", + "vdevice-host-name": "vm5", + "vdevice-name": "172.16.255.15" + }, + { + "reboot_date_time-date": 1642658548000, + "lastupdated": 1642659153477, + "reboot_date_time": "2022-01-20T06:02:28+00:00", + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write" + } + }, + "/device/reboothistory/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Reboot History" + ], + "description": "Get device reboot history synchronously", + "operationId": "createSyncedRebootHistoryList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reboot history": { + "description": "Device reboot history", + "value": { + "data": [ + { + "reboot_date_time-date": 1642658548000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T06:02:28+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T06:02:28+00:00", + "createTimeStamp": 1642659153490, + "lastupdated": 1642659153477, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1078 + }, + { + "reboot_date_time-date": 1642651714000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T04:08:34+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T04:08:34+00:00", + "createTimeStamp": 1642652319194, + "lastupdated": 1642652319187, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1086 + }, + { + "reboot_date_time-date": 1642656388000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T05:26:28+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T05:26:28+00:00", + "createTimeStamp": 1642656696210, + "lastupdated": 1642656695661, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1095 + }, + { + "reboot_date_time-date": 1642659874000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T06:24:34+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T06:24:34+00:00", + "createTimeStamp": 1642660158532, + "lastupdated": 1642660158402, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1103 + }, + { + "reboot_date_time-date": 1642659181000, + "vmanage-system-ip": "172.16.255.11", + "reboot_date_time": "2022-01-20T06:13:01+00:00", + "vdevice-dataKey": "172.16.255.11-2022-01-20T06:13:01+00:00", + "createTimeStamp": 1642659460686, + "lastupdated": 1642659460446, + "reboot_reason": "Initiated by user - Reboot issued via NETCONF", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11", + "@rid": 1104 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write" + } + }, + "/device/roleBasedCounters": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based Counters information from device", + "operationId": "getRoleBasedCounters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based counters information": { + "description": "TrustSec role based counters information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/roleBasedIpv6Counters": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based Ipv6 Counters information from device", + "operationId": "getRoleBasedIpv6Counters", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based counters information": { + "description": "TrustSec role based counters information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/roleBasedIpv6Permissions": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based ipv6 Permissions information from device", + "operationId": "getRoleBasedIpv6Permissions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based permissions information": { + "description": "TrustSec role based permissions information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/roleBasedPermissions": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based Permissions information from device", + "operationId": "getRoleBasedPermissions", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based permissions information": { + "description": "TrustSec role based permissions information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/roleBasedSgtMap": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec Role Based SGT Map information from device", + "operationId": "getRoleBasedSgtMap", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec role based SGT map information": { + "description": "TrustSec role based SGT map information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/sdwan-global-drop-statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - SDWAN Statistics" + ], + "description": "Get SD-WAN global drop statistics detail from device (Real Time)", + "operationId": "getSDWanGlobalDropStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SD-WAN global drop statistics": { + "description": "SD-WAN global drop statistics", + "value": { + "data": [ + { + "ipv4-acl-lookup-miss-octets": "0", + "ip-ttl-exceeded-pkts": "0", + "unconfigured-mpls-fia-pkts": "0", + "tunnel-pkt-sb-missed-octets": "0", + "lisp-decap-failed-octets": "0", + "sdwan-bfd-octets": "0", + "gre-bad-options-pkts": "0", + "sdwan-data-policy-octets": "0", + "inv-common-preamble-pkts": "0", + "firewall-nonsession-octets": "0", + "bqs-oor-pkts": "0", + "unconfigured-ipv4-fia-pkts": "0", + "perf-lic-policer-lo-octets": "0", + "reass-frag-too-big-octets": "0", + "unsupport-linktype-no-route-pkts": "0", + "lisp-failed-to-punt-dynmaic-eid-config-pkts": "0", + "ipv4-no-adj-pkts": "323", + "sdwan-octets": "0", + "ipv6-acl-octets": "0", + "ipv4-acl-pkts": "0", + "firewall-backpressure-octets": "0", + "ipsec-input-octets": "6185", + "ipv6-adj-drop-pkts": "0", + "lookup-oce-unsupport-linktype-octets": "0", + "ipv6-no-adj-pkts": "6", + "reass-bad-len-octets": "0", + "ipv4-null0-pkts": "0", + "tcp-badfrag-pkts": "0", + "ip-bad-options-pkts": "0", + "reass-bad-len-pkts": "0", + "reass-no-frags-left-pkts": "0", + "reass-timeout-pkts": "0", + "ipv4-no-route-octets": "63122", + "oce-drop-adj-octets": "0", + "sdwan-generic-pkts": "0", + "no-gpm-memory-err-octets": "0", + "lisp-decap-failed-pkts": "0", + "frfab-wred-drop-octets": "0", + "ipsec-ted-indicate-octets": "0", + "lisp-sfltr-pkts": "0", + "tunnel-sec-chk-fail-octets": "0", + "pa-walk-err-pkts": "0", + "loadbalance-null0-pkts": "0", + "hqf-tx-error-octets": "0", + "ipv4mc-extra-replicae-octets": "0", + "ipv4-martian-pkts": "0", + "tcp-octets": "0", + "ipv4-pbr-pkts": "0", + "ipsec-invalid-sa-octets": "0", + "no-mem-octets": "0", + "ipv4-adj-drop-octets": "0", + "glean-adj-unsupport-linktype-octets": "0", + "vdevice-name": "169.254.10.12", + "ipv4-martian-octets": "0", + "identity-cft-error-pkts": "0", + "reass-frag-too-big-pkts": "0", + "lisp-disabled-octets": "0", + "udp-octets": "0", + "multilink-cfg-pkts": "0", + "pa-walk-err-octets": "0", + "bad-adj-octets": "0", + "unconfigured-ipv6-fia-pkts": "51334", + "flow-queue-failure-id-octets": "0", + "multilink-cfg-octets": "0", + "gpm-tx-len-exceed-pkts": "0", + "tunnel-decap-too-many-times-pkts": "0", + "inv-hdr-err-pkts": "0", + "attn-invalid-spid-octets": "0", + "tail-drop-octets": "0", + "tunnel-bad-gre-checksum-octets": "0", + "ipv4mc-ttl-threshold-chk-failed-pkts": "0", + "mpass-err-octets": "0", + "nat-out2in-octets": "0", + "ip-format-err-octets": "0", + "firewall-backpressure-pkts": "0", + "illegal-obj-pkts": "0", + "reass-overlap-octets": "0", + "bad-len-octets": "0", + "tunnel-misconfiguration-pkts": "0", + "reass-too-many-frags-octets": "0", + "punt-global-policer-drop-octets": "0", + "reass-too-many-frags-pkts": "0", + "frr-oce-invalid-state-octets": "0", + "invalid-queue-pkts": "0", + "ipv4mc-extra-replicae-pkts": "0", + "mpls-adj-drop-octets": "0", + "bad-uidb-idx-octets": "0", + "mpass-err-pkts": "0", + "ipv6-truncatedpkts-octets": "0", + "lastupdated": 1645693979596, + "ip-format-err-pkts": "0", + "ipsec-deny-drop-pkts": "0", + "invalid-encap-octets": "0", + "lookup-oce-should-drop-octets": "0", + "lisp-hash-lkup-failed-octets": "0", + "unresolved-octets": "0", + "ipv4-no-route-pkts": "398", + "lisp-failed-to-punt-gsmr-enabled-pkts": "0", + "ipv6-null0-pkts": "0", + "sdwan-bfd-pkts": "0", + "ipv4mc-invalid-replica-record-pkts": "0", + "unconfigured-fia-octets": "0", + "ext-drop-path-octets": "0", + "qos-actions-pkts": "0", + "mpass-invalid-fs-vector-pkts": "0", + "oce-drop-adj-pkts": "0", + "max-tu-octets": "0", + "invalid-encap-pkts": "0", + "mpls-pkts": "0", + "punt-err-pkts": "0", + "hqf-tx-error-pkts": "0", + "reass-drop-octets": "0", + "tail-drop-pkts": "0", + "ip-frag-err-octets": "0", + "punt-policer-drop-pkts": "0", + "mlp-pkts": "0", + "max-tu-pkts": "0", + "lisp-hash-lkup-failed-pkts": "0", + "inv-l2-hdr-pkts": "0", + "ipv4-unclassified-octets": "0", + "lisp-failed-to-punt-lsb-mismatch-pkts": "0", + "nat64-v6tov4-octets": "480", + "lisp-failed-to-punt-gsmr-enabled-octets": "0", + "sdwan-data-policy-pkts": "0", + "bqs-oor-octets": "0", + "ipv4-routing-err-pkts": "0", + "disabled-pkts": "2590", + "cts-format-octets": "0", + "bad-len-pkts": "0", + "ipv6-routing-err-octets": "0", + "illegal-obj-octets": "0", + "ipv6-unclassified-octets": "0", + "bad-uidb-idx-pkts": 0, + "bad-uidb-sub-idx-pkts": "0", + "for-us-pkts": "0", + "icmp-pkts": "0", + "invalid-wred-pkts": "0", + "lisp-elig-oce-octets": "0", + "bfd-octets": "0", + "sdwan-tloc-ext-pkts": "0", + "ipv4-acl-lookup-miss-pkts": "0", + "reass-no-frag-info-octets": "0", + "mpls-adj-drop-pkts": "0", + "sdwan-generic-octets": "0", + "reass-drop-pkts": "0", + "inv-common-preamble-octets": "0", + "bad-ip-checksum-octets": "0", + "ipv6-acl-lookup-miss-pkts": "0", + "reass-no-frag-info-low-pkts": "0", + "frr-oce-no-backup-pkts": "0", + "ipv6-unclassified-pkts": "0", + "mpls-mismatch-linktype-pkts": "0", + "wred-pkts": "0", + "ipv6-badsource-pkts": "0", + "lisp-disabled-pkts": "0", + "choice-oce-octets": "0", + "ipv6-acl-lookup-miss-octets": "0", + "bad-adj-pkts": "0", + "min-tu-octets": "0", + "nat-out2in-pkts": "0", + "unsupport-linktype-null0-octets": "0", + "firewall-invalid-zone-pkts": "0", + "lisp-failed-to-punt-dynmaic-eid-config-octets": "0", + "attn-invalid-spid-pkts": "0", + "not-enabled-octets": "0", + "fia-error-pkts": "0", + "bad-ip-checksum-pkts": "0", + "ipsec-ike-indicate-octets": "0", + "sdwan-app-route-policy-pkts": "0", + "ipv6-toobigpacket-octets": "0", + "ipv6-formaterr-octets": "0", + "ipv4mc-no-route-pkts": "0", + "mpls-frag-req-octets": "0", + "vdevice-dataKey": "169.254.10.12-", + "lookup-oce-should-drop-pkts": "0", + "cts-not-enable-octets": "0", + "loadbalance-null0-octets": "0", + "frr-oce-invalid-state-pkts": "0", + "tcp-pkts": "0", + "ipv6-acl-pkts": "0", + "nat-in2out-pkts": "0", + "ipv6-badhop-pkts": "0", + "ipv6-badsource-octets": "0", + "inv-hdr-err-octets": "0", + "tcp-badfrag-octets": "0", + "ipv4-mtr-octets": "0", + "ipsec-ted-indicate-pkts": "0", + "ipsec-output-octets": "0", + "nat66-out2in-octets": "0", + "lisp-misconfiguration-octets": "0", + "ipsec-output-pkts": "0", + "cts-not-enable-pkts": "0", + "mlp-octets": "0", + "qos-actions-octets": "0", + "iphc-octets": "0", + "disabled-octets": "403111", + "unknown-ext-header-pkts": "0", + "mpls-mismatch-linktype-octets": "0", + "ipv6-no-adj-octets": "456", + "fia-error-octets": "0", + "gre-bad-options-octets": "0", + "reass-overlap-pkts": "0", + "vfr-tail-drop-octets": "0", + "sdwan-acl-octets": "0", + "ipv4-null0-octets": "0", + "unresolved-pkts": "0", + "invalid-queue-octets": "0", + "sdwan-implicit-acl-octets": "55011", + "ipv4-routing-err-octets": "0", + "inject-err-pkts": "0", + "punt-policer-drop-octets": "0", + "reass-no-frag-info-low-octets": "0", + "min-tu-pkts": "0", + "ipsec-input-pkts": "17", + "perf-lic-policer-hi-octets": "0", + "mac-acl-lookup-miss-octets": "0", + "ipv6-no-route-pkts": "3", + "cts-format-pkts": "0", + "ipsec-deny-drop-octets": "0", + "ip-bad-options-octets": "0", + "frag-tail-drop-octets": "0", + "frr-oce-no-backup-octets": "0", + "internal-ctl-pkts": "0", + "flow-queue-failure-id-pkts": "0", + "unconfigured-mpls-fia-octets": "0", + "ip-ttl-exceeded-octets": "0", + "unsupported-oce-pkts": "0", + "sdwan-acl-pkts": "0", + "no-gpm-memory-err-pkts": "0", + "perf-lic-policer-hi-pkts": "0", + "nat64-v6tov4-pkts": "6", + "unsupport-linktype-null0-pkts": "0", + "ipv4mc-ttl-threshold-chk-failed-octets": "0", + "glean-adj-unsupport-linktype-pkts": "0", + "firewall-l4-insp-pkts": "0", + "mpass-invalid-fs-vector-octets": "0", + "inv-l2-hdr-octets": "0", + "mpls-frag-req-pkts": "0", + "internal-ctl-octets": "0", + "identity-cft-error-octets": "0", + "sdwan-pkts": "0", + "reass-no-frag-info-pkts": "0", + "mpls-octets": "0", + "sdwan-interface-policy-octets": "0", + "frag-tail-drop-pkts": "0", + "ip-acl-err-octets": "0", + "discard-pkts": "0", + "sdwan-tunnel-lkup-pkts": "0", + "not-enabled-pkts": "0", + "choice-oce-pkts": "0", + "lookup-oce-unsupport-linktype-pkts": "0", + "sdwan-app-route-policy-octets": "0", + "lisp-misconfiguration-pkts": "0", + "bad-uidb-sub-idx-octets": "0", + "reass-timeout-octets": "0", + "tunnel-decap-too-many-times-octets": "0", + "vdevice-host-name": "vm5", + "icmp-octets": "0", + "ipv4-adj-drop-pkts": "0", + "tunnel-invalid-protocol-pkts": "0", + "wred-octets": "0", + "lisp-sfltr-octets": "0", + "ipv6-no-route-octets": "168", + "unconfigured-ipv6-fia-octets": "5564369", + "for-us-octets": "0", + "vfr-tail-drop-pkts": "0", + "frfab-wred-drop-pkts": "0", + "ipsec-invalid-sa-pkts": "0", + "ipv6-null0-octets": "0", + "ipv4-acl-octets": "0", + "firewall-nonsession-pkts": "0", + "ipsec-tail-drop-pkts": "0", + "tunnel-misconfiguration-octets": "0", + "bfd-pkts": "0", + "ipv4mc-invalid-replica-record-octets": "0", + "ip-acl-err-pkts": "0", + "ipsec-ike-indicate-pkts": "0", + "idle-packet-octets": "0", + "unconfigured-ipv4-fia-octets": "0", + "ipv6-toobigpacket-pkts": "0", + "idle-packet-pkts": "0", + "ipv4mc-rpf-failed-pkts": "0", + "ip-frag-err-pkts": "0", + "sdwan-interface-policy-pkts": "0", + "vfr-err-pkts": "0", + "unknown-encap-octets": "0", + "ipv4mc-no-route-octets": "0", + "unsupported-oce-octets": "0", + "unconfigured-fia-pkts": "0", + "sdwan-tloc-ext-octets": "0", + "qos-policing-octets": "0", + "sdwan-implicit-acl-pkts": "607", + "internal-intf-err-pkts": "0", + "firewall-l4-insp-octets": "0", + "mac-acl-octets": "0", + "no-mem-pkts": "0", + "ipv4-mtr-pkts": "0", + "internal-intf-err-octets": "0", + "invalid-wred-octets": "0", + "ipsec-tail-drop-octets": "0", + "lisp-elig-oce-pkts": "0", + "layer2-no-route-pkts": "0", + "ipv6-routing-err-pkts": "0", + "ext-drop-path-pkts": "0", + "unsupport-linktype-no-route-octets": "0", + "mac-acl-lookup-miss-pkts": "0", + "ipv4-fpm-pkts": "0", + "nat-in2out-octets": "0", + "ipv6-adj-drop-octets": "0", + "ipv4-no-adj-octets": "20728", + "ipv4-fpm-octets": "0", + "punt-global-policer-drop-pkts": "0", + "ipv4-pbr-octets": "0", + "nat66-in2out-octets": "0", + "nat66-out2in-pkts": "0", + "nat66-in2out-pkts": "0", + "ipv6-formaterr-pkts": "0", + "vfr-err-octets": "0", + "mac-acl-pkts": "0", + "ipv6-truncatedpkts-pkts": "0", + "tunnel-pkt-sb-missed-pkts": "0", + "qos-policing-pkts": "0", + "gpm-tx-len-exceed-octets": "0", + "layer2-no-route-octets": "0", + "perf-lic-policer-lo-pkts": "0", + "null-jib-hdr-tbl-pkts": "0", + "ipv6-badhop-octets": "0", + "udp-pkts": "0", + "unknown-encap-pkts": "0", + "ipv4-unclassified-pkts": "0", + "tunnel-bad-gre-checksum-pkts": "0", + "tunnel-invalid-protocol-octets": "0", + "reass-no-frags-left-octets": "0", + "tunnel-sec-chk-fail-pkts": "0", + "ipv4mc-rpf-failed-octets": "0", + "lisp-failed-to-punt-lsb-mismatch-octets": "0", + "inject-err-octets": "0", + "iphc-pkts": "0", + "discard-octets": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/sdwan-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - SDWAN Statistics" + ], + "description": "Get SD-WAN statistics detail from device (Real Time)", + "operationId": "getSDWanStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SD-WAN statistics": { + "description": "SD-WAN statistics", + "value": { + "data": [ + { + "ipv4-acl-out-drop-action-drop": "0", + "ipv4-acl-in-drop-action-drop": "0", + "ipv6-acl-in-drop-action-drop": "0", + "ipv4-acl-in-prior-implicit-acl-disallow-drop": "607", + "vdevice-name": "169.254.10.12", + "app-route-sla-strict-drop": "0", + "data-policy-in-drop-action-drop": "0", + "ipv6-acl-in-prior-implicit-acl-disallow-drop": "0", + "data-policy-out-drop-action-drop": "0", + "vdevice-host-name": "vm5", + "ipv4-acl-in-implicit-acl-allow-service-accept": "9484", + "ipv4-acl-out-police-exceed-drop": "0", + "ipv6-acl-out-police-exceed-drop": "0", + "ipv4-acl-in-police-exceed-drop": "0", + "ipv6-acl-in-police-exceed-drop": "0", + "vdevice-dataKey": "169.254.10.12-", + "ipv6-acl-out-drop-action-drop": "0", + "ipv6-acl-in-implicit-acl-allow-service-accept": "0", + "lastupdated": 1645691843259, + "data-policy-in-set-remote-tloc-fail-drop": "0", + "app-route-matched-none-drop": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/security/information": { + "get": { + "tags": [ + "Real-Time Monitoring - Security" + ], + "description": "Get security information from devices", + "operationId": "createSessionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Security information": { + "description": "Security information", + "value": { + "data": [ + { + "authentication-type": "deprecated", + "replay-window": "512", + "rekey": "86400", + "lastupdated": 1642754840126, + "vdevice-dataKey": "169.254.10.12", + "vdevice-host-name": "vm5", + "fips-mode": "Disabled", + "vdevice-name": "169.254.10.12" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/sfp/detail": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP detail", + "operationId": "getDetail", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ge0/0", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/0", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/1", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/2", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/3", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/3", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/4", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/5", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/5", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/6", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/7", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/7", + "lastupdated": 1643091761770, + "present": "No", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sfp/diagnostic": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP diagnostic", + "operationId": "getDiagnostic", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10-ge0/0", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/0", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/1", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/1", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/2", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/2", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/3", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/3", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/4", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/4", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/5", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/5", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/6", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/6", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + }, + { + "vdevice-dataKey": "169.254.10.10-ge0/7", + "vdevice-name": "169.254.10.10", + "ifname": "ge0/7", + "lastupdated": 1643093876343, + "present": "No", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sfp/diagnosticMeasurementAlarm": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP diagnostic measurement alarm", + "operationId": "getDiagnosticMeasurementAlarm", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sfp/diagnosticMeasurementValue": { + "get": { + "tags": [ + "Real-Time Monitoring - SFP" + ], + "description": "Get SFP diagnostic measurement value", + "operationId": "getDiagnosticMeasurementValue", + "parameters": [ + { + "name": "ifname", + "in": "query", + "description": "IF Name", + "schema": { + "type": "string", + "enum": [ + "ge0/0", + "ge0/1", + "ge0/2", + "ge0/3", + "ge0/4", + "ge0/5", + "ge0/6", + "ge0/7", + "system", + "eth0" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Serial interface": { + "description": "Serial interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/sig/getSigTunnelList": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "get Sig TunnelList", + "operationId": "getSigTunnelList", + "parameters": [ + { + "name": "pageSize", + "in": "query", + "description": "Page Size", + "schema": { + "type": "string" + } + }, + { + "name": "offset", + "in": "query", + "description": "Page offset", + "schema": { + "type": "string" + } + }, + { + "name": "lastNHours", + "in": "query", + "description": "last n hours", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/getSigTunnelTotal": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "get Sig Tunnel Total coount", + "operationId": "getSigTunnelTotal", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": { + "count": "0" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/tunnelDashboard": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "Get SIG Zscaler tunnels from device", + "operationId": "tunnelDashboard", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/umbrella/tunnels": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "Get SIG Umbrella tunnels from device", + "operationId": "getSigUmbrellaTunnels", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Umbrella tunnels": { + "description": "Sig Umbrella tunnels", + "value": [ + { + "lastupdated": 1649242617635, + "tunnel-if-name": "Tunnel100512", + "tunnel-id": "94075", + "tunnel-name": "128.107.85.118", + "tunnel-state": "active", + "fsm-state": "fsm-state", + "http-resp-code": "200", + "vdevice-name": "172.16.255.15", + "vdevice-host-name": "vm5", + "last-http-req": "activate-req", + "vdevice-dataKey": "172.16.255.15" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/sig/zscaler/tunnels": { + "get": { + "tags": [ + "Real-Time Monitoring - SIG" + ], + "description": "Get SIG Zscaler tunnels from device", + "operationId": "getSigZscalerTunnels", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sig Zscaler tunnels": { + "description": "Sig Zscaler tunnels", + "value": [ + { + "tunnel-if-name": "Tunnel100512", + "tunnel-fsm-state": "gre-add-tunnel", + "vdevice-name": "172.16.255.15", + "fqdn": "n/a", + "vdevice-host-name": "vm5", + "tunnel-id": "94075", + "last-http-req": "activate-req", + "vdevice-dataKey": "172.16.255.15", + "http-resp-code": "200", + "tunnel-name": "128.107.85.118", + "location-id": "43551040", + "lastupdated": 1649242617635, + "location-fsm-state": "location-init-state" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" + } + }, + "/device/smu": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device", + "operationId": "createSmuList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/smu/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device synchronously", + "operationId": "createSyncedSmuList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/software": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device", + "operationId": "getAAAUcreateSoftwareListsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": { + "data": [ + { + "default": "true", + "vdevice-dataKey": "169.254.10.10-20.6.2-432", + "software": true, + "vdevice-name": "169.254.10.10", + "active": "true", + "lastupdated": 1643356263821, + "version": "20.6.2-432", + "vdevice-host-name": "vm3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/software/synced": { + "get": { + "tags": [ + "Real-Time Monitoring - Software" + ], + "description": "Get software list from device synchronously", + "operationId": "createSyncedSoftwareList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Software list": { + "description": "Software list", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "software": true, + "createTimeStamp": 1647315989838, + "active": "true", + "version": "20.9.999-1787", + "vdevice-host-name": "vm1", + "default": "true", + "vdevice-dataKey": "172.16.255.11-20.9.999-1787", + "@rid": 1084, + "vmanage-system-ip": "172.16.255.11", + "lastupdated": 1647315989833 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/sslproxy/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Sslproxy" + ], + "description": "Get ssl proxy statistics from device", + "operationId": "getSslProxyStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ssl proxy statistics": { + "description": "Ssl proxy statistics", + "value": { + "data": [ + { + "exception": "0", + "app-ocsp-req-int-error": "0", + "decrypt-fail-mode": "0", + "ps-pkt-rec-from-client": "0", + "tot-client-cert-val-req": "0", + "c2s-fin-rec-from-sc": "0", + "tot-req-tls1-1-flows": "0", + "ocsp-stap-unknown-resp": "0", + "tot-failed-renego": "0", + "s2c-fin-rec": "0", + "pc-pkt-rec-from-server": "0", + "s2c-cn-rec": "0", + "c2s-fin-rec": "0", + "tot-client-cert-untrusted": "0", + "c2s-cn-rec-from-sc": "0", + "s2c-cn-rec-from-sc": "0", + "tot-ssl-renego": "0", + "s2c-fin-rec-from-sc": "0", + "drop-mempool-get-fail": "0", + "drop-load-key-packet-fail": "0", + "nodecrypt-unsup-cipher": "0", + "max-conc-non-proxied-conn": "0", + "pc-clr-pkt-rec-from-sc": "0", + "c2s-rst-generated": "0", + "pc-pkt-sent-to-server": "0", + "che-bypass": "0", + "s2c-rst-rec": "0", + "c2s-rst-rec": "0", + "che-pushdown": "0", + "client-ocsp-res": "0", + "ocsp-stap-reqs": "0", + "tot-server-cert-untrusted": "0", + "alert-genrtd-c2s": "0", + "vdevice-name": "169.254.10.12", + "alert-genrtd-s2c": "0", + "pc-rst-rec-from-sc": "0", + "c2s-cn-sent-to-sc": "0", + "lwssl-send-msg-toism-fail": "0", + "c2s-rst-rec-from-sc": "0", + "c2s-fin-sent": "0", + "ps-clr-pkt-to-client": "0", + "s2c-rst-rec-from-sc": "0", + "client-ocsp-reqs": "0", + "tot-ssl-resump-ses-tkt": "0", + "s2c-rst-sent": "0", + "drop-null-ch-buf": "0", + "non-proxied-conn": "0", + "hs-unsupported": "0", + "app-ocsp-good": "0", + "s2c-fin-rec-during-hs": "0", + "drop-inv-evt-in-fsm-state": "0", + "drop-unable-to-get-pr-cert": "0", + "lastupdated": 1645776582193, + "ism-sem-post-failed": "0", + "s2c-fin-rec-after-hs": "0", + "app-ocsp-res": "0", + "c2s-rst-sent-to-sc": "0", + "s2c-rst-sent-to-sc": "0", + "app-ocsp-unknown": "0", + "c2s-cn-rec": "0", + "ism-flow-create-fail": "0", + "c2s-cn-sent": "0", + "s2c-cn-sent": "0", + "ps-clr-pkt-rec-from-sc": "0", + "tot-client-cert-val-succes": "0", + "pc-pkt-rec-from-sc": "0", + "rm-session-alloc-success": "0", + "unsup-ssl-version": "0", + "ps-pkt-sent-to-sc": "0", + "alert-recvd-c2s": "0", + "alert-recvd-s2c": "0", + "endpoint-alert": "0", + "mem-alloc-fail": "0", + "ocsp-stap-valid-resp": "0", + "client-ocsp-revoked": "0", + "min-tls-version": "0", + "ssl-parse-failure": "0", + "s2c-fin-rec-non-ssl": "0", + "ism-flow-create": "0", + "rm-session-alloc-failures": "0", + "ps-lwssl-flow-delete": "0", + "drop-ssl-parse-abort": "0", + "drop-unsup-prot-vers": "0", + "tot-select-tls1-1-flows": "0", + "client-ocsp-failures": "0", + "pc-clr-pkt-rec-from-server": "0", + "pc-clr-pkt-sent-to-sc": "0", + "c2s-pkt-drop-deny-verdict": "0", + "decrypt-untrusted-cert": "0", + "peer-pd": "0", + "tot-server-cert-expired": "0", + "vdevice-dataKey": "169.254.10.12", + "pc-fin-rec-from-sc": "0", + "drop-untrusted-cert": "0", + "ocsp-stap-resp": "0", + "tcp-close-before-hs": "0", + "nodecrypt-unsup-prot-vers": "0", + "c2s-fin-rec-non-ssl": "0", + "tot-select-tls1-0-flows": "0", + "s2c-pkt-drop-deny-verdict": "0", + "c2s-fin-sent-to-sc": "0", + "s2c-fin-sent-to-sc": "0", + "client-ocsp-req-int-error": "0", + "client-ocsp-unknown": "0", + "app-ocsp-timeout": "0", + "tot-full-ssl-hs": "0", + "rm-session-free-success": "0", + "tot-req-sslv2-flows": "0", + "ps-cn-sent": "0", + "tot-ssl-hs-completed": "0", + "ps-clr-pkt-sent-to-sc": "0", + "ism-flow-delete": "0", + "tot-client-cert-expired": "0", + "drop-unknown-status": "0", + "clear-conn": "0", + "active-non-proxied-conn": "0", + "pc-lwssl-flow-create": "0", + "che-process": "0", + "client-ocsp-good": "0", + "tot-select-tls1-2-flows": "0", + "tot-ssl-hs-started": "0", + "drop-mem-access-issue": "0", + "app-ocsp-failures": "0", + "unknown-reasons": "0", + "tot-ssl-resump-ses-id": "0", + "app-ocsp-reqs": "0", + "tot-conn": "0", + "drop-null-ssl-rec": "0", + "drop-ocsp-cert-verify-fail": "0", + "drop-de-handle-data-fail": "0", + "ism-fifo-enqueue-failed": "0", + "unsup-cipher": "0", + "drop-fail-mode": "0", + "drop-invalid-fsm-evt": "0", + "drop-invalid-fs-type": "0", + "pc-fs-mem-alloc-fail": "0", + "error-state": "0", + "tot-server-cert-val-req": "0", + "vdevice-host-name": "vm5", + "s2c-cn-sent-to-sc": "0", + "drop-invalid-ssl-rec": "0", + "ps-clr-pkt-rec-from-client": "0", + "pc-lwssl-flow-delete": "0", + "tot-server-cert-val-succes": "0", + "c2s-fin-rec-during-hs": "0", + "drop-ism-flow-create-fail": "0", + "pc-cn-sent": "0", + "ps-lwssl-flow-create": "0", + "c2s-fin-rec-after-hs": "0", + "drop-expired-cert": "0", + "drop-key-pkt-snd-fail": "0", + "proxied-conn": "0", + "drop-other-side-key-pend": "0", + "active-proxied-conn": "0", + "max-conc-proxied-conn": "0", + "mem-access-issue": "0", + "unexpected-packet": "0", + "tot-ssl-resump": "0", + "ssl-error": "0", + "decrypt-exp-cert": "0", + "ps-pkt-sent-to-client": "0", + "rm-session-free-failures": "0", + "pc-clr-pkt-to-server": "0", + "drop-send-ism-hs-msg-fail": "0", + "ocsp-stap-revoked-resp": "0", + "client-ocsp-timeout": "0", + "ps-fin-rec-from-sc": "0", + "tot-req-sslv3-flows": "0", + "drop-invalid-msg-type": "0", + "che-strip": "0", + "active-clear-conn": "0", + "non-ssl-traffic": "0", + "drop-hs-unsupported": "0", + "max-conc-clear-conn": "0", + "ps-fs-mem-alloc-fail": "0", + "tot-req-tls1-0-flows": "0", + "pc-pkt-sent-to-sc": "0", + "s2c-rst-generated": "0", + "drop-unsup-cipher": "0", + "ocsp-stap-resp-val-fail": "0", + "tot-req-tls1-3-flows": "0", + "decrypt-unknown-status": "0", + "app-ocsp-revoked": "0", + "s2c-fin-sent": "0", + "tot-ssl-fb-full-hs": "0", + "drop-exp-cert": "0", + "drop-tcp-close-before-hs": "0", + "ps-pkt-rec-from-sc": "0", + "ism-msg-mem-alloc-failed": "0", + "tot-req-tls1-2-flows": "0", + "drop-endpoint-alert": "0", + "drop-mem-alloc-fail": "0", + "tot-closed-conn": "0", + "c2s-rst-sent": "0", + "drop-nop-read-fn": "0", + "ps-rst-rec-from-sc": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/sslproxy/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Sslproxy" + ], + "description": "Get ssl proxy status from device", + "operationId": "getSslProxyStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ssl proxy status": { + "description": "Ssl proxy status", + "value": { + "data": [ + { + "failure-mode": "failure-mode-action-close", + "minimum-tls-version": "tls-ver-1", + "vdevice-name": "169.254.10.12", + "cert-lifetime-in-days": "730", + "unsup-cipher-suite": "unsup-mode-action-drop", + "expired-cert": "cert-valid-action-decrypt", + "untrusted-cert": "cert-valid-action-decrypt", + "ca-tp-label": "PROXY-SIGNING-CA", + "unknown-status": "cert-valid-action-drop", + "rsa-key-mod": "2048", + "clear-mode": "false", + "vdevice-host-name": "vm5", + "ec-key-type": "ec-key-p256", + "cert-revocation": "cert-rev-none", + "vdevice-dataKey": "169.254.10.12", + "ca-cert-bundle": "/bootflash/vmanage-admin/sslProxyDefaultCAbundle.pem", + "lastupdated": 1645776060286, + "unsup-protocol-version": "unsup-mode-action-drop" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/staticRouteTracker": { + "get": { + "tags": [ + "Real-Time Monitoring - Static Route Tracker Service" + ], + "description": "Get single static route tracker info from device", + "operationId": "getStaticRouteTrackerInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Static route tracker info": { + "description": "Static route tracker info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/stats": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get stats queue information", + "operationId": "getStatsQueues", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue status": { + "description": "Queue status", + "value": { + "ProcessQueue-0": { + "syncing": [], + "queued": [], + "stuck": {} + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/status": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get devices status for vSmart,vBond,vEdge, and cEdge", + "operationId": "getAllDeviceStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device status list": { + "description": "Device status list", + "value": { + "header": { + "generatedOn": 1635236849570 + }, + "data": [ + { + "type": "vSmart", + "name": "vSmart", + "image": "images/vsmart.png", + "count": 3, + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart", + "statusList": [ + { + "status": "error", + "name": "Error", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=error", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "warning", + "name": "Warning", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=warning", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + }, + { + "status": "normal", + "name": "Normal", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=normal", + "color": "b0e276", + "icon": "images/device/device-normal.png", + "count": 3 + }, + { + "status": "new", + "name": "Discovered device", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=new", + "color": "7c8afa", + "icon": "images/device/device-new.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/sxpConnections": { + "get": { + "tags": [ + "Real-Time Monitoring - Trustsec" + ], + "description": "get Cisco TrustSec SXP Connections information from device", + "operationId": "getSxpConnections", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TrustSec SXP Connections information": { + "description": "TrustSec SXP Connections information", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/sync_status": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get list of currently syncing devices", + "operationId": "listCurrentlySyncingDevices", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of currently syncing devices": { + "description": "List of currently syncing devices", + "value": { + "header": { + "generatedOn": 1635237704919 + }, + "data": [ + { + "name": "vedge-C8500-12X4QC", + "templateClass": "cedge", + "displayName": "C8500-12X4QC", + "deviceType": "vedge", + "isCliSupported": true, + "templateSupported": true, + "deviceClass": "cisco-router", + "cpuCountAttribute": { + "enable": true, + "attributeField": "total_cpu_count" + }, + "interfaces": { + "wan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "lan": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "mgmt": [ + "GigabitEthernet", + "TenGigabitEthernet", + "Loopback" + ], + "day0": [ + "GigabitEthernet0/0/0" + ] + }, + "onboardCert": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/syncall/memorydb": { + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Synchronize memory database for all devices", + "operationId": "syncAllDevicesMemDB", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/system/clock": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system clock", + "operationId": "getDeviceSystemClock", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system clock": { + "description": "Device system clock", + "value": { + "data": [ + { + "current_date/date-time-string": "Tue Mar 15 16:46:40 UTC 2022" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/system/info": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device information list", + "operationId": "createDeviceInfoList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "array", + "example": "169.254.10.10", + "items": { + "type": "string", + "example": "169.254.10.10" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device info": { + "description": "Device info", + "value": { + "data": [ + { + "device-model": "vedge-cloud", + "statusOrder": 4, + "total_cpu_count": "2", + "max-controllers": "0", + "groupId": [ + "none" + ], + "certificate-not-valid-before": "Jan 29 00:19:35 2022 GMT", + "fp_cpu_count": "1", + "deviceId": "169.254.10.10", + "uuid": "bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e", + "syncScheduled": 1644759037120, + "chassis-serial-number": "None", + "cpuLoad": 1.46, + "state_description": "All daemons up", + "vsmart-list-version": "9223372036854775807", + "vbond": "10.103.135.135", + "ompPeersUp": 2, + "syncQueued": 1644759037119, + "isDeviceGeoData": false, + "device-type": "vedge", + "state": "green", + "firmwareVersion": "---", + "organization-name": "vIPtela Inc Regression-Apple Inc", + "longitude": "-122.777023", + "syncCompleted": 1644759039647, + "domain-id": "1", + "downloadedServices": [], + "availableServices": [], + "expectedControlConnections": 2, + "memUsageDisplay": "24.1", + "model_sku": "None", + "sp-organization-name": "vIPtela Inc Regression", + "version": "20.6.2-440", + "firmwareAvailablePackages": "[]", + "layoutLevel": 4, + "bootloader_version": "Not applicable", + "fips_mode": "enabled", + "name": "169.254.10.10", + "controlConnectionsUp": 3, + "controlConnectionsToVsmarts": "2", + "number-vbond-peers": "1", + "defaultVersion": "20.6.2-440", + "status": "normal", + "ompPeers": "2", + "memState": "normal", + "chassis-number": "bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e", + "board_type": "Sim", + "device-os": "next", + "local-system-ip": "172.16.254.2", + "timezone": "UTC", + "latitude": "37.666684", + "system-ip": "169.254.10.10", + "site-id": "3", + "certificate-not-valid-after": "Jan 29 00:19:35 2023 GMT", + "downloadedImages": [], + "platform": "x86_64", + "hardwareState": "normal", + "board-serial": "12345708", + "@rid": 2493, + "personality": "vedge", + "memUsage": 24.1, + "lastDataSyncTime": 1644801887955, + "certificate-status": "Installed", + "reachability": "reachable", + "controlConnections": "3", + "linux_cpu_count": "1", + "controlConnectionsDown": 0, + "availableVersions": [], + "number-vsmart-peers": 2, + "connectedVManages": [ + "169.254.10.3" + ], + "testbed_mode": true, + "syncState": "Completed", + "firmwareAvailableVersions": [], + "host-name": "vm3", + "bfdSessionsDown": 0, + "tcpd_cpu_count": "0", + "uptime": "15 days 13 hrs 52 min 15 sec", + "token": "Invalid", + "cpuLoadDisplay": "1.46", + "certificate-validity": "Valid", + "cpuState": "normal", + "number-vsmart-control-connections": 2, + "vmanage-system-ip": "169.254.10.10", + "ompPeersDown": 0, + "bfdSessions": "5", + "tenantId": "c2c6093d-a33c-400a-90e8-1f549fe7a12c", + "vmanageConnectionState": "connected", + "build_number": "440\n", + "lastupdated": 1644759039485, + "device-category": "vedge", + "device-groups": [ + "No groups" + ], + "hasGeoData": true, + "uptime-date": 1643413080000, + "isMultiStepUpgradeSupported": false, + "bfdSessionsUp": 5 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/system/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system stats list (Real Time)", + "operationId": "createDeviceSystemStatsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": { + "data": [ + { + "tx_gre_pkts": 132344, + "tx_arp_replies": 1700, + "rx_icmp_port_unreach": 303, + "rx_window_drops_tc6": 0, + "rx_window_drops_tc7": 0, + "tx_arp_reqs": 43535, + "rx_window_drops_tc4": 0, + "rx_window_drops_tc5": 0, + "pko_wred_drops": 0, + "rx_window_drops_tc2": 0, + "rx_window_drops_tc3": 0, + "rx_window_drops_tc0": 0, + "rx_window_drops_tc1": 0, + "bfd_rx_non_ip": 0, + "ip_fwd_mcast_invalid_iif": 0, + "route_to_host": 0, + "tx_pkts": 55508251, + "arp_add_fail": 51, + "tx_ipsec_policer_drops": 0, + "tx_fragment_drops": 0, + "ip_fwd_from_cpu_non_local": 0, + "ip_fwd_null_mcast_group": 0, + "buf_alloc_fails": 0, + "fragment_df_drops": 0, + "rx_drops": 0, + "tx_fragment_fail": 0, + "bfd_lkup_fail": 0, + "rx_icmp_network_unreach": 9, + "vdevice-name": "169.254.10.10", + "tx_icmp_fragment_required": 0, + "cflowd_pkts": 0, + "tx_fragment_alloc_fail": 0, + "rx_replay_integrity_drops_tc3": 0, + "rx_replay_integrity_drops_tc4": 0, + "rx_replay_integrity_drops_tc5": 0, + "rx_sa_ipsec_drops": 0, + "rx_replay_integrity_drops_tc6": 0, + "openssl_aes_encrypt": 0, + "rx_replay_integrity_drops_tc7": 0, + "to_cpu_policer_drops": 3173, + "rx_icmp_redirect": 0, + "tx_no_tunn_pre_ipsec_drops": 0, + "tx_icmp_src_quench": 0, + "rx_icmp_ttl_expired": 0, + "rx_replay_integrity_drops_tc0": 1, + "rx_replay_integrity_drops_tc1": 0, + "rx_arp_reqs": 1333, + "rx_replay_integrity_drops_tc2": 0, + "tx_icmp_ttl_expired": 0, + "ip_fwd_mirror_pkts": 0, + "rx_non_ip_drops": 1469202, + "rx_icmp_bad_ip_hdr": 0, + "tx_ip6_ipsec_drops": 0, + "nat_xlate_outbound_drops": 0, + "rx_err_pad_ipsec_drops": 0, + "rx_pre_ipsec_pkts": 0, + "lastupdated": 1644814365917, + "tx_icmp_policer_drops": 0, + "mirror_drops": 0, + "rx_ipsec_bad_inner": 0, + "rx_ip_errs": 0, + "ip_fwd_null_nhop": 132344, + "tx_bcast": 2353, + "bfd_rx_parse_err": 0, + "rx_bcast": 185, + "rx_icmp_echo_requests": 0, + "tx_if_not_preferred": 1197705, + "tx_icmp_dst_unreach_other": 0, + "rx_invalid_port": 0, + "split_horizon_drops": 0, + "rx_icmp_other_types": 5458, + "rx_arp_replies": 43098, + "tx_no_out_sa_pre_ipsec_drops": 0, + "invalid_back_ptr": 0, + "rx_pkts": 31444972, + "rx_invalid_qtags": 244, + "ip_fwd_to_cpu_nat_drops": 0, + "tx_gre_drops": 0, + "rx_icmp_src_quench": 0, + "rx_gre_policer_drops": 0, + "cbf_discards": 0, + "tx_gre_policer_drops": 0, + "rx_arp_non_local_drops": 161199, + "ip_fwd_unknown_nh_type": 0, + "tx_arp_req_fail": 0, + "tx_icmp_echo_requests": 486552, + "ip_fwd_to_egress": 22866794, + "tx_ipsec_encap": 16205725, + "rx_tunneled_pkts": 0, + "bfd_tx_record_changed": 374, + "rx_mcast_mirror_fwd_drops": 0, + "rx_unexpected_replay_drops_tc1": 0, + "rx_unexpected_replay_drops_tc2": 0, + "rx_unexpected_replay_drops_tc3": 0, + "rx_invalid_ipsec_pkt_size": 0, + "rx_unexpected_replay_drops_tc4": 0, + "ip_disabled_tx": 0, + "rx_unexpected_replay_drops_tc0": 0, + "rx_ipsec_policer_drops": 0, + "rx_unexpected_replay_drops_tc5": 0, + "rx_unexpected_replay_drops_tc6": 0, + "rx_unexpected_replay_drops_tc7": 0, + "rx_replay_drops_tc7": 0, + "rx_replay_drops_tc5": 0, + "ip_fwd_to_cpu_nat_xlates": 0, + "rx_replay_drops_tc6": 0, + "vdevice-dataKey": "169.254.10.10", + "rx_replay_drops_tc3": 0, + "rx_replay_drops_tc4": 0, + "rx_replay_drops_tc1": 0, + "rx_ipsec_decap": 16201636, + "rx_replay_drops_tc2": 0, + "rx_spi_ipsec_drops": 0, + "rx_replay_drops_tc0": 0, + "rx_host_mirror_drops": 0, + "rx_gre_drops": 0, + "ip_fwd_nat_on_tunnel": 0, + "rx_cp_non_local": 0, + "ip_fwd_to_cpu": 6893414, + "bfd_rx_record_invalid": 0, + "no_nat_nexthop": 0, + "tx_fragment_needed": 0, + "ip_fwd_mcast_life_exceeded_drops": 0, + "rx_pre_ipsec_decap": 0, + "ip_fwd": 46077192, + "rx_unexpected_replay_drops": 0, + "bfd_rec_down": 0, + "tunnel_pmtu_lowered": 0, + "filter_drops": 0, + "rx_icmp_protocol_unreach": 0, + "tx_queue_exceeded": 0, + "nat_xlate_inbound_fail": 0, + "tx_icmp_bad_ip_hdr": 0, + "nat_xlate_inbound": 0, + "rx_arp_rate_limit_drops": 0, + "bfd_rec_invalid": 1, + "rx_implicit_acl_drops": 869, + "ip_disabled_rx": 0, + "rx_mac_compare_ipsec_drops": 0, + "tx_ipsec_pkts": 16205725, + "rx_mcast_threshold_exceeded": 0, + "bfd_timer_add_fail": 0, + "openssl_aes_decrypt": 0, + "nat_xlate_outbound": 0, + "tx_ipsec_mcast_encap": 0, + "rx_gre_decap": 0, + "tx_errors": 0, + "bfd_tx_pkts": 16142569, + "service_label_fwd": 0, + "unknown_nh_type": 0, + "rx_mcast_policy_fwd_drops": 0, + "rx_pre_ipsec_drops": 0, + "tx_icmp_host_unreach": 0, + "vdevice-host-name": "vm3", + "rx_icmp_host_unreach": 0, + "rx_icmp_dst_unreach_other": 0, + "tx_icmp_redirect": 0, + "rx_mcast_link_local": 17935, + "rx_host_local_pkt": 0, + "tx_fragments": 0, + "tx_icmp_port_unreach": 50, + "icmp_redirect": 0, + "rx_mcast": 18682, + "tx_mcast": 55760, + "tx_mcast_fragment_needed": 0, + "rx_replay_integrity_drops": 1, + "rx_mcast_filter_to_cpu": 0, + "ip_fwd_rx_gre": 0, + "tx_icmp_protocol_unreach": 0, + "port_disabled_rx": 9018, + "ttl_expired": 0, + "tx_gre_encap": 132344, + "bfd_rx_pkts": 16138479, + "ip_fwd_arp": 1187, + "tx_icmp_network_unreach": 0, + "ip_fwd_invalid_tun_oil": 0, + "ip_fwd_rx_ipsec": 16202760, + "tx_icmp_other_types": 654, + "rx_no_tun_if": 0, + "app_route_policy_discards": 0, + "tx_no_out_sa_ipsec_drops": 0, + "rx_bad_label": 0, + "tx_pre_ipsec_pkts": 16205725, + "rx_mcast_filter_to_cpu_and_fwd": 0, + "tx_pre_ipsec_policer_drops": 0, + "rx_next_hdr_ipsec_drops": 0, + "bfd_tx_fail": 0, + "rx_ip6_ipsec_drops": 0, + "tunnel_loop_drops": 0, + "tx_arp_rate_limit_drops": 0, + "bfd_alloc_fail": 0, + "tx_pre_ipsec_encap": 16205725, + "ip_v6_mcast_drops": 0, + "port_disabled_tx": 193, + "ecmp_discards": 0, + "tx_icmp_echo_replies": 0, + "rx_icmp_fragment_required": 0, + "ip_fwd_from_cpu_nat_xlates": 0, + "rx_icmp_echo_replies": 486048, + "tx_no_tunn_ipsec_drops": 0, + "tx_no_arp_drop": 0, + "tx_vsmart_drop": 0, + "rx_policer_drops": 0, + "ip_fwd_invalid_oil": 0, + "rx_replay_drops": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/system/status": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system status list (Real Time)", + "operationId": "createDeviceSystemStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system status": { + "description": "Device system status", + "value": { + "data": [ + { + "mem_used": "954024", + "procs": "244", + "disk_avail": "7015M", + "disk_mount": "/", + "board_type": "Sim", + "vdevice-name": "169.254.10.10", + "total_cpu_count": "2", + "mem_cached": "740972", + "reboot_type": "Not Applicable", + "disk_fs": "/dev/root", + "fp_cpu_count": "1", + "chassis-serial-number": "None", + "min1_avg": "1.06", + "state_description": "All daemons up", + "personality": "vedge", + "disk_used": "174M", + "disk_use": "2", + "disk_status": "enabled", + "state": "green", + "config_date/date-time-string": "Mon Feb 14 04:47:05 UTC 2022", + "linux_cpu_count": "1", + "cpu_user": "5.53", + "testbed_mode": "1", + "min15_avg": "1.08", + "disk_size": "7615M", + "cpu_idle": "91.96", + "mem_buffers": "82140", + "model_sku": "None", + "cpu_system": "2.51", + "version": "20.6.2-440", + "min5_avg": "1.10", + "tcpd_cpu_count": "0", + "vdevice-host-name": "vm3", + "mem_total": "3906816", + "uptime": "16 days 05 hrs 08 min 45 sec", + "vdevice-dataKey": "169.254.10.10", + "mem_free": "2129680", + "bootloader_version": "Not applicable", + "fips_mode": "enabled", + "build_number": "440\n", + "lastupdated": 1644814027189, + "loghost_status": "disabled", + "uptime-date": 1643413080000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/device/system/synced/status": { + "get": { + "tags": [ + "Real-Time Monitoring - System" + ], + "description": "Get device system stats list synchronously", + "operationId": "createSyncedDeviceSystemStatusList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": { + "data": [ + { + "vdevice-name": "172.16.255.11", + "board_type": "Sim", + "total_cpu_count": "2", + "reboot_type": "NotApplicable", + "fp_cpu_count": "1", + "chassis-serial-number": "None", + "state_description": "Alldaemonsup", + "@rid": 1175, + "personality": "vedge", + "disk_status": "enabled", + "state": "green", + "linux_cpu_count": "1", + "testbed_mode": "1", + "createTimeStamp": 1647316043522, + "model_sku": "None", + "version": "20.9.999-1787", + "tcpd_cpu_count": "0", + "vdevice-host-name": "vm1", + "vdevice-dataKey": "172.16.255.11", + "vmanage-system-ip": "172.16.255.11", + "bootloader_version": "Notapplicable", + "fips_mode": "enabled", + "lastupdated": 1647316042867, + "build_number": "1787\n", + "loghost_status": "disabled", + "uptime-date": 1647312840000 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/device/tcpopt/activeflows": { + "get": { + "tags": [ + "Real-Time Monitoring - TCP Optimization" + ], + "description": "Get TCP optimized active flows from device (Real Time)", + "operationId": "getActiveTCPFlows", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TCP optimized active flow": { + "description": "TCP optimized active flow", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/tcpopt/expiredflows": { + "get": { + "tags": [ + "Real-Time Monitoring - TCP Optimization" + ], + "description": "Get TCP optimized expired flows from device (Real Time)", + "operationId": "getExpiredTCPFlows", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TCP optimized expired flow": { + "description": "TCP optimized expired flow", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/tcpopt/summary": { + "get": { + "tags": [ + "Real-Time Monitoring - TCP Optimization" + ], + "description": "Get TCP optimization summary from device (Real Time)", + "operationId": "getTCPSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TCP optimization summary": { + "description": "TCP optimization summary", + "value": { + "data": [ + { + "flows-expired": "0", + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "flows-optimized": "0", + "lastupdated": 1644816147644, + "flows-passthrough": "0", + "vdevice-host-name": "vm3", + "flows-in-progress": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/device/tcpproxy/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tcpproxy" + ], + "description": "Get tcp proxy statistics from device", + "operationId": "getTcpProxyStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tcp proxy statistics": { + "description": "Tcp proxy statistics", + "value": { + "data": [ + { + "syn-purged-enq": "0", + "tot-fin-processed": "0", + "enable-rx-called": "0", + "tot-ev-tx-enable-process": "0", + "tot-send-fail": "0", + "tot-ssl-trig-rst-wkq-fail": "0", + "tcpp-aoim-sync-done": "0", + "tot-tcp-buf-sent": "0", + "tot-ssl-pause-called": "0", + "tot-ssl2svc-buf-enq": "0", + "tcp-flow-stats-del-fail": "0", + "enable-rx-queued": "0", + "tot-tcp-buf-rcvd": "0", + "tot-bytes-read-less-512": "0", + "tot-dre-resume-to-be-sent": "0", + "sync-fail-marked-cleanup": "0", + "sync-fail-entry-invalid": "0", + "tot-clean-server-data-q": "0", + "tot-ssl-resume-done": "0", + "ssl-init-failure": "0", + "tot-bytes-read-less-1024": "0", + "tot-tcp-buf-alloc": "0", + "pre-list-enq-failed": "0", + "tot-actual-pause-done": "0", + "tot-tcp-flow-clean-done": "0", + "tot-sc-reset-rcvd": "0", + "tot-rx-ssl-pause-process": "0", + "tot-async-event-send": "0", + "tot-bytes-read-less-4096": "0", + "vpath-cleanup-from-nmrx": "0", + "tcp-flow-entries-created": "0", + "tot-ssl-pause-done": "0", + "tot-tx-async-event-proc": "0", + "tcp-flow-stats-add-fail": "0", + "unif-logg-deq-no-space": "0", + "vdevice-name": "169.254.10.12", + "tot-snort-resume-done": "0", + "tot-pause-count-buf": "0", + "tot-snort-reset-init": "0", + "tot-buf-128k-alloc-failed": "0", + "unified-logging-msg-recvd": "0", + "tot-bytes-read-less-2048": "0", + "wcapi-svc-flow-delete-f": "0", + "sync-flow-mismatch": "0", + "num-stack-cb-null-ctx": "0", + "tot-tcp-buf-128k-alloc": "0", + "tot-clean-flow-ign": "0", + "cur-rx-epoll-count": "0", + "cur-tx-epoll-count": "0", + "curr-val-tcp-flow-entries": "0", + "unified-logg-deq-succ": "0", + "tx-enq-failure-count": "0", + "tot-reset-processed": "0", + "vpath-cleanup-from-evlib": "0", + "tot-en-rx-sock-stk-cl-svr": "0", + "tot-rx-dre-pause-process": "0", + "unified-logg-data-too-long": "0", + "sync-fail-nat-entry-null": "0", + "tot-tcp-reset-rcvd": "0", + "current-conn-count": "0", + "tot-ssl-fin-rcvd": "0", + "tot-tcp-buf-16k-alloc": "0", + "tot-buf-16k-alloc-failed": "0", + "tot-ssl-server-init": "0", + "vdevice-host-name": "vm5", + "tot-sc-fin-rcvd": "0", + "sync-fail-entry-null": "0", + "tot-ssl-buf-free": "0", + "tot-buff-drop-sock-closed": "0", + "enable-rx-done": "0", + "tot-page-alloc-retry": "0", + "tot-resume-count-buf": "0", + "lastupdated": 1646012087379, + "tx-enqueue-drops-close": "0", + "unified-logg-enq-succ": "0", + "proxy-cleanup-enq": "0", + "tot-ssl-reset-init": "0", + "tot-buff-drop-sock-not-av": "0", + "conn-failed": "0", + "tot-dre-resume-done": "0", + "tcpp-aoim-sync-error": "0", + "timer-expire-cleanup-enq": "0", + "tcp-flow-inv-entries": "0", + "other-cleanup-enq": "0", + "tot-page-alloc-failed": "0", + "tot-ssl2tcp-buf-enq": "0", + "tot-clean-add-wk-q-fail": "0", + "tot-dre-resume-msg-sent": "0", + "tot-uhi-munmap": "2768", + "pre-list-enq": "0", + "tot-fin-ign-fd-close": "0", + "tot-buf-32k-alloc-failed": "0", + "flow-drop-sn-gbl-health-y": "0", + "stack-cleanup-enq": "0", + "pre-remove-cleanup": "0", + "tot-en-rx-sock-stk-cl-clnt": "0", + "total-conns": "0", + "tot-ev-resume-process": "0", + "tot-svc2ssl-buf-enq": "0", + "tot-page-free": "0", + "conn-in-progress": "0", + "tot-dre-close-init": "0", + "clean-req-watcher-called": "1104871", + "tot-async-event-process": "0", + "tot-svc-reset-processed": "0", + "tot-page-alloc-fail-size": "0", + "flows-drop-wcapi-health-y": "0", + "tot-rx-snort-pause-proc": "0", + "pre-remove-err-timer": "0", + "tot-uhi-mmap": "88936", + "tot-page-alloc": "0", + "tot-cleanup-add-to-wk-q": "0", + "stack-cleanup-enq-failed": "0", + "pre-remove-accept": "0", + "tot-tcp2ssl-buf-enq": "0", + "tot-ssl-clean-addwkq-fail": "0", + "tot-ssl-buf-alloc": "0", + "tot-actual-resume-done": "0", + "tot-pause-count": "0", + "wcapi-svc-flow-create-f": "0", + "enable-rx-enq-failed": "0", + "flow-drop-sn-inst-health-y": "0", + "max-conns": "0", + "proxy-cleanup-enq-failed": "0", + "tot-ssl-reset-rcvd": "0", + "pre-rem-err-accept": "0", + "tot-ssl-reset-rcvd-sc": "0", + "wcapi-svc-flow-close-f": "0", + "other-cleanup-enq-failed": "0", + "tot-ssl-fin-rcvd-sc": "0", + "tot-tcp-buf-free": "0", + "tot-resume-count": "0", + "tot-tcp-fin-rcvd": "0", + "tot-tcp-buf-32k-alloc": "0", + "tot-clean-msg-rcvd": "0", + "tot-clean-client-data-q": "0", + "enable-rx-failed": "0", + "curr-tcp-flow-entries": "0", + "syn-purge-enq-failed": "0", + "tot-tx-async-event-send": "0", + "wcapi-svc-data-send-f": "0", + "tcp-flow-entries-deleted": "0", + "timer-ex-clean-enq-failed": "0", + "pre-clean-time-update": "0", + "vdevice-dataKey": "169.254.10.12", + "tot-ssl-buf-alloc-failed": "0", + "tot-ssl-resume-called": "0", + "tcpp-aoim-sync-started": "0", + "tot-dre-pause-done": "0", + "tot-tcp-buf-alloc-failed": "0", + "tot-snort-pause-done": "0", + "sync-fail-entry-inuse": "0", + "syncache-add-done": "0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/tcpproxy/status": { + "get": { + "tags": [ + "Real-Time Monitoring - Tcpproxy" + ], + "description": "Get tcp proxy status from device", + "operationId": "getTcpProxyStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tcp proxy status": { + "description": "Tcp proxy status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "oper-state": "running", + "sng-name": "SNG-APPQOE", + "lastupdated": 1646011762240, + "sng-addr": "192.168.2.2", + "vdevice-host-name": "vm5", + "vpg-name": "VirtualPortGroup2", + "vpg-addr": "192.168.2.1", + "vpg-netmask": "255.255.255.0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/tier": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "getTiers", + "operationId": "getTiers", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "add tier", + "operationId": "addTier", + "parameters": [ + { + "name": "addTier", + "in": "path", + "description": "addTier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tier/{tierName}": { + "delete": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "deleteTier", + "operationId": "deleteTier", + "parameters": [ + { + "name": "tierName", + "in": "path", + "description": "deletetier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tloc": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get TLOC status list", + "operationId": "getDeviceTlocStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Status color", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TLOC status list": { + "description": "TLOC status list", + "value": { + "header": { + "title": "tlocStatus", + "generatedOn": 1635302852035 + }, + "data": [ + { + "expectedControlConnections": 2, + "controlConnectionsDown": 0, + "controlConnectionsUp": 7, + "color": "default", + "controlConnectionsToVsmarts": 2, + "system-ip": "172.16.255.22" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tlocutil": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get TLOC list", + "operationId": "getDeviceTlocUtil", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TLOC list": { + "description": "TLOC list", + "value": { + "header": { + "generatedOn": 1635311915500, + "title": "Transport Interface Distribution", + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-TlocUtilization" + }, + "columns": [ + { + "title": "Percentage Distribution", + "property": "percentageDistribution", + "dataType": "string" + }, + { + "title": "Value", + "property": "value", + "dataType": "number" + } + ], + "fields": [ + { + "property": "percentageDistribution", + "dataType": "string" + }, + { + "property": "value", + "dataType": "number" + } + ] + }, + "data": [ + { + "name": "less_than_10_mbps", + "percentageDistribution": "< 10 Mbps", + "detailsURL": "/dataservice/device/tlocutil/detail?util=lessthan10mbps", + "value": 0 + }, + { + "name": "10_mbps_100_mbps", + "percentageDistribution": "10 Mbps - 100 Mbps", + "detailsURL": "/dataservice/device/tlocutil/detail?util=10mbps100mbps", + "value": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tlocutil/detail": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get detailed TLOC list", + "operationId": "getDeviceTlocUtilDetails", + "parameters": [ + { + "name": "util", + "in": "query", + "description": "Tloc util", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detailed TLOC list": { + "description": "Detailed TLOC list", + "value": { + "header": { + "generatedOn": 1635314596057, + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-TlocUtilizationDetails" + }, + "columns": [ + { + "title": "Average", + "property": "average", + "hideable": false, + "dataType": "number" + } + ], + "fields": [ + { + "property": "system-ip", + "dataType": "string" + }, + { + "property": "average", + "dataType": "number" + } + ] + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Generate admin tech logs", + "operationId": "createAdminTech", + "requestBody": { + "description": "Admin tech generation request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Generate Admin tech log": { + "description": "Generate Admin tech log", + "value": { + "deviceIP": "10.3.0.1", + "device-type": "vmanage", + "exclude-cores": true, + "exclude-tech": false, + "exclude-logs": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/copy": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "copy admin tech logs", + "operationId": "copyAdminTechOnDevice", + "requestBody": { + "description": "Admin tech copy request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Copy Admin tech log": { + "description": "Copy Admin tech log", + "value": { + "deviceIP": "10.3.0.1", + "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/delete": { + "delete": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "delete admin tech logs", + "operationId": "deleteAdminTechOnDevice", + "requestBody": { + "description": "Admin tech copy request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete Admin tech log": { + "description": "Delete Admin tech log", + "value": { + "deviceIP": "10.3.0.1", + "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/download/{filename}": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Download admin tech logs", + "operationId": "downloadAdminTechFile", + "parameters": [ + { + "name": "filename", + "in": "path", + "description": "Admin tech file", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintech/{requestID}": { + "delete": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Delete admin tech logs", + "operationId": "deleteAdminTechFile", + "parameters": [ + { + "name": "requestID", + "in": "path", + "description": "Request Id of admin tech generation request", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechlist": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "List admin tech logs", + "operationId": "listAdminTechsOnDevice", + "requestBody": { + "description": "Admin tech listing request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "List Admin tech log": { + "description": "List Admin tech log", + "value": { + "deviceIP": "10.3.0.1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Admin-tech information": { + "description": "Admin-tech information", + "value": "{\n \"data\":[\n {\n \"fileName\":\"10.3.0.1-20200522-102611-admin-tech.tar.gz\",\n \"creationTime\":1590186370340,\n \"size\":1081406,\n \"state\":\"done\"\n \"requestTokenId\":\"10540562-6759-40ad-917f-71d4b81ff37d\"\n }\n ]\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechs": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Get device admin-tech information", + "operationId": "listAdminTechs", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Admin-tech information": { + "description": "Admin-tech information", + "value": { + "data": [ + { + "creationTime": 1590186370340, + "size": 1081406, + "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz", + "state": "done", + "deviceIP": "10.3.0.1", + "local-system-ip": "10.3.0.1", + "requestTokenId": "10540562-6759-40ad-917f-71d4b81ff37d" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechs/inprogress": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Get device admin-tech InProgressCount", + "operationId": "getInProgressCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Admin-tech InProgressCount": { + "description": "Admin-tech InProgressCount", + "value": { + "data": [ + { + "inProgressCount": "5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/admintechs/upload": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "upload admin tech to SR", + "operationId": "uploadAdminTech", + "requestBody": { + "description": "Admin tech upload request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "upload Admin tech log": { + "description": "upload Admin tech log", + "value": "{\n \"sr_number\":\"69131837254\",\n \"token\":\"9b42986QTUc\",\n \"vpn\":\"VPN 0\",\n \"requestTokenId\":\"ea8cb172-61c4-47e0-8957-ac83b384f53e\",\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/factoryreset": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Device factory reset", + "operationId": "factoryReset", + "requestBody": { + "description": "Device factory reset", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device factory reset": { + "description": "Device factory reset", + "value": { + "deviceIP": "172.16.255.16", + "resetOption": "full-wipe/retain-license" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/netstat": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get device tool net stat", + "operationId": "getDeviceToolsNetstat", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "options", + "in": "query", + "description": "Options", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tools netstat Data Example": { + "description": "Tools netstat Data Example", + "value": "{{\n \"rawOutput\": [\n \"Active Internet connections (w/o servers)\",\n \"Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name\",\n \"tcp 0 0 vm1:ssh 10.0.1.1:54932 ESTABLISHED 8964/sshd: admin [p\",\n \"Active UNIX domain sockets (w/o servers)\",\n \"Proto RefCnt Flags Type State I-Node PID/Program name Path\",\n \"unix 3 [ ] STREAM CONNECTED 1154465 3283/ftmd /var/run/.ftmd.512\",\n \"unix 3 [ ] STREAM CONNECTED 767015 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 1154461 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 767017 2181/cfgmgr /var/run/quagga/zebra_protobuf_notify.api.512\",\n \"unix 3 [ ] STREAM CONNECTED 1177839 8966/0 \",\n \"unix 2 [ ] STREAM CONNECTED 1177830 8964/sshd: admin [p \",\n \"unix 3 [ ] STREAM CONNECTED 1177840 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 1177838 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 766216 2519/zebra \"\n ]\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/nping/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "NPing device", + "operationId": "npingDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "NPing parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NPing parameter": { + "description": "NPing parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/nslookup": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get device tool nslookup", + "operationId": "getDeviceToolsNSlookup", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN", + "required": true, + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "dns", + "in": "query", + "description": "DNS", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "8.8.8.8" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device tool nslookup data": { + "description": "Device tool nslookup data", + "value": { + "rawOutput": [ + "Server: 10.0.1.1", + "Address 1: 10.0.1.1", + "", + "Name: 8.8.8.8", + "Address 1: 8.8.8.8" + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/ping/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Ping device", + "operationId": "pingDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ping parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ping parameter": { + "description": "Ping parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/porthopcolor/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Request port hop color", + "operationId": "processPortHopColor", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device port hop color", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device port hop color": { + "description": "Device port hop color", + "value": { + "color": "mpls" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/realtimeinfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get hardware real time info from device", + "operationId": "getRealTimeinfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "hardware real time info data": { + "description": "hardware real time info data", + "value": "{\t\"hardware-info\" : \"Hardware Information\\n---------------------------------\\n\nBaseboard Details:\\nboard type : ISR1100-4G\\nboard serial number:\nISR1100-4G-FCH2414L04T\\n-------------------------------\\nTPM Details:\\nAikido FPGA : 07250006\\n---------------------------------------------------------\\nBootloader version:\\nBIOS Version:17.7(1r)\\nBootloader Source: Upgrade\nBIOS\\n----------------------------------------------------------------\\nTemperature threshold history:\\n\",\n\"Kernel-log\" : \"Critical Kernel Logs:\"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/reset/interface/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Reset device interface", + "operationId": "processInterfaceReset", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device interface", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device interface": { + "description": "Device interface", + "value": { + "vpnId": "512", + "ifname": "GigabitEthernet1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/resetuser/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Request reset user", + "operationId": "processResetUser", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device user reset", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device user reset": { + "description": "Device user reset", + "value": { + "user": "admin" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/servicepath/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Service path", + "operationId": "servicePath", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Service path parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Service path parameter": { + "description": "Service path parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/ss": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get device tool ss", + "operationId": "getDeviceToolsSS", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN", + "schema": { + "type": "string", + "enum": [ + "0", + "512" + ] + } + }, + { + "name": "options", + "in": "query", + "description": "Options", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device tool SS data ": { + "description": "Device tool SS data ", + "value": { + "rawOutput": [ + "Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process ", + "u_str ESTAB 0 0 * 767015 * 0 users:((\"zebra\",pid=2519,fd=13)) ", + "u_str ESTAB 0 0 /var/run/quagga/zebra_protobuf_notify.api.512 767017 * 0 users:((\"cfgmgr\",pid=2181,fd=30)) ", + "u_str ESTAB 0 0 * 1154461 * 0 users:((\"zebra\",pid=2519,fd=16)) ", + "u_str ESTAB 0 0 /var/run/.ftmd.512 1154465 * 0 users:((\"ftmd\",pid=3283,fd=58)) ", + "u_str ESTAB 0 0 * 1177830 * 0 users:((\"sshd\",pid=8966,fd=6),(\"sshd\",pid=8964,fd=6)) ", + "u_str ESTAB 0 0 * 1177839 * 0 users:((\"sshd\",pid=8966,fd=5)) ", + "u_str ESTAB 0 0 * 1177840 * 0 users:((\"sshd\",pid=8964,fd=7)) ", + "u_dgr ESTAB 0 0 * 766216 * 0 users:((\"zebra\",pid=2519,fd=3)) ", + "u_dgr ESTAB 0 0 * 1177838 * 0 users:((\"sshd\",pid=8966,fd=3),(\"sshd\",pid=8964,fd=3)) ", + "tcp ESTAB 0 0 10.0.1.11:ssh 10.0.1.1:54932 users:((\"sshd\",pid=8966,fd=4),(\"sshd\",pid=8964,fd=4)) " + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/system-netfilter": { + "get": { + "tags": [ + "Real-Time Monitoring - Tools" + ], + "description": "Get system netfilter info from device", + "operationId": "getSystemNetfilter", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "System Netfilter info": { + "description": "System Netfilter info", + "value": { + "ipv4": "Chain POLICE_PROT (2 references)\n pkts bytes target prot opt in out source destination \n 113K 16M ACCEPT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT tcp -- * * 0.0.0.0/0 172.16.255.11 tcp dpt:830\n 0 0 ACCEPT icmp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT 89 -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:22\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:179\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT udp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 udp spt:67 dpt:68\nChain INPUT (policy ACCEPT 760K packets, 433M bytes)\n pkts bytes target prot opt in out source destination \n 113K 16M POLICE_PROT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 LOGGING tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 921K 494M ACCEPT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 ctstate ESTABLISHED\n 0 0 POLICE_PROT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 LOGGING all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \nChain LOGGING (2 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all -- * * 0.0.0.0/0 0.0.0.0/0 ", + "ipv6": "Chain INPUT (policy ACCEPT 90 packets, 5040 bytes)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT all ge0_2 * ::/0 ::/0 ctstate ESTABLISHED\n 30 1680 POLICE_PROT all ge0_2 * ::/0 ::/0 \n 0 0 LOGGING all ge0_2 * ::/0 ::/0 \nChain POLICE_PROT (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT tcp * * ::/0 ::/0 tcp dpt:830\n 30 1680 ACCEPT icmpv6 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT 89 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:22\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:179\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:830\n 0 0 ACCEPT udp ge0_2 * ::/0 ::/0 udp spt:547 dpt:546\nChain LOGGING (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all * * ::/0 ::/0 " + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/traceroute/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Traceroute", + "operationId": "tracerouteDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Traceroute parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Traceroute parameter": { + "description": "Traceroute parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/tools/tunnelpath/{deviceIP}": { + "post": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "TunnelPath", + "operationId": "tunnelPath", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "TunnelPath parameter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TunnelPath parameter": { + "description": "TunnelPath parameter", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/transport/connection": { + "get": { + "tags": [ + "Real-Time Monitoring - Transport" + ], + "description": "Get transport connection list from device", + "operationId": "createTransportConnectionList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Transport connection list": { + "description": "Transport connection list", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "0", + "lastupdated": 1644816647932, + "source": "0.0.0.0", + "time": "Fri Feb 11 18:19:43 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "1", + "lastupdated": 1644816647933, + "source": "0.0.0.0", + "time": "Fri Feb 11 18:16:58 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "2", + "lastupdated": 1644816647933, + "source": "0.0.0.0", + "time": "Fri Feb 4 18:19:51 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "3", + "lastupdated": 1644816647933, + "source": "0.0.0.0", + "time": "Fri Feb 4 18:17:06 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "4", + "lastupdated": 1644816647934, + "source": "0.0.0.0", + "time": "Thu Feb 3 18:23:58 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "5", + "lastupdated": 1644816647934, + "source": "0.0.0.0", + "time": "Thu Feb 3 18:21:13 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "6", + "lastupdated": 1644816647935, + "source": "0.0.0.0", + "time": "Wed Feb 2 18:19:38 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "7", + "lastupdated": 1644816647935, + "source": "0.0.0.0", + "time": "Wed Feb 2 18:16:47 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "8", + "lastupdated": 1644816647935, + "source": "0.0.0.0", + "time": "Tue Feb 1 18:19:56 2022", + "state": "up", + "vdevice-host-name": "vm3", + "track-type": "tloc" + }, + { + "vdevice-dataKey": "169.254.10.10--", + "vdevice-name": "169.254.10.10", + "destination": "10.103.135.135", + "index": "9", + "lastupdated": 1644816647936, + "source": "0.0.0.0", + "time": "Tue Feb 1 18:17:11 2022", + "state": "down", + "vdevice-host-name": "vm3", + "track-type": "tloc" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/tunnel/bfd_statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel BFD statistics all devices", + "operationId": "createBfdStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel BFD statistics": { + "description": "Tunnel BFD statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "bfd-echo-rx-pkts": 0, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 0, + "bfd-echo-tx-octets": 0, + "bfd-pmtu-rx-octets": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "bfd-pmtu-tx-pkts": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "lastupdated": 1644817628460, + "source-ip": "10.0.3.3", + "bfd-echo-tx-pkts": 0, + "bfd-pmtu-rx-pkts": 0, + "bfd-echo-rx-octets": 0 + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "bfd-echo-rx-pkts": 427365, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 307216, + "bfd-echo-tx-octets": 71583641, + "bfd-pmtu-rx-octets": 307216, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 376, + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 427365, + "bfd-pmtu-rx-pkts": 376, + "bfd-echo-rx-octets": 71583634 + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "bfd-echo-rx-pkts": 427523, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 307090, + "bfd-echo-tx-octets": 71610106, + "bfd-pmtu-rx-octets": 305818, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 375, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 427523, + "bfd-pmtu-rx-pkts": 375, + "bfd-echo-rx-octets": 71610099 + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "bfd-echo-rx-pkts": 449468, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 531622, + "bfd-echo-tx-octets": 75208785, + "bfd-pmtu-rx-octets": 2835599, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 2157, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 449468, + "bfd-pmtu-rx-pkts": 2157, + "bfd-echo-rx-octets": 75362995 + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "bfd-echo-rx-pkts": 449575, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 531622, + "bfd-echo-tx-octets": 75226641, + "bfd-pmtu-rx-octets": 2835599, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 2157, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 449575, + "bfd-pmtu-rx-pkts": 2157, + "bfd-echo-rx-octets": 75380984 + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "bfd-echo-rx-pkts": 449641, + "vdevice-name": "169.254.10.10", + "bfd-pmtu-tx-octets": 531622, + "bfd-echo-tx-octets": 75237437, + "bfd-pmtu-rx-octets": 2835599, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "bfd-pmtu-tx-pkts": 2157, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "lastupdated": 1644817628460, + "source-ip": "10.101.3.3", + "bfd-echo-tx-pkts": 449641, + "bfd-pmtu-rx-pkts": 2157, + "bfd-echo-rx-octets": 75392298 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/fec_statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel fec statistics", + "operationId": "createFecStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "tunnel fec statistics": { + "description": "tunnel fec statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "fec-tx-data-pkts": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.0.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "fec-rx-parity-pkts": 0, + "fec-capable": "false", + "fec-tx-parity-pkts": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "fec-tx-data-pkts": 0, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "fec-rx-data-pkts": 0, + "fec-reconstruct-pkts": 0, + "lastupdated": 1644821014912, + "source-ip": "10.101.3.3", + "fec-dynamic": "false" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/gre-keepalives": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get GRE keep alive information", + "operationId": "createGreKeepalivesList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "GRE keep alive": { + "description": "GRE keep alive", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "vdevice-name": "169.254.10.10", + "rx-packets": 0, + "rx-errors": 0, + "oper-state": "down", + "tx-errors": 0, + "admin-state": "up", + "vpn-id": "10", + "vdevice-host-name": "vm3", + "ka-enabled": "true", + "remote-tx-packets": 0, + "if-name": "gre1", + "vdevice-dataKey": "169.254.10.10-10-gre1", + "tx-packets": 81366, + "remote-rx-packets": 0, + "lastupdated": 1644817234436, + "source-ip": "10.0.3.3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/ipsec_statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel IPSec statistics all devices", + "operationId": "createIpsecStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel IPSec statistics": { + "description": "Tunnel IPSec statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "vdevice-name": "169.254.10.10", + "lastupdated": 1644818093996, + "source-ip": "10.0.3.3", + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre" + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "ipsec-decrypt-inbound": 428675, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 428675 + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "ipsec-decrypt-inbound": 428832, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 428832 + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "ipsec-decrypt-inbound": 452605, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 452605 + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "ipsec-decrypt-inbound": 452712, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 452712 + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "ipsec-rx-failures": 0, + "ipsec-rx-auth-failures": 0, + "ipsec-tx-auth-failures": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "ipsec-decrypt-inbound": 452777, + "lastupdated": 1644818093996, + "source-ip": "10.101.3.3", + "ipsec-tx-failures": 0, + "ipsec-encrypt-outbound": 452777 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/packet-duplicate": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel statistics packet duplication statistics", + "operationId": "createPacketDuplicateStatistics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "tunnel statistics packet duplication stats": { + "description": "tunnel statistics packet duplication stats", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.0.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "pktdup-tx": 0, + "pktdup-rx-other": 0, + "vdevice-name": "169.254.10.10", + "pktdup-rx": 0, + "pktdup-rx-this": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "pktdup-capable": "false", + "lastupdated": 1644820446648, + "source-ip": "10.101.3.3", + "pktdup-tx-other": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/tunnel/statistics": { + "get": { + "tags": [ + "Real-Time Monitoring - Tunnel" + ], + "description": "Get tunnel statistics all devices", + "operationId": "createStatisticsList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel statistics": { + "description": "Tunnel statistics", + "value": { + "data": [ + { + "dest-ip": "30.30.30.30", + "source-port": 0, + "vdevice-name": "169.254.10.10", + "rx_pkts": 0, + "tcp-mss-adjust": 1392, + "tx_octets": 0, + "vdevice-host-name": "vm3", + "tunnel-protocol": "gre", + "tx_pkts": 0, + "dest-port": 0, + "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", + "rx_octets": 0, + "tunnel-mtu": 1476, + "lastupdated": 1644819414066, + "source-ip": "10.0.3.3" + }, + { + "dest-ip": "10.101.2.2", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 431317, + "system-ip": "172.16.254.1", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 72492445, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 431317, + "dest-port": 12346, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", + "rx_octets": 72492438, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.101.4.4", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 431474, + "system-ip": "172.16.254.3", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 72518784, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 431474, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", + "rx_octets": 72517505, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.102.5.5", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 455393, + "system-ip": "172.16.254.4", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 76373141, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 455393, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", + "rx_octets": 78844158, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.102.6.6", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 455504, + "system-ip": "172.16.254.5", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 76391653, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 455504, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", + "rx_octets": 78862831, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + }, + { + "dest-ip": "10.102.16.16", + "source-port": 12366, + "vdevice-name": "169.254.10.10", + "rx_pkts": 455567, + "system-ip": "172.16.254.16", + "tcp-mss-adjust": 1361, + "remote-color": "default", + "tx_octets": 76401957, + "vdevice-host-name": "vm3", + "tunnel-protocol": "ipsec", + "local-color": "default", + "tx_pkts": 455567, + "dest-port": 12366, + "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", + "rx_octets": 78873632, + "tunnel-mtu": 1441, + "lastupdated": 1644819414066, + "source-ip": "10.101.3.3" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write,System-read,System-write" + } + }, + "/device/ucse/stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Ucse" + ], + "description": "Get UCSE stats entry from device", + "operationId": "createUcseStats", + "parameters": [ + { + "name": "remote-tloc-address", + "in": "query", + "description": "Remote TLOC address", + "schema": { + "type": "string" + } + }, + { + "name": "remote-tloc-color", + "in": "query", + "description": "Remote tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "local-tloc-color", + "in": "query", + "description": "Local tloc color", + "schema": { + "type": "string", + "enum": [ + "default", + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + " UCSE stats entry": { + "description": " UCSE stats entry", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Security-read,Security-write" + } + }, + "/device/umbrella/device-registration": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella device registration from device", + "operationId": "getUmbrellaDevReg", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella device registration": { + "description": "Umbrella device registration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/dnscrypt": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella DNScrypt information from device", + "operationId": "getUmbrellaDNSCrypt", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella DNScrypt information": { + "description": "Umbrella DNScrypt information", + "value": { + "data": [ + { + "vdevice-name": "169.254.10.10", + "index": 0, + "serial-num": 0, + "vdevice-host-name": "vm3", + "certificate-valid-from": "Jan 01 00:00:00 1970 GMT", + "client-magic": "0:0:0:0", + "vdevice-dataKey": "169.254.10.10-0", + "certificate-validity": "Invalid", + "client-public-key": "B40F:FA9A:31BB:690:C9F:7FEF:60A6:7FF5:286A:F519:64B2:586B:E35E:E4F0:E496:7FEE", + "certificate-state": "Init", + "resolver-public-key": "0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0", + "certificate-valid-till": "Jan 01 00:00:00 1970 GMT", + "lastupdated": 1644823735329, + "certificate-last-refresh-time": "Jan 01 00:00:00 1970 GMT", + "resolver-address": "208.67.222.222" + }, + { + "vdevice-name": "169.254.10.10", + "index": 1, + "serial-num": 0, + "vdevice-host-name": "vm3", + "certificate-valid-from": "Jan 01 00:00:00 1970 GMT", + "client-magic": "0:0:0:0", + "vdevice-dataKey": "169.254.10.10-1", + "certificate-validity": "Invalid", + "client-public-key": "97A1:BCCD:92FE:7FCE:2EC7:CEBC:B6CB:7589:9E63:D830:5D56:FEFD:301E:56C3:D9EF:1851", + "certificate-state": "Init", + "resolver-public-key": "0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0", + "certificate-valid-till": "Jan 01 00:00:00 1970 GMT", + "lastupdated": 1644823735329, + "certificate-last-refresh-time": "Jan 01 00:00:00 1970 GMT", + "resolver-address": "208.67.220.220" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/dp-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella dp-stats from device", + "operationId": "getUmbrellaDpStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella dp-stats": { + "description": "Umbrella dp-stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/overview": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella overview from device", + "operationId": "getUmbrellaOverview", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella overview": { + "description": "Umbrella overview", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "registrations-requested": "0", + "registrations-completed": "0", + "lastupdated": 1644823908956, + "dnscrypt": "true", + "vdevice-host-name": "vm3", + "last-success-attempt": "0000-00-00T00:00:00+00:00" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/umbrella/umbrella-config": { + "get": { + "tags": [ + "Real-Time Monitoring - Umbrella" + ], + "description": "Get Umbrella configuration from device", + "operationId": "getUmbrellaConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Umbrella configuration": { + "description": "Umbrella configuration", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.10", + "vdevice-name": "169.254.10.10", + "ldb-status": "-N/A-", + "public-key": "B0E1:6D15:C32D:4E8C:996B:635A:FA90:05B9", + "lastupdated": 1644823464208, + "DNSCrypt": "Enabled", + "vdevice-host-name": "vm3", + "resolver-address": "208.67.222.222, 208.67.220.220" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/unclaimed/vedges": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get unclaimed vEdges from vbond", + "operationId": "getUnclaimedVedges", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Unclaimed vEdges": { + "description": "Unclaimed vEdges", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write,System-read,System-write" + } + }, + "/device/unconfigured": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get wan edge devices not configured by vManage (that is, those in CLI mode)", + "operationId": "getUnconfigured", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device" + } + }, + "examples": { + "Unconfigured devices": { + "description": "Unconfigured devices", + "value": [ + { + "uuid": "3e314ce8-cbaf-4fc7-882b-bacd16bd9a33", + "systemIp": "172.16.255.11", + "deviceType": "vedge" + }, + { + "uuid": "a9d47933-ee30-4e9f-bee6-a2ac81a0b284", + "systemIp": "172.16.255.21", + "deviceType": "vedge" + }, + { + "uuid": "e417ea1d-43dd-4285-8077-f7e20975568a", + "systemIp": "172.16.255.14", + "deviceType": "vedge" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/unreachable": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get list of unreachable devices", + "operationId": "listUnreachableDevices", + "parameters": [ + { + "name": "personality", + "in": "query", + "description": "Device personality (vedge OR vsmart OR vbond... )", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "List of unreachable devices": { + "description": "List of unreachable devices", + "value": { + "header": { + "generatedOn": 1635316653935, + "viewKeys": { + "uniqueKey": [ + "system-ip" + ], + "preferenceKey": "grid-vManage Control Connections" + }, + "columns": [ + { + "title": "Reachability", + "property": "reachability", + "colorProperty": "reachability", + "color": [ + { + "key": "reachable", + "value": "616161" + }, + { + "key": "unreachable", + "value": "ef5350" + }, + { + "key": "auth-failed", + "value": "ffb300" + } + ], + "width": 100, + "minWidth": 90, + "dataType": "string" + }, + { + "title": "Hostname", + "property": "host-name", + "display": "iconAndText", + "iconProperty": "device-type", + "hideable": false, + "icon": [ + { + "key": "vmanage", + "value": "images/vmanage_table.png" + }, + { + "key": "vedge", + "value": "images/vedge_table.png" + }, + { + "key": "vedge-vbond", + "value": "images/vedge-vbond_table.png" + }, + { + "key": "vsmart", + "value": "images/vsmart_table.png" + }, + { + "key": "vbond", + "value": "images/vbond_table.png" + } + ], + "width": 150, + "dataType": "string" + } + ], + "fields": [ + { + "property": "board-serial", + "dataType": "string" + }, + { + "property": "lastupdated", + "dataType": "date" + } + ] + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/unreachable/{deviceIP}": { + "delete": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Delete unreachable device", + "operationId": "removeUnreachableDevice", + "parameters": [ + { + "name": "deviceIP", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/users": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get users from device (Real Time)", + "operationId": "getUsersFromDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Users": { + "description": "Users", + "value": [ + { + "from": "10.0.1.1", + "proto": "ssh", + "login-time": "2022-01-26T07:36:15+00:00", + "auth-group": "netadmin log ", + "lastupdated": 1644914131016, + "vdevice-dataKey": "172.16.255.11-28", + "session": "28", + "user": "admin", + "context": "cli", + "vdevice-host-name": "vm1", + "vdevice-name": "172.16.255.11" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/users/list": { + "get": { + "tags": [ + "Real-Time Monitoring - AAA" + ], + "description": "Get all users from device", + "operationId": "getAllDeviceUsers", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Users": { + "description": "Users", + "value": { + "data": [ + { + "user": "admin" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write,Tools-read,Tools-write" + } + }, + "/device/utd/dataplane-config": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane config from Device", + "operationId": "getUTDDataplaneConfig", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane config": { + "description": "UTD data plane config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/dataplane-global": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane global from Device", + "operationId": "getUTDDataplaneGlobal", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane global": { + "description": "UTD data plane global", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/dataplane-stats": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane stats from Device", + "operationId": "getUTDDataplaneStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane stats": { + "description": "UTD data plane stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/dataplane-stats-summary": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get data plane stats summary", + "operationId": "getUTDDataplaneStatsSummary", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD data plane stats summary": { + "description": "UTD data plane stats summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/engine-instance-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD engine instance status from device (Real Time)", + "operationId": "getUTDEngineInstanceStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD engine instance status": { + "description": "UTD engine instance status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/engine-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD engine status from device (Real Time)", + "operationId": "getUTDEngineStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD engine status": { + "description": "UTD engine status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/file-analysis-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD file analysis status from device (Real Time)", + "operationId": "getUTDFileAnalysisStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD file analysis status": { + "description": "UTD file analysis status", + "value": { + "data": [ + { + "utd-file-analysis-status-status": "tg-client-stat-unknown", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "lastupdated": 1645768248935, + "utd-file-analysis-status-backoff-interval": "0", + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/file-reputation-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD file reputation status from device (Real Time)", + "operationId": "getUTDFileReputationStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD file reputation status": { + "description": "UTD file reputation status", + "value": { + "data": [ + { + "vdevice-dataKey": "169.254.10.12", + "utd-file-reputation-status-status": "utd-file-repu-stat-process-unknown", + "vdevice-name": "169.254.10.12", + "lastupdated": 1645773049060, + "vdevice-host-name": "vm5" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/ips-update-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD IPS update status from device (Real Time)", + "operationId": "getUTDIpsUpdateStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD IPS update status": { + "description": "UTD IPS update status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/signature/version/details": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD Signature version information from Device", + "operationId": "getSignatureVersionInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD Signature version": { + "description": "UTD Signature version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/urlf-con-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD URLF Connection status from device (Real Time)", + "operationId": "getUTDUrlfConnectionStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD URLF connection status": { + "description": "UTD URLF connection status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/utd/urlf-update-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD URLF update status from device (Real Time)", + "operationId": "getUTDUrlfUpdateStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD URLF update status": { + "description": "UTD URLF update status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/utd/version-status": { + "get": { + "tags": [ + "Real-Time Monitoring - UTD" + ], + "description": "Get UTD version status from device (Real Time)", + "operationId": "getUTDVersionStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UTD version status": { + "description": "UTD version status", + "value": { + "data": [ + { + "utd-version-status-supported": "false", + "vdevice-dataKey": "169.254.10.12", + "vdevice-name": "169.254.10.12", + "utd-version-status-recommended-version": "1.11.1_SV2.9.18.1_XEmain", + "lastupdated": 1645756283937, + "vdevice-host-name": "vm5", + "utd-version-status-supported-regex": "^1\\.11\\.([0-9]+)_SV(.*)_XEmain$" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/coLineSpecificStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service line bonding stats from device", + "operationId": "getCoLineSpecificStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service line bonding stats": { + "description": "VDSL service line bonding stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/coStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get CO stats from device", + "operationId": "getCoStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CO stats": { + "description": "CO stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/cpeLineSpecificStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service CPE line specific stats from device", + "operationId": "getCpeLineSpecificStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service CPE line specific stats": { + "description": "VDSL service CPE line specific stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/cpeStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get CPE stats from device", + "operationId": "getCpeStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CPE stats": { + "description": "CPE stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/lineBondingStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service line bonding stats from device", + "operationId": "getLineBondingStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service line bonding stats": { + "description": "VDSL service line bonding stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/lineSpecificStats": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL service line specific stats from device", + "operationId": "getLineSpecificStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL service line specific stats": { + "description": "VDSL service line specific stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vdslService/vdslInfo": { + "get": { + "tags": [ + "Real-Time Monitoring - VDSL Service" + ], + "description": "Get VDSL info from device", + "operationId": "getVdslInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VDSL info": { + "description": "VDSL info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/vedgeinventory/detail": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get detailed vEdge inventory", + "operationId": "getVedgeInventory", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "Device status", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Detailed vEdge inventory": { + "description": "Detailed vEdge inventory", + "value": { + "data": [ + { + "site-id": "400", + "serialNumber": "12346576", + "validity": "valid", + "host-name": "vm4", + "deviceType": "vedge", + "local-system-ip": "172.16.255.14", + "chasisNumber": "59414e3c-24cd-44de-8072-261224224c25", + "system-ip": "172.16.255.14" + }, + { + "site-id": "100", + "serialNumber": "12346568", + "validity": "valid", + "host-name": "vm11", + "deviceType": "vedge", + "local-system-ip": "172.16.255.21", + "chasisNumber": "63e8518c-e76f-4d5f-a4c7-28ffb669526b", + "system-ip": "172.16.255.21" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/vedgeinventory/summary": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get vEdge inventory", + "operationId": "getVedgeInventorySummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vEdge inventory": { + "description": "vEdge inventory", + "value": { + "header": { + "generatedOn": 1635390164998, + "title": "WAN Edge Inventory", + "viewKeys": { + "uniqueKey": [], + "preferenceKey": "grid-vedgeInventory" + }, + "columns": [ + { + "title": "Inventory List", + "property": "list", + "dataType": "string" + } + ], + "fields": [ + { + "property": "list", + "dataType": "string" + } + ] + }, + "data": [ + { + "name": "Total", + "list": "Total", + "value": 0, + "detailsURL": "/dataservice/device/vedgeinventory/detail" + }, + { + "name": "Authorized", + "list": "Authorized", + "detailsURL": "/dataservice/device/vedgeinventory/detail?status=authorized", + "value": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/virtualApplication/te": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get ThousandEyes app list from device", + "operationId": "createTeList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Te apps list": { + "description": "Te apps list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/virtualApplication/utd": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get Utd apps list from device", + "operationId": "createUtdList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Utd apps list": { + "description": "Utd apps list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/virtualApplication/waas": { + "get": { + "tags": [ + "Real-Time Monitoring - NTP" + ], + "description": "Get Waas apps list from device", + "operationId": "createWaasList", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Waas apps list": { + "description": "Waas apps list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/vm/nics": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get vbranch vm lifecycle state (NIC)", + "operationId": "getVbranchVMLifecycleNics", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vBranch VM lifecycle state (NIC)": { + "description": "vBranch VM lifecycle state (NIC)", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vm/notifications": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get CloudDock vm lifecycle state", + "operationId": "getCloudDockVMLifecycleNics", + "parameters": [ + { + "name": "userGroup", + "in": "query", + "description": "userGroup Name", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudDock VM lifecycle state ": { + "description": "CloudDock VM lifecycle state ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vm/oper/state": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get vbranch vm lifecycle state", + "operationId": "getVbranchVMLifecycle", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vBranch VM lifecycle state": { + "description": "vBranch VM lifecycle state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vm/state": { + "get": { + "tags": [ + "Real-Time Monitoring - VM" + ], + "description": "Get vm lifecycle state", + "operationId": "getVMLifeCycleState", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VM lifecycle state": { + "description": "VM lifecycle state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write,Routing-read,Routing-write" + } + }, + "/device/vmanage": { + "get": { + "tags": [ + "Monitoring - Device Details" + ], + "description": "Get vManage system IP", + "operationId": "getVManageSystemIP", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage system IP": { + "description": "vManage system IP", + "value": { + "header": { + "generatedOn": 1635317321149 + }, + "data": { + "ipAddress": "169.254.10.1" + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/device/voice/dspActive": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm Active DSP info from device", + "operationId": "getDspActive", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm Active DSP info": { + "description": "DSPFarm Active DSP info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/phoneInfo": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get phone registration info from device", + "operationId": "getPhoneInfo", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VOIP call info": { + "description": "VOIP call info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/profiles": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm Profiles info from device", + "operationId": "getDSPFarmProfiles", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm Profiles info": { + "description": "DSPFarm Profiles info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/sccpCcmGroups": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm SCCP CCM Groups info from device", + "operationId": "getSccpCcmGroups", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm SCCP CCM Groups info": { + "description": "DSPFarm SCCP CCM Groups info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/sccpConnections": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get DSPFarm SCCP Connections info from device", + "operationId": "getSccpConnections", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSPFarm SCCP Connections info": { + "description": "DSPFarm SCCP Connections info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/voiceCalls": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get voice call info from device", + "operationId": "getVoiceCalls", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Voice call info": { + "description": "Voice call info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voice/voipCalls": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Get VOIP call info from device", + "operationId": "getVoipCalls", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VOIP call info": { + "description": "VOIP call info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voiceisdninfo/isdnstatus": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Retrieve Voice ISDN Status from device", + "operationId": "getT1e1IsdnStatus", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device voice ISDN status": { + "description": "Device voice ISDN status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voicet1e1controllerinfo/current15minstats": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Retrieve T1E1 controller last 15 min stats from device (Real Time)", + "operationId": "getControllerT1e1InfoCurrent15MinStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "T1E1 controller status": { + "description": "T1E1 controller status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/voicet1e1controllerinfo/totalstats": { + "get": { + "tags": [ + "Real-Time Monitoring - Voice" + ], + "description": "Retrieve T1E1 controller total stats from device (Real Time)", + "operationId": "getControllerT1e1InfoTotalStats", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "T1E1 controller status": { + "description": "T1E1 controller status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/device/vpn": { + "get": { + "tags": [ + "Real-Time Monitoring - VPN" + ], + "description": "Get VPN instance list from device (Real Time)", + "operationId": "getVPNInstances", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPN instance list ": { + "description": "VPN instance list ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/vrrp": { + "get": { + "tags": [ + "Real-Time Monitoring - VRRP" + ], + "description": "Get VRRP interface list from device", + "operationId": "getVRRPInterface", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "deviceId - Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string", + "example": "169.254.10.10" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VRRP interface": { + "description": "VRRP interface", + "value": { + "data": [ + { + "omp-state": "up", + "group-id": "123", + "if-name": "ge0/0", + "virtual-mac": "00:00:5e:00:01:7b", + "lastupdated": 1650878690993, + "vpn-id": "10", + "vdevice-dataKey": "169.254.10.9-10-ge0/0-123", + "advertisement-timer": "1", + "last-state-change-time": "0000-00-00T00:00:00+00:00", + "vdevice-host-name": "vm2", + "vrrp-state": "init", + "vdevice-name": "169.254.10.9", + "priority": "101" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Interface-read,Interface-write" + } + }, + "/device/wireless/client": { + "get": { + "tags": [ + "Real-Time Monitoring - Wireless" + ], + "description": "Get wireless clients from device", + "operationId": "getWirelessClients", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wireless client": { + "description": "Wireless client", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/wireless/radio": { + "get": { + "tags": [ + "Real-Time Monitoring - Wireless" + ], + "description": "Get wireless Radios from device", + "operationId": "getWirelessRadios", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wireless Radio": { + "description": "Wireless Radio", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/wireless/ssid": { + "get": { + "tags": [ + "Real-Time Monitoring - Wireless" + ], + "description": "Get wireless SSID from device", + "operationId": "getWirelessSsid", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wireless SSID": { + "description": "Wireless SSID", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write,System-read,System-write" + } + }, + "/device/wlan/clients": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN client from device", + "operationId": "getWLANClients", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN client": { + "description": "WLAN client", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/wlan/interfaces": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN interface from device", + "operationId": "getWLANInterfaces", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN interface": { + "description": "WLAN interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/wlan/radios": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN Radios from device", + "operationId": "getWLANRadios", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN Radios": { + "description": "WLAN Radios", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/device/wlan/radius": { + "get": { + "tags": [ + "Real-Time Monitoring - WLAN" + ], + "description": "Get WLAN RADIUS authentication from device", + "operationId": "getWLANRadius", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WLAN RADIUS authentication": { + "description": "WLAN RADIUS authentication", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "System-read,System-write" + } + }, + "/diagnostics/dbschema": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get the current database schema", + "operationId": "getDBSchema", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Schema definition": { + "description": "Schema definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/diagnostics/threadpools": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get information on the threadpools", + "operationId": "getThreadPools", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Thread pool": { + "description": "Thread pool", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/activate": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Activate cluster to start working as primary", + "operationId": "activate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/clusterInfo": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery cluster info", + "operationId": "getClusterInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR cluster info": { + "description": "DR cluster info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/dbrestore": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Signal vManage to initiate configuration-db restore operation", + "operationId": "restoreConfigDb", + "requestBody": { + "description": "Config-db meta payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Config-db meta payload": { + "description": "Config-db meta payload", + "value": { + "compressed_db": "db_bkp.tar.gz", + "destinationIP": "10.0.1.32", + "replicationToken": "38400000-8cf0-11bd-b23e-10b96e4ef00d" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/dbrestorestatus": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Config-db restore status", + "operationId": "getConfigDBRestoreStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Config-db Restore Status": { + "description": "Config-db Restore Status", + "value": { + "currentState": "DOWNLOADING" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/deleteLocalDataCenter": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Delete local data center", + "operationId": "deleteLocalDC", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request status": { + "description": "Request status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/deleteRemoteDataCenter": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Delete data center", + "operationId": "deleteDC", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request status": { + "description": "Request status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/deregister": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Delete disaster recovery", + "operationId": "delete", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/details": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery details", + "operationId": "getDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR details": { + "description": "DR details", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/download/backup/{token}/db_bkp.tar.gz": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Downloading stats file", + "operationId": "download", + "parameters": [ + { + "name": "token", + "in": "path", + "description": "Token", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": {} + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/download/{token}/{fileName}": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Download replication data", + "operationId": "downloadReplicationData", + "parameters": [ + { + "name": "token", + "in": "path", + "description": "Token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fileName", + "in": "path", + "description": "File name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Property replication info": { + "description": "Property replication info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/drstatus": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Disaster recovery status", + "operationId": "getDisasterRecoveryStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "DR status": { + "description": "DR status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/history": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery switchover history", + "operationId": "getHistory", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR switchover history": { + "description": "DR switchover history", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/localLatestHistory": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery local switchover history", + "operationId": "getLocalHistory", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR local switchover history": { + "description": "DR local switchover history", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/localdc": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get local data center details", + "operationId": "getLocalDataCenterState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Local datacenters detail": { + "description": "Local datacenters detail", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/password": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update data centers and vBonds passwords for disaster recovery", + "operationId": "update", + "requestBody": { + "description": "Datacenter/vBond password update request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter/vBond password update request": { + "description": "Datacenter/vBond password update request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR setting updated": { + "description": "DR setting updated", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pause": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR", + "operationId": "pauseDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pauseLocalArbitrator": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR for Local Arbitrator", + "operationId": "pauseLocalArbitrator", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pauseLocalDC": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR for Local datacenter", + "operationId": "pauseLocalDCForDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/pauseLocalReplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR replication for Local datacenter", + "operationId": "pauseLocalDCReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/pausereplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Pause DR data replication", + "operationId": "disasterRecoveryPauseReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/register": { + "put": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update data centers for disaster recovery", + "operationId": "update_1", + "requestBody": { + "description": "Datacenter registration request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration request": { + "description": "Datacenter registration request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR setting updated": { + "description": "DR setting updated", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + }, + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Register data centers for disaster recovery", + "operationId": "register", + "requestBody": { + "description": "Datacenter registration request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration request": { + "description": "Datacenter registration request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/remoteDcState": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Gets remote data center member state", + "operationId": "getRemoteDCMembersState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote DC member details": { + "description": "Remote DC member details", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/remotePassword": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update disaster recovery information with updated password to remote data center", + "operationId": "updateDisasterRecoveryState", + "requestBody": { + "description": "Datacenter registration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Disaster recovery information with updated password to remote data center": { + "description": "Disaster recovery information with updated password to remote data center", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/remotedc": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get remote data center details", + "operationId": "getRemoteDataCenterState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Remote datacenters detail": { + "description": "Remote datacenters detail", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + }, + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update complete disaster recovery information to remote data center", + "operationId": "updateDisasterRecoveryState_1", + "requestBody": { + "description": "Datacenter registration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration": { + "description": "Datacenter registration", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/remotedc/swversion": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get remote data center vManage version", + "operationId": "getRemoteDataCenterVersion", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage version": { + "description": "vManage version", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/requestimport": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Replication Request message sent from primary", + "operationId": "disasterRecoveryReplicationRequest", + "requestBody": { + "description": "DR request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR request": { + "description": "DR request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/restartDataCenter": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Restart data center", + "operationId": "restartDataCenter", + "requestBody": { + "description": "Datacenter registration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter registration": { + "description": "Datacenter registration", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/schedule": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery local replication schedule", + "operationId": "getDisasterRecoveryLocalReplicationSchedule", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR replication schedule": { + "description": "DR replication schedule", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/status": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Get disaster recovery status", + "operationId": "getdrStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR status": { + "description": "DR status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-read,Disaster Recovery-write" + } + }, + "/disasterrecovery/unpause": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR", + "operationId": "unpauseDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/unpauseLocalArbitrator": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR for Local Arbitrator", + "operationId": "unpauseLocalArbitrator", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/unpauseLocalDC": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR for Local datacenter", + "operationId": "unpauseLocalDCForDR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/unpauseLocalReplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Unpause DR replication for local datacenter", + "operationId": "unpauseLocalDCReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/disasterrecovery/unpausereplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Un-Pause DR data replication", + "operationId": "disasterRecoveryUnPauseReplication", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request Status": { + "description": "Request Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/updateDRConfigOnArbitrator": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update arbitrator with primary and secondary states cluster", + "operationId": "updateDrState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Request status": { + "description": "Request status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/updateReplication": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Update DR replication status", + "operationId": "updateReplication", + "requestBody": { + "description": "Replication status", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Replication status": { + "description": "Replication status", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/disasterrecovery/usernames": { + "get": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Fetch data centers and vBonds usernames for disaster recovery", + "operationId": "get", + "requestBody": { + "description": "Datacenter/vBond password update request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Datacenter/vBond password update request": { + "description": "Datacenter/vBond password update request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DR setting updated": { + "description": "DR setting updated", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Disaster Recovery-write" + } + }, + "/disasterrecovery/validateNodes": { + "post": { + "tags": [ + "Configuration - Disaster Recovery" + ], + "description": "Validate a list of nodes", + "operationId": "getReachabilityInfo", + "requestBody": { + "description": "Node list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Node list": { + "description": "Node list", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Node reachability list": { + "description": "Node reachability list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/entityownership/list": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "List all entity ownership info", + "operationId": "listEntityOwnershipInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Entity ownership": { + "description": "Entity ownership", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/entityownership/tree": { + "get": { + "tags": [ + "System - Cloud Service" + ], + "description": "Entity ownership info grouped by buckets", + "operationId": "entityOwnershipInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Entity ownership": { + "description": "Entity ownership", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_25", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/event/aggregation": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_24", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/event/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_24", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Events": { + "description": "generated by base class - Monitoring - Events" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/event/component/keyvalue": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve components as key/value pairs", + "operationId": "getComponentsAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Components as key value pair": { + "description": "Components as key value pair", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/csv": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/event/doccount": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get response count of a query", + "operationId": "getCount_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_27", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event/enable/fileprocess": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Set enable events from file flag", + "operationId": "enableEventsFromFile", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "enable.events.from.files flag": { + "description": "enable.events.from.files flag", + "value": { + "enable.events.from.files": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/event/fields": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event/getEventsByComponent": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve components as key/value pairs", + "operationId": "getEventsByComponent", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Components as key value pair": { + "description": "Components as key value pair", + "value": { + "header": { + "generatedOn": 1637035489933 + }, + "data": [ + { + "value": "Policy", + "key": "Policy" + }, + { + "value": "BFD", + "key": "BFD" + }, + { + "value": "App-Route", + "key": "App-Route" + }, + { + "value": "Security", + "key": "Security" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/listeners": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve listener information", + "operationId": "getListenersInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Event listener": { + "description": "Event listener", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/page": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_25", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/event/query/fields": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/event/query/input": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Create query configuration", + "operationId": "createEventsQueryConfig", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Event query config": { + "description": "Event query config", + "value": { + "timeOptions": [ + { + "enableDateFields": false, + "value": "Last 24 hours", + "key": "last_24_hours" + }, + { + "enableDateFields": false, + "value": "Last 12 hours", + "key": "last_12_hours" + }, + { + "enableDateFields": true, + "value": "Custom", + "key": "custom" + } + ], + "component": [ + { + "value": "System", + "key": "system" + }, + { + "value": "Hardware", + "key": "hardware" + }, + { + "value": "BFD", + "key": "bfd" + } + ], + "severityOptions": [ + { + "value": "Critical", + "key": "critical" + }, + { + "value": "Major", + "key": "major" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/severity": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve events", + "operationId": "findEvents", + "parameters": [ + { + "name": "severity-level", + "in": "query", + "description": "Severity level", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "critical", + "major", + "minor" + ] + }, + "enum": [ + "critical", + "major", + "minor" + ] + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Severity histogram": { + "description": "Severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/severity/summary": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve severity histogram", + "operationId": "getSeverityHistogram", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Severity histogram": { + "description": "Severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/event/types/keyvalue": { + "get": { + "tags": [ + "Monitoring - Events" + ], + "description": "Retrieve event types as key/value pairs", + "operationId": "getEventTypesAsKeyValue", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Events as key value pair": { + "description": "Events as key value pair", + "value": { + "header": { + "generatedOn": 1637030060147 + }, + "data": [ + { + "value": "system-software-install-change", + "key": "system-software-install-change" + }, + { + "value": "system-software-install-status", + "key": "system-software-install-status" + }, + { + "value": "system-firmware-install-status", + "key": "system-firmware-install-status" + }, + { + "value": "im-event", + "key": "im-event" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Events-read" + } + }, + "/featurecertificate/certificate": { + "get": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Get feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getDeviceCertificate", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device feature cert": { + "description": "Device feature cert", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + }, + "put": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Upload feature cert for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "installFeatureCertificate", + "requestBody": { + "description": "Install feature cert request for cEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature cert request": { + "description": "Feature cert request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/featurecertificate/devicecsr": { + "get": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Get CSR from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getDeviceCsr", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device CSR": { + "description": "Device CSR", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + }, + "put": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Create CSR for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "genDeviceCsr", + "requestBody": { + "description": "CSR request for cEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/featurecertificate/revoke": { + "put": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Revoke feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "revokeFeatureCertificate", + "requestBody": { + "description": "Revoking feature cert request for cEdge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoking feature cert request": { + "description": "Revoking feature cert request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/featurecertificate/syslogconfig": { + "get": { + "tags": [ + "Configuration - Feature Certificate" + ], + "description": "Get Feature CA state


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.", + "operationId": "getFeatureCaState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature CA state": { + "description": "Feature CA state", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/fedramp/dnssec/actions": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Request DNS-Sec actions", + "operationId": "requesDNSSecActions", + "parameters": [ + { + "name": "action", + "in": "query", + "description": "DNS-Sec action", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DNS-Sec action status": { + "description": "DNS-Sec action status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/fedramp/dnssec/config": { + "post": { + "tags": [ + "Deployment Mode" + ], + "description": "Configure DNS-Sec", + "operationId": "configureDNSSec", + "requestBody": { + "description": "DNS sec config request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DNS sec config request": { + "description": "DNS sec config request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,FedRamp-write" + } + }, + "/fedramp/dnssec/status": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Get DNS-Sec status", + "operationId": "getDNSSecStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DNS-Sec status": { + "description": "DNS-Sec status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/fedramp/status": { + "post": { + "tags": [ + "Deployment Mode" + ], + "description": "Set network deployment mode", + "operationId": "configFedrampMode", + "requestBody": { + "description": "Network deployment mode", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network deployment mode": { + "description": "Network deployment mode", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,FedRamp-write" + } + }, + "/fedramp/wazuh/actions": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Wazuh agent action", + "operationId": "requestWazuhActions", + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Wazhuh Action", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Wazhug agent action status": { + "description": "Wazhug agent action status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/fedramp/wazuh/config": { + "post": { + "tags": [ + "Deployment Mode" + ], + "description": "Configure Wazuh agent", + "operationId": "configureWazuhClient", + "requestBody": { + "description": "Wazhuh configuration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Wazhuh configuration request": { + "description": "Wazhuh configuration request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,FedRamp-write" + } + }, + "/fedramp/wazuh/status": { + "get": { + "tags": [ + "Deployment Mode" + ], + "description": "Get Wazuh agent status", + "operationId": "getWazuhAgentStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Wazhug agent status": { + "description": "Wazhug agent status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,FedRamp-read" + } + }, + "/group": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve device group list", + "operationId": "listDeviceGroupList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device group list": { + "description": "Device group list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/group/device": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve device groups", + "operationId": "listDeviceGroups", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device group": { + "description": "Device group", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/group/devices": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve devices in group", + "operationId": "listGroupDevices", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ssh", + "in": "query", + "description": "SSH", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/group/map/devices": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve group devices for map", + "operationId": "listGroupDevicesForMap", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Group devices map": { + "description": "Group devices map", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/group/map/devices/links": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Group" + ], + "description": "Retrieve devices in group for map", + "operationId": "listGroupLinksForMap", + "parameters": [ + { + "name": "groupId", + "in": "query", + "description": "Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices in group map": { + "description": "Devices in group map", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/health/devices": { + "get": { + "tags": [ + "Monitoring - Health" + ], + "description": "get the devices health properties", + "operationId": "getDevicesHealth", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "Page Number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "Page Size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "Sort By Property", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "Sort Order", + "schema": { + "type": "string" + } + }, + { + "name": "startingDeviceId", + "in": "query", + "description": "Optional device ID to start first page", + "schema": { + "type": "string" + } + }, + { + "name": "siteId", + "in": "query", + "description": "Optional site ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "group_id", + "in": "query", + "description": "Optional group ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "groupId", + "in": "query", + "description": "Optional group ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "Optional vpn ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "reachable", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "controlStatus", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "personality", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "health", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "devices health properties": { + "description": "devices health properties", + "value": { + "total_devices": 3, + "devices": [ + { + "name": "vm3", + "personality": "vedge", + "uuid": "04a116f8-9a16-4bf6-9f1f-f58e2619312d", + "reachability": "reachable", + "longitude": "-122.777023", + "latitude": "37.666684", + "health": "green", + "qoe": 10, + "location": "lat: 37.666684, long: -122.777023", + "site_id": "3", + "system_ip": "169.254.10.10", + "device_type": "vedge", + "local_system_ip": "172.16.254.2", + "device_model": "vEdge Cloud", + "software_version": "20.6.0-231", + "cpu_load": 1.32, + "memory_utilization": 25.0, + "control_connections": 3, + "control_connections_up": 3, + "has_geo_data": true, + "uptime_date": 1629963840000, + "device_groups": [ + "No groups" + ], + "connected_vmanages": [ + "169.254.10.3" + ], + "bfd_sessions_up": 5, + "bfd_sessions": 5, + "omp_peers": 2, + "omp_peers_up": 2, + "board_serial_number": "12345708", + "chassis_number": "04a116f8-9a16-4bf6-9f1f-f58e2619312d", + "vpn_ids": null + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/health/devices/overview": { + "get": { + "tags": [ + "Monitoring - Health" + ], + "description": "gets devices health overview", + "operationId": "getDevicesHealthOverview", + "parameters": [ + { + "name": "vpn_id", + "in": "query", + "description": "Optional vpn ID to filter devices", + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "Optional vpn ID to filter devices", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "devices health overview": { + "description": "devices health overview", + "value": { + "good": 3, + "fair": 3, + "poor": 0 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/hsec/activate": { + "post": { + "tags": [ + "Hsec Activate" + ], + "description": "Activate Hsec licenses on devices", + "operationId": "activateHsecLicenses", + "requestBody": { + "description": "Tenant List", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant List": { + "description": "Tenant List", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "License Management-write" + } + }, + "/hsec/assign": { + "post": { + "tags": [ + "HSEC License" + ], + "description": "hsec ", + "operationId": "hsecassign", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/assignSlac": { + "post": { + "tags": [ + "HSEC" + ], + "description": "Assign Hsec License to devices from uploaded SLAC file", + "operationId": "assignSlac", + "requestBody": { + "description": "SLAC File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/uploadHSECAuthFile" + }, + "examples": { + "License": { + "description": "License", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/hsec/devices": { + "get": { + "tags": [ + "HSEC" + ], + "description": "Give list of HSEC license devices", + "operationId": "device Summmary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/devices/install": { + "get": { + "tags": [ + "HSEC" + ], + "description": "Give list of HSEC license devices", + "operationId": "device Summmary_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/download": { + "post": { + "tags": [ + "HSEC" + ], + "description": "Download SLAC Request file for CSSM", + "operationId": "downloadSlacRequestFile", + "requestBody": { + "description": "Device List", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/hsec/fetchaccounts": { + "get": { + "tags": [ + "HSEC" + ], + "description": "fetch sava accounts that support HSEC Licensing", + "operationId": "fetchAccounts_1", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "userName", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pwd", + "in": "query", + "description": "password", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "mode", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/hsec/uploadAuth": { + "post": { + "tags": [ + "HSEC" + ], + "description": "upload SLAC File and fetch device summary", + "operationId": "uploadSlacFile", + "requestBody": { + "description": "SLAC File", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/uploadHSECAuthFile" + }, + "examples": { + "License": { + "description": "License", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device": { + "description": "Device", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/ise/connect": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "ISE connect", + "operationId": "connect_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "ISE connect": { + "description": "ISE connect", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write,default" + } + }, + "/ise/credentials": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get Ise server credentials", + "operationId": "getIseServerCredentials", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IseServer": { + "description": "IseServer", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + }, + "put": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Configure Ise server credentials", + "operationId": "updateIseServerCredentials", + "requestBody": { + "description": "Config Ise server request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server request": { + "description": "Ise server request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server": { + "description": "Ise server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Add Ise server credentials", + "operationId": "addIseServerCredentials", + "requestBody": { + "description": "Config Ise server request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server request": { + "description": "Ise server request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Ise server": { + "description": "Ise server", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/credentials/iseandpxgrid": { + "delete": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Delete ISE and PxGrid on vManage", + "operationId": "deleteIseAndPxGridAccount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ISE and PxGrid Deleted": { + "description": "ISE and PxGrid Deleted", + "value": true + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/credentials/pxgrid": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get PXGrid account", + "operationId": "getPxGridAccount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PXGrid": { + "description": "PXGrid", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + }, + "delete": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Delete PxGrid on vManage", + "operationId": "deletePxGrid", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "PxGrid Deleted": { + "description": "PxGrid Deleted", + "value": true + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/credentials/pxgrid/cert": { + "get": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "getPXgridCert", + "operationId": "getPXgridCert", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IseServer": { + "description": "IseServer", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + } + }, + "/ise/credentials/vsmart/sync": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "syncVsmart", + "operationId": "syncVsmart", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IseServer": { + "description": "IseServer", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy" + } + }, + "/ise/pxgrid/activate": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "pxGrid Account Activate", + "operationId": "AccountActivate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "pxGrid Account Activate": { + "description": "pxGrid Account Activate", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/pxgrid/approve": { + "put": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "pxGrid Account Approve with ERS API", + "operationId": "approve", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "pxGrid Account Approve": { + "description": "pxGrid Account Approve", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/ise/pxgrid/create": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "pxGrid Account Create", + "operationId": "AccountCreate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "pxGrid Account Create": { + "description": "pxGrid Account Create", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-write,Policy Deploy-write" + } + }, + "/localization/supportedLocales": { + "get": { + "tags": [ + "Locale" + ], + "description": "Get Supported locales", + "operationId": "Get Supported locales", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "locales": [ + { + "code": "en_US", + "displayName": "English (US)" + }, + { + "code": "fr_CA", + "displayName": "French (Canadian)" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/attachDevices/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP attached devices", + "operationId": "Retrieve MDP attached devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Edit attached devices", + "operationId": "Edit attached devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "deviceList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "devices": { + "description": "devices", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Share devices with MDP", + "operationId": "Attach devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "deviceList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Devices": { + "description": "Devices", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/detachDevices/{nmsId}": { + "post": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Disconnect devices from mpd controller", + "operationId": "Detach devices", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "deviceList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Onboard": { + "description": "Onboard", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/devices/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP supported devices", + "operationId": "Retrieve MDP supported devices ", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/disconnect/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "disconnect from mpd controller", + "operationId": "disconnect from mdp", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "status": { + "description": "status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/onboard": { + "post": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Start MDP onboarding operation", + "operationId": "onboardMDP", + "requestBody": { + "description": "Onboard", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "onboarding-payload": { + "description": "onboarding-payload", + "value": { + "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", + "name": "sdwane2e", + "description": "sdwan24", + "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", + "uri": "10.10.10.1:24038" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "nmsId": { + "description": "nmsId", + "value": { + "nmsId": "fc335c24-fb30-46bb-81ff-fda84264eb58" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/onboard/status": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Get MDP onboarding status", + "operationId": "Get MDP onboarding status", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "completed" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/onboard/{nmsId}": { + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "update MDP onboarding document", + "operationId": "updateOnboardingPayload", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Onboard", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "onboarding-payload": { + "description": "onboarding-payload", + "value": { + "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", + "name": "sdwane2e", + "description": "sdwan24", + "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", + "uri": "10.10.10.1:24038" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "nmsId": { + "description": "nmsId", + "value": { + "nmsId": "fc335c24-fb30-46bb-81ff-fda84264eb58" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + }, + "delete": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "offboard the mdp application", + "operationId": "offboard", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/policies/mdpconfig": { + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Add internal policy from vmanage", + "operationId": "addInternalPolicy", + "requestBody": { + "description": "addInternalPolicy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "mdpConfig-payload": { + "description": "mdpConfig-payload", + "value": { + "controllerUUID": "fc335c24-fb30-46bb-81ff-fda84264eb58", + "name": "sdwane2e", + "description": "sdwan24", + "requestStream": "request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "responseStream": "response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58", + "otp": "CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0", + "uri": "10.10.10.1:24038" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "deviceId": { + "description": "deviceId", + "value": { + "deviceId": "fc335c24-fb30-46bb-81ff-fda84264eb58" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/mdp/policies/mdpconfig/{deviceId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP ConfigObject", + "operationId": "Retrieve MDP ConfigObject", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "MdpConfig": { + "description": "MdpConfig", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/mdp/policies/{nmsId}": { + "get": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "Retrieve MDP policies", + "operationId": "Retrieve MDP policies", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policies": { + "description": "Policies", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multidomain Policy" + ], + "description": "update policy status", + "operationId": "update policy status", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "policyList", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "policies": { + "description": "policies", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/messaging/device/vmanage": { + "get": { + "tags": [ + "Device - Messaging" + ], + "description": "Create device vManage connection list", + "operationId": "createDeviceVmanageConnectionList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Connection list": { + "description": "Connection list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/monitor/sdavccloudconnector/domain": { + "get": { + "tags": [ + "SD AVC Domain-based App Rules" + ], + "description": "Get SD_AVC App Rules based on Domain", + "operationId": "getCloudConnectorDomainAppRules", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/monitor/sdavccloudconnector/ipaddress": { + "get": { + "tags": [ + "SD AVC IP Address based App Rules" + ], + "description": "Get SD_AVC App Rules based on IP Address", + "operationId": "getCloudConnectorIpAddressAppRules", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/msla/devices": { + "get": { + "tags": [ + "MSLA" + ], + "description": "Retrieve devices subscription", + "operationId": "getMSLADevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device subscription": { + "description": "Device subscription", + "value": { + "data": [ + { + "configuredHostname": "vm11", + "chasisNumber": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "UUID": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "deviceModel": "vedge-cloud", + "configuredSystemIP": "172.16.255.21", + "licenseStatus": "Subscription Needed" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/licenses/sync": { + "post": { + "tags": [ + "MSLA" + ], + "description": "Retrieve MSLA subscription/licenses", + "operationId": "syncLicenses_2", + "requestBody": { + "description": "Sync license", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sync license": { + "description": "Sync license", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription license": { + "description": "Subscription license", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/monitoring/licensedDeviceCount": { + "get": { + "tags": [ + "MSLA" + ], + "description": "get license and device count", + "operationId": "get license and device count", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/monitoring/licensedDistributionDetails": { + "get": { + "tags": [ + "MSLA" + ], + "description": "get license and device count", + "operationId": "get license and device count_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/monitoring/packagingDistributionDetails": { + "get": { + "tags": [ + "MSLA" + ], + "description": "get packaging distribution details", + "operationId": "get packaging distribution details", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/template": { + "get": { + "tags": [ + "MSLA" + ], + "description": "Retrieve all MSLA template", + "operationId": "getAllTemplate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/template/licenses": { + "post": { + "tags": [ + "MSLA" + ], + "description": "Retrieve MSLA subscription/licenses", + "operationId": "getSubscriptions_1", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/msla/va/License": { + "get": { + "tags": [ + "MSLA" + ], + "description": "Retrieve MSLA subscription/licenses", + "operationId": "getSubscriptions", + "parameters": [ + { + "name": "virtual_account_id", + "in": "query", + "description": "virtual_account_id", + "schema": { + "type": "string" + } + }, + { + "name": "licenseType", + "in": "query", + "description": "licenseType", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Subscription": { + "description": "Subscription", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/multicloud/accounts": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get All cloud accounts", + "operationId": "getAllCloudAccounts", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "cloudGatewayEnabled", + "in": "query", + "description": "Cloud gateway enabled flag", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud accounts": { + "description": "Cloud accounts" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Authenticate cloud account credentials", + "operationId": "validateAccountAdd", + "requestBody": { + "description": "Multicloud account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/accounts/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get all Multicloud edge accounts", + "operationId": "getEdgeAccounts", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge accounts": { + "description": "Edge accounts" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Authenticate edge account credentials", + "operationId": "validateEdgeAccountAdd", + "requestBody": { + "description": "Multicloud edge account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Account info": { + "description": "Edge Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/accounts/edge/{accountId}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get edge account by account Id", + "operationId": "getEdgeAccountDetails", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Multicloud edge account", + "operationId": "updateEdgeAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Multicloud Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud edge account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete edge account", + "operationId": "deleteEdgeAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/accounts/edge/{accountId}/credentials": { + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Multicloud edge account credential", + "operationId": "validateEdgeAccountUpdateCredentials", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Multicloud Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud edge account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/accounts/{accountId}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud account by account Id", + "operationId": "getCloudAccountDetails", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update multicloud account", + "operationId": "updateAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete cloud account", + "operationId": "deleteAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/accounts/{accountId}/credentials": { + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update multicloud account credential", + "operationId": "validateAccountUpdateCredentials", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Multicloud account info", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Account info": { + "description": "Account info" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/audit": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an audit with dry run", + "operationId": "auditDryRun", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an audit", + "operationId": "audit", + "requestBody": { + "description": "Audit", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Audit": { + "description": "Audit" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/audit/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an edge audit with dry run", + "operationId": "edgeAuditDryRun", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Call an edge audit", + "operationId": "edgeAudit", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Billing Accounts", + "operationId": "getEdgeBillingAccounts", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Interconnect Provider", + "required": true, + "schema": { + "type": "string", + "enum": [ + "EQUINIX" + ] + } + }, + { + "name": "edgeAccountId", + "in": "path", + "description": "Interconnect Provider Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Billing Accounts": { + "description": "Edge Billing Accounts", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/cloudRoutersAndAttachments": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get all Cloud Routers and their Attachments", + "operationId": "getCloudRoutersAndAttachments", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "network", + "in": "query", + "description": "Network", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGatewayName", + "in": "query", + "description": "Connectivity Gateway Name", + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "State", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud Router": { + "description": "Cloud Router", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/cloudgateway": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateways", + "operationId": "getCgws", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud gateway name", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityState", + "in": "query", + "description": "Connectivity State", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateways": { + "description": "Cloud gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create cloud gateway", + "operationId": "createCgw", + "requestBody": { + "description": "Cloud gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway": { + "description": "Cloud gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get NVA Security Rules", + "operationId": "getNvaSecurityRules", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Get NVA security Rules", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get NVA Security Rules": { + "description": "Get NVA Security Rules" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NVA Security Rules": { + "description": "NVA Security Rules", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update NVA Security Rules", + "operationId": "updateNvaSecurityRules", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update NVA security Rules", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update NVA Security Rules": { + "description": "Update NVA Security Rules" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task ID": { + "description": "Task ID", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/cloudgateway/nvas": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Virtual NVAs", + "operationId": "getAzureNetworkVirtualAppliances", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accoundId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "query", + "description": "Resource Group Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupSource", + "in": "query", + "description": "Resource Group Source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vhubName", + "in": "query", + "description": "VHUB name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vhubSource", + "in": "query", + "description": "VHUB source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Virtual NVAs": { + "description": "Discover Azure Virtual NVAs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/nvasku": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Azure NVA SKUs", + "operationId": "getAzureNvaSkuList", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateways NVA SKUs": { + "description": "Cloud gateways NVA SKUs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/resource": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateways", + "operationId": "getCgwOrgResources", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateways": { + "description": "Cloud gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/resourceGroups": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Resource Groups", + "operationId": "getAzureResourceGroups", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Resource Groups": { + "description": "Discover Azure Resource Groups", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/vhubs": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Virtual HUBs", + "operationId": "getAzureVirtualHubs", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accoundId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "query", + "description": "Resource Group Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupSource", + "in": "query", + "description": "Resource Group Source", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vwanName", + "in": "query", + "description": "VWAN name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vwanSource", + "in": "query", + "description": "VWAN source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Virtual HUBs": { + "description": "Discover Azure Virtual HUBs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/vwans": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Discover Azure Virtual WANs", + "operationId": "getAzureVirtualWans", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accoundId", + "in": "query", + "description": "Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "query", + "description": "Resource Group Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupSource", + "in": "query", + "description": "Resource Group Source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Discover Azure Virtual WANs": { + "description": "Discover Azure Virtual WANs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgateway/{cloudGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateway by name", + "operationId": "getCgwDetails", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway": { + "description": "Cloud gateway", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update cloud gateway", + "operationId": "updateCgw", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cloud gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway": { + "description": "Cloud gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete cloud gateway", + "operationId": "deleteCgw", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deleteAllResources", + "in": "query", + "description": "Optional Flag for deletion of Azure Resource Group, Default: True", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/cloudgateway/{cloudGatewayName}/site": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites attached to CGW", + "operationId": "getSites_1", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "systemIp", + "in": "query", + "description": "System IP", + "schema": { + "type": "string" + } + }, + { + "name": "siteId", + "in": "query", + "description": "Site Id", + "schema": { + "type": "string" + } + }, + { + "name": "color", + "in": "query", + "description": "Color", + "schema": { + "type": "string" + } + }, + { + "name": "vpnTunnelStatus", + "in": "query", + "description": "Fetch vpnTunnelStatus", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update tunnel scaling and accelerated vpn parameter for a branch endpoint", + "operationId": "TunnelScaling", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Site information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "TunnelScalingPayload": { + "description": "TunnelScalingPayload", + "value": "{\n \"cloudType\":\"AWS\",\n \"branchEndpoints\":[\n \"siteId\":\"578\",\n \"systemIp\":\"1.1.1.178\",\n \"color\":\"red\",\n \"acceleratedVpn\":\"true\",\n \"tunnelCount\":\"4\"]\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Attach sites to cloud gateway", + "operationId": "attachSites", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Site information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Detach sites from cloud gateway", + "operationId": "detachSites_1", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Site information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/cloudgateways/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the cloud by cloud type", + "operationId": "getCloudGateways", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud Gateways": { + "description": "Cloud Gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgatewaysetting/{cloudGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateway custom setting by cloud gateway name", + "operationId": "getCgwCustomSettingDetails", + "parameters": [ + { + "name": "cloudGatewayName", + "in": "path", + "description": "Cloud gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway custom setting": { + "description": "Cloud gateway custom setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/cloudgatewaytype": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud gateway types for specified cloudType", + "operationId": "getCgwTypes", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud gateway type": { + "description": "Cloud gateway type", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/connected-sites/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the interconnect gateways by edge type", + "operationId": "getCloudConnectedSites_1", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Interconnect Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect connected sites": { + "description": "Interconnect connected sites", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/connected-sites/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the cloud by cloud type", + "operationId": "getCloudConnectedSites", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud connected sites": { + "description": "Cloud connected sites", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/connectivity/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Connectivity details", + "operationId": "getEdgeConnectivityDetails", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "connectivityName", + "in": "query", + "description": "Connectivity Name", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Connectivity Type", + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Interconnect Gateway name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IC-GW Connectivity": { + "description": "IC-GW Connectivity", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Interconnect connectivity", + "operationId": "updateEdgeConnectivity", + "requestBody": { + "description": "Edge connectivity", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge connectivity": { + "description": "Edge connectivity" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Interconnect connectivity", + "operationId": "createEdgeConnectivity", + "requestBody": { + "description": "Edge connectivity", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge connectivity": { + "description": "Edge connectivity" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivity/edge/{connectionName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Interconnect connectivity", + "operationId": "deleteEdgeConnectivity", + "parameters": [ + { + "name": "connectionName", + "in": "path", + "description": "Edge connectivity name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivity/edge/{connectivityName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Connectivity by name", + "operationId": "getEdgeConnectivityDetailByName", + "parameters": [ + { + "name": "connectivityName", + "in": "path", + "description": "IC-GW connectivity name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "IC-GW Connectivity Name": { + "description": "IC-GW Connectivity Name", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivitygateway": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get all Connectivity Gateways", + "operationId": "getConnectivityGateways", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Cloud Connectivity Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGatewayName", + "in": "query", + "description": "Connectivity Gateway Name", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "network", + "in": "query", + "description": "Network", + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "State", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + }, + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge gateways": { + "description": "Edge gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Connectivity gateway", + "operationId": "createConnectivityGateway", + "requestBody": { + "description": "Connectivity gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connectivity gateway": { + "description": "Connectivity gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete all Connectivity Gateways in local DB", + "operationId": "cleanUpAllConnectivityGatewaysInLocalDB", + "parameters": [ + { + "name": "deletionType", + "in": "query", + "description": "Deletion Type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Connectivity Gateway", + "operationId": "deleteConnectivityGateway", + "parameters": [ + { + "name": "cloudProvider", + "in": "path", + "description": "Cloud Provider", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGatewayName", + "in": "path", + "description": "Connectivity gateway name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Cloud Connectivity Type", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/connectivitygatewaycreationoptions": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get connectivity gateway creation options", + "operationId": "getConnectivityGatewayCreationOptions", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "query", + "description": "Cloud Connectivity Type", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connectivity Gateway Creation options": { + "description": "Connectivity Gateway Creation options", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/dashboard/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get interconnect edge gateway dashboard info", + "operationId": "getDashboardEdgeInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Dashboard edge info": { + "description": "Dashboard edge info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/device": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get available WAN edge devices", + "operationId": "getWanDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge devices": { + "description": "Edge devices" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/devicelink/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Device Links", + "operationId": "getDeviceLinks", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "deviceLinkName", + "in": "query", + "description": "Device Link Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Links": { + "description": "Device Links", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Device Link", + "operationId": "updateDeviceLink", + "requestBody": { + "description": "Device Link", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Link": { + "description": "Device Link" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Device Link", + "operationId": "createDeviceLink", + "requestBody": { + "description": "Device Link", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Link": { + "description": "Device Link" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devicelink/edge/portspeed/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get supported port speed for Device Link", + "operationId": "getDlPortSpeed", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Interconnect Provider", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "port-speed": { + "description": "port-speed", + "value": "{100, 200}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devicelink/edge/{deviceLinkName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Device Link", + "operationId": "deleteDeviceLink", + "parameters": [ + { + "name": "deviceLinkName", + "in": "path", + "description": "Device Link Name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devicelink/metroSpeed/edge": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Device Link Metro Speed based on device link config", + "operationId": "getDeviceLinkMetroSpeed", + "requestBody": { + "description": "Device Link", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Link": { + "description": "Device Link", + "value": { + "edgeType": "EQUINIX", + "edgeAccountId": "cisco_dev", + "deviceLinkName": "test", + "bandwidth": "50", + "deviceList": [ + { + "deviceName": "test-dev-0" + }, + { + "deviceName": "test-dev-1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "dlMetroBandwidth": { + "description": "dlMetroBandwidth", + "value": 1000 + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/devices/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud devices by cloud type", + "operationId": "getCloudDevices_1", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Edge Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud devices": { + "description": "Cloud devices", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/devices/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud devices by cloud type", + "operationId": "getCloudDevices", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud devices": { + "description": "Cloud devices", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/edge/{edgeType}/device": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get available WAN edge devices", + "operationId": "getEdgeWanDevices", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge devices": { + "description": "Edge devices" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/gateway/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateways", + "operationId": "getIcgws", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "regionId", + "in": "query", + "description": "Region Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceState", + "in": "query", + "description": "Resource State", + "schema": { + "type": "string" + } + }, + { + "name": "edgeGatewayName", + "in": "query", + "description": "Edge gateway name", + "schema": { + "type": "string" + } + }, + { + "name": "billingAccountId", + "in": "query", + "description": "billing Account Id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateways": { + "description": "Interconnect Gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Interconnect Gateway", + "operationId": "createIcgw", + "requestBody": { + "description": "Interconnect Gateway", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway": { + "description": "Interconnect Gateway" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateway/edge/setting/{edgeGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateway custom setting by Interconnect Gateway name", + "operationId": "getIcgwCustomSettingDetails", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway custom setting": { + "description": "Interconnect Gateway custom setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateway/edge/types": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateway type for specified Edge Provider", + "operationId": "getIcgwTypes", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway type": { + "description": "Interconnect Gateway type", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateway/edge/{edgeGatewayName}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Gateway by name", + "operationId": "getIcgwDetails", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Gateway": { + "description": "Interconnect Gateway", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Interconnect Gateway", + "operationId": "updateIcgw", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Interconnect Gateway", + "operationId": "deleteIcgw", + "parameters": [ + { + "name": "edgeGatewayName", + "in": "path", + "description": "Edge gateway name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/gateways/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get sites with connectivity to the interconnect gateways by edge type", + "operationId": "getEdgeGateways", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Gateways": { + "description": "Edge Gateways", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/hostvpc": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get tagged, untagged, or all Host VPCs", + "operationId": "getHostVpcs", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "accountIds", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "untagged", + "in": "query", + "description": "Untagged flag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/hostvpc/tags": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get vpc tags", + "operationId": "getVpcTags", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + }, + { + "name": "tagName", + "in": "query", + "description": "Tag name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Edit VPCs for a tag", + "operationId": "editTag", + "requestBody": { + "description": "VPC tag", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC tag": { + "description": "VPC tag" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Tag a VPC", + "operationId": "hostvpcTagging", + "requestBody": { + "description": "VPC tag", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC tag": { + "description": "VPC tag" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/hostvpc/tags/{tagName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete a tag", + "operationId": "unTag", + "parameters": [ + { + "name": "tagName", + "in": "path", + "description": "Tag name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/imagename/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge provider supported images", + "operationId": "getSupportedEdgeImageNames", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge provider images": { + "description": "Edge provider images" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/instancesize": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Transit VPC supported size", + "operationId": "getSupportedInstanceSize", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "accountId", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Transit VPC size": { + "description": "Transit VPC size" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/instancesize/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge provider supported size", + "operationId": "getSupportedEdgeInstanceSize", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge provider size": { + "description": "Edge provider size" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/interfacecolor": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get WAN interface colors", + "operationId": "getWanInterfaceColors", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interface Colors": { + "description": "Interface Colors" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/license/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get License Info for Edge Gateways/Connections", + "operationId": "getLicenses", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Edge Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "productType", + "in": "query", + "description": "product Type", + "schema": { + "type": "string", + "enum": [ + "GATEWAY", + "CONNECTION", + "AWSHC" + ] + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh License Cache from Megaport", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Licenses": { + "description": "Licenses", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/locations/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Locations", + "operationId": "getEdgeLocationsInfo", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + }, + { + "name": "accountId", + "in": "query", + "description": "Edge Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge locations": { + "description": "Edge locations" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete edge account", + "operationId": "deleteEdgeAccount_1", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/locations/edge/{edgeType}/accountId/{accountId}": { + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update Edge Locations", + "operationId": "updateEdgeLocationsInfo", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ], + "default": "MEGAPORT" + } + }, + { + "name": "accountId", + "in": "path", + "description": "Edge Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge locations": { + "description": "Edge locations" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/loopbackCGWColor/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Loopback CGW supported colors", + "operationId": "getSupportedLoopbackCgwColors", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Loopback CGW colors": { + "description": "Edge Loopback CGW colors" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/loopbacktransportcolor/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Edge Loopback Tunnel supported colors", + "operationId": "getSupportedLoopbackTransportColors", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Loopback Tunnel colors": { + "description": "Edge Loopback Tunnel colors", + "value": { + "loopbackTunnelColor": [ + "mpls", + "metro-ethernet", + "biz-internet", + "public-internet", + "lte", + "3g", + "red", + "green", + "blue", + "gold", + "silver", + "bronze", + "custom1", + "custom2", + "custom3", + "private1", + "private2", + "private3", + "private4", + "private5", + "private6" + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/map": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getMappingMatrix", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map matrix": { + "description": "VPC cloud gateway map matrix", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Process intent of connecting VPNs with VPCs through cloud gateway", + "operationId": "processMapping", + "requestBody": { + "description": "VPC mapping", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC mapping": { + "description": "VPC mapping" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/map/defaults": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getDefaultMappingValues", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map": { + "description": "VPC cloud gateway map", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/status": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get mapping status", + "operationId": "getMappingStatus", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "region", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map status": { + "description": "VPC cloud gateway map status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/summary": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get mapping summary", + "operationId": "getMappingSummary", + "parameters": [ + { + "name": "vpnTunnelStatus", + "in": "query", + "description": "VPN tunnel status", + "schema": { + "type": "boolean" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map summary": { + "description": "VPC cloud gateway map summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/tags": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getMappingTags", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map tags": { + "description": "VPC cloud gateway map tags", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/tags/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default Interconnect mapping tag values", + "operationId": "getEdgeMappingTags", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Cloud Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Interconnect Cloud Tags": { + "description": "Interconnect Cloud Tags", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/map/vpns": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get default mapping values", + "operationId": "getMappingVpns", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC cloud gateway map VPN": { + "description": "VPC cloud gateway map VPN", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/mapping/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get associated mappings to the CGW", + "operationId": "getCgwAssociatedMappings", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud Gateway Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "siteUuid", + "in": "query", + "description": "Site Device UUID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud Gateway Mappings": { + "description": "Cloud Gateway Mappings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/partnerports/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get partner ports", + "operationId": "getPartnerPorts", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Edge Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "connectType", + "in": "query", + "description": "Connect Type filter", + "schema": { + "type": "string" + } + }, + { + "name": "vxcPermitted", + "in": "query", + "description": "VXC Permitted on the port", + "schema": { + "type": "string" + } + }, + { + "name": "authorizationKey", + "in": "query", + "description": "authorization Key", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge Partners ": { + "description": "Edge Partners ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get supported port speed", + "operationId": "getPortSpeed", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Interconnect Provider", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MEGAPORT", + "EQUINIX" + ] + } + }, + { + "name": "edgeAccountId", + "in": "path", + "description": "Interconnect Provider Account ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "connectivityType", + "in": "path", + "description": "Interconnect Connectivity Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Service Provider", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AZURE", + "GCP" + ] + } + }, + { + "name": "cloudAccountId", + "in": "query", + "description": "Cloud Service Provider Account ID", + "schema": { + "type": "string" + } + }, + { + "name": "connectType", + "in": "query", + "description": "Connection Type filter", + "schema": { + "type": "string" + } + }, + { + "name": "connectSubType", + "in": "query", + "description": "Connection Sub-Type filter", + "schema": { + "type": "string" + } + }, + { + "name": "connectivityGateway", + "in": "query", + "description": "Connectivity Gateway", + "schema": { + "type": "string" + } + }, + { + "name": "partnerPort", + "in": "query", + "description": "partnerPort", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "port-speed": { + "description": "port-speed", + "value": "{100, 200}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/regions": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud regions", + "operationId": "getCloudRegions", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud regions": { + "description": "Cloud regions" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/settings/edge/global": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get edge global settings", + "operationId": "getEdgeGlobalSettings", + "parameters": [ + { + "name": "edgeType", + "in": "query", + "description": "Edge type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "MP", + "EQ" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update edge global settings for Edge provider", + "operationId": "updateEdgeGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Add global settings for Edge provider", + "operationId": "addEdgeGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/settings/global": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get global settings", + "operationId": "getGlobalSettings", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Update ip in resource pool", + "operationId": "updateGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Acquire ip from resource pool", + "operationId": "addGlobalSettings", + "requestBody": { + "description": "Global setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global setting": { + "description": "Global setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/site": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get available sites", + "operationId": "getSites", + "parameters": [ + { + "name": "color", + "in": "query", + "description": "Color", + "schema": { + "type": "string" + } + }, + { + "name": "attached", + "in": "query", + "description": "Is endpoint attached", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Sites": { + "description": "Sites" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/sshkeys": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get SSH keys", + "operationId": "getSshKeyList", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SSH key": { + "description": "SSH key" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/statistics/interface/aggregation": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_25", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/multicloud/swimages": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get software image list", + "operationId": "getSupportedSoftwareImageList", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "AWS", + "AWS_GOVCLOUD", + "AZURE", + "AZURE_GOVCLOUD", + "GCP" + ] + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Region", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Software images": { + "description": "Software images" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/telemetry": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "reports telemetry data", + "operationId": "telemetry", + "requestBody": { + "description": "telemetry", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "telemetry": { + "description": "telemetry" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/multicloud/tunnels/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get tunnel names", + "operationId": "getTunnelNames", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudGatewayName", + "in": "query", + "description": "Cloud gateway name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel names": { + "description": "Tunnel names" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/types": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud types", + "operationId": "getCloudTypes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud types": { + "description": "Cloud types" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/types/edge": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get edge types", + "operationId": "getEdgeTypes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud types": { + "description": "Cloud types" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vhubs": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Virtual Hubs", + "operationId": "getVHubs", + "parameters": [ + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + }, + { + "name": "vWanName", + "in": "query", + "description": "VWan Name", + "schema": { + "type": "string" + } + }, + { + "name": "vNetTags", + "in": "query", + "description": "VNet Tags", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Azure Virtual WANs": { + "description": "Azure Virtual WANs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vwan": { + "post": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Create Virtual WAN", + "operationId": "createVirtualWan", + "requestBody": { + "description": "Virtual WAN", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Virtual WAN": { + "description": "Virtual WAN" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vwan/{cloudProvider}/{vWanName}": { + "delete": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Delete Virtual Wan", + "operationId": "deleteVirtualWan", + "parameters": [ + { + "name": "cloudProvider", + "in": "path", + "description": "Cloud Provider", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vWanName", + "in": "path", + "description": "Virtual Wan name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/vwans": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Virtual Wans", + "operationId": "getVWans", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "schema": { + "type": "string" + } + }, + { + "name": "cloudType", + "in": "query", + "description": "Cloud Type", + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroup", + "in": "query", + "description": "Resource Group", + "schema": { + "type": "string" + } + }, + { + "name": "refresh", + "in": "query", + "description": "Refresh", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Azure Virtual WANs": { + "description": "Azure Virtual WANs", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/multicloud/widget/edge/{edgeType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get Interconnect Edge widget by edge type", + "operationId": "getEdgeWidget", + "parameters": [ + { + "name": "edgeType", + "in": "path", + "description": "Edge type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge widget": { + "description": "Edge widget", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/multicloud/widget/{cloudType}": { + "get": { + "tags": [ + "Configuration - Multi Cloud" + ], + "description": "Get cloud widget by cloud type", + "operationId": "getCloudWidget", + "parameters": [ + { + "name": "cloudType", + "in": "path", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud widget": { + "description": "Cloud widget", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/network/connectionssummary": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve vManage control status", + "operationId": "getVmanageControlStatus", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Is cached flag", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VPNID" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage control status": { + "description": "vManage control status", + "value": { + "data": [ + { + "name": "vSmart", + "count": 2, + "detailsURL": "/dataservice/device/reachable?personality=vsmart", + "status": "error", + "statusList": [ + { + "name": "vSmart", + "status": "error", + "message": "Number of devices down", + "detailsURL": "/dataservice/device/unreachable?personality=vsmart", + "count": 0 + } + ] + }, + { + "name": "WAN Edge", + "count": 5, + "detailsURL": "/dataservice/device/reachable?personality=vedge", + "status": "error", + "statusList": [ + { + "name": "vEdge", + "status": "error", + "message": "Number of devices down", + "detailsURL": "/dataservice/device/unreachable?personality=vedge", + "count": 0 + } + ] + }, + { + "name": "vBond", + "count": 1, + "detailsURL": "/dataservice/device/reachable?personality=vbond", + "status": "error", + "statusList": [ + { + "name": "vBond", + "status": "error", + "message": "Number of devices down", + "detailsURL": "/dataservice/device/unreachable?personality=vbond", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/network/issues/rebootcount": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve reboot count", + "operationId": "getRebootCount", + "parameters": [ + { + "name": "isCached", + "in": "query", + "description": "Is cached flag", + "required": true, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Reboot count": { + "description": "Reboot count", + "value": { + "data": [ + { + "type": "Reboot count", + "name": "Reboot", + "showTitle": false, + "count": 3, + "detailView": "dialog", + "detailsURL": "dataservice/device/reboothistory/details", + "status": "error" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/network/issues/summary": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve network issues summary", + "operationId": "getNetworkIssuesSummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network issues": { + "description": "Network issues", + "value": { + "data": [ + { + "type": "Status summary", + "name": "Status summary", + "showTitle": false, + "count": 3, + "detailView": "dialog", + "statusList": [ + { + "status": "Crashes", + "name": "Crashes", + "detailView": "dialog", + "detailsURL": "dataservice/device/crashlog/details", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "Reboots", + "name": "Reboots", + "detailView": "dialog", + "detailsURL": "dataservice/device/reboothistory/details", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 3 + }, + { + "status": "Hardware errors", + "name": "Hardware errors", + "detailView": "dialog", + "detailsURL": "dataservice/device/hardware/errors", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/network/status": { + "get": { + "tags": [ + "Device - Network" + ], + "description": "Retrieve network status summary", + "operationId": "getNetworkStatusSummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Network status": { + "description": "Network status", + "value": { + "header": { + "generatedOn": 1635483849920 + }, + "data": [ + { + "type": "vSmart", + "name": "vSmart", + "image": "images/vsmart.png", + "count": 3, + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart", + "statusList": [ + { + "status": "error", + "name": "Error", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=error", + "color": "fa7c7d", + "icon": "images/device/device-error.png", + "count": 0 + }, + { + "status": "warning", + "name": "Warning", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=warning", + "color": "f2ce60", + "icon": "images/device/device-warning.png", + "count": 0 + }, + { + "status": "normal", + "name": "Normal", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=normal", + "color": "b0e276", + "icon": "images/device/device-normal.png", + "count": 3 + }, + { + "status": "new", + "name": "Discovered device", + "detailView": "dialog", + "detailsURL": "/dataservice/device?personality=vsmart&status=new", + "color": "7c8afa", + "icon": "images/device/device-new.png", + "count": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/networkdesign": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get existing network design", + "operationId": "getNetworkDesign", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design": { + "description": "Network design", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Edit network segment", + "operationId": "editNetworkDesign", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network design payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design template": { + "description": "Network design template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + }, + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Create network design", + "operationId": "createNetworkDesign", + "requestBody": { + "description": "Network design payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User": { + "description": "User", + "value": { + "dc": [ + { + "name": "DC4", + "segments": [ + "c952c18b-30b3-4f0b-b985-494693d7adfb" + ], + "deviceProfiles": [ + { + "deviceProfileName": "ASR1001", + "deviceModel": "vedge-ASR-1001-X", + "deviceTemplateID": "", + "deviceProfileId": "", + "circuits": [ + "07dce48b-3c7d-46c0-ac91-36f0d64d61e7" + ] + } + ] + } + ], + "showDeviceProfileHelpText": true, + "globalParameters": [ + { + "templateType": "aaa", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cisco_snmp", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "omp-vedge", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "banner", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "ntp", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "snmp", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cisco_bfd", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cisco_ntp", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cedge_global", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cisco_logging", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "bfd-vedge", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cedge_aaa", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "logging", + "gTemplateClass": "vedge", + "isUsed": false + }, + { + "templateType": "cisco_omp", + "gTemplateClass": "cedge", + "isUsed": false + }, + { + "templateType": "cisco_banner", + "gTemplateClass": "cedge", + "isUsed": false + } + ], + "customizedProfiles": [] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": { + "id": "07c1e0a1-d28a-4372-b819-0f1ab5fc8e39" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + } + }, + "/networkdesign/attachment": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Attach network design", + "operationId": "pushNetworkDesign", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/networkdesign/circuit": { + "get": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Get network circuits", + "operationId": "getCircuits", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuits": { + "description": "Network circuits", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Create network circuits", + "operationId": "createCircuit", + "requestBody": { + "description": "Network circuit", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuit": { + "description": "Network circuit", + "value": { + "type": "private", + "color": "biz-internet" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuit Id": { + "description": "Network circuit Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/networkdesign/circuit/{id}": { + "put": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Edit network circuits", + "operationId": "editCircuit", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network circuit", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network circuit": { + "description": "Network circuit" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Circuits" + ], + "description": "Delete network circuits", + "operationId": "deleteCircuit", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/networkdesign/global/parameters": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get global parameter templates", + "operationId": "getGlobalParameters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Global parameters": { + "description": "Global parameters", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/global/template/{templateId}": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Get global template", + "operationId": "getGlobalTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design template": { + "description": "Network design template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + }, + "put": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Edit global template", + "operationId": "editGlobalTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network design template": { + "description": "Network design template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/networkdesign/lock/edit": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Acquire edit lock", + "operationId": "acquireEditLock", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Lock Id": { + "description": "Lock Id", + "value": { + "id": "nd_edit-96c1ff5a-44fa-4316-ad15-cc820347f7d3" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + } + }, + "/networkdesign/mytest/{name}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get all device templates for this feature template", + "operationId": "runMyTest", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Test bane", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/attachment/{profileId}": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Attach to device profile", + "operationId": "pushDeviceProfileTemplate", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/networkdesign/profile/feature": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Generate device profile template list", + "operationId": "getDeviceProfileFeatureTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + } + }, + "/networkdesign/profile/lock/{profileId}": { + "post": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get the service profile config for a given device profile id", + "operationId": "acquireAttachLock", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/networkdesign/profile/status": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration status", + "operationId": "getDeviceProfileConfigStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config status": { + "description": "Device config status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/status/{profileId}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration status by profile Id", + "operationId": "getDeviceProfileConfigStatusByProfileId", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config status": { + "description": "Device config status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/task/count": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration task count", + "operationId": "getDeviceProfileTaskCount", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config task count": { + "description": "Device config task count", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/task/status": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration task status", + "operationId": "getDeviceProfileTaskStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config task status": { + "description": "Device config task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/task/status/{profileId}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get device profile configuration status by profile Id", + "operationId": "getDeviceProfileTaskStatusByProfileId", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config task status": { + "description": "Device config task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/template": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Generate profile template list", + "operationId": "generateProfileTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/networkdesign/profile/template/{templateId}": { + "get": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Get device profile template", + "operationId": "getDeviceProfileTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device profile template": { + "description": "Device profile template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + }, + "put": { + "tags": [ + "Configuration - Network Design Templates" + ], + "description": "Edit device profile template", + "operationId": "editDeviceProfileTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device profile template": { + "description": "Device profile template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/networkdesign/serviceProfileConfig/{profileId}": { + "get": { + "tags": [ + "Configuration - Network Design" + ], + "description": "Get the service profile config for a given device profile id", + "operationId": "getServiceProfileConfig", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Device profile Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceModel", + "in": "query", + "description": "Device model", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device profile": { + "description": "Device profile", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/notifications/rule": { + "put": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Update notification rule", + "operationId": "updateNotificationRule", + "parameters": [ + { + "name": "ruleId", + "in": "query", + "description": "Rule Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Notification rule", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "notificationRuleName": "testwebhook", + "severity": "Medium", + "alarmName": "BFD_Node_Up", + "accountDetails": "noreply@cisco.com", + "webHookEnabled": true, + "webhookUsername": "admin", + "webhookPassword": "admin", + "webhookUrl": "https://localhost:8444", + "updatedBy": "admin", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "accountDetailsArray": [ + "noreply@cisco.com" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + }, + "post": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Add notification rule", + "operationId": "createNotificationRule", + "requestBody": { + "description": "Notification rule", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "notificationRuleName": "testwebhook", + "severity": "Medium", + "alarmName": "BFD_Node_Up", + "accountDetails": "noreply@cisco.com", + "webHookEnabled": true, + "webhookUsername": "admin", + "webhookPassword": "admin", + "webhookUrl": "https://localhost:8444", + "updatedBy": "admin", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "accountDetailsArray": [ + "noreply@cisco.com" + ] + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "notificationRuleName": "testwebhook", + "severity": "Medium", + "alarmName": "BFD_Node_Up", + "accountDetails": "noreply@cisco.com", + "webHookEnabled": true, + "webhookUsername": "admin", + "webhookPassword": "admin", + "webhookUrl": "https://localhost:8444", + "updatedBy": "admin", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "accountDetailsArray": [ + "noreply@cisco.com" + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/notifications/rules": { + "get": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Get all rules or specific notification rule by its Id", + "operationId": "getNotificationRule", + "parameters": [ + { + "name": "ruleId", + "in": "query", + "description": "Rule Id", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Notification rule": { + "description": "Notification rule", + "value": { + "data": [ + { + "severity": "Medium", + "webhookPassword": "$CRYPT$R21YRfP4HWOv+Z9nSi7zRw==$hEU/zplzA+IJlI/4LsNY/Q==", + "updatedBy": "admin", + "alarmName": "BFD_Node_Up", + "webhookUrl": "https://localhost:8444", + "notificationRuleName": "testwebhook", + "lastUpdated": 1588177200725, + "@rid": 1158, + "accountDetails": "cqx@cisco.com", + "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", + "emailThreshold": 5, + "webhookUsername": "admin", + "notificationRuleId": "e947efc8-e86a-4eb4-b8ce-7ed0c2828f13" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,Settings-read" + }, + "delete": { + "tags": [ + "Monitoring - Alarms Notification" + ], + "description": "Delete notification rule", + "operationId": "deleteNotificationRule", + "parameters": [ + { + "name": "ruleId", + "in": "query", + "description": "Rule Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/opentaccase/authcode": { + "get": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Gets Access Token for SSO Logjn", + "operationId": "oauthAccess", + "parameters": [ + { + "name": "code", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "redirect", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "isRefreshNeeded", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Access Token": { + "description": "Access Token", + "value": { + "access_token": "emQHZjOpma4gfco2c14BShVrdAqQ", + "refresh_token": "6cGDKZhHbYRR1ySrVpeKVmtIBSJifPopC8k5NeXVRW", + "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjJNc1VCbzE3Rnl4QVpMUVhGVHpqQVdoX2htcyJ9.eyJzdWIiOiJzaG9hYmFzdSIsImF1ZCI6InZtYW5hZ2Vfc2NtX2NsaWVudCIsImp0aSI6IlNKa1pKYWNsNkE4SVJ6UlBOTTFNbkMiLCJpc3MiOiJodHRwczovL2Nsb3Vkc3NvLXRlc3QuY2lzY28uY29tIiwiaWF0IjoxNjQ5ODM1ODcyLCJleHAiOjE2NDk4MzYxNzIsInBpLnNyaSI6Ikp4N1dJcmp4U1hDdFJuZ0hiT2tQRzhyV0MtYy4uVm45ZyIsImFjciI6InN0ZG5vbWZhIn0.IErZIsHsytpseCO1ReE-Y1i37bST3NPDnbHRiBInO8xhM6L0cbb7f7OhvWnKTSTaFQ_n-qDcG9iqCPZsNBGVX_e88L48S39QTn8OKndNfOmbmqZwkl5chno_6zUgXK-TsVWBKov3jEH2tC0TWRApIl0q9JGXkbrIzWh0qDnEhdk0aMtQf0WyhYvxAjR6W5ErzcqvZOiYBcWcfL4oRzr8wf2kULv1Z9V69aKIucA_Sxs3HflgamqzUaRVafeJW2rtJcnM4hHVMRZ5rjRtVj7KJz1xiZs9AyVuBceaF_XFEmzLrHiEbeNfPdCX0DVZl39uJNO9Z0Fe9wdj3Kq-TEa-VQ", + "token_type": "Bearer", + "expires_in": 3599 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + } + }, + "/opentaccase/getClientID": { + "get": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Gets vManage Client ID", + "operationId": "getClientID", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Access Token": { + "description": "Access Token", + "value": "{ client_id: xxxxxxxxx}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + } + }, + "/opentaccase/scmwidget": { + "get": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Proxy API for SCM Widget", + "operationId": "getCall", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "banner.json (Files needed by scm to load widget )": { + "description": "banner.json (Files needed by scm to load widget )", + "value": { + "statusCode": "SUCCESS", + "webexCategoriesList": [ + { + "categoryHeader": "Meetings", + "category": "Joining a meeting", + "techId": "81", + "techName": "Cloud and Hybrid Products", + "subTechId": "3604", + "subTechName": "Webex joining a meeting", + "problemCodeDescription": "Configuration Assistance", + "problemCode": "CONFIG_ASSISTANCE", + "labelKey": "webexcategory.joiningameeting.tooltip", + "customerActivity": "Configuration", + "containerType": "W", + "type": "webex", + "enableVA": true + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + }, + "post": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Prxoy API for SCM Widget", + "operationId": "postCall", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "getAuthCodeUrl.json (Files needed by scm to load widget )": { + "description": "getAuthCodeUrl.json (Files needed by scm to load widget )", + "value": "{CSRFTOKEN: \"1da3fee1-18c9-4cfd-a8ff-8fe28aafbbd7\",\napixAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=48cvgdjcuf72je6x37ztbv52&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fcase%2F\",\nlogoutURL: \"https://www-stage.cisco.com/autho/logout.html\",\nmaxAppReload: 5 ,\nmuleAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=f7371b79ebeb4c0f8a5a0052120c2efa&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fmule\",\nrmaAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=b69k7tfhs45wf59yfpcdu98c&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fauthcode%2Frmaapi\",\nstatus: \"SUCCESS\",\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + }, + "delete": { + "tags": [ + "Tools - TAC Cases" + ], + "description": "Proxy API for SCM Widget", + "operationId": "deleteCall", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "banner.json (Files needed by scm to load widget )": { + "description": "banner.json (Files needed by scm to load widget )", + "value": "{\"clientTrxId\":\"SCM-1650876738048-shoabasu\",\"errorMessages\":null,\"responseOut\":\"2022-04-25T08:52:19.369Z\",\"requestId\":\"02e8c630-c475-11ec-a61b-005056bc2cda\",\"recordCount\":1,\"\"responseDetails\":{\"draftNumber\":\"9010540440\"},\"messageId\":null,\"eventLog\":null,\"eventResult\":null,\"statusCode\":\"SUCCESS\"}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-write" + } + }, + "/partner": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get all NMS partners", + "operationId": "getPartners", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Partners": { + "description": "Partners", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "type": "dnac", + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5", + "description": "dnac-test", + "owner": "admin", + "registrationDate": "1632900123277", + "devicesAttached": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + } + }, + "/partner/aci/policy": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get ACI definitions", + "operationId": "getACIDefinitions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACI policy": { + "description": "ACI policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/dscpmapping/{partnerId}": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get DSCP policy", + "operationId": "getDscpMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DSCP policy": { + "description": "DSCP policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + }, + "post": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Create an ACI definition entry", + "operationId": "createDscpMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "ACI definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACI definition": { + "description": "ACI definition", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action Id": { + "description": "Action Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write" + }, + "delete": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Delete DSCP mapping", + "operationId": "deleteDscpMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action Id": { + "description": "Action Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/events/{partnerId}": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get ACI events", + "operationId": "getEvents", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "starttime", + "in": "query", + "description": "Start time", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "endtime", + "in": "query", + "description": "End time", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "ACI events": { + "description": "ACI events", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/prefixmapping/{partnerId}": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get prefix mapping", + "operationId": "getDataPrefixMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Prefix mapping": { + "description": "Prefix mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + }, + "post": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Create data prefix mapping", + "operationId": "setDataPrefixMappings", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Prefix definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Prefix definition": { + "description": "Prefix definition", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Action Id": { + "description": "Action Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write" + } + }, + "/partner/aci/policy/sequences": { + "get": { + "tags": [ + "Partner - ACI Policy Builder" + ], + "description": "Get data prefix sequence", + "operationId": "getDataPrefixSequences", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Data prefix sequence": { + "description": "Data prefix sequence", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write" + } + }, + "/partner/dnac/sda/config/{partnerId}": { + "post": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Create SDA enabled device", + "operationId": "createSDAConfig", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device SDA configuration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device SDA configuration": { + "description": "Device SDA configuration", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceConfig": "PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg==" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device Id": { + "description": "Device Id", + "value": { + "id": "push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Integration Management-write" + } + }, + "/partner/dnac/sda/device/{partnerId}": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get SDA enabled devices", + "operationId": "getSDAEnabledDevices", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices list": { + "description": "Devices list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "uuid": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "reachability": "reachable", + "status": "normal", + "personality": "vedge", + "device-type": "normal", + "device-model": "C8000v", + "version": "17.06.01.0.1422", + "site-id": "500", + "platform": "x86_64", + "device-os": "next", + "state": "green", + "chassis-serial-number": "SSI130300YK", + "host-name": "vm5", + "system-ip": "172.16.255.15", + "serialNumber": "12345712", + "templateStatus": "Success", + "validity": "valid", + "configuredAaaUser": [ + "admin" + ], + "wanInterfaces": [ + "GigabitEthernet1" + ], + "discoveredDeviceInterfaces": [ + "GigabitEthernet8", + "GigabitEthernet1", + "GigabitEthernet2" + ], + "registrationDate": "1632900123277", + "devicesAttached": 0, + "loopback": [] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/dnac/sda/device/{partnerId}/{uuid}": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get SDA enabled devices detail", + "operationId": "getDeviceDetails", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string", + "example": "C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device detail list": { + "description": "Device detail list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "uuid": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "reachability": "reachable", + "status": "normal", + "personality": "vedge", + "device-type": "normal", + "device-model": "C8000v", + "version": "17.06.01.0.1422", + "site-id": "500", + "platform": "x86_64", + "device-os": "next", + "state": "green", + "chassis-serial-number": "SSI130300YK", + "host-name": "vm5", + "system-ip": "172.16.255.15", + "serialNumber": "12345712", + "templateStatus": "Success", + "validity": "valid", + "configuredAaaUser": [ + "admin" + ], + "wanInterfaces": [ + "GigabitEthernet1" + ], + "discoveredDeviceInterfaces": [ + "GigabitEthernet8", + "GigabitEthernet1", + "GigabitEthernet2" + ], + "registrationDate": "1632900123277", + "devicesAttached": 0, + "loopback": [] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/dnac/sda/netconfconfig/{partnerId}": { + "post": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Create SDA enabled device from Netconf", + "operationId": "createSDAConfigFromNetconf", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device SDA configuration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device SDA configuration": { + "description": "Device SDA configuration", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "deviceId": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f", + "deviceConfig": "PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg==" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template push Id": { + "description": "Device template push Id", + "value": { + "id": "push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Integration Management-write" + } + }, + "/partner/dnac/sda/site/{partnerId}": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get SDA enabled devices", + "operationId": "getSitesForPartner", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Sites": { + "description": "Sites", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "partnerId": "dnac-test", + "sites": [ + "400" + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/dnac/sda/vpn": { + "get": { + "tags": [ + "Partner - DNAC SDA API" + ], + "description": "Get Overlay VPN list", + "operationId": "getOverlayVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN list": { + "description": "VPN list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "vpnId": "33", + "vpnType": "configuredVPN" + }, + { + "vpnId": "0", + "vpnType": "vmanageVPN" + }, + { + "vpnId": "512", + "vpnType": "vmanageVPN" + }, + { + "vpnId": "65528", + "vpnType": "vmanageVPN" + }, + { + "vpnId": "Mgmt-intf", + "vpnType": "vmanageVPN" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "DNAC SDA-read,DNAC SDA-write,Integration Management-read,Integration Management-write" + } + }, + "/partner/vpn": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get all VPNs", + "operationId": "getVPNList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN list": { + "description": "VPN list", + "value": { + "header": { + "generatedOn": 1649645769219 + }, + "data": [ + { + "vpnId": "1", + "vpnType": "configuredVPN" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + } + }, + "/partner/wcm/netconf/{nmsId}": { + "post": { + "tags": [ + "Partner - WCM Configs" + ], + "description": "Push device configs", + "operationId": "pushNetconfConfigs", + "parameters": [ + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Netconf configuration", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Netconf configuration": { + "description": "Netconf configuration", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Integration Management-write" + } + }, + "/partner/{partnerType}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get NMS partners by partner type", + "operationId": "getPartnersByPartnerType", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string" + }, + "example": "dnac" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Partners": { + "description": "Partners", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "type": "dnac", + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5", + "description": "dnac-test", + "owner": "admin", + "registrationDate": "1632900123277", + "devicesAttached": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + }, + "post": { + "tags": [ + "Partner - Registration" + ], + "description": "Register NMS partner", + "operationId": "registerPartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "description": "dnac-test" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": { + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/partner/{partnerType}/map/{nmsId}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "List mapped devices for the partner", + "operationId": "getPartnerDevices", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PartnerType" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "example": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Devices": { + "description": "Devices", + "value": "[{ \"uuid\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"deviceId\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"reachability\": \"reachable\", \"status\": \"normal\", \"personality\": \"vedge\", \"device-type\": \"normal\", \"device-model\": \"C8000v\", \"version\": \"17.06.01.0.1422\", \"site-id\": \"500\", \"platform\": \"x86_64\", \"device-os\": \"next\", \"state\": \"green\", \"chassis-serial-number\": \"SSI130300YK\", \"host-name\": \"vm5\", \"system-ip\": \"172.16.255.15\", \"serialNumber\": \"12345712\", \"templateStatus\": \"Success\", \"validity\": \"valid\", \"configuredAaaUser\": [\"admin\"], \"wanInterfaces\": [\"GigabitEthernet1\"], \"discoveredDeviceInterfaces\": [\"GigabitEthernet8\",\"GigabitEthernet1\"\"GigabitEthernet2\"], \"registrationDate\": \"1632900123277\", \"devicesAttached\": 0, \"loopback\": []}]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write,Policy Configuration-write" + }, + "post": { + "tags": [ + "Partner - Registration" + ], + "description": "Map devices for the partner", + "operationId": "mapDevices", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "requestBody": { + "description": "List of devices", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "List of devices": { + "description": "List of devices", + "value": { + "devices": [ + "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + }, + "delete": { + "tags": [ + "Partner - Registration" + ], + "description": "Unmap all devices for the partner", + "operationId": "unmapDevices", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PartnerType" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/partner/{partnerType}/unmap/{nmsId}": { + "post": { + "tags": [ + "Partner - Registration" + ], + "description": "Unmap a set of devices for the partner", + "operationId": "deleteDeviceMapping", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "requestBody": { + "description": "List of devices", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "List of devices": { + "description": "List of devices", + "value": { + "devices": [ + "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/partner/{partnerType}/{nmsId}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Get NMS partners by partner type and Id", + "operationId": "getPartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partners": { + "description": "Partners", + "value": [ + { + "name": "DNAC-test", + "partnerId": "dnac-test", + "type": "dnac", + "id": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5", + "description": "dnac-test", + "owner": "admin", + "registrationDate": "1632900123277", + "devicesAttached": 0 + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-read,Integration Management-write" + }, + "put": { + "tags": [ + "Partner - Registration" + ], + "description": "Update NMS partner details", + "operationId": "updatePartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "type": "string", + "example": "dnac" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "example": "f54a0f0e-734b-4c31-a539-9dc5e0fd67a5" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": { + "name": "DNAC-test-new", + "description": "dnac-test-new" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + }, + "delete": { + "tags": [ + "Partner - Registration" + ], + "description": "Delete NMS partner", + "operationId": "deletePartner", + "parameters": [ + { + "name": "partnerType", + "in": "path", + "description": "Partner type", + "required": true, + "schema": { + "$ref": "#/components/schemas/PartnerType" + } + }, + { + "name": "nmsId", + "in": "path", + "description": "NMS Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "example": "341e4f9a-e72c-4d34-9c9a-e6c82248743f" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "status": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Integration Management-write" + } + }, + "/resourcepool/resource/vpn": { + "get": { + "tags": [ + "Resource - Pool" + ], + "description": "Get tenant device vpn resource", + "operationId": "getResources", + "parameters": [ + { + "name": "tenantId", + "in": "query", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tenantVpn", + "in": "query", + "description": "Tenant Vpn Number", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Resources": { + "description": "Resources", + "value": { + "resourcePoolDataType": "vpn", + "tenantId": "foobar", + "tenantVpn": 2, + "deviceVpn": 1 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Resource - Pool" + ], + "description": "Create Vpn resource pool and return tenant device vpn", + "operationId": "createResources", + "requestBody": { + "description": "create resources from resource pool", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Resources": { + "description": "Resources", + "value": "{\n\t\"resourcePoolDataType\": \"vpn\",\n\t\"tenantId\": \"foobar\",\n\t\"tenantVpn\": 2,\n} " + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Resources": { + "description": "Resources", + "value": { + "resourcePoolDataType": "vpn", + "tenantId": "foobar", + "tenantVpn": 2, + "deviceVpn": 1 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Resource - Pool" + ], + "description": "Delete tenant device vpn and release the resource", + "operationId": "deleteResources", + "parameters": [ + { + "name": "tenantId", + "in": "query", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tenantVpn", + "in": "query", + "description": "Tenant Vpn Number", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/restore/import": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Submit a previously backed up file and import the data and apply it to the configuraion database", + "operationId": "importScheduledBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/restore/remoteimport": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Remote import backup from a remote URL and import the data and apply it to the configuraion database", + "operationId": "remoteImportBackup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/schedule/create": { + "post": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "create backup scheduler config-db and statstics database with startDateTime and persist to config-db", + "operationId": "scheduleBackup", + "requestBody": { + "description": "schedule request information", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/schedule/list": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Get a schedule record for backup by scheduler id", + "operationId": "listSchedules", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "size", + "schema": { + "type": "integer", + "format": "int64", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get backup schedule ": { + "description": "Get backup schedule ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/schedule/{schedulerId}": { + "get": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Get a schedule record for backup by scheduler id", + "operationId": "getScheduleRecordForBackup", + "parameters": [ + { + "name": "schedulerId", + "in": "path", + "description": "scheduler id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Get backup schedule ": { + "description": "Get backup schedule ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Scheduled Backup Restore" + ], + "description": "Delete a schedule record for backup in vManage by scheduler id", + "operationId": "deleteSchedule", + "parameters": [ + { + "name": "schedulerId", + "in": "path", + "description": "scheduler id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete backup scheduler job ": { + "description": "Delete backup scheduler job ", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/sdavc/cloudconnector": { + "get": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Get SD_AVC Cloud Connector Config", + "operationId": "getCloudConnector", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Disable SD_AVC Cloud Connector", + "operationId": "disableCloudConnector", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Enable SD_AVC Cloud Connector", + "operationId": "enableCloudConnector", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/sdavc/cloudconnector/status": { + "get": { + "tags": [ + "SD AVC Cloud Connector" + ], + "description": "Get SD_AVC Cloud Connector Status", + "operationId": "getCloudConnectorStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/sdavc/customapps": { + "get": { + "tags": [ + "System - Container" + ], + "description": "Displays the user-defined applications", + "operationId": "getCustomApp", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Custom applications": { + "description": "Custom applications", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/sdavc/task/{taskId}": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Activate container", + "operationId": "activateContainer", + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "Task Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Container task config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Container task config": { + "description": "Container task config", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/sdavc/test": { + "post": { + "tags": [ + "System - Container" + ], + "description": "Test SD_AVC load balancer", + "operationId": "testLoadBalancer", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/segment": { + "get": { + "tags": [ + "Configuration - Segments" + ], + "description": "Get network segments", + "operationId": "getSegments", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Segment list": { + "description": "Segment list", + "value": { + "data": [ + { + "segmentName": "Discovered_VPN_10", + "segmentId": "10", + "id": "c952c18b-30b3-4f0b-b985-494693d7adfb", + "referenceCount": 2 + }, + { + "segmentName": "Discovered_VPN_65529", + "segmentId": "65529", + "id": "5dd3f122-e52f-437e-b5e5-5ae94ad09cd6", + "referenceCount": 0 + }, + { + "segmentName": "Discovered_VPN_20", + "segmentId": "20", + "id": "83b6309d-f61d-4ac5-9699-7d3c04a1caef", + "referenceCount": 0 + }, + { + "segmentName": "Discovered_VPN_40", + "segmentId": "40", + "id": "64b30b74-08e2-4b4b-81ca-d019c7e452d5", + "referenceCount": 1 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Segments" + ], + "description": "Create network segment", + "operationId": "createSegment", + "requestBody": { + "description": "Network segment", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network segment": { + "description": "Network segment", + "value": { + "segmentName": "Discovered_VPN_80", + "segmentId": "80" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "bab577b9-e3c7-4385-abc1-d800dacb5f36" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/segment/{id}": { + "get": { + "tags": [ + "Configuration - Segments" + ], + "description": "Get network segment", + "operationId": "getSegment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Segment Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Segment list": { + "description": "Segment list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Segments" + ], + "description": "Edit network segment", + "operationId": "editSegment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Segment Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network segment", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network segment": { + "description": "Network segment", + "value": "{{\n \"segmentName\":\"Discovered_VPN_80\",\n \"segmentId\":\"90\",\n \"id\":\"bab577b9-e3c7-4385-abc1-d800dacb5f36\",\n \"referenceCount\":0\n}}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Segments" + ], + "description": "Delete network segment", + "operationId": "deleteSegment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Segment Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/server/info": { + "get": { + "tags": [ + "Monitoring - Server Info" + ], + "description": "Get Server info", + "operationId": "createServerInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage server info": { + "description": "vManage server info", + "value": { + "Achitecture": "amd64", + "Available processors": 8 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/serverlongpoll/event/poll/{partnerId}": { + "get": { + "tags": [ + "Partner - Registration" + ], + "description": "Retrieve registration change information", + "operationId": "getDataChangeInfo", + "parameters": [ + { + "name": "partnerId", + "in": "path", + "description": "Partner Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "event_id", + "in": "query", + "description": "Continuation token of ongoing event-polling session", + "schema": { + "type": "string" + } + }, + { + "name": "eventNames", + "in": "query", + "description": "Names of type of events to filter on", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventName" + } + } + }, + { + "name": "wait_time", + "in": "query", + "description": "Maximum polling wait time in seconds", + "schema": { + "type": "integer", + "format": "int64", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/setting/configuration/webserver/certificate": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Retrieves Certificate Signing Request information", + "operationId": "showInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR detail info": { + "description": "CSR detail info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "put": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Import a signed web server certificate", + "operationId": "importCertificate", + "requestBody": { + "description": "Singed certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Singed certificate": { + "description": "Singed certificate", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + }, + "post": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Generate Certificate Signing Request", + "operationId": "getCSR", + "requestBody": { + "description": "CSR signing request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR signing request": { + "description": "CSR signing request", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR": { + "description": "CSR", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/setting/configuration/webserver/certificate/certificate": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Get certificate with alias name", + "operationId": "DumpCertificate", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Key alias", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + } + }, + "/setting/configuration/webserver/certificate/getcertificate": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Get certificate for alias server", + "operationId": "GetCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + } + }, + "/setting/configuration/webserver/certificate/rollback": { + "get": { + "tags": [ + "Certificate Management - vManage" + ], + "description": "Rollback certificate with alias name", + "operationId": "rollback", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Key alias", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Certificate detail info": { + "description": "Certificate detail info" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write" + } + }, + "/settings/banner": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve banner", + "operationId": "getBanner", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Banner": { + "description": "Banner", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/settings/clientSessionTimeout": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Get client session timeout", + "operationId": "getSessionTimout", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Client session timeout": { + "description": "Client session timeout", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/settings/configuration/analytics/dca": { + "post": { + "tags": [ + "Configuration - Settings" + ], + "description": "Create analytics data file", + "operationId": "createAnalyticsDataFile", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write,dca" + } + }, + "/settings/configuration/certificate/{settingType}": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve certificate configuration value by settingType", + "operationId": "getCertConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate configuration value": { + "description": "Certificate configuration value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write,dca" + }, + "put": { + "tags": [ + "Configuration - Settings" + ], + "description": "Update certificate configuration", + "operationId": "editCertConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Certificate config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write" + }, + "post": { + "tags": [ + "Configuration - Settings" + ], + "description": "Add new certificate configuration", + "operationId": "newCertConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Certificate config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate config": { + "description": "Certificate config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write" + } + }, + "/settings/configuration/googleMapKey": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve Google map key", + "operationId": "getGoogleMapKey", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Google map key": { + "description": "Google map key", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write,RBAC VPN-read,RBAC VPN-write" + } + }, + "/settings/configuration/maintenanceWindow": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve maintenance window", + "operationId": "getMaintenanceWindow", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Maintenance window": { + "description": "Maintenance window", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/settings/configuration/{settingType}": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve configuration value by settingType", + "operationId": "getConfigurationBySettingType", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration value": { + "description": "Configuration value", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,Settings-write,dca,Certificates-read" + }, + "put": { + "tags": [ + "Configuration - Settings" + ], + "description": "Update configuration setting", + "operationId": "editConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Configuration setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write" + }, + "post": { + "tags": [ + "Configuration - Settings" + ], + "description": "Add new configuration", + "operationId": "newConfiguration", + "parameters": [ + { + "name": "settingType", + "in": "path", + "description": "Setting type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Configuration setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Configuration setting": { + "description": "Configuration setting", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write,Settings-write,dca" + } + }, + "/settings/passwordPolicy": { + "get": { + "tags": [ + "Configuration - Settings" + ], + "description": "Retrieve password policy from global settings", + "operationId": "getPasswordPolicy", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Password policy": { + "description": "Password policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/sig/datacenters/{type}/{tunneltype}/{devicetype}": { + "get": { + "tags": [ + "Configuration - Policy Secure Internet Gateway Data Centers Builder" + ], + "description": "Get list of data centers for zscaler or umbrella", + "operationId": "getSigDataCenterList", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Provider type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tunneltype", + "in": "path", + "description": "Type of the tunnel ipsec/gre", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "devicetype", + "in": "path", + "description": "Type of the device vedge/cedge", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/smartLicensing/authenticate": { + "post": { + "tags": [ + "Smart License" + ], + "description": "authenticate user for sle", + "operationId": "sleauthenticate", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/fetchAccounts": { + "get": { + "tags": [ + "Smart License" + ], + "description": "fetch sava for sle", + "operationId": "fetchAccounts", + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "mode", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/fetchAllSa": { + "get": { + "tags": [ + "Smart License" + ], + "description": "fetch reports offline for sle", + "operationId": "fetchReports_1", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SLE": { + "description": "SLE", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/fetchReportsForSa": { + "get": { + "tags": [ + "Smart License" + ], + "description": "fetch reports offline for sle", + "operationId": "fetchReports", + "parameters": [ + { + "name": "saDomain", + "in": "query", + "description": "saDomain", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saId", + "in": "query", + "description": "saId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "SLE": { + "description": "SLE", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/getUserSettings": { + "get": { + "tags": [ + "Smart License" + ], + "description": "get settings", + "operationId": "get settings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Devices": { + "description": "Devices", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/removeSaVaSelection": { + "post": { + "tags": [ + "Smart License" + ], + "description": "get all licenses for sa/va", + "operationId": "syncLicenses_1", + "requestBody": { + "description": "Partner", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner": { + "description": "Partner", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Partner Id": { + "description": "Partner Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/smartLicensing/syncLicenses": { + "post": { + "tags": [ + "Smart License" + ], + "description": "get all licenses for sa/va", + "operationId": "syncLicenses", + "requestBody": { + "description": "Partner", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/LicenseUplodFile" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "license": { + "description": "license", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/smartLicensing/uploadAck": { + "post": { + "tags": [ + "Smart License" + ], + "description": "upload ack file for sa/va", + "operationId": "uploadAck", + "requestBody": { + "description": "Partner", + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/AckUplodFile" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "license": { + "description": "license", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin,Software Upgrade-write" + } + }, + "/software/compliance/ip/origin/check": { + "post": { + "tags": [ + "Utility - Security" + ], + "description": "Block IP based on list", + "operationId": "checkGivenIpList", + "requestBody": { + "description": "Device detail", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device detail": { + "description": "Device detail", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "IP validation status": { + "description": "IP validation status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/sslproxy/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get edge proxy certificate", + "operationId": "getProxyCertOfEdge", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Edge proxy certificate": { + "description": "Edge proxy certificate", + "value": { + "enterpriseCA": true, + "vManageRootCA": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "put": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Upload device certificate", + "operationId": "updateCertificate", + "requestBody": { + "description": "Upload device certificate", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Upload device certificate": { + "description": "Upload device certificate", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{id: \"210c2bc2-5423-4a6b-9269-22eaf058d774\"}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/certificate/wanedge/{deviceId}": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Add SSL proxy wan edge", + "operationId": "addWANEdge", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cert state", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cert state": { + "description": "Cert state", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/certificates": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Upload device certificates", + "operationId": "uploadCertificiates", + "requestBody": { + "description": "Certificate file", + "content": { + "multipart/form-data": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate file": { + "description": "Certificate file" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "207": { + "description": "Multi-status" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/csr": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get SSL proxy CSR", + "operationId": "getSslProxyCSR", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "device UUID", + "required": true, + "schema": { + "type": "string", + "example": "8d86d8b2-2239-402e-9fef-467f7bad3f2f" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR": { + "description": "CSR", + "value": { + "csr": [ + { + "hostCommonName": "vManageCA_vm12", + "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n", + "last updated": "07 Apr 2022 07:56:17 UTC", + "commonName": "vManageCA", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/devicecertificates": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get certificate for all cEdges", + "operationId": "getAllDeviceCertificates", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [ + { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate": { + "description": "Certificate", + "value": { + "header": { + "generatedOn": 1650355912089 + }, + "data": [ + { + "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/devicecsr": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get CSR for all cEdges", + "operationId": "getAllDeviceCSR", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [ + { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR": { + "description": "CSR", + "value": { + "header": { + "generatedOn": 1650354738278 + }, + "data": [ + { + "csr": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n", + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/generate/csr/sslproxy": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "CSR request SSL proxy for edge", + "operationId": "generateSslProxyCSR", + "requestBody": { + "description": "CSR request for edge", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request for edge": { + "description": "CSR request for edge" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/generate/vmanage/csr": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Generate CSR", + "operationId": "generateSSLProxyCSR", + "requestBody": { + "description": "CSR request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CSR request": { + "description": "CSR request", + "value": { + "commonName": "vManageCA", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com", + "intermediateCA": "true" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "ba6586b6-6caf-4eac-a6ae-ec4d57d0fe2c" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/list": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get SSL proxy certificate list", + "operationId": "getSslProxyList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Certificate list": { + "description": "Certificate list", + "value": [ + { + "deviceModel": "vedge-C8000V", + "chasisNumber": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "configuredHostname": "vm5", + "managementSystemIP": "172.16.255.15", + "deviceSerialNumber": "12345712", + "configuredSiteId": "500", + "commonName": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "csr": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n", + "serialNumber": "", + "@rid": 1023, + "last updated": "07 Apr 2022 09:07:34 UTC", + "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "state": "CSR_GENERATED", + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "scep": false, + "expirationDate": "Apr 08 09:07:34 2022 UTC", + "hasCert": true, + "hasCSR": true, + "hasEnterpriseCert": false + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/renew": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Renew device certificate", + "operationId": "renewCertificate", + "requestBody": { + "description": "Renew device certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Renew device certificate request": { + "description": "Renew device certificate request", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "0ed22d4e-ba07-4828-9bd6-f3ea9d281513" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/revoke": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Revoke device certificate", + "operationId": "revokeCertificate", + "requestBody": { + "description": "Revoke device certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoke device certificate request": { + "description": "Revoke device certificate request", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "revokeReason": "Unspecified" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/revokerenew": { + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Revoke and renew device certificate", + "operationId": "revokeRenewCertificate", + "requestBody": { + "description": "Revoke device certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Revoke and renew device certificate request": { + "description": "Revoke and renew device certificate request", + "value": { + "uuid": "C8K-2e556375-5d15-420b-aa4d-dd3e5072e585", + "revokeReason": "Unspecified" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get certificate state", + "operationId": "getCertificateState", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate State": { + "description": "Certificate State", + "value": { + "enterpriseCA": false, + "vManageRootCA": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/settings/enterprise/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get enterprise certificate", + "operationId": "getEnterpriseCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise certificate": { + "description": "Enterprise certificate", + "value": { + "scep": false, + "last updated": "07 Apr 2022 03:45:59 UTC", + "commonName": "OCSP-CA", + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Configure enterprise certificate", + "operationId": "setEnterpriseCert", + "requestBody": { + "description": "Config enterprise certificate request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise certificate request": { + "description": "Enterprise certificate request", + "value": { + "scep": "false", + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Certificate": { + "description": "Certificate", + "value": { + "scep": false, + "last updated": "07 Apr 2022 03:45:59 UTC", + "commonName": "OCSP-CA", + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/enterprise/rootca": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage enterprise root certificate", + "operationId": "getVManageEnterpriseRootCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise root certificate": { + "description": "Enterprise root certificate", + "value": { + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289", + "last updated": "07 Apr 2022 03:53:12 UTC" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Set vManage enterprise root certificate", + "operationId": "setEnterpriseRootCaCert", + "requestBody": { + "description": "Set enterprise root CA request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise root CA": { + "description": "Enterprise root CA", + "value": { + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "intermediateCA": "true" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enterprise root certificate": { + "description": "Enterprise root certificate", + "value": { + "enterpriseRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "fingerprint": "db06d0f8799353eabbc47bb201321d54f5086289", + "last updated": "07 Apr 2022 03:53:12 UTC" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/vmanage/certificate": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage intermediate certificate", + "operationId": "getvManageCertificate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage intermediate certificate": { + "description": "vManage intermediate certificate", + "value": { + "header": { + "generatedOn": 1649322823353 + }, + "data": [ + { + "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "hostCommonName": "vManageCA_vm12", + "commonName": "vManageCA_vm12", + "fingerprint": "fcb9c623aa9022354fecd95b1f355e1372802aeb", + "last updated": "07 Apr 2022 07:56:17 UTC", + "intermediateCA": "true" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Set vManage root certificate", + "operationId": "setvManageintermediateCert", + "requestBody": { + "description": "Set vManage intermediate CA request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage intermediate CA": { + "description": "vManage intermediate CA", + "value": { + "data": [ + { + "commonName": "vManageCA_vm12", + "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "intermediateCA": "true" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage intermediate certificate": { + "description": "vManage intermediate certificate", + "value": { + "header": { + "generatedOn": 1649318177975 + }, + "data": [ + { + "vManageRootCA": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n", + "hostCommonName": "vManageCA_vm12", + "commonName": "vManageCA_vm12", + "fingerprint": "fcb9c623aa9022354fecd95b1f355e1372802aeb", + "last updated": "07 Apr 2022 07:56:17 UTC", + "intermediateCA": "true" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/sslproxy/settings/vmanage/csr": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage CSR", + "operationId": "getvManageCSR", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage CSR": { + "description": "vManage CSR", + "value": { + "csr": [ + { + "hostCommonName": "vManageCA_vm12", + "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n", + "last updated": "07 Apr 2022 04:37:37 UTC", + "commonName": "vManageCA", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + } + }, + "/sslproxy/settings/vmanage/rootca": { + "get": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Get vManage root certificate", + "operationId": "getvManageRootCA", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage root certificate": { + "description": "vManage root certificate", + "value": { + "header": { + "generatedOn": 1649300400918 + }, + "data": [ + { + "vManageRootCA": "...", + "publickey": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "csr": "-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n", + "hostCommonName": "vManageRootCa_vm12", + "last updated": "07 Apr 2022 02:59:59 UTC", + "uuid": "3a0733ad-3967-4f71-b4fc-a64c3f634366", + "fingerprint": "1aef4396ce2c71e5df49c448a5eb49b488e9305b", + "commonName": "vManageRootCa", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "email": "name@cisco.com", + "validity": "10" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-read,Certificates-write" + }, + "post": { + "tags": [ + "Configuration - Device SSL Proxy Certificate Management" + ], + "description": "Set vManage root certificate", + "operationId": "setvManageRootCA", + "requestBody": { + "description": "Set vManage root CA request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage root CA": { + "description": "vManage root CA", + "value": { + "commonName": "vManageRootCa", + "org": "Cisco System", + "orgUnit": "Cisco System", + "locality": "Shanghai", + "state": "Shanghai", + "country": "CN", + "validity": 10, + "email": "name@cisco.com" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vManage root certificate": { + "description": "vManage root certificate", + "value": { + "id": "4aa25a65-b65a-443c-9ebf-21d1dee0ed20" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Certificates-write" + } + }, + "/statistics": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get statistics types", + "operationId": "getStatisticType", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Stats type": { + "description": "Stats type", + "value": [ + "interfacestatistics", + "eioltestatistics", + "providerdpistatistics", + "sulstatistics", + "qosstatistics", + "devicesystemstatusstatistics", + "bridgemacstatistics", + "dpistatistics", + "approutestatsstatistics", + "provideraggregatedappsdpistatistics", + "wlanclientinfostatistics", + "flowlogstatistics", + "urlf", + "fwall", + "vnfstatistics", + "umbrella", + "apphostingstatistics", + "utddaqioxstatistics", + "ipsalert", + "aggregatedappsdpistatistics", + "bridgeinterfacestatistics", + "artstatistics", + "trackerstatistics", + "cloudxstatistics", + "deviceevents", + "sleofflinereport", + "alarm", + "auditlog", + "deviceconfiguration", + "nwpi", + "nwpiflowraw", + "speedtest" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_1", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting/aggregation": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_1", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphosting/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_1", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphosting/csv": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting/doccount": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCount_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_3", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphosting/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphosting/page": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_1", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_1", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphosting/query/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphostinginterface": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphostinginterface/aggregation": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphostinginterface/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/apphostinginterface/csv": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphostinginterface/doccount": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCount_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_2", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphostinginterface/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/apphostinginterface/page": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/apphostinginterface/query/fields": { + "get": { + "tags": [ + "Monitoring - App Hosting" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_2", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/aggregation": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated each result": { + "description": "Aggregated each result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_2", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/approute/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_2", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/approute/csv": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/device/tunnel/summary": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get statistics for top applications per tunnel in a grid table", + "operationId": "getApprouteGridStat", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics for top application": { + "description": "Statistics for top application", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/device/tunnels": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get statistics for top applications per tunnel in a grid table", + "operationId": "getTunnel", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/doccount": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get response count of a query", + "operationId": "getCount_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_4", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute/fec/aggregation": { + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get aggregation data and fec recovery rate", + "operationId": "getAggregationDataAppRoute", + "requestBody": { + "description": "Query filter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.254.16" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1, + "size": 50 + }, + { + "property": "state", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "metrics": [ + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + }, + { + "property": "latency", + "type": "avg" + }, + { + "property": "jitter", + "type": "avg" + }, + { + "property": "rx_octets", + "type": "sum" + }, + { + "property": "tx_octets", + "type": "sum" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data and fec recovery rate": { + "description": "Aggregation data and fec recovery rate", + "value": { + "data": [ + { + "loss_percentage": 0, + "latency": 0.0012674271229404308, + "count": 1578, + "tx_octets": 0, + "jitter": 0.0025348542458808617, + "rx_octets": 0, + "proto": "IPSEC", + "name": "172.16.254.16:default-172.16.254.2:default", + "state": "Up", + "fecLossRecovery": "-", + "vqoe_score": 10 + }, + { + "loss_percentage": 0.1266624445851805, + "latency": 0.0031665611146295125, + "count": 1579, + "tx_octets": 0, + "jitter": 0.006333122229259025, + "rx_octets": 0, + "proto": "IPSEC", + "name": "172.16.254.16:default-172.16.254.3:default", + "state": "Up", + "fecLossRecovery": "-", + "vqoe_score": 10 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/fields": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute/page": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_2", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_2", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/query/fields": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/approute/transport/summary/{type}": { + "get": { + "tags": [ + "Monitoring - Application-Aware Routing Statistics", + "Monitoring - Application Aware Routing" + ], + "description": "Get application-aware routing statistics summary from device", + "operationId": "getTransportHealthSummary", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type (example:latency)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64", + "default": 5 + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "operator": "last_n_hours", + "value": [ + "12" + ], + "field": "entry_time", + "type": "date" + } + ], + "type": "latency" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application-aware routing statistics summary": { + "description": "Application-aware routing statistics summary", + "value": { + "data": [ + { + "entry_time": 1640066400000, + "jitter": 0.0, + "color": "", + "loss_percentage": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640062800000, + "color": "default:default", + "loss_percentage": 0.0, + "jitter": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640059200000, + "color": "default:default", + "loss_percentage": 0.0, + "jitter": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640055600000, + "color": "default:default", + "loss_percentage": 0.05, + "jitter": 0.0, + "latency": 0.0, + "app_probe_class": "" + }, + { + "entry_time": 1640052000000, + "color": "default:default", + "loss_percentage": 0.015, + "jitter": 0.001, + "latency": 0.001, + "app_probe_class": "" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/transport/{type}": { + "get": { + "tags": [ + "Monitoring - Application-Aware Routing Statistics", + "Monitoring - Application Aware Routing" + ], + "description": "Get application-aware routing statistics from device", + "operationId": "getTransportHealth", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application-aware routing statistics": { + "description": "Application-aware routing statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnel/{type}/summary": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel top statistics in as chart", + "operationId": "getTunnelChart", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnels/health/{type}": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel health", + "operationId": "getTunnelsHealth", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type (example:latency)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64", + "default": 10 + } + }, + { + "name": "last_n_hours", + "in": "query", + "description": "Time range for health average", + "schema": { + "type": "integer", + "format": "int64", + "default": 3 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": { + "data": [ + { + "name": "172.16.254.16:default-172.16.254.3:default", + "remote_system_ip": "172.16.254.3", + "local_system_ip": "172.16.254.16", + "vqoe_score": 9.997916666666667, + "jitter": 0.002777777777777778, + "rx_octets": 0.0, + "loss_percentage": 0.06944444444444445, + "latency": 0.001388888888888889, + "state": "Up", + "tx_octets": 0.0, + "health": "green" + }, + { + "name": "172.16.254.16:default-172.16.254.1:default", + "remote_system_ip": "172.16.254.1", + "local_system_ip": "172.16.254.16", + "vqoe_score": 10.0, + "jitter": 0.001388888888888889, + "rx_octets": 0.0, + "loss_percentage": 0.0, + "latency": 0.0006944444444444445, + "state": "Up", + "tx_octets": 0.0, + "health": "green" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnels/summary/{type}": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel top statistics from device", + "operationId": "getTunnelsSummary", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64", + "default": 10 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/approute/tunnels/{type}": { + "get": { + "tags": [ + "Monitoring - Application Aware Routing" + ], + "description": "Get tunnel top statistics from device", + "operationId": "getTunnels", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Query result size", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tunnel top statistics": { + "description": "Tunnel top statistics", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_3", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art/aggregation": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_3", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/art/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_3", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/art/csv": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art/doccount": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get response count of a query", + "operationId": "getCount_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_5", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/art/fields": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/art/page": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_3", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_3", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/art/query/fields": { + "get": { + "tags": [ + "Monitoring - ART" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bfd": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_4", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bfd/aggregation": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_4", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bfd/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_4", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bfd/csv": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bfd/doccount": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get response count of a query", + "operationId": "getCount_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_6", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bfd/fields": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bfd/page": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_4", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_4", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bfd/query/fields": { + "get": { + "tags": [ + "Monitoring - BFD" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgeinterface": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_5", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgeinterface/aggregation": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_5", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgeinterface/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_5", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgeinterface/csv": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgeinterface/doccount": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCount_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_7", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgeinterface/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgeinterface/page": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_5", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_5", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgeinterface/query/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgemac": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_6", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgemac/aggregation": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_6", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgemac/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_6", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/bridgemac/csv": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgemac/doccount": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCount_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_8", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgemac/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/bridgemac/page": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_6", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_6", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/bridgemac/query/fields": { + "get": { + "tags": [ + "Monitoring - Bridge" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cflowd": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_8", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/aggregation": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_8", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cflowd/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_8", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cflowd/applications": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Generate cflowd flows list in a grid table", + "operationId": "createFlowsGrid", + "parameters": [ + { + "name": "vpn", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Limit", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Flows": { + "description": "Flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/applications/summary": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Generate cflowd flows list in a grid table", + "operationId": "createFlowssummary", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Limit", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Flows": { + "description": "Flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/csv": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/device/applications": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Generate cflowd flows list in a grid table", + "operationId": "createFlowDeviceData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Flows": { + "description": "Flows", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/doccount": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get response count of a query", + "operationId": "getCount_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_10", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cflowd/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cflowd/page": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_8", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_8", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cflowd/query/fields": { + "get": { + "tags": [ + "Monitoring - Cflowd" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cloudx": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_9", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cloudx/aggregation": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_9", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cloudx/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_9", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/cloudx/csv": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cloudx/doccount": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get response count of a query", + "operationId": "getCount_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_11", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cloudx/fields": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/cloudx/page": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_9", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/cloudx/query/fields": { + "get": { + "tags": [ + "Monitoring - CloudExpress" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/collect": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Start stats collect", + "operationId": "startStatsCollection", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "ActivateDataCollection": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/collect/thread/status": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get stats collect thread report", + "operationId": "generateStatsCollectThreadReport", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Process thread report": { + "description": "Process thread report", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/collection/reset/{processQueue}": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Reset stats collect thread report", + "operationId": "resetStatsCollection", + "parameters": [ + { + "name": "processQueue", + "in": "path", + "description": "Process queue", + "required": true, + "schema": { + "type": "integer", + "format": "int64", + "default": -1 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "statisticsCollectionReset": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/demomode": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Enable statistic demo mode", + "operationId": "enableStatisticsDemoMode", + "parameters": [ + { + "name": "enable", + "in": "query", + "description": "Demo mode flag", + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Demo mode": { + "description": "Demo mode", + "value": { + "DemoMode": "Stats collection interval: 1 minute, Stats Processing interval: 1 min" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/device": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_15", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/device/aggregation": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_14", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/device/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_14", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/device/csv": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/device/doccount": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCount_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_17", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/device/fields": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/device/page": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_15", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/device/query/fields": { + "get": { + "tags": [ + "Monitoring - Device Statistics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/download/{processType}/fetchvManageList": { + "get": { + "tags": [ + "Monitoring - Stats Download" + ], + "operationId": "fetchList", + "parameters": [ + { + "name": "processType", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}": { + "get": { + "tags": [ + "Monitoring - Stats Download" + ], + "description": "Downloading stats file", + "operationId": "download_1", + "parameters": [ + { + "name": "processType", + "in": "path", + "description": "Process type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fileType", + "in": "path", + "description": "File type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "queue", + "in": "path", + "description": "Queue name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceIp", + "in": "path", + "description": "Device IP", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "token", + "in": "path", + "description": "Token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fileName", + "in": "path", + "description": "File name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": {} + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/download/{processType}/filelist": { + "post": { + "tags": [ + "Monitoring - Stats Download" + ], + "description": "Downloading list of stats file", + "operationId": "downloadList", + "parameters": [ + { + "name": "processType", + "in": "path", + "description": "Possible types are: remoteprocessing, dr", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_12", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/agg-app/aggregation": { + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get raw aggregated data and display applications with the highest utilization for a device", + "operationId": "getPostAggregationAppData", + "requestBody": { + "description": "Query filter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data and fec recovery rate": { + "description": "Aggregation data and fec recovery rate", + "value": { + "data": [ + { + "latency": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/dpi/aggregation": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - DPI": { + "description": "generated by base class - Monitoring - DPI" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - DPI": { + "description": "generated by base class - Monitoring - DPI" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get raw aggregated data and display applications with the highest utilization for a device", + "operationId": "getPostAggregationData", + "requestBody": { + "description": "Query filter", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data and fec recovery rate": { + "description": "Aggregation data and fec recovery rate", + "value": { + "data": [ + { + "latency": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/dpi/applications": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI application flows list in a grid table", + "operationId": "createDPIFlowsGridListQuery", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "limit", + "in": "query", + "description": "Query size (example: 10)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI applications": { + "description": "DPI applications", + "value": { + "header": { + "fields": [ + { + "dataType": "string", + "property": "application" + }, + { + "dataType": "number", + "property": "octets" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_applications", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.clientViewDpiApplication.time", + "title": "view.statistics.clientViewDpiApplication.dpiApplication", + "series": [ + "" + ], + "yAxis": [ + "octets" + ], + "yAxisLabel": "view.statistics.clientViewDpiApplication.count", + "xAxis": [ + "application" + ] + }, + "columns": [ + { + "hideable": false, + "dataType": "string", + "property": "application", + "title": "Application" + }, + { + "hideable": false, + "dataType": "number", + "property": "octets", + "title": "Octets" + } + ], + "generatedOn": 1637722663222 + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/statistics/dpi/applications/summary": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI application flows summary", + "operationId": "createDPISummary", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "limit", + "in": "query", + "description": "Query size", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI application summary": { + "description": "DPI application summary", + "value": { + "header": { + "fields": [ + { + "dataType": "string", + "property": "application" + }, + { + "dataType": "number", + "property": "octets" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_applications", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.clientViewDpiApplication.time", + "title": "view.statistics.clientViewDpiApplication.dpiApplication", + "series": [ + "" + ], + "yAxis": [ + "octets" + ], + "yAxisLabel": "view.statistics.clientViewDpiApplication.count", + "xAxis": [ + "application" + ] + }, + "columns": [ + { + "hideable": false, + "dataType": "string", + "property": "application", + "title": "Application" + }, + { + "hideable": false, + "dataType": "number", + "property": "octets", + "title": "Octets" + } + ], + "generatedOn": 1637722663222 + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/csv": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/device/application/flowcount": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get application flow count per tunnel", + "operationId": "getUniqueFlowCount", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "interval", + "in": "query", + "description": "Interval", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "Application", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "window", + "in": "query", + "description": "Window", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "family", + "in": "query", + "description": "Family", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Application flow count per tunnel": { + "description": "Application flow count per tunnel", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/device/applications": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI flows list", + "operationId": "createDPIDeviceGridData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "limit", + "in": "query", + "description": "Query size", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI flows": { + "description": "DPI flows", + "value": { + "header": { + "fields": [ + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "number", + "property": "octets" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_devices", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.clientViewDpiDevices.time", + "title": "view.statistics.clientViewDpiDevices.dpiDevice", + "series": [ + "" + ], + "yAxis": [ + "octets" + ], + "yAxisLabel": "view.statistics.clientViewDpiDevices.count", + "xAxis": [ + "vdevice_name" + ] + }, + "columns": [ + { + "dataType": "string", + "property": "vdevice_name", + "title": "Devices" + }, + { + "dataType": "number", + "property": "octets", + "title": "Octets" + } + ], + "generatedOn": 1637749963171 + }, + "data": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read" + } + }, + "/statistics/dpi/device/details/applications": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get detailed DPI device and app list", + "operationId": "createDPIDeviceAndAppDetails", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-11-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "DPI device and app list": { + "description": "DPI device and app list", + "value": { + "header": { + "fields": [ + { + "dataType": "number", + "property": "packets" + }, + { + "dataType": "number", + "property": "ip_proto" + } + ], + "viewKeys": { + "preferenceKey": "grid-dpi_devices_detials", + "uniqueKey": [] + }, + "chart": { + "xAxisLabel": "view.statistics.viewDpiDevicesDetails.time", + "title": "view.statistics.viewDpiDevicesDetails.dpiDeviceAppli", + "series": [ + "application", + "vdevice_name" + ], + "yAxis": [ + "octets", + "packets" + ], + "yAxisLabel": "view.statistics.viewDpiDevicesDetails.count", + "xAxis": [ + "entry_time" + ] + }, + "columns": [ + { + "dataType": "numberStr", + "property": "dest_port", + "title": "Destination port" + }, + { + "dataType": "number", + "property": "packets", + "title": "Packets" + } + ], + "generatedOn": 1637749402671 + }, + "data": [], + "pageInfo": { + "count": 0 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/doccount": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get response count of a query", + "operationId": "getCount_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_14", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi/fields": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi/page": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_12", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/pktdup/aggregation": { + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get time series aggregation data for packet duplication for an application over TLOCs if available", + "operationId": "getAggregationDataForPacketDup", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query filter": { + "description": "Query filter", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "1" + ], + "field": "packets", + "type": "number", + "operator": "greater" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "packets", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data rate": { + "description": "Aggregation data rate", + "value": { + "data": [ + { + "packets": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/dpi/query/fields": { + "get": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/dpi/recovery/aggregation": { + "post": { + "tags": [ + "Monitoring - DPI" + ], + "description": "Get aggregation data and fec recovery rate if available", + "operationId": "getAggregationDataDPI", + "requestBody": { + "description": "Query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query string": { + "description": "Query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "1" + ], + "field": "packets", + "type": "number", + "operator": "greater" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "packets", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregation data rate": { + "description": "Aggregation data rate", + "value": { + "data": [ + { + "packets": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/eiolte": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_7", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/eiolte/aggregation": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_7", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/eiolte/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_7", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/eiolte/csv": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/eiolte/doccount": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get response count of a query", + "operationId": "getCount_9", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_9", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/eiolte/fields": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/eiolte/page": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_7", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_7", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/eiolte/query/fields": { + "get": { + "tags": [ + "Monitoring - Cellular-EIOLTE" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/endpointTracker": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + }, + "size": 10000 + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "entry_time": "1623811598645", + "tracker_name": "track1", + "vmanage_system_ip": "172.16.255.15", + "host_name": "vm5", + "vdevice_name": "172.16.255.15", + "device_model": "vedge-CSR-1000v", + "vpn_idx": 2, + "tracker_status": "DOWN", + "rtt_avg": 4, + "rtt_min": 0, + "rtt_max": 42, + "tenant": "default", + "statcycletime": "1623813001149", + "id": "xELMEnoBED2frxv5D_e_" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_18", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/endpointTracker/aggregation": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_17", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/endpointTracker/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_17", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/endpointTracker/csv": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/endpointTracker/doccount": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get response count of a query", + "operationId": "getCount_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_20", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/endpointTracker/fields": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/endpointTracker/page": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_18", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/endpointTracker/query/fields": { + "get": { + "tags": [ + "Monitoring - Endpoint Tracker Status" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/flowlog": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_26", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/flowlog/aggregation": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_26", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/flowlog/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_25", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/flowlog/csv": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/flowlog/doccount": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get response count of a query", + "operationId": "getCount_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_28", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/flowlog/fields": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/flowlog/page": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_26", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/flowlog/query/fields": { + "get": { + "tags": [ + "Monitoring - Flowlog" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/fwall": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_23", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/fwall/aggregation": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_22", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/fwall/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_22", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella Patterns": { + "description": "generated by base class - Monitoring - Umbrella Patterns" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/fwall/csv": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/fwall/doccount": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get response count of a query", + "operationId": "getCount_25", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_25", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/fwall/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/fwall/page": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_23", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/fwall/query/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella Patterns" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_10", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/aggregation": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_10", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/interface/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_10", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Interface Statistics": { + "description": "generated by base class - Monitoring - Interface Statistics" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/interface/ccapacity/distribution": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get bandwidth distribution", + "operationId": "getBandwidthDistribution", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Bandwidth distribution": { + "description": "Bandwidth distribution", + "value": { + "header": { + "fields": [ + { + "dataType": "number", + "property": "min_up_capacity_percentage" + }, + { + "dataType": "number", + "property": "bw_down" + } + ], + "generatedOn": 1635413183137 + }, + "distribution": { + ">100": 0, + "75-100": 0, + "0-25": 30, + "50-75": 0, + "25-50": 0, + "uncategorized": 0 + }, + "data": [ + { + "count": 262, + "avg_up_capacity_percentage": 0.0022625954198473284, + "bw_up": 1000000, + "bw_down": 1000000, + "avg_down_capacity_percentage": 0.0017068702290076335, + "max_down_capacity_percentage": 0.0034, + "range": "0-25", + "min_up_capacity_percentage": 0.0089, + "vdevice_name": "172.16.255.16", + "min_down_capacity_percentage": 0.0034, + "interface": "GigabitEthernet1", + "max_up_capacity_percentage": 0.0089 + }, + { + "count": 262, + "avg_up_capacity_percentage": 0, + "bw_up": 1000000, + "bw_down": 1000000, + "avg_down_capacity_percentage": 0, + "max_down_capacity_percentage": 0, + "range": "0-25", + "min_up_capacity_percentage": 0, + "vdevice_name": "172.16.255.16", + "min_down_capacity_percentage": 0, + "interface": "GigabitEthernet2", + "max_up_capacity_percentage": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/csv": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/doccount": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCount_12", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_12", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface/fields": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface/page": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_10", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_10", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/interface/query/fields": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/interface/type": { + "get": { + "tags": [ + "Monitoring - Interface Statistics" + ], + "description": "Get statistics per interface", + "operationId": "getStatisticsPerInterface", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics per interface": { + "description": "Statistics per interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_20", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_21", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert/aggregation": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_20", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/ipsalert/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_20", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - IPsAlert": { + "description": "generated by base class - Monitoring - IPsAlert" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/ipsalert/csv": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert/doccount": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get response count of a query", + "operationId": "getCount_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_23", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/ipsalert/fields": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/ipsalert/page": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_21", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/ipsalert/query/fields": { + "get": { + "tags": [ + "Monitoring - IPsAlert" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/on-demand/queue": { + "get": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "gets current on-demand queue entries", + "operationId": "getQueueEntries", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue Entries": { + "description": "Queue Entries", + "value": { + "entries": [ + { + "status": "COMPLETED", + "complete": true, + "data_type": "ConnectionEvents", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640765713644, + "value": 48, + "completionTime": 1640765718372, + "end_time": 0, + "startProcessingTime": 1640765717682, + "time_period": "LAST_N_HOURS", + "id": "0a43d31b-fde9-400a-b0ed-319f72115323", + "device_id": "172.16.255.11" + }, + { + "status": "QUEUED", + "complete": false, + "data_type": "DPI", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640764758920, + "value": 24, + "completionTime": 0, + "end_time": 0, + "startProcessingTime": 0, + "time_period": "LAST_N_HOURS", + "id": "93629fed-ec81-4f37-9c85-24b577191c9c", + "device_id": "10.0.1.17" + }, + { + "status": "COMPLETED", + "complete": true, + "data_type": "DPI", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640765915038, + "value": 48, + "completionTime": 1640765918258, + "end_time": 0, + "startProcessingTime": 1640765917678, + "time_period": "LAST_N_HOURS", + "id": "d9111cd6-59ab-482c-bd95-41fdaba9fc5b", + "device_id": "172.16.255.11" + }, + { + "status": "QUEUED", + "complete": false, + "data_type": "ConnectionEvents", + "tenant_id": "default", + "start_time": 0, + "creationTime": 1640767377708, + "value": 24, + "completionTime": 0, + "end_time": 0, + "startProcessingTime": 0, + "time_period": "LAST_N_HOURS", + "id": "544ce0e1-9f57-4266-b789-ed50d043761c", + "device_id": "10.0.1.17" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + }, + "post": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "Create on-demand troubleshooting queue entry", + "operationId": "createQueueEntry", + "requestBody": { + "description": "On-demand queue entry", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "device_id": "10.0.1.17", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "value": 24 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "complete": false, + "creationTime": 1641373054019, + "startProcessingTime": 0, + "completionTime": 0, + "id": "bc4e2dbe-a226-4a01-aa1a-1859978014d3", + "device_id": "169.254.10.10", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "tenant_id": "a200c754-22bc-4a99-b0b9-a2957755e3ba", + "value": 3, + "start_time": 0, + "end_time": 0, + "status": "QUEUED" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/on-demand/queue/properties": { + "get": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "gets current size of on-demand queue", + "operationId": "getQueueProperties", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Queue size is 2": { + "description": "Queue size is 2", + "value": { + "tenant_current_size": 2, + "max_size": 20, + "tenant_max_size": 5 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + } + }, + "/statistics/on-demand/queue/{entryId}": { + "put": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "Updates on-demand troubleshooting queue entry", + "operationId": "updateQueueEntry", + "parameters": [ + { + "name": "entryId", + "in": "path", + "description": "Entry Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "On-demand queue entry", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "device_id": "10.0.1.17", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "value": 24 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "OnDemandQueueEntry": { + "description": "OnDemandQueueEntry", + "value": { + "id": "ac031e7b-9c6e-4375-8589-ad503f9d52d2", + "device_id": "10.0.1.17", + "data_type": "DPI", + "time_period": "LAST_N_HOURS", + "value": 24 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-read,RBAC VPN-write" + }, + "delete": { + "tags": [ + "Monitoring - DPI - On-demand troubleshooting" + ], + "description": "removes on-demand queue entry", + "operationId": "deleteQueueEntry", + "parameters": [ + { + "name": "entryId", + "in": "path", + "description": "Entry Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,RBAC VPN-write" + } + }, + "/statistics/process": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Process stats data", + "operationId": "processStatisticsData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Status": { + "description": "Status", + "value": { + "ActivateDataProcessing": "success" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/process/counters": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get statistics processing counters", + "operationId": "getStatisticsProcessingCounters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Statistics processing counters": { + "description": "Statistics processing counters", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/process/status": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get stats process report", + "operationId": "generateStatsProcessReport", + "parameters": [ + { + "name": "processQueue", + "in": "query", + "description": "Process queue", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Process report": { + "description": "Process report", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/process/thread/status": { + "get": { + "tags": [ + "Monitoring - Stats Processing" + ], + "description": "Get stats process thread report", + "operationId": "generateStatsProcessThreadReport", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Process thread report": { + "description": "Process thread report", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/statistics/qos": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_13", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/qos/aggregation": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_12", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/qos/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_12", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - QoS": { + "description": "generated by base class - Monitoring - QoS" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/qos/csv": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/qos/doccount": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get response count of a query", + "operationId": "getCount_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_15", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/qos/fields": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/qos/page": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_13", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/qos/query/fields": { + "get": { + "tags": [ + "Monitoring - QoS" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/settings/disable/devicelist/{indexName}": { + "get": { + "tags": [ + "Monitoring - Status" + ], + "description": "Get list of disabled devices for a statistics index", + "operationId": "getDisabledDeviceList", + "parameters": [ + { + "name": "indexName", + "in": "path", + "description": "Index name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Disabled device list": { + "description": "Disabled device list", + "value": [ + "172.16.255.14" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read" + }, + "put": { + "tags": [ + "Monitoring - Status" + ], + "description": "Update list of disabled devices for a statistics index", + "operationId": "updateStatisticsDeviceList", + "parameters": [ + { + "name": "indexName", + "in": "path", + "description": "Index name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Disabled device", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Disabled device": { + "description": "Disabled device", + "value": [ + "172.16.255.14" + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update status": { + "description": "Update status", + "value": { + "response": true + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write" + } + }, + "/statistics/settings/status": { + "get": { + "tags": [ + "Monitoring - Status" + ], + "description": "Get statistics settings", + "operationId": "getStatisticsSettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Statistics settings": { + "description": "Statistics settings", + "value": [ + { + "indexName": "approutestatsstatistics", + "status": "enable", + "displayName": "Approute" + }, + { + "indexName": "interfacestatistics", + "status": "enable", + "displayName": "Interface" + }, + { + "indexName": "wlanclientinfostatistics", + "status": "enable", + "displayName": "Wlan Client Info" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read,dca" + }, + "put": { + "tags": [ + "Monitoring - Status" + ], + "description": "Update statistics settings", + "operationId": "updateStatisticsSettings", + "requestBody": { + "description": "Stats setting", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats setting": { + "description": "Stats setting", + "value": [ + { + "indexName": "interfacestatistics", + "status": "enable" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-write,dca" + } + }, + "/statistics/settings/status/device": { + "get": { + "tags": [ + "Monitoring - Status" + ], + "description": "Get list of enabled device for statistics index", + "operationId": "getEnabledIndexForDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Enabled device": { + "description": "Enabled device", + "value": [ + "interfacestatistics", + "eioltestatistics", + "sulstatistics", + "qosstatistics", + "devicesystemstatusstatistics", + "bridgemacstatistics", + "dpistatistics", + "approutestatsstatistics", + "wlanclientinfostatistics", + "flowlogstatistics", + "urlf", + "fwall", + "vnfstatistics", + "umbrella", + "apphostingstatistics", + "utddaqioxstatistics", + "ipsalert", + "aggregatedappsdpistatistics", + "bridgeinterfacestatistics", + "artstatistics", + "trackerstatistics", + "cloudxstatistics" + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Settings-read" + } + }, + "/statistics/speedtest": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_28", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/speedtest/aggregation": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_28", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/speedtest/app-agg/aggregation": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_27", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/speedtest/csv": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/speedtest/doccount": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCount_30", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_30", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/speedtest/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/speedtest/page": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_28", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_28", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/speedtest/query/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get security connection events stats raw data", + "operationId": "getSulStatDataRawData", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "fw_zone_pair": "ulogging_in2out", + "statcycletime": 1616121001459, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616120034778, + "create_time": 1616120009235, + "fw_dst_zone": "ulogging_z_out", + "end_time": 1616120024267, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_src_zone": "ulogging_z_in", + "fw_policy": "p1", + "src_port": 34128, + "start_time": 1616120009235, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "103.235.46.39", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "_dlRSHgBQcANHsKKdbP0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_14", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "fw_zone_pair": "ulogging_in2out", + "statcycletime": 1616121001459, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616120034778, + "create_time": 1616120009235, + "fw_dst_zone": "ulogging_z_out", + "end_time": 1616120024267, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_src_zone": "ulogging_z_in", + "fw_policy": "p1", + "src_port": 34128, + "start_time": 1616120009235, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "103.235.46.39", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "_dlRSHgBQcANHsKKdbP0" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/sul/connections/aggregation": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated each result": { + "description": "Aggregated each result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_13", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "statcycletime": 1616170802027, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616170026992, + "create_time": 1616170001492, + "end_time": 1616170016505, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_policy": "p1", + "src_port": 53105, + "start_time": 1616170001492, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "90.130.70.73", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "uNlJS3gBQcANHsKKW_5s" + } + ], + "pageInfo": { + "startTime": "1615956601540", + "endTime": "1616170802027", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", + "hasMoreData": false, + "count": 14, + "totalCount": 14 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/sul/connections/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_13", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "1" + ], + "operator": "greater" + }, + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Aggregated search result": { + "description": "Aggregated search result", + "value": { + "data": [ + { + "latency": 0.6404125644631974 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/sul/connections/csv": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "168" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "1" + ], + "field": "vpn_id", + "type": "int", + "operator": "in" + }, + { + "value": [ + "p1" + ], + "field": "fw_policy", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/sul/connections/doccount": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get response count of a query", + "operationId": "getCount_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_16", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "24" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections/fields": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections/filter/policy_name/{policyType}": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get filter Policy Name list", + "operationId": "getFilterPolicyNameList", + "parameters": [ + { + "name": "policyType", + "in": "path", + "description": "Policy type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "zoneBasedFW", + "intrusionPrevention", + "urlFiltering", + "advancedMalwareProtection" + ] + } + }, + { + "name": "query", + "in": "query", + "description": "query string", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "field": "vdevice_name", + "type": "string", + "operator": "in", + "value": [ + "172.16.255.15" + ] + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Filter Policy Name list": { + "description": "Filter Policy Name list", + "value": [ + { + "fw_policy": "FW-Block-AV" + }, + { + "fw_policy": "FW-Block-p2p" + }, + { + "fw_policy": "FW_policy1" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/sul/connections/page": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_14", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "168" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "1" + ], + "field": "vpn_id", + "type": "int", + "operator": "in" + }, + { + "value": [ + "p1" + ], + "field": "fw_policy", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "statcycletime": 1616170802027, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616170026992, + "create_time": 1616170001492, + "end_time": 1616170016505, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_policy": "p1", + "src_port": 53105, + "start_time": 1616170001492, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "90.130.70.73", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "uNlJS3gBQcANHsKKW_5s" + } + ], + "pageInfo": { + "startTime": "1615956601540", + "endTime": "1616170802027", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", + "hasMoreData": false, + "count": 14, + "totalCount": 14 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_14", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "168" + ], + "field": "entry_time", + "type": "date", + "operator": "last_n_hours" + }, + { + "value": [ + "1" + ], + "field": "vpn_id", + "type": "int", + "operator": "in" + }, + { + "value": [ + "p1" + ], + "field": "fw_policy", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "vdevice_name", + "type": "string", + "operator": "in" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "ip_proto": 6, + "device_model": "vedge-CSR-1000v", + "egress_intf": "cpu", + "packets": 5, + "src_ip": "10.20.24.1", + "statcycletime": 1616170802027, + "octets": 300, + "sdvt_drop_reason_name": "Service Node not healthy", + "tenant": "default", + "dest_port": 80, + "entry_time": 1616170026992, + "create_time": 1616170001492, + "end_time": 1616170016505, + "fw_action": "Pass", + "vmanage_system_ip": "172.16.255.15", + "fw_policy": "p1", + "src_port": 53105, + "start_time": 1616170001492, + "application": "unknown", + "fw_protocol": "http", + "ingress_intf": "GigabitEthernet5", + "fw_class": "1", + "vdevice_name": "172.16.255.15", + "dest_ip": "90.130.70.73", + "vip_idx": 1, + "family": "network-service", + "host_name": "vm5", + "vpn_id": 1, + "id": "uNlJS3gBQcANHsKKW_5s" + } + ], + "pageInfo": { + "startTime": "1615956601540", + "endTime": "1616170802027", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", + "hasMoreData": false, + "count": 14, + "totalCount": 14 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/sul/connections/query/fields": { + "get": { + "tags": [ + "Monitoring - Security Unified Logging Connection Events" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_15", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_16", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/aggregation": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_15", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/app-agg/aggregation": { + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_15", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/cpu": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get device system CPU stats list", + "operationId": "createDeviceSystemCPUStat", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/csv": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/doccount": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get response count of a query", + "operationId": "getCount_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_18", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/memory": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get device system memory stats list", + "operationId": "createDeviceSystemMemoryStat", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "query", + "description": "Device IP", + "required": true, + "schema": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device system stats": { + "description": "Device system stats", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/page": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_16", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/query/fields": { + "get": { + "tags": [ + "Real-Time Monitoring - Device System Stats" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/stats": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_16", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_17", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/stats/aggregation": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_16", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/stats/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_16", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/system/stats/csv": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/stats/doccount": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get response count of a query", + "operationId": "getCount_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_19", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/stats/fields": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/system/stats/page": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_17", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_17", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/system/stats/query/fields": { + "get": { + "tags": [ + "Monitoring - System Status Stats" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/umbrella": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_23", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_24", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/umbrella/aggregation": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_23", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/umbrella/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_23", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - Umbrella": { + "description": "generated by base class - Monitoring - Umbrella" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/umbrella/csv": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/umbrella/doccount": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get response count of a query", + "operationId": "getCount_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_26", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/umbrella/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/umbrella/page": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_24", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/umbrella/query/fields": { + "get": { + "tags": [ + "Monitoring - Umbrella" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/urlf": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_22", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/urlf/aggregation": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_21", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/urlf/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_21", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Monitoring - URL Filtering": { + "description": "generated by base class - Monitoring - URL Filtering" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/urlf/csv": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/urlf/doccount": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get response count of a query", + "operationId": "getCount_24", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_24", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/urlf/fields": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/urlf/page": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_22", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_22", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/urlf/query/fields": { + "get": { + "tags": [ + "Monitoring - URL Filtering" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/vnfstatistics": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_11", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/vnfstatistics/aggregation": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_11", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/vnfstatistics/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_11", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/vnfstatistics/csv": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/vnfstatistics/doccount": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCount_13", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_13", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/vnfstatistics/fields": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/vnfstatistics/page": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_11", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_11", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/vnfstatistics/query/fields": { + "get": { + "tags": [ + "Monitoring - VNF Interface Statistics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/wlanclientinfo": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_18", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_19", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/wlanclientinfo/aggregation": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_18", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/wlanclientinfo/app-agg/aggregation": { + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_18", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/statistics/wlanclientinfo/csv": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/wlanclientinfo/doccount": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get response count of a query", + "operationId": "getCount_21", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_21", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/wlanclientinfo/fields": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/statistics/wlanclientinfo/page": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_19", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_19", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/statistics/wlanclientinfo/query/fields": { + "get": { + "tags": [ + "Monitoring - Wlan Client Info" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/capture": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSessionInfoCapture", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/disable/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "disablePacketCaptureSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/download/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "downloadFile", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/octet-stream": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/forcedisbale/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "forceStopPcapSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/start/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "startPcapSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/status/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFileDownloadStatus", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/stop/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "stopPcapSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/vnicsInfo/{vnfId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getVnicInfoByVnfId", + "parameters": [ + { + "name": "vnfId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/capture/{deviceUUID}/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "formPostPacketCapture", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "*/*": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSessionInfoLog", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/disable/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "disableDeviceLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/download/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "downloadDebugLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/octet-stream": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/renew/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "renewSessionInfo", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/search/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "searchDeviceLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/sessions": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSessions", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/sessions/clear/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "clearSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/type": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getLogType", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/{logType}/{deviceUUID}/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "streamLog", + "parameters": [ + { + "name": "logType", + "in": "path", + "description": "Log type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceUUID", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sessionId", + "in": "path", + "description": "Session Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/log/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getDeviceLog", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + }, + { + "name": "logId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64", + "default": -1 + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatDataRawData_26", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + }, + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by(emp:entry_time)", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "3g", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.101.2", + "local_color": "lte", + "src_ip": "10.1.14.14", + "sla_class_names": "None", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400056, + "state": "Up", + "local_system_ip": "172.16.255.14", + "tenant": "default", + "entry_time": 1589073792008, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.14", + "fec_rx": 0, + "src_port": 12380, + "jitter": 1, + "remote_system_ip": "172.16.255.11", + "vdevice_name": "172.16.255.14", + "proto": "IPSEC", + "vip_idx": 190, + "dst_port": 12366, + "name": "172.16.255.14:lte-172.16.255.11:3g", + "sla_class_list": "0", + "tunnel_color": "3g:lte", + "host_name": "vm4", + "id": "4OBG_HEB_JLsavezVUfr" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatsRawData_27", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "page size", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "sort by", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "sort order", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2020-05-10T01:00:00 UTC", + "2020-05-10T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + }, + { + "value": [ + "172.16.255.15" + ], + "field": "local_system_ip", + "type": "string", + "operator": "in" + }, + { + "value": [ + "172.16.255.16" + ], + "field": "remote_system_ip", + "type": "string", + "operator": "in" + } + ] + }, + "aggregation": { + "field": [ + { + "property": "name", + "sequence": 1 + }, + { + "property": "proto", + "sequence": 2 + } + ], + "histogram": { + "property": "entry_time", + "type": "minute", + "interval": 30, + "order": "asc" + }, + "metrics": [ + { + "property": "latency", + "type": "avg" + }, + { + "property": "loss", + "type": "avg" + }, + { + "property": "loss_percentage", + "type": "avg" + }, + { + "property": "vqoe_score", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "remote_color": "lte", + "fec_re": 0, + "vqoe_score": 10, + "device_model": "vedge-cloud", + "latency": 1, + "tx_octets": 0, + "dst_ip": "10.0.106.1", + "local_color": "lte", + "src_ip": "10.1.15.15", + "sla_class_names": "test_sla_class", + "loss": 0, + "total": 600, + "tx_pkts": 0, + "fec_tx": 0, + "rx_octets": 0, + "statcycletime": 1589075400052, + "state": "Up", + "local_system_ip": "172.16.255.15", + "tenant": "default", + "entry_time": 1589073783045, + "loss_percentage": 0, + "rx_pkts": 0, + "vmanage_system_ip": "172.16.255.15", + "fec_rx": 0, + "src_port": 12366, + "jitter": 1, + "remote_system_ip": "172.16.255.16", + "vdevice_name": "172.16.255.15", + "proto": "IPSEC", + "vip_idx": 351, + "dst_port": 12386, + "name": "172.16.255.15:lte-172.16.255.16:lte", + "sla_class_list": "0,1", + "tunnel_color": "lte:lte", + "host_name": "vm5", + "id": "IuBG_HEB_JLsavezVkiZ" + } + ], + "pageInfo": { + "startTime": "1589073783045", + "endTime": "1589072535795", + "count": 15 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/aggFlow": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated flow data for NWPI.", + "operationId": "getAggFlow", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "traceState", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/aggregation": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getAggregationDataByQuery_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + }, + "examples": { + "query string": {} + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationDataByQuery_27", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/stream/device/nwpi/app-agg/aggregation": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", + "operationId": "getPostAggregationAppDataByQuery_26", + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "query string": {} + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/stream/device/nwpi/appQosData": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get QoS Application data for NWPI.", + "operationId": "getAppQosData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "receivedTimestamp", + "in": "query", + "description": "received timestamp", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/appQosState": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get QoS Application state to received timestamp mapping for NWPI.", + "operationId": "getAppQosState", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "traceState", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/concurrentData": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get concurrent data for NWPI.", + "operationId": "getConcurrentData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/concurrentDomainData": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get concurrent domain data for NWPI.", + "operationId": "getConcurrentDomainData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/csv": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get raw data with optional query as CSV", + "operationId": "getStatDataRawDataAsCSV_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1000, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ], + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/csv": { + "schema": { + "type": "string" + }, + "examples": { + "Search result in csv format": { + "description": "Search result in csv format", + "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/currentTimestamp": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getCurrentTimestamp", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/doccount": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCount_29", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query", + "required": true, + "schema": { + "type": "string" + }, + "example": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 17193 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get response count of a query", + "operationId": "getCountPost_29", + "requestBody": { + "description": "Query", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query": { + "description": "Query", + "value": { + "query": { + "condition": "AND", + "rules": [ + { + "value": [ + "2021-05-10T01:00:00 UTC", + "2021-11-30T01:30:00 UTC" + ], + "field": "entry_time", + "type": "date", + "operator": "between" + } + ] + }, + "aggregation": { + "metrics": [ + { + "property": "latency", + "type": "avg" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "count": 9642 + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/domainMetric": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getDomainMetric", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "domain", + "in": "query", + "description": "domain name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "firstTimestamp", + "in": "query", + "description": "first timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "lastTimestamp", + "in": "query", + "description": "last timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/eventAppHopList": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Application and HopList for NWPI.", + "operationId": "getEventAppHopList", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "event app hop list": { + "description": "event app hop list", + "value": "{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-hoplist\",\"application\": \"smtp\",\"upHopListInfo\": [[ {\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\"}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\"}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\"}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\"}]]}]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/eventAppScoreBandwidth": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Event Application Performance Score and Bandwidth for NWPI.", + "operationId": "getEventAppScoreBandwidth", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "receivedTimestamp", + "in": "query", + "description": "received timestamp", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "event application score and bandwidth": { + "description": "event application score and bandwidth", + "value": "{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-score-bandwidth\",\"data\": {\"received_timestamp\": 1647581328105,\"detail\": [{\"application\": \"smtp\",\"received_timestamp\":1647581328105,\"upHopListInfo\": [[{\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 249381,\"performanceScore\": 95,\"bandwidth\": 79998}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 683820,\"performanceScore\": 95,\"bandwidth\": 207353.2}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 15690,\"performanceScore\": 95,\"bandwidth\": 5598}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 20775,\"performanceScore\": 95,\"bandwidth\": 5472}]]}]}, \"tenant\":\"default\"}]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/eventFlowFromAppHop": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Event Flow From Application And Hop for NWPI.", + "operationId": "getEventFlowFromAppHop", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "app name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "direction", + "in": "query", + "description": "direction", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "from", + "in": "query", + "description": "from", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "to", + "in": "query", + "description": "to", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceTraceId", + "in": "query", + "description": "deviceTraceId", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "event flow from app and hop": { + "description": "event flow from app and hop", + "value": "{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-flow\",\"data\": {\"app_name\": \"smtp\",\"received_timestamp\": 1647581328105,\"direction\": \"upstream\",\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"intervalActiveFlow\": 7,\"intervalFinFlow\": 7,\"inspectedFlow\": 7,\"qosCongestedFlow\": 0,\"slaViolatedFlow\": 0,\"asymmetryFlow\": 0,\"fifNotClassifiledFlow\": 0,\"pathChangedFlow\": 0,\"policyBypassedFlow\": 0,\"wanAsymmetryFlow\": 0},\"tenant\":\"default\"}]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/eventReadout": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Trace Event Readout for NWPI.", + "operationId": "getEventReadout", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get fields and type", + "operationId": "getStatDataFields_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "example": [ + { + "dataType": "string", + "property": "mac" + }, + { + "dataType": "string", + "property": "vap" + }, + { + "dataType": "number", + "property": "rssi" + }, + { + "dataType": "string", + "property": "mode" + }, + { + "dataType": "number", + "property": "bandwidth" + }, + { + "dataType": "string", + "property": "data_security" + }, + { + "dataType": "number", + "property": "rx_rate" + }, + { + "dataType": "string", + "property": "assoc_time" + }, + { + "dataType": "date", + "property": "entry_time" + }, + { + "dataType": "date", + "property": "statcycletime" + }, + { + "dataType": "string", + "property": "ssid" + }, + { + "dataType": "number", + "property": "vip_idx" + }, + { + "dataType": "date", + "property": "vip_time" + }, + { + "dataType": "string", + "property": "vdevice_name" + }, + { + "dataType": "string", + "property": "host_name" + }, + { + "dataType": "string", + "property": "device_model" + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/finalizedData": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFinalizedData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/finalizedDomainData": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFinalizedDomainData", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/flowDetail": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFlowDetail", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "flowId", + "in": "query", + "description": "flow id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/flowMetric": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getFlowMetric", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "flowId", + "in": "query", + "description": "flow id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "firstTimestamp", + "in": "query", + "description": "first timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "lastTimestamp", + "in": "query", + "description": "last timestamp of xAxis", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/getMonitorState": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getMonitorState", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/monitor/overrideStart": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "CXP Monitor Action - Override Start", + "operationId": "monitorOverrideStart", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Start CXP Monitor": { + "description": "Start CXP Monitor", + "value": { + "source-site": "500", + "duration": "5", + "vpn-id": "1", + "src-ip": "100.0.0.1", + "dst-ip": "200.0.0.1", + "app": "webex", + "src-if": "GigabitEthernet0/1", + "protocol": "1", + "src-port": "8080", + "dst-port": "8443", + "dscp-is-valid": "true", + "dscp": "1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/monitor/start": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "CXP Monitor Action - Start", + "operationId": "monitorStart", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Start CXP Monitor": { + "description": "Start CXP Monitor", + "value": { + "source-site": "500", + "duration": "5", + "vpn-id": "1", + "src-ip": "100.0.0.1", + "dst-ip": "200.0.0.1", + "app": "webex", + "src-if": "GigabitEthernet0/1", + "protocol": "1", + "src-port": "8080", + "dst-port": "8443", + "dscp-is-valid": "true", + "dscp": "1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/monitor/stop": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "CXP Monitor Action - Stop", + "operationId": "monitorStop", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stop CXP Monitor": { + "description": "Stop CXP Monitor", + "value": { + "source-site": "500", + "duration": "5", + "vpn-id": "1", + "src-ip": "100.0.0.1", + "dst-ip": "200.0.0.1", + "app": "webex", + "src-if": "GigabitEthernet0/1", + "protocol": "1", + "src-port": "8080", + "dst-port": "8443", + "dscp-is-valid": "true", + "dscp": "1" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/nwpiDSCP": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getNwpiDscp", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/nwpiNbarAppGroup": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getNwpiNbarAppGroup", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/nwpiProtocol": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getNwpiProtocol", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/packetFeatures": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getPacketFeatures", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "flowId", + "in": "query", + "description": "flow id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/page": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getStatBulkRawData_27", + "parameters": [ + { + "name": "query", + "in": "query", + "description": "Query string", + "schema": { + "type": "string" + }, + "example": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + }, + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + }, + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get stats raw data", + "operationId": "getPostStatBulkRawData_27", + "parameters": [ + { + "name": "scrollId", + "in": "query", + "description": "ES scroll Id", + "schema": { + "type": "string" + }, + "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" + }, + { + "name": "count", + "in": "query", + "description": "Result size", + "schema": { + "type": "string" + }, + "example": 10 + } + ], + "requestBody": { + "description": "Stats query string", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Stats query string": { + "description": "Stats query string", + "value": { + "query": { + "field": "latency", + "type": "long", + "value": [ + "100" + ], + "operator": "greater" + }, + "size": 1, + "sort": [ + { + "field": "latency", + "type": "long", + "order": "asc" + } + ], + "fields": [ + "latency" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Search result": { + "description": "Search result", + "value": { + "data": [ + { + "mem_used": 19407626240, + "disk_avail": 9305948160, + "device_model": "vmanage", + "mem_cached": 6740430848, + "mem_util": 0.59, + "min1_avg": 0.92, + "disk_used": 5789007872, + "statcycletime": 1647394800045, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393870251, + "runningp": 0, + "cpu_user": 8.63, + "cpu_idle_new": 88.14, + "vip_time": 1647393870252, + "min15_avg": 1.08, + "totalp": 2427, + "cpu_idle": 88.14, + "mem_buffers": 892911616, + "cpu_system": 3.23, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.07, + "cpu_min1_avg": 0.115, + "mem_free": 5716930560, + "vdevice_name": "172.16.255.201", + "vip_idx": 82, + "cpu_min15_avg": 0.135, + "system_ip": "172.16.255.201", + "cpu_user_new": 8.63, + "cpu_system_new": 3.23, + "host_name": "vm201", + "cpu_min5_avg": 0.13375, + "id": "4YphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19433402368, + "disk_avail": 9305391104, + "device_model": "vmanage", + "mem_cached": 6743166976, + "mem_util": 0.59, + "min1_avg": 1.02, + "disk_used": 5789564928, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393930306, + "runningp": 0, + "cpu_user": 7.18, + "cpu_idle_new": 89.78, + "vip_time": 1647393930306, + "min15_avg": 1.07, + "totalp": 2323, + "cpu_idle": 89.78, + "mem_buffers": 895946752, + "cpu_system": 3.04, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.06, + "cpu_min1_avg": 0.1275, + "mem_free": 5685383168, + "vdevice_name": "172.16.255.201", + "vip_idx": 83, + "cpu_min15_avg": 0.13375, + "system_ip": "172.16.255.201", + "cpu_user_new": 7.18, + "cpu_system_new": 3.04, + "host_name": "vm201", + "cpu_min5_avg": 0.1325, + "id": "4ophkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19544223744, + "disk_avail": 9304797184, + "device_model": "vmanage", + "mem_cached": 6744907776, + "mem_util": 0.6, + "min1_avg": 1.56, + "disk_used": 5790158848, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647393990365, + "runningp": 0, + "cpu_user": 19.58, + "cpu_idle_new": 75.25, + "vip_time": 1647393990365, + "min15_avg": 1.11, + "totalp": 2324, + "cpu_idle": 75.25, + "mem_buffers": 897961984, + "cpu_system": 5.17, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.19, + "cpu_min1_avg": 0.195, + "mem_free": 5570805760, + "vdevice_name": "172.16.255.201", + "vip_idx": 84, + "cpu_min15_avg": 0.13875, + "system_ip": "172.16.255.201", + "cpu_user_new": 19.58, + "cpu_system_new": 5.17, + "host_name": "vm201", + "cpu_min5_avg": 0.14875, + "id": "44phkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19527507968, + "disk_avail": 9304543232, + "device_model": "vmanage", + "mem_cached": 6746238976, + "mem_util": 0.6, + "min1_avg": 1.11, + "disk_used": 5790412800, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394050422, + "runningp": 0, + "cpu_user": 5.18, + "cpu_idle_new": 92.16, + "vip_time": 1647394050422, + "min15_avg": 1.09, + "totalp": 2331, + "cpu_idle": 92.16, + "mem_buffers": 899567616, + "cpu_system": 2.66, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.12, + "cpu_min1_avg": 0.13875, + "mem_free": 5584584704, + "vdevice_name": "172.16.255.201", + "vip_idx": 85, + "cpu_min15_avg": 0.13625, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.18, + "cpu_system_new": 2.66, + "host_name": "vm201", + "cpu_min5_avg": 0.14, + "id": "5IphkH8BPIGvVbrdtzXi" + }, + { + "mem_used": 19534016512, + "disk_avail": 9304268800, + "device_model": "vmanage", + "mem_cached": 6747897856, + "mem_util": 0.6, + "min1_avg": 1.14, + "disk_used": 5790687232, + "statcycletime": 1647394800046, + "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", + "entry_time": 1647394110479, + "runningp": 0, + "cpu_user": 5.53, + "cpu_idle_new": 91.49, + "vip_time": 1647394110479, + "min15_avg": 1.1, + "totalp": 2323, + "cpu_idle": 91.49, + "mem_buffers": 902213632, + "cpu_system": 2.97, + "vmanage_system_ip": "169.254.10.2", + "min5_avg": 1.14, + "cpu_min1_avg": 0.1425, + "mem_free": 5573771264, + "vdevice_name": "172.16.255.201", + "vip_idx": 86, + "cpu_min15_avg": 0.1375, + "system_ip": "172.16.255.201", + "cpu_user_new": 5.53, + "cpu_system_new": 2.97, + "host_name": "vm201", + "cpu_min5_avg": 0.1425, + "id": "5YphkH8BPIGvVbrdtzXi" + } + ], + "pageInfo": { + "startTime": "1647394800045", + "endTime": "1647394800047", + "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10", + "hasMoreData": true, + "count": 5, + "totalCount": 11140 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/preloadinfo": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getPreloadInfo", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/query/fields": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get query fields", + "operationId": "getStatQueryFields_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Query result count": { + "description": "Query result count", + "value": { + "data": [ + { + "property": "entry_time", + "name": "Event Time", + "isRequired": true, + "dataType": "date", + "fieldData": { + "type": "dateList" + }, + "options": [ + { + "key": "last_1_hour", + "value": "Last 1 hour", + "number": "1", + "enableDateFields": false + }, + { + "key": "last_3_hours", + "value": "Last 3 hours", + "number": "3", + "enableDateFields": false + }, + { + "key": "last_6_hours", + "value": "Last 6 hours", + "number": "6", + "enableDateFields": false + }, + { + "key": "last_12_hours", + "value": "Last 12 hours", + "number": "12", + "enableDateFields": false + }, + { + "key": "last_24_hours", + "value": "Last 24 hours", + "number": "24", + "enableDateFields": false, + "isSelected": true + }, + { + "key": "last_168_hours", + "value": "Last 7 days", + "number": "168", + "enableDateFields": false + }, + { + "key": "custom", + "value": "Custom", + "enableDateFields": true + } + ] + }, + { + "property": "vdevice_name", + "name": "Device name", + "isRequired": true, + "multiSelect": false, + "dataType": "string" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/stream/device/nwpi/routingDetail": { + "get": { + "tags": [ + "NWPI", + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get Routing Details for NWPI.", + "operationId": "getRoutingDetailFromLocal", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "traceState", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "routePrefixs", + "in": "query", + "description": "route prefixs", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access list associations": { + "description": "Access list associations", + "value": { + "upstream": [ + { + "hostname": "Site20-cEdge-1", + "system_ip": "4.4.4.2", + "route": "119.0.0.0/8", + "route_preference": 1, + "metric": 0, + "next_hop": { + "outgoing_interface": "NULL0", + "next_hop_address": "168.19.1.200" + }, + "source_protocol": "static", + "last_update_time": 1646093417790 + } + ], + "downstream": [ + { + "hostname": "Site20-cEdge-2", + "system_ip": "4.4.4.3", + "route": "10.20.25.0/24", + "route_preference": 1, + "metric": 0, + "next_hop": { + "outgoing_interface": "NULL0", + "next_hop_address": "168.19.1.201" + }, + "source_protocol": "static", + "last_update_time": 1646093417790 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Routing-read,Routing-write" + } + }, + "/stream/device/nwpi/trace/delete": { + "delete": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Trace Action - Delete", + "operationId": "traceDelete", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/trace/record/{deviceUUID}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "post flow data", + "operationId": "nwpiPostFlowData", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,vmanage-http-stream" + } + }, + "/stream/device/nwpi/trace/start": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Trace Action - Start", + "operationId": "traceStart", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Start Flow Monitor trace": { + "description": "Start Flow Monitor trace", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_1", + "device-list": [ + { + "local-system-ip": "172.16.255.16", + "deviceId": "172.16.255.16", + "uuid": "C8K-25e26fb8-e692-4b24-bf10-1da949728c41", + "version": "17.07.01.0.144090" + }, + { + "local-system-ip": "172.16.255.15", + "deviceId": "172.16.255.15", + "uuid": "C8K-bea08f58-91b6-498a-86f3-9b74646c318b", + "version": "17.04.01.0.144091" + } + ], + "app": [ + "webex-meeting", + "ms-office-365" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000", + "source-site-version": "17.04.01.0.144091", + "warning": " " + } + }, + "Start Flow Monitor trace for a specific device": { + "description": "Start Flow Monitor trace for a specific device", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_2", + "device-ip": "172.16.255.16", + "device-list": [ + { + "local-system-ip": "172.16.255.16", + "deviceId": "172.16.255.16", + "uuid": "C8K-25e26fb8-e692-4b24-bf10-1da949728c41", + "version": "17.07.01.0.144090" + } + ], + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000", + "source-site-version": "17.07.01.0.144090", + "warning": " " + } + }, + "Start Domain Monitor trace": { + "description": "Start Domain Monitor trace", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_3", + "device-list": [ + { + "local-system-ip": "172.16.255.16", + "deviceId": "172.16.255.16", + "uuid": "C8K-25e26fb8-e692-4b24-bf10-1da949728c41", + "version": "17.07.01.0.144090" + }, + { + "local-system-ip": "172.16.255.14", + "deviceId": "172.16.255.14", + "uuid": "C8K-0ea91298-f8db-41e4-a167-e7af0461ed81", + "version": "17.06.01.0.144092" + } + ], + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "client-ip": "100.0.0.0/8", + "domain-mon": "true", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000", + "source-site-version": "17.06", + "warning": " " + } + }, + "Start Flow Monitor trace (without vManage UI)": { + "description": "Start Flow Monitor trace (without vManage UI)", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_4", + "app": [ + "webex-meeting", + "ms-office-365" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000" + } + }, + "Start Flow Monitor trace for a specific device (without vManage UI)": { + "description": "Start Flow Monitor trace for a specific device (without vManage UI)", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_5", + "device-ip": "172.16.255.16", + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "src-pfx": "100.0.0.0/8", + "dst-pfx": "200.0.0.0/8", + "src-if": "GigabitEthernet5", + "protocol": "6", + "dscp": "1", + "src-port": "8080", + "dst-port": "8443", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000" + } + }, + "Start Domain Monitor trace (without vManage UI)": { + "description": "Start Domain Monitor trace (without vManage UI)", + "value": { + "source-site": "600", + "vpn-id": "1", + "duration": "60", + "trace-name": "trace_6", + "app-grp": [ + "google-group", + "ms-cloud-group" + ], + "client-ip": "100.0.0.0/8", + "domain-mon": "true", + "art-vis": "true", + "app-vis": "true", + "dia-vis": "true", + "hub-wan-vis": "true", + "sampling": "true", + "spl-intvl": "60000" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/trace/stop/{traceId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Trace Action - Stop", + "operationId": "traceStop", + "parameters": [ + { + "name": "traceId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFinFlowCount": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Retrieve total Fin Flow counts", + "operationId": "getFinalizedFlowCount", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Finalized flow count": { + "description": "Finalized flow count", + "value": { + "total_flow_count": "10000" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFinFlowTimeRange": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Retrieve Fin Flow time range", + "operationId": "getFinFlowTimeRange", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Finalized flow time range": { + "description": "Finalized flow time range", + "value": [ + { + "start_time": "1651543925251", + "end_time": "1651545413468" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFinFlowWithQuery": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Retrieve Certain Fin Flows", + "operationId": "traceFinFlowWithQuery", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "query", + "in": "query", + "description": "Query filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Severity histogram": { + "description": "Severity histogram", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/nwpi/traceFlow": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getTraceFlow", + "parameters": [ + { + "name": "traceId", + "in": "query", + "description": "trace id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "timestamp", + "in": "query", + "description": "start time", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "state", + "in": "query", + "description": "trace state", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + } + } + }, + "/stream/device/nwpi/traceHistory": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getTraceHistory", + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSession", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/disable/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "disableSpeedTestSession", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/interface/bandwidth": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getInterfaceBandwidth", + "parameters": [ + { + "name": "circuit", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceUUID", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceUuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/start/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "startSpeedTest", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/status/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSpeedTestStatus", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/stop/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "stopSpeedTest", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/{deviceUUID}/{sessionId}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "saveSpeedTestResults", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "*/*": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/speed/{sessionId}": { + "get": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "operationId": "getSpeedTest", + "parameters": [ + { + "name": "sessionId", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Uuid" + } + }, + { + "name": "logId", + "in": "query", + "schema": { + "type": "integer", + "format": "int64", + "default": 0 + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "x-roles-required": "default" + } + }, + "/stream/device/status/{deviceUUID}": { + "post": { + "tags": [ + "Troubleshooting Tools - Diagnostics" + ], + "description": "Get device status stream", + "operationId": "processDeviceStatus", + "parameters": [ + { + "name": "deviceUUID", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "*/*": {} + } + } + }, + "x-roles-required": "vmanage-http-stream" + } + }, + "/system/device": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create new device


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createDevice", + "requestBody": { + "description": "Create device request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/device/{uuid}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create vEdge device config", + "operationId": "generateBootstrapConfigForVedge", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configtype", + "in": "query", + "description": "Device config type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "inclDefRootCert", + "in": "query", + "description": "Include default root certs flag", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "version", + "in": "query", + "description": "cloud-init format version", + "schema": { + "type": "string", + "default": "v1" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": { + "bootstrapConfig": "#cloud-config\nvinitparam:\n - otp : 7f162ca042174e37ae8a633ce7b08d4a\n - vbond : 10.0.12.26\n - uuid : 71001c48-fdcf-4ac0-aaf3-ca4a20386a18\n - org : vIPtela Inc Regression\n" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/devices": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create bootstrap config for software vEdges", + "operationId": "generateBootstrapConfigForVedges", + "requestBody": { + "description": "Device bootstrap type and id", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap config type and id": { + "description": "Device bootstrap config type and id", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/download/{id}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Download vEdge device config", + "operationId": "getBootstrapConfigZip", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Bootstrap config id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/bootstrap/generic/devices": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Create bootstrap config for software vEdges", + "operationId": "generateGenericBootstrapConfigForVedges", + "parameters": [ + { + "name": "wanif", + "in": "query", + "description": "Device WAN interface", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device bootstrap configuration": { + "description": "Device bootstrap configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/claimDevices": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Claim the selected unclaimed devices", + "operationId": "claimDevices", + "requestBody": { + "description": "Claim device request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Claim device request": { + "description": "Claim device request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Claimed device info": { + "description": "Claimed device info", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Colocation-write" + } + }, + "/system/device/controllers/vedge/status": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get controllers vEdge sync status", + "operationId": "getControllerVEdgeSyncStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vEdge status": { + "description": "vEdge status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/decommission/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Decomission vEdge device", + "operationId": "decommissionVedgeCloud", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task id": { + "description": "Task id", + "value": { + "id": "4279226e-162e-4df0-a174-73215c5d839f" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/devicesWithoutSubjectSudi": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "retrieve devices without subject sudi", + "operationId": "devicesWithoutSubjectSudi", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/system/device/fileupload": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Upload file to vEdge", + "operationId": "formPost", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/generate-payg": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Authenticate vSmart user account", + "operationId": "validateUser_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access token": { + "description": "Access token", + "value": "{accessToken: }" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/lifecycle/management/{uuid}": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Set device lifecycle needed flag", + "operationId": "setLifeCycle", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "enable", + "in": "query", + "description": "lifecycle needed flag", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device lifecycle needed value": { + "description": "Device lifecycle needed value", + "value": true + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/management/systemip": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get management system IP mapping", + "operationId": "getManagementSystemIPInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "System IP mapping": { + "description": "System IP mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/migrateDevice/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Migrate device software to vedge/cedge", + "operationId": "migrateDevice", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device migration result": { + "description": "Device migration result", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/reset/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Reset vEdge device", + "operationId": "resetVedgeCloud", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task id": { + "description": "Task id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/rma/candidates/{deviceType}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get RMA candidates by device type", + "operationId": "getRMACandidates", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device Type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vsmart" + ] + } + }, + { + "name": "uuid", + "in": "query", + "description": "Excluded currently selected uuid", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device type": { + "description": "Device type", + "value": "[\"data\": [\n {\n \"uuid\": \"347eca1b-a0ae-42be-92d1-4702b5285aae\",\n \"deviceIP\": \"8.8.8.8\",\n \"validity\": \"valid\",\n \"managementSystemIP\": \"169.254.0.1\"\n \"host-name\": \"vm130\"\n }\n\"]\"]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/rootcertchain/status": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get controllers vEdge sync status", + "operationId": "getRootCertStatusAll", + "parameters": [ + { + "name": "state", + "in": "query", + "description": "Root certificate state", + "required": true, + "schema": { + "type": "string", + "enum": [ + "pending", + "done" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vEdge sync status": { + "description": "vEdge sync status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/system/device/selfsignedcert/iscreated": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Whether self signed certificate created", + "operationId": "checkSelfSignedCert", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Self signed certificate created": { + "description": "Self signed certificate created", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/smartaccount/authenticate": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Authenticate vSmart user account", + "operationId": "validateUser", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartAccountModel" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Access token": { + "description": "Access token", + "value": "{accessToken: }" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/smartaccount/sync": { + "post": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Sync devices from Smart-Account", + "operationId": "syncDevices", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartAccountModel" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/device/sync/rootcertchain": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Sync root certificate", + "operationId": "syncRootCertChain", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/tenant/management/systemip": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get management system IP


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantManagementSystemIPs", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "System IP": { + "description": "System IP", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/type/{deviceCategory}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get devices details", + "operationId": "getCloudDockDataBasedOnDeviceType", + "parameters": [ + { + "name": "deviceCategory", + "in": "path", + "description": "Device category", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedges", + "controllers" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device info": { + "description": "Device info", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/type/{deviceCategory}/defaultConfig": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get devices default config", + "operationId": "getCloudDockDefaultConfigBasedOnDeviceType", + "parameters": [ + { + "name": "deviceCategory", + "in": "path", + "description": "Device category", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedges", + "controllers" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device default config": { + "description": "Device default config", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/unclaimedDevices": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get list of all unclaimed devices", + "operationId": "getAllUnclaimedDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device info": { + "description": "Device info", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/updateDeviceSubjectSUDI/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "update subject sudi value of given device uuid", + "operationId": "updateDeviceSubjectSUDI", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/system/device/vmanagerootca/{uuid}": { + "delete": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Invalidate vManage root CA", + "operationId": "invalidateVmanageRootCA", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/system/device/{deviceCategory}": { + "get": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart.\nWhen {deviceCategory = vedges}, it returns all available vEdge routers", + "operationId": "getDevicesDetails", + "parameters": [ + { + "name": "deviceCategory", + "in": "path", + "description": "Device category", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "model", + "in": "query", + "description": "Device model", + "schema": { + "type": "string", + "enum": [ + "vedge-cloud", + "vedge-1000", + "vedge-2000", + "vedge-100", + "vedge-ISR1100-4G", + "vedge-ISR1100-4GLTE", + "vedge-ISR1100X-4G", + "vedge-ISR1100-6G", + "vedge-ISR1100X-6G", + "vedge-100-B", + "vedge-100-WM", + "vedge-100-M", + "vEdge-5000", + "vedge-CSR-1000v", + "vedge-IR-1101", + "vedge-IR-1821", + "vedge-IR-1831", + "vedge-IR-1833", + "vedge-IR-1835", + "vedge-IR-8140H", + "vedge-IR8140H-P", + "vedge-IR-8340", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-IR-1101", + "vedge-ESR-6300", + "vedge-ISR-4331", + "vedge-ISR-4321", + "vedge-ISR-4351", + "vedge-ISR-4221", + "vedge-ISR-4221X", + "vedge-ISR-4431", + "vedge-ISR-4451-X", + "vedge-ASR-1001-HX", + "vedge-ASR-1002-X", + "vedge-ASR-1002-HX", + "vedge-ASR-1006-X", + "vedge-C1111-8P", + "vedge-C1121X-8P", + "vedge-C1111X-8P", + "vedge-C1111-8PLTELAW", + "vedge-C1111-8PLTEEA", + "vedge-C1121-8PLTEPW", + "vedge-C1111-8PLTELA", + "vedge-C1117-4PLTEEA", + "vedge-C1126X-8PLTEP", + "vedge-C1127X-8PLTEP", + "vedge-C1127X-8PMLTEP", + "vedge-C1127-8PMLTEP", + "vedge-C1117-4PLTELA", + "vedge-ISRv", + "vedge-C8000V", + "vedge-ASR-1001-X", + "vedge-C1111-4P", + "vedge-C1101-4P", + "vedge-C1101-4PLTEP", + "vedge-C8500-12X4QC", + "vedge-C8500-12X", + "vedge-C8500L-8S4X", + "vedge-C1111-8PW", + "vedge-C1111-8PLTEEAW", + "vedge-C1111-4PLTEEA", + "vedge-C1101-4PLTEPW", + "vedge-C1109-4PLTE2PW", + "vedge-C1109-4PLTE2P", + "vedge-C1121X-8PLTEP", + "vedge-C1161X-8PLTEP", + "vedge-C1113-8PMLTEEA", + "vedge-C1111-4PLTELA,vedge-C1116-4P", + "vedge-C1116-4PLTEEA", + "vedge-C1117-4P", + "vedge-C1117-4PM", + "vedge-C1117-4PMLTEEA", + "vsmart", + "vmanage", + "vbond", + "vedge-ISR-4461", + "vedge-C8300-1N1S-4T2X", + "vedge-C8300-1N1S-6T", + "vedge-C1161X-8P", + "vedge-C8300-2N2S-4T2X", + "vedge-C8300-2N2S-6T", + "vedge-C8200-1N-4T", + "vedge-C8200L-1N-4T", + "vedge-C1161-8P", + "vedge-C1126-8PLTEP", + "vedge-C1127-8PLTEP", + "vedge-C1121-4P", + "vedge-C1121-4PLTEP", + "vedge-C1128-8PLTEP", + "vedge-C1121X-8PLTEPW", + "vedge-C1121-8PLTEP", + "vedge-C1121-8P", + "vedge-C1161-8PLTEP", + "vedge-C1113-8PLTEEA", + "vedge-C1131-8PW", + "vedge-C1131X-8PW", + "vedge-C1131-8PLTEPW", + "vedge-C1131X-8PLTEPW", + "vedge-C1113-8PLTEW", + "vedge-C1111-4PW", + "vedge-C1112-8P", + "vedge-C1112-8PLTEEA", + "vedge-C1112-8PLTEEAWE", + "vedge-C1112-8PWE", + "vedge-C1113-8P", + "vedge-C1113-8PLTEEAW", + "vedge-C1113-8PLTELA", + "vedge-C1113-8PLTELAWZ", + "vedge-C1113-8PM", + "vedge-C1113-8PMWE", + "vedge-C1113-8PW", + "vedge-C1116-4PLTEEAWE", + "vedge-C1116-4PWE", + "vedge-C1117-4PLTEEAW", + "vedge-C1117-4PLTELAWZ", + "vedge-C1117-4PMLTEEAWE", + "vedge-C1117-4PMWE", + "vedge-C1117-4PW", + "vedge-C1118-8P", + "vedge-C1109-2PLTEGB", + "vedge-C1109-2PLTEUS", + "vedge-C1109-2PLTEVZ" + ] + } + }, + { + "name": "state", + "in": "query", + "description": "List of states", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CertificateStates" + }, + "enum": [ + "tokengenerated", + "bootstrapconfiggenerated", + "csrgenerated", + "csrfailed", + "certinstalled", + "certinstallfailed" + ] + } + }, + { + "name": "uuid", + "in": "query", + "description": "List of device uuid", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUuid" + } + } + }, + { + "name": "deviceIP", + "in": "query", + "description": "List of device system IP", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + }, + { + "name": "validity", + "in": "query", + "description": "List of device validity", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CertificateValidity" + }, + "enum": [ + "valid", + "invalid", + "staging" + ] + } + }, + { + "name": "family", + "in": "query", + "description": "The platform family to filter for", + "schema": { + "type": "string", + "enum": [ + "aon", + "cedge" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default,dca" + } + }, + "/system/device/{uuid}": { + "put": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Edit device", + "operationId": "editDevice", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device config": { + "description": "Device config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + }, + "delete": { + "tags": [ + "Configuration - Device Inventory" + ], + "description": "Delete vEdges", + "operationId": "deleteDevice", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write" + } + }, + "/system/reverseproxy/{uuid}": { + "get": { + "tags": [ + "System - Reverse Proxy" + ], + "description": "Get reverse proxy IP/Port mappings for controller", + "operationId": "getReverseProxyMappings", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reverse proxy mappings": { + "description": "Device reverse proxy mappings", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "System - Reverse Proxy" + ], + "description": "Create reverse proxy IP/Port mappings for controller", + "operationId": "createReverseProxyMappings", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Device reverse proxy mappings", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device reverse proxy mappings": { + "description": "Device reverse proxy mappings", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag": { + "get": { + "tags": [ + "Tag" + ], + "description": "Get all tags", + "operationId": "getTag", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagRestfulResource" + } + }, + "examples": { + "Group": { + "description": "Group", + "value": [ + { + "name": "US - West coast", + "id": "1" + }, + { + "name": "US - East coast", + "id": "2" + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Tag" + ], + "description": "Create a tag", + "operationId": "createTag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "create or associate tag": { + "description": "create or associate tag", + "value": { + "associate": [ + { + "deviceId": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "tagList": [ + { + "name": "PR_Tag1", + "tagId": "a4f6ed92-31b9-4f4c-8f6d-30257916b912", + "tagType": "device" + } + ], + "devicesAdded": [ + { + "configGroupName": "PR_Tagging", + "configGroupId": "34787e8e-7b4e-4b1e-829a-a0e5452da54e", + "@rid": 1250, + "tagId": "0bacc10d-384d-4d0a-9c4e-272eb1b45c05", + "values": "[\"PR_Tag1\"]", + "rule": "equal", + "deviceAttribute": "tags" + } + ] + } + ], + "create": [] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": "{\"C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5\":{\"configGroupId\":\"34787e8e-7b4e-4b1e-829a-a0e5452da54e\",\"configGroupName\":\"PR_Tagging\u201d}}\n" + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/checkRules": { + "post": { + "tags": [ + "Tag" + ], + "description": "This API will check if a rule can be created or not", + "operationId": "checkRules", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Config Group": { + "description": "Config Group", + "value": "{\"configGroupId\":\"34787e8e-7b4e-4b1e-829a-a0e5452da54e\",\"deviceAttribute\":\"tags\",\"rule\":\"equal\",\"values\":[\"PR_Tag1\"],\"tagId\":\u201d\"}\n" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": { + "devices": [ + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "serialNumber": "12345711", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.14", + "configuredSiteId": "", + "deploymentStatus": "" + }, + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-363f3468-d0ac-469d-ad53-e47c8ada5a0e", + "serialNumber": "12345712", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.15", + "configuredSiteId": "", + "deploymentStatus": "" + } + ], + "isConflict": false + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/conflictCheck": { + "post": { + "tags": [ + "Tag" + ], + "description": "Check for conflicts when tagging", + "operationId": "check for conflicts when tagging", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "conflict check": { + "description": "conflict check", + "value": { + "associate": [ + { + "deviceId": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "deviceModel": "vedge-C8000V", + "tagList": [ + { + "name": "PR_Tag1", + "tagId": "a4f6ed92-31b9-4f4c-8f6d-30257916b912", + "tagType": "device" + } + ] + } + ], + "create": [] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": [ + { + "deviceId": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "devicesAdded": [ + { + "configGroupName": "PR_Tagging", + "configGroupId": "34787e8e-7b4e-4b1e-829a-a0e5452da54e", + "@rid": 1250, + "tagId": "0bacc10d-384d-4d0a-9c4e-272eb1b45c05", + "values": "[\"PR_Tag1\"]", + "rule": "equal", + "deviceAttribute": "tags" + } + ] + } + ] + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/reindex": { + "get": { + "tags": [ + "Tag" + ], + "description": "Re-index device tags for search. Only call this API very occasionally if tag search is not returning expected results.", + "operationId": "reindexTag", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/remove": { + "post": { + "tags": [ + "Tag" + ], + "description": "Deletes multiple tags", + "operationId": "deleteTag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/tagRules": { + "put": { + "tags": [ + "Tag" + ], + "description": "Edit a tag rule", + "operationId": "editTagRule", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Tag" + ], + "description": "Create a tag rule", + "operationId": "createTagRule", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tag Rule Creation": { + "description": "Tag Rule Creation", + "value": { + "configGroupId": "34787e8e-7b4e-4b1e-829a-a0e5452da54e", + "deviceAttribute": "tags", + "rule": "equal", + "values": [ + "PR_Tag1" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": { + "devices": [ + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-32da1457-0ca0-45ee-a89d-efe1056b65d5", + "serialNumber": "12345711", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.14", + "configuredSiteId": "", + "deploymentStatus": "" + }, + { + "deviceModel": "vedge-C8000V", + "chassisNumber": "C8K-363f3468-d0ac-469d-ad53-e47c8ada5a0e", + "serialNumber": "12345712", + "tags": [ + "PR_Tag1" + ], + "configuredSystemIP": "172.16.255.15", + "configuredSiteId": "", + "deploymentStatus": "" + } + ], + "isConflict": false + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/tagRules/{configGroupId}": { + "get": { + "tags": [ + "Tag" + ], + "description": "Get tag rules", + "operationId": "getTagRules", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "ConfigGroup Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/tag/tagRules/{tagRuleId}": { + "delete": { + "tags": [ + "Tag" + ], + "description": "Delete a tag rule", + "operationId": "deleteTagRule", + "parameters": [ + { + "name": "tagRuleId", + "in": "path", + "description": "tagRule Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configGroupId", + "in": "query", + "description": "ConfigGroup Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/cloudx": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get CloudX feature list", + "operationId": "getCloudXStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX status": { + "description": "CloudX status", + "value": { + "data": [ + { + "appType": "amazon_aws", + "longName": "Amazon AWS", + "totalSites": 2, + "goodSites": 0, + "badSites": 0, + "averageSites": 0 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read" + } + }, + "/template/cloudx/addcloudx/{type}": { + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Add cloudx gateway", + "operationId": "addCloudxType", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Cloudx type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cloudx", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx": { + "description": "Cloudx" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/cloudx/attachedclient": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get attached client site list", + "operationId": "getAttachedClientList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX attached client site": { + "description": "CloudX attached client site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/attacheddia": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get attached Dia site list", + "operationId": "getAttachedDiaList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX attached Dia site": { + "description": "CloudX attached Dia site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/attachedgateway": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get attached gateway list", + "operationId": "getAttachedGatewayList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX attached gateway": { + "description": "CloudX attached gateway", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/availableapps": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get CloudX available apps list", + "operationId": "getCloudXAvailableApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX app list": { + "description": "CloudX app list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read" + } + }, + "/template/cloudx/clientlist": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get site list", + "operationId": "getSiteList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX site": { + "description": "CloudX site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/dialist": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get Dia site list", + "operationId": "getDiaList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX Dia site": { + "description": "CloudX Dia site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/gatewaylist": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get gateway list", + "operationId": "getGatewayList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX gateway": { + "description": "CloudX gateway", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/interfaces": { + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Enable cloudx gateway", + "operationId": "addCloudxInterfaces", + "requestBody": { + "description": "Cloudx", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx": { + "description": "Cloudx" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/cloudx/manage/apps": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get apps and vpns", + "operationId": "getApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + }, + "put": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Edit apps and vpns", + "operationId": "editApps", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx apps and vpns": { + "description": "Cloudx apps and vpns", + "value": { + "appList": [ + { + "appType": "amazon_aws", + "longName": "Amazon AWS", + "appVpnList": "1,10" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Change required": { + "description": "Change required", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Add apps and vpns", + "operationId": "addApps", + "requestBody": { + "description": "Cloudx apps and vpns", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloudx apps and vpns": { + "description": "Cloudx apps and vpns", + "value": { + "appList": [ + { + "appType": "amazon_aws", + "longName": "Amazon AWS", + "appVpnList": "1,5" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX apps and vpns": { + "description": "CloudX apps and vpns", + "value": { + "pushRequired": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/cloudx/sig_tunnels": { + "get": { + "tags": [ + "Configuration - Secure Internet Gateway Tunnels" + ], + "description": "Get Secure Internet Gateway Tunnel List", + "operationId": "getSigTunnelList_1", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cloudx/status": { + "get": { + "tags": [ + "Configuration - CloudExpress" + ], + "description": "Get sites per application per vpn", + "operationId": "sitePerApp", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "App name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "query", + "description": "VPN Id", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "CloudX site": { + "description": "CloudX site", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read" + } + }, + "/template/config/attach/{deviceId}": { + "put": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Upload device config", + "operationId": "uploadConfig", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template config": { + "description": "Template config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write,Template Deploy-write" + } + }, + "/template/config/attached/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get local template attached config for given device", + "operationId": "getAttachedConfig", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "Config type", + "schema": { + "type": "string", + "enum": [ + "CFS", + "RFS", + "DRAFT_RFS", + "DRAFT_CFS" + ], + "default": "CFS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attached config": { + "description": "Attached config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write" + } + }, + "/template/config/device/mode/cli": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Generates a JSON object that contains a list of valid devices in CLI mode", + "operationId": "generateCLIModeDevices", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Device type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge", + "controller", + "vmanage" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": "data" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template", + "operationId": "updateDeviceToCLIMode", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "deviceType": "vedge", + "devices": [ + { + "deviceId": "932f70dd-5815-4712-b9ed-3d34a238f2ca", + "deviceIP": "172.16.255.21" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template Id": { + "description": "Device template Id", + "value": { + "id": "device_config_mode_cli-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write,Template Deploy-write" + } + }, + "/template/config/device/mode/vmanage": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get list of devices that are allowable for vmanage modes", + "operationId": "generatevManageModeDevices", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Device type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge", + "controller", + "vmanage" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/diff/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Generates a JSON object that contains the diff for a given device", + "operationId": "getDeviceDiff", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Config diff": { + "description": "Config diff", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/quickConnect/submitDevices": { + "post": { + "tags": [ + "Configuration - Quick Connect" + ], + "description": "Creates and pushes bootstrap configurations onto day0 devices.", + "operationId": "submitDay0Config", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "data": { + "description": "data", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/rmalist/{oldDeviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get compatible devices of model, chassis number, certificate serial number with the old device", + "operationId": "getCompatibleDevices", + "parameters": [ + { + "name": "oldDeviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/config/rmaupdate": { + "put": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Update new device", + "operationId": "rmaUpdate", + "requestBody": { + "description": "Template config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template config": { + "description": "Template config" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-write,Template Deploy-write" + } + }, + "/template/config/running/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get device running config", + "operationId": "getRunningConfig", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Running config": { + "description": "Running config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write" + } + }, + "/template/config/vpn/{deviceId}": { + "get": { + "tags": [ + "Configuration - Template Configuration" + ], + "description": "Get list of configured VPN (excluding reserved VPN) for a device", + "operationId": "getVpnForDevice", + "parameters": [ + { + "name": "deviceId", + "in": "path", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPN": { + "description": "VPN", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/cor": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get Cloud On Ramp list", + "operationId": "getCORStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cloud on ramp status": { + "description": "Cloud on ramp status", + "value": { + "data": [ + { + "accountId": "010098612700", + "accountName": "010098612700", + "cloudType": "AWS", + "mappedAccountCount": 0, + "cloudRegionList": [ + { + "cloudRegion": "us-west-1", + "transitVpcCount": 1, + "hostVpcCount": 0, + "deviceCount": 2, + "hostVpcReachableCount": 0, + "hostVpcUnreachableCount": 0, + "deviceReachableCount": 0, + "deviceUnreachableCount": 2 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Map Host to Transit VPC/VNet", + "operationId": "createAndMap", + "requestBody": { + "description": "Map host to transit VPC request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Map host to transit VPC request": { + "description": "Map host to transit VPC request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/accountid/{accountid}": { + "delete": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Delete transit VPC/VNet", + "operationId": "removeTransitVPC", + "parameters": [ + { + "name": "accountid", + "in": "path", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transitvpcid", + "in": "query", + "description": "Cloud VPC Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/acquireResourcePool": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Acquire IP from resource pool", + "operationId": "acquireResourcePool", + "requestBody": { + "description": "Add IP from resource pool request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add IP from resource pool request": { + "description": "Add IP from resource pool request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/ami": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get AMI list", + "operationId": "getAmiList", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "AMI": { + "description": "AMI", + "value": "{\"data\":{\n \"amis\":[\n {\n \"amiId\":\"ami-00c8377340219e9fc\",\n \"version\":\"18.3.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-0136d4095d027e741\",\n \"version\":\"19.1.0-temp\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02a3c4c89a7e3294e\",\n \"version\":\"19.1.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02f9c3711e326dcb6\",\n \"version\":\"csr-CSR_SDWAN-AMI.16.12.01b-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0be17bfec080cee40.4\",\n \"modelType\":\"csr\"\n },\n {\n \"amiId\":\"ami-053eee5e68e33f25b\",\n \"version\":\"Cisco-CSR-SDWAN-16.12.03-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0379a842c0f9e5378.4\",\n \"modelType\":\"csr\"\n }\n ]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud list", + "operationId": "getCloudList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cloud type": { + "description": "Cloud type", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud/account": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud accounts", + "operationId": "getCloudAccounts", + "parameters": [ + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudEnvironment", + "in": "query", + "description": "Cloud environment", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud/authenticate": { + "put": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Authenticate and update cloud account credentials", + "operationId": "authenticateCredAndUpdate", + "requestBody": { + "description": "Cloud account credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account credential": { + "description": "Cloud account credential", + "value": { + "cloudType": "AWS", + "authType": "KEY", + "apiKey": "dummy", + "secretKey": "dummy" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Authenticate cloud account credentials", + "operationId": "authenticateCloudOnRampCredAndAdd", + "requestBody": { + "description": "Cloud account credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account credential": { + "description": "Cloud account credential", + "value": { + "cloudType": "AWS", + "authType": "KEY", + "apiKey": "dummy", + "secretKey": "dummy" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud account": { + "description": "Cloud account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/cloud/host/accountdetails": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud host VPC account details", + "operationId": "getCloudHostVpcAccountDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud host account": { + "description": "Cloud host account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/cloud/mappedhostaccounts": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get cloud mapped accounts view", + "operationId": "getCloudMappedHostAccounts", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Cloud mapped host account": { + "description": "Cloud mapped host account", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/createResourcePool": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Add resource pool", + "operationId": "createResourcePool", + "requestBody": { + "description": "Add resource pool request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add resource pool request": { + "description": "Add resource pool request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/deleteDevicepair": { + "delete": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Remove device pair", + "operationId": "removeDeviceId", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transitvpcid", + "in": "query", + "description": "VPC Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transitvpcname", + "in": "query", + "description": "VPC Name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + }, + { + "name": "devicePairId", + "in": "query", + "description": "Device pair Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/device": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get available device list", + "operationId": "getCloudOnRampDevices", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": "data" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/devicepair": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Add device pair", + "operationId": "addDevicePair", + "requestBody": { + "description": "Add device pair request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Add device pair request": { + "description": "Add device pair request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/devicepair/hostvpc": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get host VPC details", + "operationId": "getHostVPCs", + "parameters": [ + { + "name": "transitVpcId", + "in": "query", + "description": "Transit VPC Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "devicePairId", + "in": "query", + "description": "Device pair Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Host VPC": { + "description": "Host VPC", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/externalId": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get the vManage external ID for AWS", + "operationId": "getExternalId", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "externalId": { + "description": "externalId", + "value": "12345abcd" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/getTransitDevicePairAndHostList": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get device and host details", + "operationId": "getTransitDevicePairAndHostList", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudRegion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device and host": { + "description": "Device and host", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/getTransitVpnList": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPN list", + "operationId": "getTransitVpcVpnList", + "parameters": [ + { + "name": "accountId", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Transit VPN": { + "description": "Transit VPN", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/hostvpc": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get host VPC/VNet list", + "operationId": "getCloudHostVPCs", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPC/VNet": { + "description": "VPC/VNet", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/map": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get mapped VPC/VNet list", + "operationId": "getMappedVPCs", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Map host to transit VPC/VNet", + "operationId": "mapVPCs", + "requestBody": { + "description": "Map host to VPC/VNet", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Map host to VPC/VNet": { + "description": "Map host to VPC/VNet" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + }, + "delete": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Unmap host from transit VPC/VNet", + "operationId": "unmapVPCs", + "requestBody": { + "description": "Unmap host to VPC/VNet", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Unmap host to VPC/VNet": { + "description": "Unmap host to VPC/VNet" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/pem": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPC PEM key list", + "operationId": "getPemKeyList", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "PEM key": { + "description": "PEM key", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cor/scale/down": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Scale down cloud on ramp", + "operationId": "scaleDown", + "requestBody": { + "description": "Update VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update VPC": { + "description": "Update VPC" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "viptela-reserved-cloud" + } + }, + "/template/cor/scale/up": { + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Scale up cloud on ramp", + "operationId": "scaleUp", + "requestBody": { + "description": "Update VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Update VPC": { + "description": "Update VPC" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "viptela-reserved-cloud" + } + }, + "/template/cor/transitvpc": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPC/VNet list", + "operationId": "getTransitVPCs", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPC/VNet list": { + "description": "VPC/VNet list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + }, + "put": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Update transit VPC/VNet", + "operationId": "updateTransitVPC", + "requestBody": { + "description": "VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC", + "value": { + "accountId": "010098612700", + "cloudRegion": "us-west-1", + "cloudType": "AWS", + "transitVpcName": "DemoVPC", + "transitVpcId": "vpc-0dfdd169a61492554", + "dia": "DISABLED" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + }, + "post": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Create transit VPC/VNet", + "operationId": "addTransitVPC", + "requestBody": { + "description": "VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC", + "value": { + "accountId": "010098612700", + "cloudRegion": "us-west-1", + "cloudType": "AWS", + "transitVpcName": "DemoVPC", + "transitVpcSize": "c3.large", + "amiId": "ami-0f0f993e800121941", + "deviceModelType": "vedge", + "transitVpcSubnet": "", + "maxHostVpcPerDevicePair": 1, + "devicePairList": [ + { + "deviceList": [ + { + "uuid": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35", + "preference": "active" + }, + { + "uuid": "52c7911f-c5b0-45df-b826-3155809a2a1a", + "preference": "backup" + } + ], + "devicePairId": "f21dbb35-30b3-47f4-93bb-d2b2fe092d35", + "isPrimary": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "b634bf94-b47b-40a2-ba72-d289036234fd" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/transitvpc/autoscale-properties": { + "put": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Update transit VPC autoscale properties", + "operationId": "updateTransitVpcAutoscaleProperties", + "requestBody": { + "description": "VPC", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "VPC": { + "description": "VPC", + "value": { + "accountId": "010098612700", + "cloudRegion": "us-west-1", + "cloudType": "AWS", + "transitVpcName": "DemoVPC", + "transitVpcId": "vpc-0dfdd169a61492554", + "maxHostVpcPerDevicePair": 2 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-write" + } + }, + "/template/cor/transitvpc/size": { + "get": { + "tags": [ + "Configuration - Cloud On Ramp" + ], + "description": "Get transit VPC supported size", + "operationId": "getTransitVPCSupportedSize", + "parameters": [ + { + "name": "cloudtype", + "in": "query", + "description": "Cloud type", + "schema": { + "type": "string", + "default": "AWS" + } + }, + { + "name": "cloudEnvironment", + "in": "query", + "description": "Cloud environment", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "VPC size": { + "description": "VPC size", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Cloud OnRamp-read" + } + }, + "/template/cortex": { + "get": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Get Cortex List", + "operationId": "getCortexStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cortex status": { + "description": "Cortex status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-read" + } + }, + "/template/cortex/cloud/authenticate": { + "post": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Authenticate Cloud Account Credentials", + "operationId": "authenticateAzureConnectCredAndAdd", + "requestBody": { + "description": "Credential", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Credential": { + "description": "Credential" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/cortex/map": { + "get": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Get Mapped WAN Resource Groups", + "operationId": "getMappedWanResourceGroups", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cloudregion", + "in": "query", + "description": "Cloud region", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource groups": { + "description": "WAN resource groups", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/cortex/sync": { + "post": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Sync WAN Resource Groups", + "operationId": "syncWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/cortex/wanrg": { + "get": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Get WAN Resource Groups", + "operationId": "getWanResourceGroups", + "parameters": [ + { + "name": "accountid", + "in": "query", + "description": "Account Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource groups": { + "description": "WAN resource groups", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + }, + "put": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Edit WAN Resource Groups", + "operationId": "editWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + }, + "post": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Create WAN Resource Groups", + "operationId": "saveWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + }, + "delete": { + "tags": [ + "Configuration - Azure Connect" + ], + "description": "Delete WAN Resource Groups", + "operationId": "deleteWanResourceGroups", + "requestBody": { + "description": "WAN resource group", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "WAN resource group": { + "description": "WAN resource group" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Cortex-write" + } + }, + "/template/device": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Generate template list


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateMasterTemplateList", + "parameters": [ + { + "name": "feature", + "in": "query", + "description": "Feature", + "required": true, + "schema": { + "type": "string", + "enum": [ + "lawful-interception", + "cloud-dock", + "network-design", + "vmanage-default", + "all" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": { + "data": [ + { + "deviceType": "vsmart", + "lastUpdatedBy": "admin", + "factoryDefault": false, + "templateName": "vSmartConfigurationTemplate", + "devicesAttached": 0, + "draftMode": false, + "templateDescription": "Config template for vSmarts", + "templateClass": "vedge", + "lastUpdatedOn": 1529606745011, + "configType": "file", + "templateId": "e1f3de23-1ded-49d8-85b1-1e6ab668775f", + "templateAttached": 0 + }, + { + "deviceType": "vedge-C1111-8PLTELA", + "lastUpdatedBy": "system", + "templateClass": "cedge", + "configType": "template", + "templateId": "b6aacdc9-ae1f-4471-a359-13657ce98204", + "factoryDefault": true, + "templateName": "Factory_Default_C1111_8PLTELA_V01", + "devicesAttached": 0, + "draftMode": false, + "templateDescription": "Factory Default template for C1111-8PLTELA", + "lastUpdatedOn": 1588082428579, + "templateAttached": 15 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/cli": { + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Create CLI template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createCLITemplate", + "requestBody": { + "description": "Create template request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": "{\n \"templateId\":\"e1f3de23-1ded-49d8-85b1-1e6ab668775f\",\n \"templateName\":\"vSmartConfigurationTemplate\",\n \"templateDescription\":\"Config template for vSmarts\",\n \"deviceType\":\"vsmart\",\n \"templateConfiguration\":\n \"system\n host-name {{Hostname}}\n gps-location latitude {{gps-latitude}}\n gps-location longitude {{gps-longitude}}\n system-ip {{System-IP}}\n site-id {{Site-ID}}\n organization-name \"Cisco Sy1 - 19968\"\n vbond vbond.cisco.com\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n user admin\n password $6$YsNdljyTklJyRlUZ$u.vOqeMSUbzfc.aWBty9OIovNCxlUASviwfgXO2bTCJV5ddUoV7EG8Q3EA3Yl0aMv./GnJLPPbjC6uQPjtwVo.\n !\n !\n logging\n disk\n enable\n !\n !\n !\n omp\n no shutdown\n send-path-limit 8\n send-backup-paths\n graceful-restart\n !\n banner\n login \"Cisco SD-WAN/Viptela dCloud Demo V2\"\n !\n !\n vpn 0\n dns 198.18.1.1 secondary\n dns 198.18.1.254 primary\n host vbond.cisco.com ip 198.18.1.11 198.18.1.21\n interface eth0\n ip address {{Tunnel-IP-Address}}\n ipv6 dhcp-client\n tunnel-interface\n allow-service dhcp\n allow-service dns\n allow-service icmp\n allow-service sshd\n allow-service netconf\n no allow-service ntp\n no allow-service stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 {{Default GW}}\n !\n vpn 512\n!\"\n \"factoryDefault\":false,\n \"configType\":\"file\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/config/attachBootStrap": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "pushMasterTemplate_1", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "deviceTemplateList": [ + { + "templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "device": [ + { + "csv-status": "complete", + "csv-deviceId": "5e5f45e7-3062-44b2-b6f6-40c682149e05", + "csv-deviceIP": "172.16.255.11", + "csv-host-name": "vm1", + "//system/host-name": "vm1", + "//system/system-ip": "172.16.255.11", + "//system/site-id": "100", + "csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "selected": "true" + } + ], + "isEdited": false, + "isMasterEdited": false, + "isDraftDisabled": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attachcli": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach CLI device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "pushCLITemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": "{\n \"deviceTemplateList\":[\n {\n \"templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\", \n \"device\":[ \n {\n \"csv-status\":\"complete\",\n \"csv-deviceId\":\"5e5f45e7-3062-44b2-b6f6-40c682149e05\",\n \"csv-deviceIP\":\"172.16.255.11\",\n \"csv-host-name\":\"vm1\",\n \"//system/host-name\":\"vm1\",\n \"//system/system-ip\":\"172.16.255.11\",\n \"//system/site-id\":\"100\",\n \"csv-templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\",\n \"selected\":\"true\"\n \"pseudoCommitTimer\":11\n }\n ],\n \"isEdited\":false, \n \"isMasterEdited\":false, \n \"isDraftDisabled\":false \n }\n ]\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attachcloudx": { + "put": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Edit already enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editCloudxConfig", + "requestBody": { + "description": "CloudX config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudX config": { + "description": "CloudX config", + "value": { + "isEdited": true, + "siteList": [ + 100, + 400 + ], + "siteType": "dia" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Tenant Id": { + "description": "Tenant Id", + "value": { + "id": "push_file_template_configuration-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Enable gateways, clients, dias", + "operationId": "pushCloudxConfig", + "requestBody": { + "description": "CloudX config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudX config": { + "description": "CloudX config", + "value": { + "isEdited": false, + "siteList": [ + 100 + ], + "siteType": "dia" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Tenant Id": { + "description": "Tenant Id", + "value": { + "id": "push_file_template_configuration-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attached/{masterTemplateId}": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get attached device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAttachedDeviceList", + "parameters": [ + { + "name": "masterTemplateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Configuration-read" + } + }, + "/template/device/config/attachedconfig": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get attached config to device


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAttachedConfigToDevice", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Model ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "policyId", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CLI config": { + "description": "CLI config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Device Inventory-read" + } + }, + "/template/device/config/attachfeature": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "pushMasterTemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "deviceTemplateList": [ + { + "templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "device": [ + { + "csv-status": "complete", + "csv-deviceId": "5e5f45e7-3062-44b2-b6f6-40c682149e05", + "csv-deviceIP": "172.16.255.11", + "csv-host-name": "vm1", + "//system/host-name": "vm1", + "//system/system-ip": "172.16.255.11", + "//system/site-id": "100", + "csv-templateId": "41f6a440-c5cc-4cc6-9ca1-af18e332a781", + "selected": "true" + } + ], + "isEdited": false, + "isMasterEdited": false, + "isDraftDisabled": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/attachment": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Attach device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "attachDeviceTemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/available/{masterTemplateId}": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get possible device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDeviceListByMasterTemplateId", + "parameters": [ + { + "name": "masterTemplateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/template/device/config/config": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get device configuration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDeviceConfigurationPreview", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "templateId": "45d94bf1-30fb-4b00-8bde-2a62c8af97b5", + "device": { + "csv-status": "complete", + "csv-deviceId": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "csv-deviceIP": "172.16.255.21", + "csv-host-name": "vm11", + "csv-templateId": "45d94bf1-30fb-4b00-8bde-2a62c8af97b5" + }, + "isEdited": false, + "isMasterEdited": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": "system\nhost-name vm11\ngps-location latitude 35.0\ngps-location longitude -78.0\nsystem-ip 172.16.255.21\nsite-id 100\norganization-name \"vIPtela Inc Regression\"\nclock timezone America/Los_Angeles\nvbond 10.0.12.26\naaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write" + } + }, + "/template/device/config/detach": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Detach device template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "detachDeviceTemplate", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/detachcloudx": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Disable enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "detachSites", + "requestBody": { + "description": "CloudX config", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CloudX config": { + "description": "CloudX config", + "value": { + "siteList": [ + 100 + ], + "siteType": "none" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Tenant Id": { + "description": "Tenant Id", + "value": { + "id": "push_file_template_configuration-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/duplicateip": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDevicesWithDuplicateIP", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "device": [ + { + "csv-deviceIP": "10.1.0.1", + "csv-deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de", + "csv-host-name": "DC1-VEDGE1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/device/config/duplicatelocationname": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDevicesWithDuplicateLocationName", + "requestBody": { + "description": "Device list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device list": { + "description": "Device list", + "value": { + "locations": [ + { + "locationName": "Milpitas, CA", + "csv-deviceId": "ebdc8bd9-17e5-4eb3-a5e0-f438403a83de" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/device/config/exportcsv": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Export the device template to CSV format for given template id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createInputWithoutDevice", + "requestBody": { + "description": "Device template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template", + "value": { + "templateId": "e1f3de23-1ded-49d8-85b1-1e6ab668775f", + "isEdited": false, + "isMasterEdited": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device input": { + "description": "Device input", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/input": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Create device input


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createDeviceInput", + "requestBody": { + "description": "Template device input", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template device input": { + "description": "Template device input", + "value": "{{\n \"templateId\":\"6c7d22bc-73d5-4877-9402-26c75a22bd08\",\n \"deviceIds\":[\n \"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de\"\n ],\n \"isEdited\":false,\n \"isMasterEdited\":false\n}}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device input": { + "description": "Device input", + "value": { + "data": [ + { + "csv-status": "in_complete", + "csv-deviceId": "a1d010e6-bd61-4fbd-8980-96f02db4d0b9", + "csv-deviceIP": "172.16.255.21", + "csv-host-name": "vm11", + "//system/host-name": "vm11", + "//system/system-ip": "172.16.255.21", + "//system/site-id": "11" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/process/input/file": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Process input comma separated file


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "processInputCommaSepFile", + "requestBody": { + "description": "Device template", + "content": { + "multipart/form-data": { + "schema": { + "type": "object" + }, + "examples": { + "Device template": { + "description": "Device template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Device config": { + "description": "Device config", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/quickconnectvariable": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Get connection variables to be configured", + "operationId": "getQuickConnectVariables", + "requestBody": { + "description": "Device List", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device List": { + "description": "Device List", + "value": [] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Variable list": { + "description": "Variable list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/config/vbond": { + "get": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Check if vBond is configured


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "checkVbond", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Is vBond configured": { + "description": "Is vBond configured", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Configuration-read" + } + }, + "/template/device/config/verify": { + "post": { + "tags": [ + "Configuration - Device Template" + ], + "description": "Validate full template\"\n


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "validateTemplate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "default": { + "description": "default response", + "content": { + "application/json": {} + } + } + }, + "deprecated": true, + "x-roles-required": "Template Deploy-write" + } + }, + "/template/device/feature": { + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Create a device template from feature templates and sub templates


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createMasterTemplate", + "requestBody": { + "description": "Create template request", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "templateName": "vEdge_Device_Template", + "templateDescription": "Demo device template", + "deviceType": "vedge-100", + "configType": "template", + "factoryDefault": false, + "policyId": "", + "featureTemplateUidRange": [], + "connectionPreferenceRequired": true, + "connectionPreference": true, + "generalTemplates": [ + { + "templateId": "3b30e089-2e26-44f1-b5b2-ac44f3f4279e", + "templateType": "aaa" + }, + { + "templateId": "0419c4f6-eb61-4048-a3fe-78ea7f7248b0", + "templateType": "bfd-vedge" + }, + { + "templateId": "eb7162be-b018-47c5-b1de-bbb65ff802e3", + "templateType": "omp-vedge" + }, + { + "templateId": "486d419f-4e6c-44a5-a6fb-7b5ccf94ff90", + "templateType": "security-vedge" + }, + { + "templateId": "7d7396a2-4715-44d8-8f6e-ddf0ca06be44", + "templateType": "system-vedge", + "subTemplates": [ + { + "templateId": "edf3d309-91d4-45be-98d9-cfd57a05a479", + "templateType": "logging" + } + ] + }, + { + "templateId": "171e9bd4-7a7b-460d-b692-83f0d5ce0124", + "templateType": "vpn-vedge", + "subTemplates": [ + { + "templateId": "a632ee5f-f489-46ec-8761-1b493d5a6a40", + "templateType": "vpn-vedge-interface" + } + ] + }, + { + "templateId": "45ea940a-45d2-4fd9-8da2-570a1a6d6874", + "templateType": "vpn-vedge" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": { + "templateId": "81610551-9dc5-492f-ad3b-b2c30077b992" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/is_migration_required": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Check if any device templates need migration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "isMigrationRequired", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Boolean": { + "description": "Boolean", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/migration": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateForMigration", + "parameters": [ + { + "name": "hasAAA", + "in": "query", + "description": "Return only those uses AAA", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "data": [ + { + "deviceType": "vedge-CSR-1000v", + "lastUpdatedBy": "admin", + "templateClass": "cedge_vedge", + "templateId": "c62e6fba-fb53-4562-b436-3878de0fbbc2", + "configType": "template", + "factoryDefault": false, + "templateName": "BranchType1Template-CSR", + "devicesAttached": 2, + "templateDescription": "Branch Type 1 Template for CSR Routers", + "lastUpdatedOn": 1588093291553, + "templateAttached": 22 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Migrate the device templates given the template Ids", + "operationId": "migrateTemplates", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Template Id", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "prefix", + "in": "query", + "description": "Prefix", + "schema": { + "type": "string", + "default": "cisco" + } + }, + { + "name": "includeAll", + "in": "query", + "description": "Include all flag", + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "status": "Template migration started", + "taskId": "TEMPLATE_MIGRATIONa548c416-bfb8-46dd-9866-d0aa042f17ab" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/migration_info": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Returns the mapping between old and migrated templates


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "migrationInfo", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Migrated templates mapping": { + "description": "Migrated templates mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/object/{templateId}": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Generate template by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getMasterTemplateDefinition", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/resource-group/{resourceGroupName}/{templateId}": { + "post": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Change template resource group", + "operationId": "changeTemplateResourceGroup_1", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/syncstatus": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Get template sync status


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getOutOfSyncTemplates", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/syncstatus/{templateId}": { + "get": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Get out of sync devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getOutOfSyncDevices", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Devices": { + "description": "Devices", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/device/{templateId}": { + "put": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Edit template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editMasterTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "templateId": "81610551-9dc5-492f-ad3b-b2c30077b992", + "templateName": "vEdge_Device_Template", + "templateDescription": "Demo device template", + "deviceType": "vedge-100", + "configType": "template", + "factoryDefault": false, + "policyId": "", + "featureTemplateUidRange": [], + "connectionPreferenceRequired": true, + "connectionPreference": true, + "draftMode": false, + "generalTemplates": [ + { + "templateId": "3b30e089-2e26-44f1-b5b2-ac44f3f4279e", + "templateType": "aaa" + }, + { + "templateId": "e1b5b6e9-3b54-4279-a532-a2aaaef3e6a1", + "templateType": "bfd-vedge" + }, + { + "templateId": "998725f9-3572-4950-a5e5-d48827d347cd", + "templateType": "omp-vedge" + }, + { + "templateId": "486d419f-4e6c-44a5-a6fb-7b5ccf94ff90", + "templateType": "security-vedge" + }, + { + "templateId": "7d7396a2-4715-44d8-8f6e-ddf0ca06be44", + "templateType": "system-vedge", + "subTemplates": [ + { + "templateId": "edf3d309-91d4-45be-98d9-cfd57a05a479", + "templateType": "logging" + } + ] + }, + { + "templateId": "171e9bd4-7a7b-460d-b692-83f0d5ce0124", + "templateType": "vpn-vedge", + "subTemplates": [ + { + "templateId": "a632ee5f-f489-46ec-8761-1b493d5a6a40", + "templateType": "vpn-vedge-interface" + } + ] + }, + { + "templateId": "45ea940a-45d2-4fd9-8da2-570a1a6d6874", + "templateType": "vpn-vedge" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Attached devices": { + "description": "Attached devices", + "value": { + "data": { + "attachedDevices": [] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Template Master" + ], + "description": "Delete template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteMasterTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/feature": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get feature template list


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateFeatureTemplateList", + "parameters": [ + { + "name": "summary", + "in": "query", + "description": "Flag to include template definition", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit on templateId", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Feature template": { + "description": "Feature template", + "value": { + "data": [ + { + "templateId": "07a5de3c-4dfa-4eb3-bf52-7ee8076e29a9", + "templateName": "Default_Azure_vWAN_C8000V_VPN0_INTF_GE1_V01", + "templateDescription": "Default VPN 0 Interface GigabitEthernet1 template for Azure vWAN C8000V", + "templateType": "cisco_vpn_interface", + "deviceType": [ + "vedge-C8000V" + ], + "lastUpdatedBy": "system", + "lastUpdatedOn": 1631281281614, + "factoryDefault": true, + "devicesAttached": 0, + "attachedMastersCount": 1, + "templateMinVersion": "20.4.0", + "configType": "xml", + "createdBy": "system", + "createdOn": 1631281281614, + "resourceGroup": "global" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + }, + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Create feature template", + "operationId": "createFeatureTemplate", + "requestBody": { + "description": "Feature template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CedgeVoiceCard-example": { + "description": "CedgeVoiceCard-example" + }, + "CedgeVoiceSrst-example": { + "description": "CedgeVoiceSrst-example" + }, + "aaa-example": { + "description": "aaa-example" + }, + "appqoe-example": { + "description": "appqoe-example" + }, + "archive-example": { + "description": "archive-example" + }, + "banner-example": { + "description": "banner-example" + }, + "bfd-vedge-example": { + "description": "bfd-vedge-example" }, + "bgp-example": { + "description": "bgp-example" + }, + "bridge-example": { + "description": "bridge-example" + }, + "cedge_aaa-example": { + "description": "cedge_aaa-example" + }, + "cedge_global-example": { + "description": "cedge_global-example" + }, + "cedge_igmp-example": { + "description": "cedge_igmp-example" + }, + "cedge_multicast-example": { + "description": "cedge_multicast-example" + }, + "cedge_pim-example": { + "description": "cedge_pim-example" + }, + "cellular-cedge-controller-example": { + "description": "cellular-cedge-controller-example" + }, + "cellular-cedge-gps-controller-example": { + "description": "cellular-cedge-gps-controller-example" + }, + "cellular-cedge-profile-example": { + "description": "cellular-cedge-profile-example" + }, + "cellular-gateway-platform-example": { + "description": "cellular-gateway-platform-example" + }, + "cellular-gateway-profile-example": { + "description": "cellular-gateway-profile-example" + }, + "cellular-profile-example": { + "description": "cellular-profile-example" + }, + "cisco_banner-example": { + "description": "cisco_banner-example" + }, + "cisco_bfd-example": { + "description": "cisco_bfd-example" + }, + "cisco_bgp-example": { + "description": "cisco_bgp-example" + }, + "cisco_dhcp_server-example": { + "description": "cisco_dhcp_server-example" + }, + "cisco_dsp_farm-example": { + "description": "cisco_dsp_farm-example" + }, + "cisco_logging-example": { + "description": "cisco_logging-example" + }, + "cisco_ntp-example": { + "description": "cisco_ntp-example" + }, + "cisco_omp-example": { + "description": "cisco_omp-example" + }, + "cisco_ospf-example": { + "description": "cisco_ospf-example" + }, + "cisco_ospfv3-example": { + "description": "cisco_ospfv3-example" + }, + "cisco_secure_internet_gateway-example": { + "description": "cisco_secure_internet_gateway-example" + }, + "cisco_security-example": { + "description": "cisco_security-example" + }, + "cisco_sig_credential-example": { + "description": "cisco_sig_credential-example" + }, + "cisco_snmp-example": { + "description": "cisco_snmp-example" + }, + "cisco_system-example": { + "description": "cisco_system-example" + }, + "cisco_thousandeye-example": { + "description": "cisco_thousandeye-example" + }, + "cisco_trustsec-example": { + "description": "cisco_trustsec-example" + }, + "cisco_vp-example": { + "description": "cisco_vp-example" + }, + "cisco_vpn_interface-example": { + "description": "cisco_vpn_interface-example" + }, + "cisco_vpn_interface_gre-example": { + "description": "cisco_vpn_interface_gre-example" + }, + "cisco_vpn_interface_ipsec-example": { + "description": "cisco_vpn_interface_ipsec-example" + }, + "cisco_wireless_la-example": { + "description": "cisco_wireless_la-example" + }, + "cli-template-example": { + "description": "cli-template-example" + }, + "dhcp-server-example": { + "description": "dhcp-server-example" + }, + "eigrp-example": { + "description": "eigrp-example" + }, + "igmp-example": { + "description": "igmp-example" + }, + "logging-example": { + "description": "logging-example" + }, + "multicast-example": { + "description": "multicast-example" + }, + "ntp-example": { + "description": "ntp-example" + }, + "omp-vedge-example": { + "description": "omp-vedge-example" + }, + "omp-vsmart-example": { + "description": "omp-vsmart-example" + }, + "ospf-example": { + "description": "ospf-example" + }, + "pim-example": { + "description": "pim-example" + }, + "probe-example": { + "description": "probe-example" + }, + "secure-internet-gateway-example": { + "description": "secure-internet-gateway-example" + }, + "security-vedge-example": { + "description": "security-vedge-example" + }, + "security-vsmart-example": { + "description": "security-vsmart-example" + }, + "sig-credential-example": { + "description": "sig-credential-example" + }, + "snmp-example": { + "description": "snmp-example" + }, + "switchport-example": { + "description": "switchport-example" + }, + "system-vedge-example": { + "description": "system-vedge-example" + }, + "system-vsmart-example": { + "description": "system-vsmart-example" + }, + "t1-e1-controller-example": { + "description": "t1-e1-controller-example" + }, + "tenant-example": { + "description": "tenant-example" + }, + "ucse-example": { + "description": "ucse-example" + }, + "virtual-application-utd-example": { + "description": "virtual-application-utd-example" + }, + "vpn-cedge-interface-cellular-example": { + "description": "vpn-cedge-interface-cellular-example" + }, + "vpn-cedge-interface-multilink-controller-example": { + "description": "vpn-cedge-interface-multilink-controller-example" + }, + "vpn-interface-ethpppoe-example": { + "description": "vpn-interface-ethpppoe-example" + }, + "vpn-interface-ipoe-example": { + "description": "vpn-interface-ipoe-example" + }, + "vpn-interface-pppoa-example": { + "description": "vpn-interface-pppoa-example" + }, + "vpn-interface-pppoe-example": { + "description": "vpn-interface-pppoe-example" + }, + "vpn-interface-svi-example": { + "description": "vpn-interface-svi-example" + }, + "vpn-interface-t1-e1-example": { + "description": "vpn-interface-t1-e1-example" + }, + "vpn-vedge-interface-bridge-example": { + "description": "vpn-vedge-interface-bridge-example" + }, + "vpn-vedge-interface-cellular-example": { + "description": "vpn-vedge-interface-cellular-example" + }, + "vpn-vedge-interface-gre-example": { + "description": "vpn-vedge-interface-gre-example" + }, + "vpn-vedge-interface-ipsec-example": { + "description": "vpn-vedge-interface-ipsec-example" + }, + "vpn-vedge-interface-natpool-example": { + "description": "vpn-vedge-interface-natpool-example" + }, + "vpn-vedge-interface-ppp-example": { + "description": "vpn-vedge-interface-ppp-example" + }, + "vpn-vedge-interface-vap-example": { + "description": "vpn-vedge-interface-vap-example" + }, + "vpn-vedge-interface-example": { + "description": "vpn-vedge-interface-example" + }, + "vpn-vedge-pppoe-enabled-interface-example": { + "description": "vpn-vedge-pppoe-enabled-interface-example" + }, + "vpn-vedge-example": { + "description": "vpn-vedge-example" + }, + "vpn-vmanage-interface-example": { + "description": "vpn-vmanage-interface-example" + }, + "vpn-vsmart-interface-example": { + "description": "vpn-vsmart-interface-example" + }, + "vpn-vsmart-example": { + "description": "vpn-vsmart-example" + }, + "wla-example": { + "description": "wla-example" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Feature template": { + "description": "Feature template", + "value": { + "templateId": "ff3b31b1-0262-44d3-badf-d9cf472fb4b1" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/template/feature/clone": { + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Clone a feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "cloneTemplate", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Template Id to clone from", + "required": true, + "schema": { + "type": "string" + }, + "example": "220a6bd0-28ef-4c88-92e6-ee7539396fd7" + }, + { + "name": "name", + "in": "query", + "description": "Name for the cloned template", + "required": true, + "schema": { + "type": "string" + }, + "example": "BR2-VPN10-Feature" + }, + { + "name": "desc", + "in": "query", + "description": "Description for the cloned template", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": { + "templateId": "ff3b31b1-0262-44d3-badf-d9cf472fb4b1" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/template/feature/default/networkinterface": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get default network interface


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getNetworkInterface", + "parameters": [ + { + "name": "deviceModel", + "in": "query", + "description": "Device model", + "required": true, + "schema": { + "type": "string", + "enum": [ + "ENCS", + "C8200-UCPE", + "C8200-UCPEVM" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Default network Interface": { + "description": "Default network Interface", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/feature/default/networks": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get default networks


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDefaultNetworks", + "parameters": [ + { + "name": "deviceModel", + "in": "query", + "description": "Device model", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge-nfvis-ENCS5400", + "vedge-nfvis-C8200-UCPE", + "vedge-nfvis-C8200-UCPEVM" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Default network": { + "description": "Default network", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/definition/{templateId}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get the configured template definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTemplateDefinition", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template definition": { + "description": "Template definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + } + }, + "/template/feature/devicetemplates/{templateId}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get all device templates for this feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getDeviceTemplatesAttachedToFeature", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Feature template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/li": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get LI feature template", + "operationId": "listLITemplate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "LI template": { + "description": "LI template", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Lawful Interception-read" + }, + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Create LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createLITemplate", + "requestBody": { + "description": "LI template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "LI template": { + "description": "LI template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template Id": { + "description": "Template Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Lawful Interception-write" + } + }, + "/template/feature/li/{templateId}": { + "put": { + "tags": [ + "Configuration - General Template" + ], + "description": "Update LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editLITemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "LI template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "LI template": { + "description": "LI template", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Lawful Interception-write" + } + }, + "/template/feature/master/{type_name}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template type definition by device type


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateMasterTemplateDefinition", + "parameters": [ + { + "name": "type_name", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/migration": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTemplateForMigration", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": { + "data": [ + { + "deviceType": "vedge-CSR-1000v", + "lastUpdatedBy": "admin", + "templateClass": "cedge_vedge", + "templateId": "c62e6fba-fb53-4562-b436-3878de0fbbc2", + "configType": "template", + "factoryDefault": false, + "templateName": "BranchType1Template-CSR", + "devicesAttached": 2, + "templateDescription": "Branch Type 1 Template for CSR Routers", + "lastUpdatedOn": 1588093291553, + "templateAttached": 22 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read,Lawful Interception-read" + } + }, + "/template/feature/object/{templateId}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get template object definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getGeneralTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Policy Configuration-read" + } + }, + "/template/feature/resource-group/{resourceGroupName}/{templateId}": { + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Change template resource group", + "operationId": "changeTemplateResourceGroup", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resrouce group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write" + } + }, + "/template/feature/types": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template types


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateTypes", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Device type", + "required": true, + "schema": { + "type": "string", + "enum": [ + "vedge", + "cedge", + "all", + "default" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template type": { + "description": "Template type", + "value": { + "data": [ + { + "parent": "basic_info", + "default": "aaa/aaa.json", + "deviceModels": [ + { + "name": "vedge-1000" + }, + { + "name": "vedge-2000" + }, + { + "name": "vedge-cloud" + }, + { + "name": "vedge-5000" + }, + { + "name": "vedge-ISR1100-6G" + }, + { + "name": "vedge-100-B" + }, + { + "name": "vedge-ISR1100-4G" + }, + { + "name": "vedge-100" + }, + { + "name": "vsmart" + }, + { + "name": "vedge-ISR1100-4GLTE" + }, + { + "name": "vedge-100-WM" + }, + { + "name": "vmanage" + }, + { + "name": "vbond" + }, + { + "name": "vedge-100-M" + }, + { + "name": "vedge-ISR1100X-6G" + }, + { + "name": "vedge-ISR1100X-4G" + } + ], + "displayName": "AAA", + "name": "aaa", + "typeClass": "DefaultGeneralTemplate", + "description": "AAA", + "write_permission": true, + "read_permission": true, + "helperType": [] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/types/definition/{type_name}/{version}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template type definition


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateTypeDefinition", + "parameters": [ + { + "name": "type_name", + "in": "path", + "description": "Feature template type", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "path", + "description": "Version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template type": { + "description": "Template type", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/{deviceType}": { + "get": { + "tags": [ + "Configuration - General Template" + ], + "description": "Generate template based on device


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "generateTemplateByDeviceType", + "parameters": [ + { + "name": "deviceType", + "in": "path", + "description": "Device type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Feature template": { + "description": "Feature template", + "value": "[\"data\": [\n{\n \"deviceType\": [\n \"vedge-1000\",\n \"vedge-2000\",\n \"vedge-cloud\",\n \"vedge-5000\",\n \"vedge-ISR1100-6G\",\n \"vedge-100-B\",\n \"vedge-ISR1100-4G\",\n \"vedge-100\",\n \"vedge-ISR1100-4GLTE\",\n \"vedge-100-WM\",\n \"vedge-100-M\",\n \"vedge-ISR1100X-6G\",\n \"vedge-ISR1100X-4G\"\n ],\n \"templateType\": \"system-vedge\",\n \"templateMinVersion\": \"15.0.0\",\n \"lastUpdatedBy\": \"system\",\n \"editedTemplateDefinition\": \"{\"clock\":{\"timezone\":{\"vipObjectType\":\"object\",\"vipValue\":\"America/Los_Angeles\",\"vipType\":\"ignore\"}},\"gps-location\":{\"latitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"longitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"}},\"timer\":{\"dns-cache-timeout\":{\"vipObjectType\":\"object\",\"vipValue\":30,\"vipType\":\"ignore\"}},\"location\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"system-tunnel-mtu\":{\"vipObjectType\":\"object\",\"vipValue\":1024,\"vipType\":\"ignore\"},\"track-transport\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"port-offset\":{\"vipObjectType\":\"object\",\"vipValue\":0,\"vipType\":\"ignore\"},\"port-hop\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"control-session-pps\":{\"vipObjectType\":\"object\",\"vipValue\":300,\"vipType\":\"ignore\"},\"description\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"device-groups\":{\"vipObjectType\":\"list\",\"vipType\":\"ignore\"},\"site-id\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"system-ip\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"host-name\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"console-baud-rate\":{\"vipObjectType\":\"object\",\"vipValue\":\"115200\",\"vipType\":\"ignore\"},\"max-controllers\":{\"vipObjectType\":\"object\",\"vipValue\":2,\"vipType\":\"ignore\"},\"usb-controller\":{\"vipObjectType\":\"object\",\"vipValue\":\"false\",\"vipType\":\"ignore\"},\"track-default-gateway\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"host-policer-pps\":{\"vipObjectType\":\"object\",\"vipValue\":5000,\"vipType\":\"ignore\"},\"icmp-error-pps\":{\"vipObjectType\":\"object\",\"vipValue\":100,\"vipType\":\"ignore\"}}\",\n \"gTemplateClass\": \"vedge\",\n \"templateDefinition\": \"{\"clock\":{\"timezone\":{\"vipObjectType\":\"object\",\"vipValue\":\"America/Los_Angeles\",\"vipType\":\"ignore\"}},\"gps-location\":{\"latitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"longitude\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"}},\"timer\":{\"dns-cache-timeout\":{\"vipObjectType\":\"object\",\"vipValue\":30,\"vipType\":\"ignore\"}},\"location\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"system-tunnel-mtu\":{\"vipObjectType\":\"object\",\"vipValue\":1024,\"vipType\":\"ignore\"},\"track-transport\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"port-offset\":{\"vipObjectType\":\"object\",\"vipValue\":0,\"vipType\":\"ignore\"},\"port-hop\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"control-session-pps\":{\"vipObjectType\":\"object\",\"vipValue\":300,\"vipType\":\"ignore\"},\"description\":{\"vipObjectType\":\"object\",\"vipType\":\"ignore\"},\"device-groups\":{\"vipObjectType\":\"list\",\"vipType\":\"ignore\"},\"site-id\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"system-ip\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"host-name\":{\"vipObjectType\":\"object\",\"vipType\":\"variable\",\"vipValue\":\"\"},\"console-baud-rate\":{\"vipObjectType\":\"object\",\"vipValue\":\"115200\",\"vipType\":\"ignore\"},\"max-controllers\":{\"vipObjectType\":\"object\",\"vipValue\":2,\"vipType\":\"ignore\"},\"usb-controller\":{\"vipObjectType\":\"object\",\"vipValue\":\"false\",\"vipType\":\"ignore\"},\"track-default-gateway\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"host-policer-pps\":{\"vipObjectType\":\"object\",\"vipValue\":5000,\"vipType\":\"ignore\"},\"icmp-error-pps\":{\"vipObjectType\":\"object\",\"vipValue\":100,\"vipType\":\"ignore\"}}\",\n \"templateId\": \"347eca1b-a0ae-42be-92d1-4702b5285aae\",\n \"attachedMastersCount\": 0,\n \"configType\": \"xml\",\n \"createdOn\": 1588001883034,\n \"@rid\": 49,\n \"feature\": \"vmanage-default\",\n \"factoryDefault\": true,\n \"createdBy\": \"system\",\n \"templateName\": \"Factory_Default_vEdge_System_Template\",\n \"devicesAttached\": 0,\n \"templateDescription\": \"Default System template settings for vEdge\",\n \"lastUpdatedOn\": 1588001883034\n}\n]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/template/feature/{templateId}": { + "put": { + "tags": [ + "Configuration - General Template" + ], + "description": "Update feature template


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "editFeatureTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "CedgeVoiceCard-example": { + "description": "CedgeVoiceCard-example" + }, + "CedgeVoiceSrst-example": { + "description": "CedgeVoiceSrst-example" + }, + "aaa-example": { + "description": "aaa-example" + }, + "appqoe-example": { + "description": "appqoe-example" + }, + "archive-example": { + "description": "archive-example" + }, + "banner-example": { + "description": "banner-example" + }, + "bfd-vedge-example": { + "description": "bfd-vedge-example" + }, + "bgp-example": { + "description": "bgp-example" + }, + "bridge-example": { + "description": "bridge-example" + }, + "cedge_aaa-example": { + "description": "cedge_aaa-example" + }, + "cedge_global-example": { + "description": "cedge_global-example" + }, + "cedge_igmp-example": { + "description": "cedge_igmp-example" + }, + "cedge_multicast-example": { + "description": "cedge_multicast-example" + }, + "cedge_pim-example": { + "description": "cedge_pim-example" + }, + "cellular-cedge-controller-example": { + "description": "cellular-cedge-controller-example" + }, + "cellular-cedge-gps-controller-example": { + "description": "cellular-cedge-gps-controller-example" + }, + "cellular-cedge-profile-example": { + "description": "cellular-cedge-profile-example" + }, + "cellular-gateway-platform-example": { + "description": "cellular-gateway-platform-example" + }, + "cellular-gateway-profile-example": { + "description": "cellular-gateway-profile-example" + }, + "cellular-profile-example": { + "description": "cellular-profile-example" + }, + "cisco_banner-example": { + "description": "cisco_banner-example" + }, + "cisco_bfd-example": { + "description": "cisco_bfd-example" + }, + "cisco_bgp-example": { + "description": "cisco_bgp-example" + }, + "cisco_dhcp_server-example": { + "description": "cisco_dhcp_server-example" + }, + "cisco_dsp_farm-example": { + "description": "cisco_dsp_farm-example" + }, + "cisco_logging-example": { + "description": "cisco_logging-example" + }, + "cisco_ntp-example": { + "description": "cisco_ntp-example" + }, + "cisco_omp-example": { + "description": "cisco_omp-example" + }, + "cisco_ospf-example": { + "description": "cisco_ospf-example" + }, + "cisco_ospfv3-example": { + "description": "cisco_ospfv3-example" + }, + "cisco_secure_internet_gateway-example": { + "description": "cisco_secure_internet_gateway-example" + }, + "cisco_security-example": { + "description": "cisco_security-example" + }, + "cisco_sig_credential-example": { + "description": "cisco_sig_credential-example" + }, + "cisco_snmp-example": { + "description": "cisco_snmp-example" + }, + "cisco_system-example": { + "description": "cisco_system-example" + }, + "cisco_thousandeye-example": { + "description": "cisco_thousandeye-example" + }, + "cisco_trustsec-example": { + "description": "cisco_trustsec-example" + }, + "cisco_vp-example": { + "description": "cisco_vp-example" + }, + "cisco_vpn_interface-example": { + "description": "cisco_vpn_interface-example" + }, + "cisco_vpn_interface_gre-example": { + "description": "cisco_vpn_interface_gre-example" + }, + "cisco_vpn_interface_ipsec-example": { + "description": "cisco_vpn_interface_ipsec-example" + }, + "cisco_wireless_la-example": { + "description": "cisco_wireless_la-example" + }, + "cli-template-example": { + "description": "cli-template-example" + }, + "dhcp-server-example": { + "description": "dhcp-server-example" + }, + "eigrp-example": { + "description": "eigrp-example" + }, + "igmp-example": { + "description": "igmp-example" + }, + "logging-example": { + "description": "logging-example" + }, + "multicast-example": { + "description": "multicast-example" + }, + "ntp-example": { + "description": "ntp-example" + }, + "omp-vedge-example": { + "description": "omp-vedge-example" + }, + "omp-vsmart-example": { + "description": "omp-vsmart-example" + }, + "ospf-example": { + "description": "ospf-example" + }, + "pim-example": { + "description": "pim-example" + }, + "probe-example": { + "description": "probe-example" + }, + "secure-internet-gateway-example": { + "description": "secure-internet-gateway-example" + }, + "security-vedge-example": { + "description": "security-vedge-example" + }, + "security-vsmart-example": { + "description": "security-vsmart-example" + }, + "sig-credential-example": { + "description": "sig-credential-example" + }, + "snmp-example": { + "description": "snmp-example" + }, + "switchport-example": { + "description": "switchport-example" + }, + "system-vedge-example": { + "description": "system-vedge-example" + }, + "system-vsmart-example": { + "description": "system-vsmart-example" + }, + "t1-e1-controller-example": { + "description": "t1-e1-controller-example" + }, + "tenant-example": { + "description": "tenant-example" + }, + "ucse-example": { + "description": "ucse-example" + }, + "virtual-application-utd-example": { + "description": "virtual-application-utd-example" + }, + "vpn-cedge-interface-cellular-example": { + "description": "vpn-cedge-interface-cellular-example" + }, + "vpn-cedge-interface-multilink-controller-example": { + "description": "vpn-cedge-interface-multilink-controller-example" + }, + "vpn-interface-ethpppoe-example": { + "description": "vpn-interface-ethpppoe-example" + }, + "vpn-interface-ipoe-example": { + "description": "vpn-interface-ipoe-example" + }, + "vpn-interface-pppoa-example": { + "description": "vpn-interface-pppoa-example" + }, + "vpn-interface-pppoe-example": { + "description": "vpn-interface-pppoe-example" + }, + "vpn-interface-svi-example": { + "description": "vpn-interface-svi-example" + }, + "vpn-interface-t1-e1-example": { + "description": "vpn-interface-t1-e1-example" + }, + "vpn-vedge-interface-bridge-example": { + "description": "vpn-vedge-interface-bridge-example" + }, + "vpn-vedge-interface-cellular-example": { + "description": "vpn-vedge-interface-cellular-example" + }, + "vpn-vedge-interface-gre-example": { + "description": "vpn-vedge-interface-gre-example" + }, + "vpn-vedge-interface-ipsec-example": { + "description": "vpn-vedge-interface-ipsec-example" + }, + "vpn-vedge-interface-natpool-example": { + "description": "vpn-vedge-interface-natpool-example" + }, + "vpn-vedge-interface-ppp-example": { + "description": "vpn-vedge-interface-ppp-example" + }, + "vpn-vedge-interface-vap-example": { + "description": "vpn-vedge-interface-vap-example" + }, + "vpn-vedge-interface-example": { + "description": "vpn-vedge-interface-example" + }, + "vpn-vedge-pppoe-enabled-interface-example": { + "description": "vpn-vedge-pppoe-enabled-interface-example" + }, + "vpn-vedge-example": { + "description": "vpn-vedge-example" + }, + "vpn-vmanage-interface-example": { + "description": "vpn-vmanage-interface-example" + }, + "vpn-vsmart-interface-example": { + "description": "vpn-vsmart-interface-example" }, + "vpn-vsmart-example": { + "description": "vpn-vsmart-example" + }, + "wla-example": { + "description": "wla-example" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - General Template" + ], + "description": "Delete feature template", + "operationId": "deleteGeneralTemplate", + "parameters": [ + { + "name": "templateId", + "in": "path", + "description": "Template Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write" + } + }, + "/template/lock/{processId}": { + "put": { + "tags": [ + "Configuration - Template Lock" + ], + "description": "Update lease", + "operationId": "updateLeaseTime", + "parameters": [ + { + "name": "processId", + "in": "path", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Template Lock" + ], + "description": "Remove lock", + "operationId": "removeLock", + "parameters": [ + { + "name": "processId", + "in": "path", + "description": "Process Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-write,Template Deploy-write,Policy Configuration-write" + } + }, + "/template/policy/assembly/security": { + "post": { + "tags": [ + "Configuration - Policy Security Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/security/{id}": { + "get": { + "tags": [ + "Configuration - Policy Security Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vedge": { + "post": { + "tags": [ + "Configuration - Policy vEdge Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview_1", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vedge/{id}": { + "get": { + "tags": [ + "Configuration - Policy vEdge Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/voice": { + "post": { + "tags": [ + "Configuration - Policy Voice Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview_2", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/voice/{id}": { + "get": { + "tags": [ + "Configuration - Policy Voice Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vsmart": { + "post": { + "tags": [ + "Configuration - Policy vSmart Assembler" + ], + "description": "Get policy assembly preview", + "operationId": "preview_3", + "requestBody": { + "description": "Policy assembly", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly": { + "description": "Policy assembly", + "value": { + "assembly": [ + { + "definitionId": "aee2adc2-7b10-437e-8d74-fc52557f7cb7", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "cf4bbb13-0a3f-4302-adfa-6cfce6b3950c" + ], + "vpnLists": [ + "ab2b3ffa-b390-4143-95f3-14d084efc85f" + ] + } + ] + }, + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": "{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/assembly/vsmart/{id}": { + "get": { + "tags": [ + "Configuration - Policy vSmart Assembler" + ], + "description": "Get policy assembly preview for feature policy", + "operationId": "previewById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy assembly preview": { + "description": "Policy assembly preview", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write" + } + }, + "/template/policy/clouddiscoveredapp": { + "get": { + "tags": [ + "Configuration - Policy Cloud Application Builder" + ], + "description": "Get all cloud discovered applications", + "operationId": "getCloudDiscoveredApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Cloud Discovered App": { + "description": "Cloud Discovered App", + "value": { + "data": [ + { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05", + "appName": "DemoApp", + "lastUpdated": "1590201349732", + "owner": "admin" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Set SLA class for policy cloud discovered applications", + "operationId": "MapTrafficProfiles", + "requestBody": { + "description": "App payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App payload": { + "description": "App payload", + "value": "[\n {\n \"appId\":\"71001c48-fdcf-4ac0-aaf3-ca4a20386a18\",\n \"slaClass\":\"video\",\n }\n]" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App": { + "description": "App", + "value": { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/customapp": { + "get": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Get all policy custom applications", + "operationId": "getCustomApps", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Custom App": { + "description": "Custom App", + "value": { + "data": [ + { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05", + "appName": "DemoApp", + "lastUpdated": "1590201349732", + "owner": "admin" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Create a policy custom applications", + "operationId": "createCustomApp", + "requestBody": { + "description": "App payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App payload": { + "description": "App payload", + "value": { + "appName": "DemoApp" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App Id": { + "description": "App Id", + "value": { + "appId": "679cdb6f-67d8-45bd-9de0-a73138a9ca05" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/customapp/{id}": { + "get": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Get a policy custom applications", + "operationId": "getCustomAppById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Custom App": { + "description": "Custom App", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Edit a policy custom applications", + "operationId": "editCustomApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "App payload", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "App payload": { + "description": "App payload", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Policy Custom Application Builder" + ], + "description": "Delete a policy custom applications", + "operationId": "deleteCustomApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/definition/acl": { + "get": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_8", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/acl/bulk": { + "put": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_8", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/acl/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/acl/preview": { + "post": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_8", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/acl/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/acl/{id}": { + "get": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Access List Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/aclv6": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_9", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/aclv6/bulk": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_9", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/aclv6/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/aclv6/preview": { + "post": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_9", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/aclv6/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/aclv6/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Access Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,ACL Policy-write" + } + }, + "/template/policy/definition/advancedMalwareProtection": { + "get": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_11", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/bulk": { + "put": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_11", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/preview": { + "post": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_11", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedMalwareProtection/{id}": { + "get": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy AMP Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile": { + "get": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_10", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/bulk": { + "put": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_10", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/preview": { + "post": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_10", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/advancedinspectionprofile/{id}": { + "get": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Advanced Inspection Profile Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/approute": { + "get": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_12", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-writeAppRoute Policy-write" + } + }, + "/template/policy/definition/approute/bulk": { + "put": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_12", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/approute/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/approute/preview": { + "post": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_12", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/approute/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/approute/{id}": { + "get": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-writeAppRoute Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy AppRoute Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-writeAppRoute Policy-write" + } + }, + "/template/policy/definition/cflowd": { + "get": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_13", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,CFlowD Policy-write" + } + }, + "/template/policy/definition/cflowd/bulk": { + "put": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_13", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/cflowd/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/cflowd/preview": { + "post": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_13", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/cflowd/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/cflowd/{id}": { + "get": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,CFlowD Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Cflowd Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,CFlowD Policy-write" + } + }, + "/template/policy/definition/control": { + "get": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_14", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/control/bulk": { + "put": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_14", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/control/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/control/preview": { + "post": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_14", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/control/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/control/{id}": { + "get": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Control Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/data": { + "get": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_15", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/data/bulk": { + "put": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_15", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/data/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/data/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_15", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/data/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/data/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicy": { + "get": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_16", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/bulk": { + "put": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_16", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/preview": { + "post": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_16", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicy/{id}": { + "get": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Device Access Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_17", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/bulk": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_17", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/preview": { + "post": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_17", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/deviceaccesspolicyv6/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Device Access Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Device Access Policy-write" + } + }, + "/template/policy/definition/dialpeer": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_25", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dialpeer/bulk": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_25", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dialpeer/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dialpeer/preview": { + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_25", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dialpeer/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dialpeer/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity/bulk": { + "put": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/dnssecurity/preview": { + "post": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dnssecurity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/dnssecurity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Local Domain Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport": { + "get": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_26", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport/bulk": { + "put": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_26", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxoport/preview": { + "post": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_26", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxoport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxoport/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy FXO Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport": { + "get": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_28", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport/bulk": { + "put": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_28", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsdidport/preview": { + "post": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_28", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsdidport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsdidport/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy FXSDID Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport": { + "get": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_27", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport/bulk": { + "put": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_27", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/fxsport/preview": { + "post": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_27", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/fxsport/{id}": { + "get": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy FXS Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke": { + "get": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_4", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke/bulk": { + "put": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_4", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/hubandspoke/preview": { + "post": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_4", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/hubandspoke/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/hubandspoke/{id}": { + "get": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Hub and Spoke Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention": { + "get": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_18", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention/bulk": { + "put": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_18", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/intrusionprevention/preview": { + "post": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_18", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/intrusionprevention/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/intrusionprevention/{id}": { + "get": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Intrusion Prevention Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/mesh": { + "get": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_5", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/mesh/bulk": { + "put": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_5", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/mesh/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/mesh/preview": { + "post": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_5", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/mesh/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/mesh/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Mesh Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport": { + "get": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_29", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport/bulk": { + "put": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_29", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/priisdnport/preview": { + "post": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_29", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/priisdnport/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/priisdnport/{id}": { + "get": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy PRI ISDN Port Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap": { + "get": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write" + }, + "post": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_1", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap/bulk": { + "put": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_1", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/qosmap/preview": { + "post": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_1", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/qosmap/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/qosmap/{id}": { + "get": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Qos Map Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/rewriterule": { + "get": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_19", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Rewrite Policy-write" + } + }, + "/template/policy/definition/rewriterule/bulk": { + "put": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_19", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/rewriterule/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/rewriterule/preview": { + "post": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_19", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/rewriterule/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/rewriterule/{id}": { + "get": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Rewrite Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Rewrite Rule Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Rewrite Policy-write" + } + }, + "/template/policy/definition/ruleset": { + "get": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_20", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ruleset/bulk": { + "put": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_20", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ruleset/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ruleset/preview": { + "post": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_20", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ruleset/preview/{id}": { + "get": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ruleset/{id}": { + "get": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Rule Set Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup": { + "get": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_21", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup/bulk": { + "put": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_21", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/securitygroup/preview": { + "post": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_21", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/securitygroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/securitygroup/{id}": { + "get": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Security Group Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_30", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile/bulk": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_30", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/srstphoneprofile/preview": { + "post": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_30", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/srstphoneprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/srstphoneprofile/{id}": { + "get": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy DialPeer Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption": { + "get": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_3", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption/bulk": { + "put": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_3", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption/multiple/{id}": { + "put": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/ssldecryption/preview": { + "post": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_3", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ssldecryption/preview/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/ssldecryption/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - SSL Decryption Policy Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile": { + "get": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_22", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile/bulk": { + "put": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_22", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile/multiple/{id}": { + "put": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/sslutdprofile/preview": { + "post": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_22", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/sslutdprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/sslutdprofile/{id}": { + "get": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - SSL Decryption UTD Profile Definition" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering": { + "get": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_23", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering/bulk": { + "put": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_23", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/urlfiltering/preview": { + "post": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_23", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/urlfiltering/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/urlfiltering/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL Filtering Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vedgeroute": { + "get": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_24", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Route Policy-write" + } + }, + "/template/policy/definition/vedgeroute/bulk": { + "put": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_24", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vedgeroute/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vedgeroute/preview": { + "post": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_24", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vedgeroute/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vedgeroute/{id}": { + "get": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Route Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy vEdge Route Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write,Route Policy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup": { + "get": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write" + }, + "post": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_6", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,VPN Membership Policy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/bulk": { + "put": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_6", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/preview": { + "post": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_6", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnmembershipgroup/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,VPN Membership Policy-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN Membership Group Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Topology Policy-write,VPN Membership Policy-write" + } + }, + "/template/policy/definition/vpnqosmap": { + "get": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write" + }, + "post": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_2", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/vpnqosmap/bulk": { + "put": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_2", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnqosmap/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/vpnqosmap/preview": { + "post": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_2", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnqosmap/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/vpnqosmap/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write" + }, + "put": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN-Qos Map Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "QoSMap Policy-write,Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw": { + "get": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Get policy definitions", + "operationId": "getDefinitions_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Create policy definition", + "operationId": "createPolicyDefinition_7", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": false, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "", + "fileAnalysisFileTypes": [], + "fileAnalysisAlert": "", + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": true, + "umbrellaDefault": true, + "localDomainBypassEnabled": true, + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + }, + "HubandSpoke definition": { + "description": "HubandSpoke definition", + "value": { + "name": "Demo-Hub-n-Spoke-Policy", + "type": "hubAndSpoke", + "description": "Demo-Hub-n-Spoke-Policy", + "definition": { + "vpnList": "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf", + "subDefinitions": [ + { + "name": "My Hub-and-Spoke", + "equalPreference": false, + "advertiseTloc": true, + "spokes": [ + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "hubs": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "preference": "20", + "prefixLists": [ + "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + ], + "ipv6PrefixLists": [] + } + ] + } + ], + "tlocList": "1e97c258-4323-4754-9dc0-44e9656d43bf" + } + ] + } + } + }, + "VPN membership group definition": { + "description": "VPN membership group definition", + "value": { + "name": "Demo-VPN-Membership-Policy", + "type": "vpnMembershipGroup", + "description": "Demo-VPN-Membership-Policy", + "definition": { + "sites": [ + { + "siteList": "24747ccd-4f7f-4dfa-8800-34f565fb65b4", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + }, + { + "siteList": "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "vpnList": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + } + } + }, + "AppRoute definition": { + "description": "AppRoute definition", + "value": { + "name": "Demo-AAR-Policy", + "type": "appRoute", + "description": "Demo-AAR-Policy", + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "request" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "1025" + }, + { + "field": "destinationDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "saasAppList", + "ref": "1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06" + } + ] + }, + "actions": [ + { + "type": "cloudSaas", + "parameter": "" + } + ] + }, + { + "sequenceId": 21, + "sequenceName": "App Route", + "sequenceType": "appRoute", + "sequenceIpType": "ipv6", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceIpv6", + "value": "2001::/8" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIpv6", + "value": "2001::/8" + }, + { + "field": "destinationPort", + "value": "65000" + } + ] + }, + "actions": [ + { + "type": "backupSlaPreferredColor", + "parameter": "biz-internet" + }, + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "slaClass", + "parameter": [ + { + "field": "name", + "ref": "46cea5a1-1570-4921-b87a-837d590eb37e" + }, + { + "field": "preferredColor", + "value": "public-internet" + }, + { + "field": "strict" + } + ] + } + ] + } + ] + } + }, + "Data policy definition": { + "description": "Data policy definition", + "value": { + "name": "Demo-Data-Policy", + "type": "data", + "description": "Demo-Data-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dnsAppList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + }, + { + "field": "dns", + "value": "response" + }, + { + "field": "dscp", + "value": "46" + }, + { + "field": "packetLength", + "value": "1504" + }, + { + "field": "plp", + "value": "high" + }, + { + "field": "protocol", + "value": "6" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.0.0.0/12" + }, + { + "field": "destinationPort", + "value": "65000" + }, + { + "field": "tcp", + "value": "syn" + } + ] + }, + "actions": [ + { + "type": "count", + "parameter": "Demo-Counter" + }, + { + "type": "set", + "parameter": [ + { + "field": "dscp", + "value": "34" + }, + { + "field": "forwardingClass", + "value": "ef-class" + }, + { + "field": "localTlocList", + "value": { + "color": "public-internet", + "restrict": "", + "encap": "ipsec" + } + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "policer", + "ref": "ecf250c7-bef0-405b-8e74-4d67440cac90" + } + ] + }, + { + "type": "cflowd" + }, + { + "type": "log", + "parameter": "" + }, + { + "type": "nat", + "parameter": { + "field": "pool", + "value": "1" + } + }, + { + "type": "redirectDns", + "parameter": { + "field": "dnsType", + "value": "umbrella" + } + } + ] + }, + { + "sequenceId": 11, + "sequenceName": "Custom", + "baseAction": "accept", + "sequenceType": "data", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "appList", + "ref": "b6752dba-969b-46de-a7e7-da11910fb1bf" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "service", + "value": { + "type": "FW", + "vpn": "10", + "tloc": { + "ip": "10.0.0.1", + "color": "biz-internet", + "encap": "ipsec" + } + } + } + ] + }, + { + "type": "tcpOptimization", + "parameter": "" + }, + { + "type": "lossProtect", + "parameter": "fecAdaptive" + }, + { + "type": "lossProtectFec", + "parameter": "fecAdaptive" + }, + { + "type": "sig", + "parameter": "" + } + ] + } + ] + } + }, + "CFlowd definition": { + "description": "CFlowd definition", + "value": { + "name": "Demo-cflowd-Policy", + "type": "cflowd", + "description": "Demo-cflowd-Policy", + "definition": { + "flowActiveTimeout": 3600, + "flowInactiveTimeout": 3600, + "flowSamplingInterval": 65513, + "templateRefresh": 86400, + "collectors": [ + { + "vpn": "10", + "address": "10.0.0.1", + "port": 9912, + "transport": "transport_tcp", + "sourceInterface": "ge0/1" + }, + { + "vpn": "20", + "address": "10.0.0.1", + "port": 1025, + "transport": "transport_udp", + "sourceInterface": "GigabitEthernet0/0/1" + } + ], + "protocol": "ipv4" + } + } + }, + "QoS map definition": { + "description": "QoS map definition", + "value": { + "name": "Demo-QoS-Policy", + "type": "qosMap", + "description": "Demo-QoS-Policy", + "definition": { + "qosSchedulers": [ + { + "queue": "0", + "bandwidthPercent": "75", + "bufferPercent": "75", + "burst": "15000", + "scheduling": "llq", + "drops": "tail-drop", + "classMapRef": "" + }, + { + "queue": "7", + "bandwidthPercent": "25", + "bufferPercent": "25", + "scheduling": "wrr", + "drops": "red-drop", + "classMapRef": "4484c444-b956-4016-bd15-538b74fc2785" + } + ] + } + } + }, + "VPN-QoS map definition": { + "description": "VPN-QoS map definition", + "value": { + "name": "Demo-VPN-QoS-Policy", + "type": "vpnQosMap", + "description": "Demo-VPN-QoS-Policy", + "definition": { + "vpnQosSchedulers": [ + { + "vpnListRef": "", + "bandwidthRate": "100000", + "shapingRate": "120000", + "childMapRef": "" + }, + { + "childMapRef": "" + } + ] + } + } + }, + "Rewrite rule definition": { + "description": "Rewrite rule definition", + "value": { + "name": "Demo-Rewrite-Rule", + "type": "rewriteRule", + "description": "Demo-Rewrite-Rule", + "definition": { + "rules": [ + { + "class": "4484c444-b956-4016-bd15-538b74fc2785", + "plp": "low", + "dscp": "46", + "layer2Cos": "2" + } + ] + } + } + }, + "Device access policy definition": { + "description": "Device access policy definition", + "value": { + "name": "Demo-DeviceAccess-Policy", + "type": "deviceaccesspolicy", + "description": "Demo-DeviceAccess-Policy", + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Device Access Control List", + "baseAction": "accept", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "22" + }, + { + "field": "sourceIp", + "value": "10.10.24.0/24" + }, + { + "field": "sourcePort", + "value": "65000" + }, + { + "field": "destinationIp", + "value": "10.10.10.1/32" + }, + { + "field": "vpn", + "value": "10" + } + ] + }, + "actions": [] + }, + { + "sequenceId": 11, + "sequenceName": "Device Access Control List", + "baseAction": "drop", + "sequenceType": "deviceaccesspolicy", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "destinationPort", + "value": "161" + }, + { + "field": "sourceDataPrefixList", + "ref": "6c2b7164-5de2-4775-938c-b443504324ab" + } + ] + }, + "actions": [] + } + ] + } + }, + "vEdge route definition": { + "description": "vEdge route definition", + "value": { + "name": "Demo-Route-Policy", + "type": "vedgeRoute", + "description": "Demo-Route-Policy", + "defaultAction": { + "type": "reject" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Route", + "baseAction": "accept", + "sequenceType": "vedgeRoute", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "address", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "asPath", + "ref": "79f8c180-1a23-4f09-800d-62652b571258" + }, + { + "field": "community", + "matchFlag": "or", + "ref": "33de059b-27ec-4a83-be28-8985128381eb" + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "ref": "b5c4d764-20bc-4de3-9bac-52ef70f1186c" + }, + { + "field": "ompTag", + "value": "10" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "ospfTag", + "value": "10" + }, + { + "field": "peer", + "value": "10.0.0.1" + } + ] + }, + "actions": [ + { + "type": "set", + "parameter": [ + { + "field": "asPath", + "value": { + "exclude": "120 130", + "prepend": "65521 65521" + } + }, + { + "field": "localPreference", + "value": "200" + }, + { + "field": "metricType", + "value": "type1" + }, + { + "field": "metric", + "value": "100" + }, + { + "field": "nextHop", + "value": "10.0.0.1" + }, + { + "field": "ompTag", + "value": "100" + }, + { + "field": "weight", + "value": "200" + }, + { + "field": "ospfTag", + "value": "122" + }, + { + "field": "originator", + "value": "10.0.0.1" + }, + { + "field": "origin", + "value": "igp" + }, + { + "field": "community", + "value": "1000:10000" + } + ] + } + ] + } + ] + } + }, + "vSmart definition": { + "description": "vSmart definition", + "value": { + "policyDescription": "Demo-Centralized-Policy", + "policyType": "feature", + "policyName": "Demo-Centralized-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "eb0daba9-7fc4-4f4f-bae7-cd958f81f863", + "type": "cflowd", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ] + } + ] + }, + { + "definitionId": "3e33fa50-a30d-4586-9d69-106121feaaf4", + "type": "data", + "entries": [ + { + "direction": "service", + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "8b2e7c44-2666-48a7-87a0-36a43c2d003e", + "type": "appRoute", + "entries": [ + { + "siteLists": [ + "5c58c36c-9cd6-468f-8434-ee6d5801c6ba", + "24747ccd-4f7f-4dfa-8800-34f565fb65b4" + ], + "vpnLists": [ + "cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf" + ] + } + ] + }, + { + "definitionId": "1b76052e-1cb5-44b1-8e5e-4096cb261736", + "type": "vpnMembershipGroup" + }, + { + "definitionId": "62960276-c797-41fd-bebb-c017fc752f4e", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + }, + "vEdge definition": { + "description": "vEdge definition", + "value": { + "policyDescription": "Demo-Local-Policy", + "policyType": "feature", + "policyName": "Demo-Local-Policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "56283dcf-6dda-4831-bcd1-d9cf62d33fdc", + "type": "qosMap" + }, + { + "definitionId": "a75ead1f-f6ab-4a80-af29-79b742b31c5c", + "type": "rewriteRule" + }, + { + "definitionId": "555dd393-e7b6-4861-866f-f227f5f780b7", + "type": "deviceAccessPolicy" + }, + { + "definitionId": "22655824-d0df-4a8b-9be0-9808938a0e6b", + "type": "vedgeRoute" + } + ], + "settings": { + "flowVisibility": true, + "flowVisibilityIPv6": true, + "appVisibility": true, + "cloudQos": true, + "cloudQosServiceSide": true, + "implicitAclLogging": true, + "appVisibilityIPv6": true + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "definitionId": "00f718df-4f95-4363-8639-1fe855c9eb09" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw/bulk": { + "put": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Create/Edit policy definitions in bulk", + "operationId": "savePolicyDefinitionInBulk_7", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw/multiple/{id}": { + "put": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Edit multiple policy definitions", + "operationId": "editMultiplePolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/definition/zonebasedfw/preview": { + "post": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinition_7", + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/zonebasedfw/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Preview policy definition", + "operationId": "previewPolicyDefinitionById_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/definition/zonebasedfw/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Get a specific policy definitions", + "operationId": "getPolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Edit a policy definitions", + "operationId": "editPolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy definition", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "ACL policy": { + "description": "ACL policy", + "value": { + "name": "Demo-ACL", + "type": "acl", + "description": "Demo-ACL", + "defaultAction": { + "type": "accept" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Access Control List", + "baseAction": "accept", + "sequenceType": "acl", + "sequenceIpType": "ipv4", + "match": { + "entries": [ + { + "field": "dscp", + "value": "46" + }, + { + "field": "protocol", + "value": "6" + } + ] + }, + "actions": [ + { + "type": "class", + "parameter": { + "ref": "89d20034-7149-4492-b392-b5c4f7903235" + } + } + ] + } + ] + } + }, + "ZBFW definition": { + "description": "ZBFW definition", + "value": { + "name": "Demo-ZBFW", + "type": "zoneBasedFW", + "description": "Demo-ZBFW", + "definition": { + "defaultAction": { + "type": "drop" + }, + "sequences": [ + { + "sequenceId": 1, + "sequenceName": "Demo-Rule-1", + "baseAction": "inspect", + "sequenceType": "zoneBasedFW", + "match": { + "entries": [ + { + "field": "sourceDataPrefixList", + "ref": "ecbea5de-b200-4ff7-aa76-f537b5f858e9" + } + ] + }, + "actions": [] + } + ], + "entries": [ + { + "sourceZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53", + "destinationZone": "5f35c58e-234e-4013-9e1a-77c7fa6aec53" + } + ] + } + } + }, + "IPS definition": { + "description": "IPS definition", + "value": { + "name": "Demo-IPS-Policy", + "type": "intrusionPrevention", + "description": "Testing", + "definition": { + "signatureSet": "security", + "inspectionMode": "detection", + "signatureWhiteList": { + "ref": "ad189f08-af06-4799-97d6-0a7c7409cb8d" + }, + "logLevel": "error", + "logging": [], + "targetVpns": [ + "10", + "20" + ] + } + } + }, + "URL filtering definition": { + "description": "URL filtering definition", + "value": { + "name": "Demo-URL-Filtering-Policy", + "type": "urlFiltering", + "description": "", + "definition": { + "webCategoriesAction": "block", + "webCategories": [ + "auctions", + "bot-nets", + "news-and-media" + ], + "webReputation": "moderate-risk", + "urlWhiteList": { + "ref": "c20e31fb-fcea-4f48-93e3-09d2c6492d8b" + }, + "urlBlackList": { + "ref": "557ed432-6cf8-495b-a445-d340d4c6236e" + }, + "blockPageAction": "text", + "blockPageContents": "Access to the requested page has been denied. Please contact your Network Administrator", + "enableAlerts": true, + "alerts": [ + "blacklist", + "whitelist", + "categories-reputation" + ], + "logging": [], + "targetVpns": [ + "30" + ] + } + } + }, + "AMP definition": { + "description": "AMP definition", + "value": { + "name": "Demo-AMP-Policy", + "type": "advancedMalwareProtection", + "description": "", + "definition": { + "matchAllVpn": true, + "fileReputationCloudServer": "nam", + "fileReputationEstServer": "nam", + "fileReputationAlert": "critical", + "fileAnalysisCloudServer": "nam", + "fileAnalysisFileTypes": [ + "pdf", + "ms-exe" + ], + "fileAnalysisAlert": "critical", + "targetVpns": [ + "10", + "20" + ], + "fileAnalysisEnabled": true + } + } + }, + "DNS definition": { + "description": "DNS definition", + "value": { + "name": "Demo-DNS-Policy", + "type": "DNSSecurity", + "description": "Testing", + "definition": { + "localDomainBypassList": { + "ref": "143f753f-8d51-4be6-805d-bc330f09982f" + }, + "matchAllVpn": false, + "targetVpns": [ + { + "vpns": [ + "10" + ], + "umbrellaDefault": false, + "dnsServerIP": "10.10.10.1", + "localDomainBypassEnabled": true + } + ], + "dnsCrypt": true, + "umbrellaData": { + "ref": "e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy definition": { + "description": "Policy definition", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Zone Based Firewall Definition Builder" + ], + "description": "Delete policy definition", + "operationId": "deletePolicyDefinition_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/ise/identity/deleteAllLists": { + "delete": { + "tags": [ + "Configuration - Identity Service Engine" + ], + "description": "Delete all identity lists", + "operationId": "deleteAllIdentityLists", + "requestBody": { + "description": "Delete lists", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Delete Identity Listsr": { + "description": "Delete Identity Listsr", + "value": { + "type": "identity" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "deleteAllLists": { + "description": "deleteAllLists", + "value": true + }, + "deleteSomeOrNoLists": { + "description": "deleteSomeOrNoLists", + "value": false + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/ise/identity/referenced/{listType}": { + "get": { + "tags": [ + "Configuration - Identity Service Engine" + ], + "description": "Get all referenced Identity Lists", + "operationId": "getIdentityListReference", + "parameters": [ + { + "name": "listType", + "in": "path", + "description": "list type", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "referenced identity list Ids": { + "description": "referenced identity list Ids", + "value": "[\n {\n \"listId\": \"851cb243-d0da-4d7f-bdf9-124d979eadb9\",\n \"name\": \"universal\",\n \"type\": \"identity\",\n \"description\": \"test\",\n \"entries\": [\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Schema Admins\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Enterprise Admins\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Enterprise Read-only Domain Controllers\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Enterprise Key Admins\"\n }\n ],\n \"lastUpdated\": 1644359006986,\n \"owner\": \"admin\",\n \"readOnly\": false,\n \"version\": \"0\",\n \"infoTag\": \"\",\n \"referenceCount\": 1,\n \"references\": [\n {\n \"id\": \"0836d356-b89a-4fb9-abbc-1bb14d270ac8\",\n \"type\": \"zoneBasedFW\"\n }\n ],\n \"isActivatedByVsmart\": false\n },\n {\n \"listId\": \"5ad0dd2d-cc45-4710-8965-94965fe45ad4\",\n \"name\": \"test\",\n \"type\": \"identity\",\n \"description\": \"test\",\n \"entries\": [\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Cert Publishers\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/RAS and IAS Servers\"\n },\n {\n \"userGroup\": \"SDWAN-IDENTITY.CISCO.COM/Users/Allowed RODC Password Replication Group\"\n },\n {\n " + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/ise/identity/usergroups": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get all identity user groups", + "operationId": "getIdentityUserGroups", + "requestBody": { + "description": "Get Users", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UserGroup Filter": { + "description": "UserGroup Filter", + "value": { + "filter": "Cert Publishers" + } + }, + "UserGroup Empty Braces": { + "description": "UserGroup Empty Braces", + "value": {} + }, + "UserGroup Filter No Entry": { + "description": "UserGroup Filter No Entry" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User/Group return Json": { + "description": "User/Group return Json", + "value": { + "header": { + "generatedOn": 1643067620683, + "viewKeys": {}, + "columns": {}, + "fields": {} + }, + "data": { + "ERSActiveDirectoryGroups": { + "groups": [ + { + "name": "b1.com/Builtin/Administrators", + "sid": "b1.com/S-1-5-32-544", + "type": "BUILTIN, DOMAIN LOCAL" + } + ] + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/ise/identity/users": { + "post": { + "tags": [ + "Configuration - Ise Server" + ], + "description": "Get all identity users", + "operationId": "getIdentityUsers", + "requestBody": { + "description": "Get Users", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User Filter": { + "description": "User Filter", + "value": { + "filter": "a*" + } + }, + "User Filter Empty Braces": { + "description": "User Filter Empty Braces", + "value": {} + }, + "User Filter No Entry": { + "description": "User Filter No Entry" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "User/Group return Json": { + "description": "User/Group return Json", + "value": { + "header": { + "generatedOn": 1641942304491, + "viewKeys": {}, + "columns": {}, + "fields": {} + }, + "data": { + "ERSActiveDirectoryUsers": { + "users": [ + { + "adUserSamAccountName": "guest" + }, + { + "adUserSamAccountName": "defaultaccount" + }, + { + "adUserSamAccountName": "administrator" + }, + { + "adUserSamAccountName": "krbtgt" + }, + { + "adUserSamAccountName": "waseem" + } + ] + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list": { + "get": { + "tags": [ + "Configuration - Policy List Builder" + ], + "description": "Get all policy lists", + "operationId": "getAllPolicyLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/app": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_3", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_3", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_3", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/app/filtered": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_3", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/app/preview": { + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_3", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/app/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/app/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_3", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/appprobe": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_4", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_4", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_4", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/appprobe/filtered": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_4", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/appprobe/preview": { + "post": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_4", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/appprobe/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/appprobe/{id}": { + "get": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy App Probe Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_4", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/aspath": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_5", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_5", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_5", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/aspath/filtered": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_5", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/aspath/preview": { + "post": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_5", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/aspath/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/aspath/{id}": { + "get": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy ASPath List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_5", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/class": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_13", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_14", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_14", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/class/filtered": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_14", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/class/preview": { + "post": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_14", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/class/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/class/{id}": { + "get": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Forwarding Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_14", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/color": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_6", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_6", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_6", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/color/filtered": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_6", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/color/preview": { + "post": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_6", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/color/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/color/{id}": { + "get": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Color List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/community": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_7", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_7", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_7", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/community/filtered": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_7", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/community/preview": { + "post": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_7", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/community/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/community/{id}": { + "get": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Community List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_7", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataipv6prefix": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_8", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_8", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_8", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataipv6prefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_8", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataipv6prefix/preview": { + "post": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_8", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataipv6prefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataipv6prefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data IPV6 Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_8", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataprefix": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_9", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_10", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_10", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_10", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefix/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_10", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_10", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataprefixall": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Get policy lists for all data prefixes", + "operationId": "getListsForAllDataPrefixes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_9", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_9", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixall/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_9", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixall/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_9", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixall/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixall/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix All Types Of Lists Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_9", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/dataprefixfqdn": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Get lists for all all data-prefix(IPv4) and Fqdn lists", + "operationId": "getAllDataPrefixAndFQDNLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Data prefix and FQDN": { + "description": "Data prefix and FQDN", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_15", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_15", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixfqdn/filtered": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_15", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/dataprefixfqdn/preview": { + "post": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_15", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixfqdn/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/dataprefixfqdn/{id}": { + "get": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_15", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/expandedcommunity": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_10", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_11", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_11", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/expandedcommunity/filtered": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_11", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/expandedcommunity/preview": { + "post": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_11", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/expandedcommunity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/expandedcommunity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Expanded Community List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_11", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/extcommunity": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_11", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_12", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_12", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/extcommunity/filtered": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_12", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/extcommunity/preview": { + "post": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_12", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/extcommunity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/extcommunity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Extended Community List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_12", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/faxprotocol": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_12", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_13", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_13", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/faxprotocol/filtered": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_13", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/faxprotocol/preview": { + "post": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_13", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/faxprotocol/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/faxprotocol/{id}": { + "get": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Fax Protocol List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_13", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/fqdn": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_14", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_16", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_16", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/fqdn/filtered": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_16", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/fqdn/preview": { + "post": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_16", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/fqdn/preview/{id}": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/fqdn/{id}": { + "get": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - FQDN List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_16", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/geolocation": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_15", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_17", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_17", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/geolocation/entries": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get list of countries and continents for geo location", + "operationId": "getGeoLocationLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/geolocation/filtered": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_17", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/geolocation/preview": { + "post": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_17", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/geolocation/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/geolocation/{id}": { + "get": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Geo Location List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_17", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/identity": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_16", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_18", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_18", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/identity/filtered": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_18", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/identity/preview": { + "post": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_18", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/identity/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/identity/{id}": { + "get": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Identity List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_18", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/ipprefixall": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Get lists for all prefixes", + "operationId": "getListsForAllPrefixes", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Prefixes": { + "description": "Prefixes", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_21", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_21", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipprefixall/filtered": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_21", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipprefixall/preview": { + "post": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_21", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipprefixall/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipprefixall/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix for All Types of Lists Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_21", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/ipssignature": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_17", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_19", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_19", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipssignature/filtered": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_19", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipssignature/preview": { + "post": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_19", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipssignature/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipssignature/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPS Signature List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_19", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/ipv6prefix": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_18", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_20", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_20", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipv6prefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_20", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/ipv6prefix/preview": { + "post": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_20", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipv6prefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/ipv6prefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy IPv6 Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_20", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/localapp": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_19", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_22", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_22", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localapp/filtered": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_22", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localapp/preview": { + "post": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_22", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localapp/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localapp/{id}": { + "get": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Application List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_22", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/localdomain": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_20", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_23", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_23", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localdomain/filtered": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_23", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/localdomain/preview": { + "post": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_23", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localdomain/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/localdomain/{id}": { + "get": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Local Domain Name List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_23", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/mediaprofile": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mediaprofile/filtered": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mediaprofile/preview": { + "post": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mediaprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mediaprofile/{id}": { + "get": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Media Profile List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/mirror": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_21", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_24", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_24", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mirror/filtered": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_24", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/mirror/preview": { + "post": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_24", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mirror/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/mirror/{id}": { + "get": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Mirror List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_24", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/modempassthrough": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_22", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_25", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_25", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/modempassthrough/filtered": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_25", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/modempassthrough/preview": { + "post": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_25", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/modempassthrough/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/modempassthrough/{id}": { + "get": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Modem Passthrough List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_25", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/policer": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_23", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_26", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_26", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/policer/filtered": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_26", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/policer/preview": { + "post": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_26", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/policer/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/policer/{id}": { + "get": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Policer Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_26", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/port": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_24", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_27", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_27", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/port/filtered": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_27", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/port/preview": { + "post": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_27", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/port/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/port/{id}": { + "get": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Port List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_27", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/preferredcolorgroup": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_25", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_28", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_28", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/preferredcolorgroup/filtered": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_28", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/preferredcolorgroup/preview": { + "post": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_28", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/preferredcolorgroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/preferredcolorgroup/{id}": { + "get": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Preferred Color Group List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_28", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/prefix": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_26", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_29", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_29", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/prefix/filtered": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_29", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/prefix/preview": { + "post": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_29", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/prefix/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/prefix/{id}": { + "get": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Prefix List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_29", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/protocolname": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_27", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_30", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_30", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/protocolname/filtered": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_30", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/protocolname/preview": { + "post": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_30", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/protocolname/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/protocolname/{id}": { + "get": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Protocol Name List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_30", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/region": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_28", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_31", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_31", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/region/filtered": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_31", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/region/preview": { + "post": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_31", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/region/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/region/{id}": { + "get": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Region List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_31", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/site": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_29", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_32", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_32", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/site/defaultsite": { + "post": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Create default site list for sites missing from centralized policy", + "operationId": "createDefaultSiteList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Site list": { + "description": "Site list", + "value": { + "name": "Demo_site_list", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "200" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy-read,Policy-write" + } + }, + "/template/policy/list/site/filtered": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_32", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/site/preview": { + "post": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_32", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/site/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/site/{id}": { + "get": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Site List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_32", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/sla": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_30", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_33", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_33", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/sla/filtered": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_33", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/sla/preview": { + "post": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_33", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/sla/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/sla/{id}": { + "get": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy SLA Class List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_33", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/supervisorydisc": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_31", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_34", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_34", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/supervisorydisc/filtered": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_34", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/supervisorydisc/preview": { + "post": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_34", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/supervisorydisc/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/supervisorydisc/{id}": { + "get": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Supervisory Disc List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_34", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/tgapikey": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_32", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Create policy list", + "operationId": "createPolicyList_35", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_35", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tgapikey/filtered": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_35", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tgapikey/preview": { + "post": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_35", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tgapikey/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tgapikey/{id}": { + "get": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Threat Grid Api Key List" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_35", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/tloc": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_33", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_36", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_36", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tloc/filtered": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_36", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/tloc/preview": { + "post": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_36", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tloc/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/tloc/{id}": { + "get": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TLOC List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_36", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/translationprofile": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_1", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_1", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationprofile/filtered": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_1", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationprofile/preview": { + "post": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_1", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationprofile/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationprofile/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationProfile List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_1", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/translationrules": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_2", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_2", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_2", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationrules/filtered": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_2", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/translationrules/preview": { + "post": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_2", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationrules/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/translationrules/{id}": { + "get": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy TranslationRules List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_2", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/trunkgroup": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_34", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_37", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_37", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/trunkgroup/filtered": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_37", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/trunkgroup/preview": { + "post": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_37", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/trunkgroup/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/trunkgroup/{id}": { + "get": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Trunk Group List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_37", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/umbrelladata": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_35", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_38", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_38", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/umbrelladata/filtered": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_38", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/umbrelladata/preview": { + "post": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_38", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/umbrelladata/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/umbrelladata/{id}": { + "get": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Umbrella Data List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_38", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/urlblacklist": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_36", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_39", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_39", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlblacklist/filtered": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_39", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlblacklist/preview": { + "post": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_39", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlblacklist/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlblacklist/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL BlackList Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_39", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/urlwhitelist": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_37", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_40", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_40", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlwhitelist/filtered": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_40", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/urlwhitelist/preview": { + "post": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_40", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlwhitelist/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/urlwhitelist/{id}": { + "get": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy URL WhiteList Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_40", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/vpn": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_38", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_41", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_41", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/vpn/filtered": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_41", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/vpn/preview": { + "post": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_41", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/vpn/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/vpn/{id}": { + "get": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy VPN List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_41", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/list/webex": { + "post": { + "tags": [ + "Configuration - Policy List Builder" + ], + "description": "TEMP-Create Webex policy lists", + "operationId": "createWebexPrefixLists", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/webex/update": { + "post": { + "tags": [ + "Configuration - Policy List Builder" + ], + "description": "TEMP-Update Webex policy lists from Webex config", + "operationId": "createWebexPrefixLists_1", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/zone": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Get policy lists", + "operationId": "getPolicyLists_39", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "App Policy": { + "description": "App Policy", + "value": "{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n }," + }, + "Prefix List": { + "description": "Prefix List", + "value": { + "data": [ + { + "listId": "8bc43c09-f72c-40b8-aa90-608c7005e607", + "name": "Example", + "type": "prefix", + "description": "Desc Not Required", + "entries": [ + { + "ipPrefix": "10.0.0.0/24" + } + ], + "lastUpdated": 1588178457305, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Create policy list", + "operationId": "createPolicyList_42", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Zone list": { + "description": "Zone list", + "value": { + "name": "Demo-Zone", + "description": "Desc Not Required", + "type": "zone", + "entries": [ + { + "vpn": "10" + } + ] + } + }, + "IPS list": { + "description": "IPS list", + "value": { + "name": "Demo-IPS-list", + "description": "Desc Not Required", + "type": "ipssignature", + "entries": [ + { + "generatorId": "1111", + "signatureId": "4444" + } + ] + } + }, + "URL white list": { + "description": "URL white list", + "value": { + "name": "Demo-Whitelist", + "description": "Desc Not Required", + "type": "urlwhitelist", + "entries": [ + { + "pattern": "https://www.youtube.com" + } + ] + } + }, + "URL black list": { + "description": "URL black list", + "value": { + "name": "Demo-Black-list", + "description": "Desc Not Required", + "type": "urlblacklist", + "entries": [ + { + "pattern": "www.facebook.com" + } + ] + } + }, + "TG API key list": { + "description": "TG API key list", + "value": { + "name": "threatGridApiKeyList", + "description": "", + "type": "threatGridApiKey", + "entries": [ + { + "region": "nam", + "apikey": "1234567" + }, + { + "region": "eur", + "apikey": "1234567" + } + ] + } + }, + "Local domain list": { + "description": "Local domain list", + "value": { + "name": "Demo-Domain-Name-List", + "description": "Desc Not Required", + "type": "localdomain", + "entries": [ + { + "nameServer": "cisco.com" + } + ] + } + }, + "Umbrella data list": { + "description": "Umbrella data list", + "value": { + "name": "umbrellaTokenList", + "description": "", + "type": "umbrellaData", + "entries": [ + { + "apiKey": "abcd", + "secret": "12345", + "umbOrgId": "23405", + "token": "abcedabcedabcedabcedabcedabcedabcedabced" + } + ] + } + }, + "App family": { + "description": "App family", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "appFamily": "web" + }, + { + "appFamily": "audio-video" + } + ] + } + }, + "App list": { + "description": "App list", + "value": { + "name": "Demo-App-List", + "description": "Desc Not Required", + "type": "app", + "entries": [ + { + "app": "facebook" + }, + { + "app": "netshow" + } + ] + } + }, + "Color list": { + "description": "Color list", + "value": { + "name": "Demo-Color-List", + "description": "Desc Not Required", + "type": "color", + "entries": [ + { + "color": "biz-internet" + }, + { + "color": "public-internet" + } + ] + } + }, + "Data prefix": { + "description": "Data prefix", + "value": { + "name": "Demo-Data-Prefix-List", + "description": "Desc Not Required", + "type": "dataprefix", + "entries": [ + { + "ipPrefix": "10.1.0.0/16" + }, + { + "ipPrefix": "10.2.0.0/16" + } + ] + } + }, + "Policer": { + "description": "Policer", + "value": { + "name": "Demo-Policer-list", + "description": "Desc Not Required", + "type": "policer", + "entries": [ + { + "burst": "16000", + "exceed": "drop", + "rate": "10000" + } + ] + } + }, + "Prefix": { + "description": "Prefix", + "value": { + "name": "Demo-Prefix-list", + "description": "Desc Not Required", + "type": "prefix", + "entries": [ + { + "ipPrefix": "10.0.0.0/12", + "le": "32" + } + ] + } + }, + "Site": { + "description": "Site", + "value": { + "name": "Demo-Site-List", + "description": "Desc Not Required", + "type": "site", + "listId": null, + "entries": [ + { + "siteId": "100" + }, + { + "siteId": "200" + }, + { + "siteId": "300-500" + } + ] + } + }, + "Class": { + "description": "Class", + "value": { + "name": "Demo-Class-Map", + "description": "Desc Not Required", + "type": "class", + "entries": [ + { + "queue": "4" + } + ] + } + }, + "App probe": { + "description": "App probe", + "value": { + "name": "Demo-Probe-Class", + "type": "appProbe", + "entries": [ + { + "map": [ + { + "color": "biz-internet", + "dscp": 46 + }, + { + "color": "public-internet", + "dscp": 20 + } + ], + "forwardingClass": "391c5977-0af8-46b2-a9b2-e48702593d70" + } + ] + } + }, + "SLA": { + "description": "SLA", + "value": { + "name": "Demo-SLA-Class", + "description": "Desc Not Required", + "type": "sla", + "entries": [ + { + "latency": "100", + "loss": "10", + "jitter": "10", + "appProbeClass": "39269a77-9592-4a5a-8b35-633a5615c47d" + } + ] + } + }, + "TLOC": { + "description": "TLOC", + "value": { + "name": "Demo-TLOC-List", + "description": "Desc Not Required", + "type": "tloc", + "entries": [ + { + "tloc": "10.1.1.1", + "color": "biz-internet", + "encap": "ipsec", + "preference": "10" + }, + { + "tloc": "10.2.2.2", + "color": "biz-internet", + "encap": "ipsec", + "preference": "20" + } + ] + } + }, + "VPN": { + "description": "VPN", + "value": { + "name": "Demo-VPN-List", + "description": "Desc Not Required", + "type": "vpn", + "listId": null, + "entries": [ + { + "vpn": "100" + }, + { + "vpn": "200" + }, + { + "vpn": "300-500" + } + ] + } + }, + "AS path": { + "description": "AS path", + "value": { + "name": "Demo-AS-Path-List", + "description": "Desc Not Required", + "type": "aspath", + "listId": null, + "entries": [ + { + "asPath": "100" + }, + { + "asPath": "200" + }, + { + "asPath": "65002" + } + ] + } + }, + "Community": { + "description": "Community", + "value": { + "name": "Demo-Community-List", + "description": "Desc Not Required", + "type": "community", + "listId": null, + "entries": [ + { + "community": "1000:10000" + } + ] + } + }, + "Ext community": { + "description": "Ext community", + "value": { + "name": "Demo-Extended-Community-List", + "description": "Desc Not Required", + "type": "extcommunity", + "listId": null, + "entries": [ + { + "community": "rt 100:10" + } + ] + } + }, + "Mirror": { + "description": "Mirror", + "value": { + "name": "Demo-Mirror-List", + "description": "Desc Not Required", + "type": "mirror", + "entries": [ + { + "remoteDest": "10.1.1.1", + "source": "20.1.1.1" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Delete policy lists with specific info tag", + "operationId": "deletePolicyListsWithInfoTag_42", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/zone/filtered": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Get policy lists with specific info tag", + "operationId": "getPolicyListsWithInfoTag_42", + "parameters": [ + { + "name": "infoTag", + "in": "query", + "description": "InfoTag", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/list/zone/preview": { + "post": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Preview a policy list based on the policy list type", + "operationId": "previewPolicyList_42", + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/zone/preview/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Preview a specific policy list entry based on id provided", + "operationId": "previewPolicyListById_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Preview policy list": { + "description": "Preview policy list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + } + }, + "/template/policy/list/zone/{id}": { + "get": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Get a specific policy list based on the id", + "operationId": "getListsById_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "name": "Community", + "type": "community", + "description": "Desc Not Required", + "entries": [ + { + "community": "1000:5000" + } + ], + "lastUpdated": 1590184928436, + "owner": "admin", + "readOnly": false, + "version": "0", + "infoTag": "", + "referenceCount": 0, + "references": [], + "isActivatedByVsmart": false + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Edit policy list entries for a specific type of policy list", + "operationId": "editPolicyList_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy list", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy list": { + "description": "Policy list", + "value": { + "name": "Community", + "description": "Desc Not Required", + "type": "community", + "listId": "1066ffec-e6ab-426a-b303-434d41b0a4a6", + "entries": [ + { + "community": "1000:8000" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy": { + "description": "Policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + }, + "delete": { + "tags": [ + "Configuration - Policy Zone List Builder" + ], + "description": "Delete policy list entry for a specific type of policy list", + "operationId": "deletePolicyList_42", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Policy Configuration-write" + } + }, + "/template/policy/security": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Generate template list", + "operationId": "generateSecurityTemplateList", + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "Mode", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Create Template", + "operationId": "createSecurityTemplate", + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "Security Policy", + "policyType": "feature", + "policyName": "securitypolicy", + "policyUseCase": "guestAccess", + "policyDefinition": { + "assembly": [ + { + "definitionId": "840f9d3e-b31d-48b6-8365-79b75ba206a9", + "type": "urlFiltering" + } + ], + "settings": { + "logging": [ + { + "vpn": "512", + "serverIP": "10.0.0.1" + } + ], + "failureMode": "open" + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get Template", + "operationId": "getSecurityTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/devices": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get device list", + "operationId": "getSecurityPolicyDeviceList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/devices/{policyId}": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get device list by Id", + "operationId": "getDeviceListById", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/staging/{policyId}": { + "put": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Edit Template", + "operationId": "editTemplateWithLenientLock", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/summary": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Generate security policy summary", + "operationId": "generateSecurityPolicySummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Security policy summary": { + "description": "Security policy summary", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/{deviceModel}": { + "get": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Get templates that map a device model", + "operationId": "getSecurityTemplatesForDevice", + "parameters": [ + { + "name": "deviceModel", + "in": "path", + "description": "Device model", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/security/{policyId}": { + "put": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Edit Template", + "operationId": "editSecurityTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "Security Policy", + "policyType": "feature", + "policyName": "securitypolicy", + "policyUseCase": "guestAccess", + "policyDefinition": { + "assembly": [ + { + "definitionId": "f41167bd-6948-42ff-bc06-94f450e43999", + "type": "zoneBasedFW" + }, + { + "definitionId": "840f9d3e-b31d-48b6-8365-79b75ba206a9", + "type": "urlFiltering" + } + ], + "settings": { + "zoneToNozoneInternet": "deny", + "logging": [ + { + "vpn": "512", + "serverIP": "10.0.0.1" + } + ], + "failureMode": "open" + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template": { + "description": "Template", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Security Template Policy" + ], + "description": "Delete Template", + "operationId": "deleteSecurityTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get policy details", + "operationId": "generatePolicyTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Create template", + "operationId": "createVEdgeTemplate", + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "policyDescription": "Demo", + "policyType": "feature", + "policyName": "demo-policy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "b628d664-d4ec-428f-831c-aff2b688c54c", + "type": "vedgeRoute" + }, + { + "definitionId": "e4b25c74-f594-49db-b78b-61bbb41464ba", + "type": "acl" + } + ], + "settings": { + "appVisibility": true, + "logFrequency": 60 + } + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy Id": { + "description": "Policy Id", + "value": { + "policyId": "f8efb9ed-7524-41ff-aa12-1b6635087ce1" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get template", + "operationId": "getVEdgeTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "data": [ + { + "mastersAttached": 0, + "lastUpdatedBy": "admin", + "policyName": "AppVisibility", + "policyDefinition": "policy\n app-visibility\n flow-visibility\n!\n", + "policyDefinitionEdit": "policy\n app-visibility\n flow-visibility\n!\n", + "createdOn": 1505676829880, + "policyDescription": "Application Visibility Only", + "@rid": 481, + "policyId": "0b860b3a-9446-4c19-86f4-49699f4ed2c7", + "createdBy": "admin", + "devicesAttached": 0, + "lastUpdatedOn": 1505676829880, + "policyType": "cli" + }, + { + "mastersAttached": 1, + "lastUpdatedBy": "admin", + "policyName": "BaselinePolicy", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}", + "policyDefinitionEdit": "{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}", + "createdOn": 1548341101877, + "policyDescription": "Baseline dCloud Policy for all WAN Edge", + "@rid": 2095, + "policyId": "f73b285f-72eb-4f6d-865f-eae0e453bd8e", + "createdBy": "admin", + "devicesAttached": 2, + "policyType": "feature", + "lastUpdatedOn": 1548341101877 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/devices": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get device list", + "operationId": "getVEdgePolicyDeviceList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/devices/{policyId}": { + "get": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Get device list by policy", + "operationId": "getDeviceListByPolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/{policyId}": { + "put": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Edit template", + "operationId": "editVEdgeTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": "{\n \"policyId\":\"8715a21d-9367-47ea-9bc6-e25163ed9513\",\n \"policyState\":\"edit\",\n \"mastersAttached\":2,\n \"lastUpdatedBy\":\"admin\",\n \"policyName\":\"LocalizedPolicyBaseline\",\n \"policyDefinition\": \"\"\n \"policyDefinitionEdit\":\"\"\n \"createdOn\":1548015105326,\n \"policyDescription\":\"Baseline Localized Policiy for dcloud\",\n \"@rid\":483,\n \"createdBy\":\"admin\",\n \"devicesAttached\":2,\n \"policyType\":\"cli\",\n \"lastUpdatedOn\":1548015105326\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Delete template", + "operationId": "deleteVEdgeTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vedge/{resourceGroupName}/{policyId}": { + "post": { + "tags": [ + "Configuration - vEdge Template Policy" + ], + "description": "Change policy resource group", + "operationId": "changePolicyResourceGroup", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resrouce group name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Generate template list", + "operationId": "generateVoiceTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": { + "data": [ + { + "lastUpdatedBy": "admin", + "mastersAttached": 0, + "policyName": "SIPpolicy", + "virtualApplicationTemplates": [], + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}", + "policyDefinitionEdit": "{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}", + "createdOn": 1590272854518, + "policyDescription": "SIP dail peers", + "policyUseCase": "custom", + "@rid": 1124, + "policyId": "87fed5e0-3b95-47a3-9dae-bed8b68562ed", + "createdBy": "admin", + "devicesAttached": 0, + "policyType": "feature", + "lastUpdatedOn": 1590272854518, + "supportedDevices": [ + "vedge-C8300-2N2S-4T2X", + "vedge-C8200-1N-4T", + "vedge-C8200L-1N-4T", + "vedge-C8300-2N2S-6T", + "vedge-C8300-1N1S-4T2X", + "vedge-C8300-1N1S-6T", + "vedge-ISR-4451-X", + "vedge-ISR-4351", + "vedge-ISR-4461", + "vedge-ISR-4431", + "vedge-ISR-4321", + "vedge-ISR-4331" + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Create Template", + "operationId": "createVoiceTemplate", + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "SIP dail peers", + "policyType": "feature", + "policyName": "SIPpolicy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac", + "type": "dialPeer", + "portType": "sipDialPeer" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy Id": { + "description": "Policy Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get templates by policy Id", + "operationId": "getTemplateById", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/devices": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get all device list", + "operationId": "getVoicePolicyDeviceList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/devices/{policyId}": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get device list by policy Id", + "operationId": "getDeviceListByPolicyId", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Device list": { + "description": "Device list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/summary": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get templates that map a device model", + "operationId": "generateVoicePolicySummary", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Policy summary": { + "description": "Policy summary", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/{deviceModel}": { + "get": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Get templates that map a device model", + "operationId": "getVoiceTemplatesForDevice", + "parameters": [ + { + "name": "deviceModel", + "in": "path", + "description": "Device model", + "required": true, + "schema": { + "$ref": "#/components/schemas/DeviceModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template list": { + "description": "Template list", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/voice/{policyId}": { + "put": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Edit Template", + "operationId": "editVoiceTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Policy template", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "policyDescription": "SIP dail peers", + "policyType": "feature", + "policyName": "SIPpolicy", + "policyDefinition": { + "assembly": [ + { + "definitionId": "5557cab0-b8f7-43d6-97d5-2dc572007aac", + "type": "dialPeer", + "portType": "sipDialPeer" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy template": { + "description": "Policy template", + "value": { + "masterTemplatesAffected": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - Voice Template Policy" + ], + "description": "Delete Template", + "operationId": "deleteVoiceTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Get all template vsmart policy list", + "operationId": "generateVSmartPolicyTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template vSmart policy list": { + "description": "Template vSmart policy list", + "value": { + "data": [ + { + "policyVersion": "12282017T235740495", + "lastUpdatedBy": "admin", + "policyName": "StrictHub-n-Spoke", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"4ddd51c0-d8a4-4dff-8874-09c24742b518\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}", + "createdOn": 1514732091489, + "isPolicyActivated": false, + "policyDescription": "BFD/IPSec based Hub-n-Spoke Topology", + "@rid": 6, + "policyId": "a8205140-92d9-4688-a127-c70d5f1b93a5", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514732091489 + }, + { + "policyVersion": "12302017T143348286", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPolicy", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]}]}", + "createdOn": 1514732164516, + "isPolicyActivated": false, + "policyDescription": "Multi-Topology Policy", + "@rid": 7, + "policyId": "45f0b251-bce6-4b6b-bb8c-de7dbf13ea0f", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514732164516 + }, + { + "policyVersion": "12312017T143840434", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPlusFWInsertion", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"1ded189f-4c6b-41cf-a686-655120fdf179\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"73096eaf-8bfe-43bd-a67a-9fcaaa2f8c38\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}", + "createdOn": 1514732296993, + "isPolicyActivated": false, + "policyDescription": "Adding FW for inter-branch communication in VPN 10", + "@rid": 8, + "policyId": "b33477d1-1ebc-4080-ba44-b89dbf14fef7", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514732296993 + }, + { + "policyVersion": "12312017T153128841", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPlusACL", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"968d1ce3-7ff7-4f97-8b69-01e4e06ecad2\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"19f53630-0ce6-4f6b-8e4f-6a527cd15ca4\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}", + "createdOn": 1514734542150, + "isPolicyActivated": false, + "policyDescription": "Application/ACL Policy for inter-branch traffic in VPN 20", + "@rid": 9, + "policyId": "7f156d32-537d-493f-9a7d-53d9e1f05a19", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514734542150 + }, + { + "policyVersion": "04092018T121824907", + "lastUpdatedBy": "admin", + "policyName": "MultiTopologyPlusAppRoute", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"433db0fb-c89a-4642-a498-e3b9a257faef\",\"type\":\"appRoute\",\"entries\":[{\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]},{\"siteLists\":[\"1baf2339-97c0-43fb-98d2-285428a61820\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}", + "createdOn": 1514736045181, + "isPolicyActivated": false, + "policyDescription": "App Aware Routing Policy based on SLA", + "@rid": 10, + "policyId": "12df3ed9-6b1f-4b0a-91a2-377cefb8039f", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1514736045181 + }, + { + "policyVersion": "06212018T190131728", + "lastUpdatedBy": "admin", + "policyName": "cflowd_policy", + "policyDefinition": "policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template\n ", + "createdOn": 1530540307108, + "isPolicyActivated": false, + "policyDescription": "cflowd", + "@rid": 12, + "policyId": "1c865c35-05ac-43a7-a6ee-6328138cd1c4", + "createdBy": "admin", + "policyType": "cli", + "lastUpdatedOn": 1530540307108 + }, + { + "policyVersion": "02242019T10524417", + "lastUpdatedBy": "admin", + "policyName": "Hub-Spoke-Policy-PCI", + "policyDefinition": "{\"assembly\":[{\"definitionId\":\"605fabbd-4c99-4be4-8842-aebb256f7010\",\"type\":\"hubAndSpoke\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"}]}", + "createdOn": 1551005623067, + "isPolicyActivated": false, + "policyDescription": "Enforce PCI VPN to be Hub and Spoke per corporate requirements", + "@rid": 1365, + "policyId": "67b2d453-671f-4eaf-b79a-d1c4c0069f1a", + "createdBy": "admin", + "policyType": "feature", + "lastUpdatedOn": 1551005623067 + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Create template for given policy", + "operationId": "createVSmartTemplate", + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "policyDescription": "demoVPN", + "policyType": "feature", + "policyName": "demoVPN", + "policyDefinition": { + "assembly": [ + { + "definitionId": "605fabbd-4c99-4be4-8842-aebb256f7010", + "type": "hubAndSpoke" + } + ] + }, + "isPolicyActivated": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Policy Id": { + "description": "Policy Id", + "value": { + "policyId": "05917007-14e4-42b0-9575-3d3d11f8a371" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/activate/central/{policyId}": { + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Activate vsmart policy for a given policy id", + "operationId": "activatePolicyForCloudServices", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/activate/{policyId}": { + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Activate vsmart policy for a given policy id", + "operationId": "activatePolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Activate policy": { + "description": "Activate policy", + "value": { + "isEdited": false + } + }, + "Deactivate policy": { + "description": "Deactivate policy", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "vsmart_policy_config-01242017T020647984" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/central/{policyId}": { + "put": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Edit template for given policy id to allow for multiple component edits", + "operationId": "editTemplateWithoutLockChecks", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/connectivity/status": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Check VSmart Connectivity Status", + "operationId": "checkVSmartConnectivityStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Connectivity Status": { + "description": "Connectivity Status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/deactivate/{policyId}": { + "post": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Deactivate vsmart policy for a given policy id", + "operationId": "deActivatePolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": { + "id": "vsmart_policy_config-60851f10-d9f0-4f41-a27e-9eedbd1bae65" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/definition/{policyId}": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Get template policy definition by policy id", + "operationId": "getTemplateByPolicyId", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template vSmart policy": { + "description": "Template vSmart policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/qosmos_nbar_migration_warning": { + "get": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Qosmos Nbar migration", + "operationId": "QosmosNbarMigrationWarning", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "NBAR list": { + "description": "NBAR list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/policy/vsmart/{policyId}": { + "put": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Edit template for given policy id", + "operationId": "editVSmartTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Template policy", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": { + "policyId": "1c865c35-05ac-43a7-a6ee-6328138cd1c4", + "policyState": "edit", + "policyVersion": "06212018T190131728", + "lastUpdatedBy": "admin", + "policyName": "cflowd_policy", + "policyDefinition": "policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template\n ", + "createdOn": 1530540307108, + "isPolicyActivated": false, + "policyDescription": "cflowd", + "@rid": 12, + "createdBy": "admin", + "policyType": "cli", + "lastUpdatedOn": 1530540307108, + "isEdited": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Template policy": { + "description": "Template policy", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "Configuration - vSmart Template Policy" + ], + "description": "Delete template for a given policy id", + "operationId": "deleteVSmartTemplate", + "parameters": [ + { + "name": "policyId", + "in": "path", + "description": "Policy Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/template/security/encryptText/encrypt": { + "post": { + "tags": [ + "Configuration - General Template" + ], + "description": "Get Type 6 Encryptedd String for a given value", + "operationId": "getEncryptedString", + "requestBody": { + "description": "Type6 Encryption", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Encryption": { + "description": "Encryption", + "value": { + "inputString": "string " + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Encrypted String": { + "description": "Encrypted String", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write" + } + }, + "/tenant": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAllTenants", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "List all tenants associated with a vSmart", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Tenant models": { + "description": "Tenant models", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + }, + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createTenant", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/async": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createTenantAsync", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/bulk/async": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "createTenantAsyncBulk", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": [ + { + "orgName": "fq-tenan1 - 19442", + "subDomain": "tenant1-fq-dev-dev.viptela.info", + "name": "fq-tenan1 - 19442", + "desc": "fq-tenan1 - 19442", + "wanEdgeForecast": "100" + }, + { + "orgName": "fq-tenan2 - 19442", + "subDomain": "tenant1-fq-dev-dev.viptela.info", + "name": "fq-tenan1 - 19442", + "desc": "fq-tenan1 - 19442", + "wanEdgeForecast": "100", + "vSmarts": "[vSmartUUID1, vSmartUUID2]" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "[{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + }, + "delete": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteTenantAsyncBulk", + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": { + "password": "12345", + "tenantIdList": [ + "0f4f1c6e-47da-40c4-8517-9d1e918965d9", + "6b7b23bf-5dba-4cca-a36c-1c3cc2254d68" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": "{[\n \"id\": \u201c537911061561\u201d .\n]}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/vsmart": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantvSmartMapping", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart tenant mapping": { + "description": "vSmart tenant mapping", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + } + }, + "/tenant/vsmart-mt/migrate": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "tenantvSmartMtMigrate", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/vsmart/capacity": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenantHostingCapacityOnvSmarts", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "vSmart Capacity": { + "description": "vSmart Capacity", + "value": "[\"data\": [\n {\n \"vSmartUuid\": \"6dbf3f8d-d537-4650-9200-154d8b98b302\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"05aab9ac-44f7-4292-b8c5-2cc40f3afb5a\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"b20b4468-7a5f-48f1-8ee6-f393afd3ac72\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n }\n ]]" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + } + }, + "/tenant/{tenantId}": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read" + }, + "put": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "updateTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": { + "orgName": "fq-tenan1 - 19442", + "subDomain": "tenant1-fq-dev-dev.viptela.info", + "desc": "fq-tenan1 - 19442" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": "{\n \"id\": \u201c537911061561\u201d .\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/{tenantId}/delete": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant model": { + "description": "Tenant model", + "value": { + "password": "password" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenant/{tenantId}/switch": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "switchTenant", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vSession model": { + "description": "vSession model", + "value": "{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read" + } + }, + "/tenant/{tenantId}/vsessionid": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "vSessionId", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "vSession model": { + "description": "vSession model", + "value": "{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,dca" + } + }, + "/tenant/{tenantId}/vsmart": { + "put": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "updateTenantvSmartPlacement", + "parameters": [ + { + "name": "tenantId", + "in": "path", + "description": "Tenant Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tenant model", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "UpdateTenantvSmartModel": { + "description": "UpdateTenantvSmartModel", + "value": { + "srcvSmartUuid": "UUID", + "destvSmartUuid": "UUID" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/tenantbackup/delete": { + "delete": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deleteTenantBackup", + "parameters": [ + { + "name": "fileName", + "in": "query", + "description": "File name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Deleted file list": { + "description": "Deleted file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write,Tenant Status-write" + } + }, + "/tenantbackup/download/{path}": { + "get": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Download a Backup File that is already stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "downloadExistingBackupFile", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "File path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file stream": { + "description": "Backup file stream" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" + } + }, + "/tenantbackup/export": { + "get": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Trigger a backup of configuration database and store it in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "exportTenantBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" + } + }, + "/tenantbackup/import": { + "post": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "importTenantBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task status": { + "description": "Task status", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write,Tenant Status-write" + } + }, + "/tenantbackup/list": { + "get": { + "tags": [ + "Tenant Backup Restore", + "Multitenant APIs - Provider" + ], + "description": "List all backup files of a tenant stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "listTenantBackup", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Backup file list": { + "description": "Backup file list", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write" + } + }, + "/tenantmigration/download/{path}": { + "get": { + "tags": [ + "Tenant Migration" + ], + "description": "Download tenant data", + "operationId": "downloadTenantData", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "File path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Tenant data": { + "description": "Tenant data", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/export": { + "post": { + "tags": [ + "Tenant Migration" + ], + "description": "Export tenant data", + "operationId": "exportTenantData", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTenantModel" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/import": { + "post": { + "tags": [ + "Tenant Migration" + ], + "description": "Import tenant data", + "operationId": "importTenantData", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/migrationToken": { + "get": { + "tags": [ + "Tenant Migration" + ], + "description": "Get migration token", + "operationId": "getMigrationToken", + "parameters": [ + { + "name": "migrationId", + "in": "query", + "description": "Migration Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Migration token": { + "description": "Migration token", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantmigration/networkMigration": { + "get": { + "tags": [ + "Tenant Migration" + ], + "description": "Re-trigger network migration", + "operationId": "reTriggerNetworkMigration", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + }, + "post": { + "tags": [ + "Tenant Migration" + ], + "description": "Migrate network", + "operationId": "migrateNetwork", + "requestBody": { + "description": "Network migration", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Network migration": { + "description": "Network migration", + "value": {} + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Task Id": { + "description": "Task Id", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/tenantstatus": { + "get": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "getAllTenantStatuses", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Tenant status": { + "description": "Tenant status", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-read" + } + }, + "/tenantstatus/force": { + "post": { + "tags": [ + "Tenant Management", + "Multitenant APIs - Provider" + ], + "description": "Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "forceStatusCollection", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tenant Management-write" + } + }, + "/topology": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Create full topology", + "operationId": "createFullTopology", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Topologies": { + "description": "Topologies", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/topology/device": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Create device topology", + "operationId": "createDeviceTopology", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Topology": { + "description": "Topology", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/topology/device/site/{siteId}": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Get topology for a given site id", + "operationId": "getSiteTopology", + "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write" + } + }, + "/topology/monitor/site/{siteId}": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Get topology monitor data for a given site id", + "operationId": "getSiteTopologyMonitorData", + "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Site topology monitor": { + "description": "Site topology monitor", + "value": { + "data": [ + { + "device-id": "C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88", + "device-health": "yellow", + "circuits": [ + { + "color": "lte", + "system_ip": "172.16.255.14", + "circuit-health": "yellow", + "tunnels": [ + { + "name": "172.16.255.14:lte-172.16.255.15:lte", + "health": "yellow", + "state": "Up", + "vqoe_score": 7 + } + ] + } + ], + "if-speed": [ + { + "interface": "GigabitEthernet1", + "count": 34, + "tx_kbps": 0, + "rx_kbps": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Device Monitoring-read,Device Monitoring-write" + } + }, + "/topology/physical": { + "get": { + "tags": [ + "Configuration - Topology" + ], + "description": "Create pysical topology", + "operationId": "createPhysicalTopology", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "Device Id list", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceIP" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Topology": { + "description": "Topology", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/troubleshooting/control/{uuid}": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Troubleshoot control connections", + "operationId": "getControlConnections", + "parameters": [ + { + "name": "uuid", + "in": "path", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device control connection": { + "description": "Device control connection", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-read" + } + }, + "/troubleshooting/devicebringup": { + "get": { + "tags": [ + "Troubleshooting Tools - Device Connectivity" + ], + "description": "Debug device bring up", + "operationId": "getDeviceConfiguration", + "parameters": [ + { + "name": "uuid", + "in": "query", + "description": "Device uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Device configuration": { + "description": "Device configuration", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Tools-read" + } + }, + "/umbrella/getkeys": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get keys from Umbrella", + "operationId": "getAllKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/umbrella/getkeys/management": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get management keys from Umbrella", + "operationId": "getManagementKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/umbrella/getkeys/networkdevices": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get network devices keys from Umbrella", + "operationId": "getNetworkKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/umbrella/getkeys/reporting": { + "get": { + "tags": [ + "Umbrella" + ], + "description": "Get reporting keys from Umbrella", + "operationId": "getReportingKeysFromUmbrella", + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "default" + } + }, + "/util/configdb/size": { + "get": { + "tags": [ + "Utility - Configuration DB" + ], + "description": "Fetches the disk usage by configuration-db", + "operationId": "getDBSizeOnFile", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Size": { + "description": "Size", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/util/logfile/appserver": { + "get": { + "tags": [ + "Utility - Logging" + ], + "description": "Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.", + "operationId": "listLogFileDetails", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "log content": { + "description": "log content" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/util/logfile/appserver/lastnlines": { + "get": { + "tags": [ + "Utility - Logging" + ], + "description": "List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.", + "operationId": "listVManageServerLogLastNLines", + "parameters": [ + { + "name": "lines", + "in": "query", + "description": "Number of lines", + "schema": { + "type": "integer", + "format": "int64", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "log content": { + "description": "log content" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/util/logging/debuglog": { + "post": { + "tags": [ + "Utility - Logging" + ], + "description": "Test whether logging works", + "operationId": "debugLog", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "required": [ + "logMessage", + "loggerName" + ], + "type": "object", + "properties": { + "loggerName": { + "type": "string" + }, + "logMessage": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "deprecated": true, + "x-roles-required": "admin" + } + }, + "/util/logging/level": { + "post": { + "tags": [ + "Utility - Logging" + ], + "description": "Set log level for logger", + "operationId": "setLogLevel", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "required": [ + "logLevel", + "loggerName" + ], + "type": "object", + "properties": { + "loggerName": { + "type": "string" + }, + "logLevel": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/util/logging/loggers": { + "get": { + "tags": [ + "Utility - Logging" + ], + "description": "List loggers", + "operationId": "listLoggers", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Loggers": { + "description": "Loggers", + "value": [] + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "admin" + } + }, + "/v1/config-group": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a Configuration Group by Solution", + "operationId": "GetConfigGroupBySolution", + "parameters": [ + { + "name": "solution", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-read" + }, + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Create a new Configuration Group", + "operationId": "CreateConfigGroup", + "requestBody": { + "description": "Config Group", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "AON-ConfigGroup1-SF": { + }, + "CEDGE-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "example_2": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write,Config Group-write" + } + }, + "/v1/config-group/schema/sdwan": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a Cedge famiy Configuration Group Schema by Schema Type", + "operationId": "GetCedgeConfigGroupSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "post", + "put", + "associate/post", + "associate/put", + "associate/delete", + "deploy/post" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-read" + } + }, + "/v1/config-group/{configGroupId}": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a Configuration Group by ID", + "operationId": "GetConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigGroup" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-read" + }, + "put": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Edit a Configuration Group", + "operationId": "EditConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Config Group", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "AON-ConfigGroup1-SF": { + }, + "CEDGE-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "example_2": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-write" + }, + "delete": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Delete Config Group", + "operationId": "DeleteConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group-write" + } + }, + "/v1/config-group/{configGroupId}/device/associate": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get devices association with a config group", + "operationId": "GetConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-read" + }, + "put": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Move the devices from one config group to another", + "operationId": "UpdateConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "example_2": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + }, + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Create associations with device and a config group", + "operationId": "CreateConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "example_2": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + }, + "delete": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Delete Config Group Association from devices", + "operationId": "DeleteConfigGroupAssociation", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "example_2": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + } + }, + "/v1/config-group/{configGroupId}/device/deploy": { + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "deploy config group to devices


Note: In a multitenant vManage system, this API is only available in the Provider view.", + "operationId": "deployConfigGroup", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "example_2": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + } + }, + "/v1/config-group/{configGroupId}/device/variables": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get device variables", + "operationId": "getConfigGroupDeviceVariables", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "device-id", + "in": "query", + "description": "Comma separated device id's like d1,d2", + "schema": { + "type": "string" + } + }, + { + "name": "suggestions", + "in": "query", + "description": "Suggestions for possible values", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-read" + }, + "put": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "assign values to device variables", + "operationId": "createConfigGroupDeviceVariables", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + } + }, + "/v1/config-group/{configGroupId}/device/variables/schema": { + "get": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "assign values to device variables", + "operationId": "createConfigGroupDeviceVariables_1", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-read" + } + }, + "/v1/config-group/{configGroupId}/device/{deviceId}/preview": { + "post": { + "tags": [ + "Configuration - Configuration Group" + ], + "description": "Get a preview of the configuration for a device", + "operationId": "getConfigGroupDeviceConfigurationPreview", + "parameters": [ + { + "name": "configGroupId", + "in": "path", + "description": "Config Group Id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "deviceId", + "in": "path", + "description": "Device Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + }, + "empty": { + "type": "boolean" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device-write" + } + }, + "/v1/feature-profile/mobility/global/basic/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get a Mobility Global Basic Parcel Schema by Schema Type", + "operationId": "GetMobilityGlobalBasicParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/mobility/global/{profileId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get a Mobility Global Feature Profile by profileId", + "operationId": "GetMobilityFeatureProfileByGlobalId", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "profileId": { + "description": "profileId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/basic": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Basic Profile Parcels for Mobility Global Feature Profile", + "operationId": "GetBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create a Basic Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "AonBasicParcelConfig": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "profileId": { + "description": "profileId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile", + "operationId": "GetBasicProfileParcelByParcelIdForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parcelId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "TODO": { + "description": "TODO", + "value": "TODO" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Update a Basic Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parcelId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "AonBasicParcelConfig": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "profileId": { + "description": "profileId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Basic Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteBasicProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parcelId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Basic-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/cellular": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetCellularProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729307062 + }, + "data": [ + { + "parcelId": "8b698d5b-be6e-47bd-8567-1e5087b4b8d9", + "parcelType": "cellular", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729253148, + "lastUpdatedOn": 1628729253148, + "payload": { + "id": "1", + "name": "ATTSingleSimPap", + "variables": null, + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none", + "userName": null, + "password": null + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfile": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none", + "userName": null, + "password": null + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfile": 1 + }, + "primarySlot": 1, + "wanConfig": null, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "cellular" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateCellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CellularProfile" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "cellular", + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "primarySlot": 1, + "id": "1", + "name": "ATTSingleSimPap" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetCellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "cellular", + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "primarySlot": 1, + "id": "1", + "name": "ATTSingleSimPap" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditCellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cellular" + }, + "examples": { + "Cellular Profile Parcel For Mobility Global Feature Profile": { + "description": "Cellular Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "cellular", + "simSlot0": { + "carrierName": "AT&T", + "slotNumber": 0, + "profileList": [ + { + "id": 1, + "apn": "att-apn1", + "pdnType": "IPv4", + "authMethod": "pap", + "userName": "att1", + "password": "admin1" + }, + { + "id": 2, + "apn": "att-apn11", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "simSlot1": { + "carrierName": "AT&T", + "slotNumber": 1, + "profileList": [ + { + "id": 1, + "apn": "att-apn2", + "pdnType": "IPv4", + "authMethod": "chap", + "userName": "att2", + "password": "admin2" + }, + { + "id": 2, + "apn": "att-apn22", + "pdnType": "IPv6", + "authMethod": "none" + } + ], + "dataProfileIdList": [ + 1 + ], + "attachProfileId": 1 + }, + "primarySlot": 1, + "id": "1", + "name": "ATTSingleSimPap" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Cellular Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteACellularProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Cellular-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Ethernet Profile Parcels for feature profile", + "operationId": "GetEthernetProfileParcels", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Ethernet Profile Parcel For Mobility Global Feature Profile": { + "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "portType": "WAN", + "wanConfiguration": "Active", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "5.5.5.5" + }, + { + "interfaceName": "GigabitEthernet0/1", + "portType": "LAN", + "adminState": "enabled", + "corporateLan": true + }, + { + "interfaceName": "GigabitEthernet0/2", + "portType": "LAN", + "adminState": "disabled" + } + ], + "parcelType": "ethernet", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an ethernet Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateEthernetProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Ethernet" + }, + "examples": { + "Ethernet Profile Parcel For Aon Feature Profile": { + "description": "Ethernet Profile Parcel For Aon Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "portType": "WAN", + "wanConfiguration": "Active", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "5.5.5.5" + }, + { + "interfaceName": "GigabitEthernet0/1", + "portType": "LAN", + "adminState": "enabled", + "corporateLan": true + }, + { + "interfaceName": "GigabitEthernet0/2", + "portType": "LAN", + "adminState": "disabled" + } + ], + "parcelType": "ethernet", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "ethernetId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Ethernet Profile Parcels for feature profile", + "operationId": "GetEthernetProfileParcel", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Ethernet Profile Parcel For Mobility Global Feature Profile": { + "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "portType": "WAN", + "wanConfiguration": "Active", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "5.5.5.5" + }, + { + "interfaceName": "GigabitEthernet0/1", + "portType": "LAN", + "adminState": "enabled", + "corporateLan": true + }, + { + "interfaceName": "GigabitEthernet0/2", + "portType": "LAN", + "adminState": "disabled" + } + ], + "parcelType": "ethernet", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Update a Ethernet Profile Parcel for feature profile", + "operationId": "EditEthernetProfileParcelForSystem", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Ethernet Profile Parcel For Mobility Global Feature Profile": { + "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "ethernet", + "ethernetInterfaceList": [ + { + "interfaceName": "GigabitEthernet0/0", + "wanConfiguration": "Active", + "portType": "WAN", + "ipAssignment": "static", + "staticIpAddress": "1.1.1.2", + "staticIpAddressSubnetMask": "255.255.0.0", + "staticRouteIp": "3.3.3.3" + }, + { + "interfaceName": "GigabitEthernet0/1", + "adminState": "enabled" + }, + { + "interfaceName": "GigabitEthernet0/2", + "adminState": "disabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Ethernet Profile Parcel for feature profile", + "operationId": "DeleteEthernetProfileParcelForSystem", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/networkProtocol": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetNetworkProtocolProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { + "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729936548 + }, + "data": [ + { + "parcelId": "4e958a77-03dc-4558-a45b-eeba554bb873", + "parcelType": "networkProtocol", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729896431, + "lastUpdatedOn": 1628729896431, + "payload": { + "id": null, + "name": null, + "variables": null, + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": 2, + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DNSSettings": "1.1.1.1", + "NTPInherit": false, + "NTPSettings": [ + "1.1.1.1", + "1.1.1.2" + ], + "DHCPOptions": [ + { + "type": 2, + "dhcpValue": "2", + "dataType": "integer" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test", + "interface": "Cellular1/0" + } + ], + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "networkProtocol" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "NetworkProtocol Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkProtocol" + }, + "examples": { + "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { + "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "networkProtocol", + "DNSSettings": "1.1.1.1", + "NTPInherit": false, + "NTPSettings": [ + "1.1.1.1", + "1.1.1.2" + ], + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": "2", + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DHCPOptions": [ + { + "type": 2, + "dataType": "integer", + "dhcpValue": "2" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "networkProtocolId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { + "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "networkProtocol", + "DNSSettings": "1.1.1.1", + "NTPInherit": false, + "NTPSettings": [ + "1.1.1.1", + "1.1.1.2" + ], + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": "2", + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DHCPOptions": [ + { + "type": 2, + "dataType": "integer", + "dhcpValue": "2" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "networkProtocolId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Network Protocol Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkProtocol" + }, + "examples": { + "Network Protocol Profile Parcel For Mobility Global Feature Profile": { + "description": "Network Protocol Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "networkProtocol", + "DNSSettings": "1.1.1.1", + "NTPInherit": true, + "DHCPPool": { + "poolNetwork": "192.168.0.0/24", + "leaseTime": "2", + "startAddress": "1.1.1.2", + "endAddress": "1.1.1.3" + }, + "DHCPOptions": [ + { + "type": 2, + "dataType": "integer", + "dhcpValue": "2" + } + ], + "NATRules": [ + { + "protocol": "udp", + "outPort": 23, + "inPort": 2, + "insideIp": "1.1.1.1", + "description": "test" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteNetworkProtocolProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "networkProtocolId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/securityPolicy": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetSecurityPolicyProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { + "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729560981 + }, + "data": [ + { + "parcelId": "b79d5ede-263f-4229-aa9b-7b6581058c50", + "parcelType": "securityPolicy", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729517699, + "lastUpdatedOn": 1628729517699, + "payload": { + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ], + "type": "securityPolicy" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SecurityPolicy Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + }, + "examples": { + "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { + "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "securityPolicy", + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "securityPolicyId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { + "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "securityPolicy", + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Security Policy Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "securityPolicyId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Security Policy Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + }, + "examples": { + "Security Policy Profile Parcel For Mobility Global Feature Profile": { + "description": "Security Policy Profile Parcel For Mobility Global Feature Profile", + "value": { + "type": "securityPolicy", + "policyName": "security-policy", + "defaultAction": "pass", + "policyRules": [ + { + "protocolType": [ + "tcp", + "udp" + ], + "sourceIp": "10.10.1.2/32", + "destIp": "10.10.10.1/32", + "sourcePort": 2000, + "destPort": 3000, + "action": "pass" + }, + { + "protocolType": [ + "icmp" + ], + "sourceIp": "11.11.1.1/32", + "destIp": "11.11.2.2/32", + "action": "drop" + }, + { + "protocolType": [ + "tcp" + ], + "sourceIp": "12.12.1.1/32", + "destIp": "12.12.5.1/32", + "sourcePort": 4000, + "destPort": 5000, + "action": "pass" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Security Policy Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteSecurityPolicyProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "securityPolicyId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Vpn Profile Parcel list for Mobility Global Feature Profile", + "operationId": "GetVpnProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729629351 + }, + "data": [ + { + "parcelId": "75cfe22c-228c-4421-9527-62dddc81572f", + "parcelType": "vpn", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729605834, + "lastUpdatedOn": 1628729605834, + "payload": { + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "5", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "vpn" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "CreateVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Vpn" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "tunnelDnsAddress": "2.0.0.3", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-cbc-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "21", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "parcelType": "vpn", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Mobility Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "GetVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "tunnelDnsAddress": "2.0.0.3", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-cbc-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "21", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "parcelType": "vpn", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "EditVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Vpn" + }, + "examples": { + "Vpn Profile Parcel For Mobility Global Feature Profile": { + "description": "Vpn Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "siteToSiteVpn": { + "name": "s2svpn", + "remotePrivateSubnets": "1.0.0.0/1", + "preSharedSecret": "$ecret!@#$", + "remotePublicIp": "2.0.0.2", + "tunnelDnsAddress": "2.0.0.3", + "localInterface": "Cellular1/0", + "localPrivateSubnet": "3.0.0.0/1" + }, + "ipSecPolicy": { + "preset": "preset", + "ikePhase1": { + "cipherSuite": "aes128-cbc-sha1", + "ikeVersion": 2, + "diffeHellmanGroup": "21", + "rekeyTimer": 1209600 + }, + "ikePhase2CipherSuite": "aes128-sha1" + }, + "id": "12345", + "name": "vpn-profile1", + "variables": [ + { + "varName": "", + "jsonPath": "" + } + ], + "parcelType": "vpn", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete a Vpn Profile Parcel for Mobility Global Feature Profile", + "operationId": "DeleteAVpnProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Vpn-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/wifi": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get Wifi Profile Parcel List for Mobility feature profile", + "operationId": "GetWifiProfileParcelListForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "header": { + "generatedOn": 1628729177130 + }, + "data": [ + { + "parcelId": "70c55c19-5043-4c6f-9b64-d710ee174bfd", + "parcelType": "wifi", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628729108424, + "lastUpdatedOn": 1628729108424, + "payload": { + "id": null, + "name": null, + "ssid0": { + "ssid": "myWIFI", + "security": "WLAN_VAP_SECURITY_WPA", + "password": "mypasswd", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "visibility": true + }, + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_NONE", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1", + "encryptionKey": "B1C2DE1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1WPA2", + "encryptionKey": "A4B5EA1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_8021X", + "wpaEncryptionMode": "WPA2", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + } + } + }, + "variables": null, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "wifi" + } + }, + { + "parcelId": "ef215fe9-af7f-4fa1-83c5-0d1e281749a0", + "parcelType": "wifi", + "createdBy": "admin", + "lastUpdatedBy": "admin", + "createdOn": 1628716782903, + "lastUpdatedOn": 1628716782903, + "payload": { + "id": null, + "name": null, + "ssid0": { + "ssid": "myWIFI", + "security": "WLAN_VAP_SECURITY_WPA", + "password": "mypasswd", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "visibility": true + }, + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_NONE", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1", + "encryptionKey": "B1C2DE1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_WPA", + "wpaEncryptionMode": "WPA1WPA2", + "encryptionKey": "A4B5EA1", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WLAN_VAP_SECURITY_8021X", + "wpaEncryptionMode": "WPA2", + "encryptionKey": "", + "encryptionType": "cipherAES", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": 11, + "transmitPower": 1, + "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" + } + } + }, + "variables": null, + "lastUpdatedBy": null, + "lastUpdatedOn": null, + "createdBy": null, + "createdOn": null, + "type": "wifi" + } + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Create an Wifi Profile Parcel for Mobility feature profile", + "operationId": "CreateWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wifi Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Wifi" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "OPEN", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "B1C2DE1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A4B5EA1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WPA2-Enterprise", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": "11", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": "36", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + } + } + }, + "parcelType": "wifi", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-write" + } + }, + "/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Get an Wifi Profile Parcel for Mobility feature profile", + "operationId": "GetWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wifiId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "OPEN", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "B1C2DE1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A4B5EA1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WPA2-Enterprise", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": "11", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": "36", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + } + } + }, + "parcelType": "wifi", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Edit an Wifi Profile Parcel for Mobility feature profile", + "operationId": "EditWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wifiId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wifi Profile Parcel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Wifi" + }, + "examples": { + "Wifi Profile Parcel For Mobility Global Feature Profile": { + "description": "Wifi Profile Parcel For Mobility Global Feature Profile", + "value": { + "name": "config_grp_test", + "description": "config_grp_test", + "family": "aon", + "featureprofiles": [ + { + "profileName": "config_grp_test_aon", + "description": "", + "profileType": "aon", + "parcels": [ + { + "ssidConfigList": [ + { + "ssid": "myssid1", + "visibility": true, + "securityAuthType": "OPEN", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_VIDEO" + }, + { + "ssid": "myssid2", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "B1C2DE1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid3", + "visibility": true, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A4B5EA1", + "qosSettings": "WLAN_QOS_BEST_EFFORT" + }, + { + "ssid": "myssid4", + "visibility": true, + "securityAuthType": "WPA2-Enterprise", + "wpaPskKey": "", + "qosSettings": "WLAN_QOS_BEST_EFFORT", + "radiusServer": [ + { + "host": "1.2.3.4", + "port": 1812, + "secret": "secret1" + }, + { + "host": "5.6.7.8", + "port": 1814, + "secret": "secret2" + } + ] + } + ], + "guestWifi": { + "ssid": "Guest123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60" + }, + "corporateWifi": { + "ssid": "Corporate123", + "visibility": false, + "securityAuthType": "WPA2-PSK_AES", + "wpaPskKey": "A2BC3ED", + "encryptionType": "cipherAES", + "wpaEncryptionMode": "WPA2", + "validityPeriod": "60", + "corporateWlan": true + }, + "advancedRadioSetting": { + "countryRegionSettings": { + "countryRegion": "United State", + "regulatoryDomain": "REG_DOMAIN_A" + }, + "channelPowerSettings": { + "radioBand2Dot4Ghz": { + "band": "RADIO_2_DOT_4_GHZ", + "channel": "11", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + }, + "radioBand5Ghz": { + "band": "RADIO_5_GHZ", + "channel": "36", + "transmitPower": "1", + "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" + } + } + }, + "parcelType": "wifi", + "subparcels": [] + } + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (Mobility)" + ], + "description": "Delete an Wifi Profile Parcel for Mobility feature profile", + "operationId": "DeleteWifiProfileParcelForMobility", + "parameters": [ + { + "name": "profileId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wifiId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Teleworker > Wifi-write" + } + }, + "/v1/feature-profile/sdwan": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles", + "operationId": "GetSdwanFeatureProfileBySdwanFamily", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cliId": { + "description": "cliId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile-read" + } + }, + "/v1/feature-profile/sdwan/cli": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanFeatureProfilesByFamilyAndType", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cliId": { + "description": "cliId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Feature Profile with profile type", + "operationId": "CreateSdwanFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/v1/feature-profile/sdwan/cli/{cliId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Feature Profile with Cli profile type", + "operationId": "GetSdwanFeatureProfileByProfileId", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "cliId": { + "description": "cliId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Feature Profile", + "operationId": "EditSdwanFeatureProfile", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanFeatureProfileForCli", + "parameters": [ + { + "name": "cliId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write" + } + }, + "/v1/feature-profile/sdwan/cli/{cliId}/config": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get config Profile Parcels for cli feature profile", + "operationId": "GetConfigProfileParcelForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-read,Config Group > Device > Deploy-write" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a config Profile Parcel for cli feature profile", + "operationId": "CreateSdwanConfigProfileParcelForCli", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "cli config Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "CliConfigParcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + } + }, + "/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get config Profile Parcel by configId for cli feature profile", + "operationId": "GetConfigProfileParcelByParcelIdForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-read,Config Group > Device > Deploy-write" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a config Profile Parcel for cli feature profile", + "operationId": "EditConfigProfileParcelForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "cli config Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "CliConfigParcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a config Profile Parcel for cli feature profile", + "operationId": "DeleteConfigProfileParcelForCLI", + "parameters": [ + { + "name": "cliId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Config Group > Device > Deploy-write" + } + }, + "/v1/feature-profile/sdwan/other": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanOtherFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Other Feature Profile", + "operationId": "CreateSDWANOtherFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-write" + } + }, + "/v1/feature-profile/sdwan/other/thousandeyes/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Other Thousandeyes Parcel Schema by Schema Type", + "operationId": "GetSdwanOtherThousandeyesParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-read" + } + }, + "/v1/feature-profile/sdwan/other/{otherId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Other Feature Profile with otherId", + "operationId": "GetSdwanOtherFeatureProfileByProfileId", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Other Feature Profile", + "operationId": "EditSdwanOtherFeatureProfile", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanOtherFeatureProfile", + "parameters": [ + { + "name": "otherId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other-write" + } + }, + "/v1/feature-profile/sdwan/other/{otherId}/thousandeyes": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Thousandeyes Profile Parcels for Other feature profile", + "operationId": "GetThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Thousandeyes Profile Parcel for Other feature profile", + "operationId": "CreateThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Thousandeyes Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "thousandeyesParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-write" + } + }, + "/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Thousandeyes Profile Parcel by parcelId for Other feature profile", + "operationId": "GetThousandeyesProfileParcelByParcelIdForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "thousandeyesId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Thousandeyes Profile Parcel for Other feature profile", + "operationId": "EditThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "thousandeyesId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Thousandeyes Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "thousandeyesParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Thousandeyes Profile Parcel for Other feature profile", + "operationId": "DeleteThousandeyesProfileParcelForOther", + "parameters": [ + { + "name": "otherId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "thousandeyesId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Other > Thousandeyes-write" + } + }, + "/v1/feature-profile/sdwan/service": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanServiceFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Service Feature Profile", + "operationId": "CreateSdwanServiceFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-write" + } + }, + "/v1/feature-profile/sdwan/service/dhcp-server/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service DhcpServer Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceDhcpServerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-read" + } + }, + "/v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service LanVpn InterfaceEthernet Schema by Schema Type", + "operationId": "GetSdwanServiceLanVpnInterfaceEthernetParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + } + }, + "/v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a Cedge Service LanVpn InterfaceSvi Schema by Schema Type", + "operationId": "GetCedgeServiceLanVpnInterfaceSviParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + } + }, + "/v1/feature-profile/sdwan/service/lan/vpn/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service LanVpn Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceLanVpnParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/routing/bgp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service RoutingBgp Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceRoutingBgpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/routing/ospf/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service RoutingOspf Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceRoutingOspfParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/switchport/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a Cedge Service Switchport Parcel Schema by Schema Type", + "operationId": "GetCedgeServiceSwitchportParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Feature Profile > Service > Switchport-read" + } + }, + "/v1/feature-profile/sdwan/service/wirelesslan/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a sdwan Service Wirelesslan Parcel Schema by Schema Type", + "operationId": "GetSdwanServiceWirelesslanParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Service Feature Profile with serviceId", + "operationId": "GetSdwanServiceFeatureProfileByProfileId", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Service Feature Profile", + "operationId": "EditSdwanServiceFeatureProfile", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanServiceFeatureProfile", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Dhcp Server Profile Parcels for Service feature profile", + "operationId": "GetDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Dhcp Server Profile Parcel for Service feature profile", + "operationId": "CreateDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Dhcp Server Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Default_DHCP_Server_Parcel": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Dhcp Server Profile Parcel by parcelId for Service feature profile", + "operationId": "GetDhcpServerProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Dhcp Server Profile Parcel for Service feature profile", + "operationId": "EditDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Dhcp Server Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Default_DHCP_Server_Parcel": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Dhcp Server Profile Parcel for Service feature profile", + "operationId": "DeleteDhcpServerProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Dhcp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Lan Vpn Profile Parcels for Service feature profile", + "operationId": "GetLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Lan Vpn Profile Parcel for Service feature profile", + "operationId": "CreateLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Service_Lan_Vpn_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Lan Vpn Profile Parcel by parcelId for Service feature profile", + "operationId": "GetLanVpnProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Lan Vpn Profile Parcel for Service feature profile", + "operationId": "EditLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Service_Lan_Vpn_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Lan Vpn Profile Parcel for Service feature profile", + "operationId": "DeleteLanVpnProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceEthernet Parcels for service LanVpn Parcel", + "operationId": "GetInterfaceEthernetParcelsForServiceLanVpn", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a LanVpn InterfaceEthernet parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceEthernetParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceLanVpnInterfaceEthernetParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "LanVpn Interface Ethernet Parcel For Service Feature Profile": { + "description": "LanVpn Interface Ethernet Parcel For Service Feature Profile", + "value": { + "data": { + "shutdown": { + "optionType": "global", + "value": false + }, + "interfaceName": { + "optionType": "variable", + "variableName": "{{lan_int_0}}" + }, + "description": { + "optionType": "global", + "value": "LAN Interface - LocalInternetAccessforGuestUsersInterface" + }, + "nat": { + "optionType": "default", + "value": false + }, + "dhcpHelper": { + "optionType": "global", + "value": [ + "5.6.7.8" + ] + }, + "intfIpAddress": { + "static": { + "staticIpV4AddressPrimary": { + "ipAddress": { + "optionType": "global", + "value": "4.4.4.4" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + "staticIpV4AddressSecondary": [ + { + "ipAddress": { + "optionType": "global", + "value": "5.5.5.5" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + { + "ipAddress": { + "optionType": "global", + "value": "6.6.6.6" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + } + ] + } + }, + "intfIpV6Address": { + "static": { + "primaryIpV6Address": { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.6/24" + } + }, + "secondaryIpV6Address": [ + { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.7/24" + } + }, + { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.8/24" + } + } + ], + "dhcpHelperV6": [ + { + "ipAddress": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.9" + }, + "vpn": { + "optionType": "default" + } + }, + { + "ipAddress": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.10" + }, + "vpn": { + "optionType": "global", + "value": 1 + } + } + ] + } + }, + "natIpv6": { + "optionType": "global", + "value": true + }, + "natAttributesIpv6": { + "nat64": { + "optionType": "global", + "value": false + }, + "nat66": { + "optionType": "global", + "value": true + }, + "staticNat66": [ + { + "sourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.11/24" + }, + "translatedSourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.12/24" + }, + "sourceVpnId": { + "optionType": "global", + "value": 1 + } + } + ] + }, + "advanced": { + "ipMtu": { + "optionType": "default", + "value": 1500 + }, + "arpTimeout": { + "optionType": "default", + "value": 1200 + }, + "loadInterval": { + "optionType": "default", + "value": 30 + }, + "ipDirectedBroadcast": { + "optionType": "default", + "value": false + } + }, + "vrrp": [], + "vrrpIpv6": [ + { + "optionalRow": { + "optionType": "global", + "value": false + }, + "groupId": { + "optionType": "global", + "value": 2 + }, + "priority": { + "optionType": "global", + "value": 100 + }, + "timer": { + "optionType": "global", + "value": 100 + }, + "trackOmp": { + "optionType": "global", + "value": true + }, + "ipv6": [ + { + "ipv6LinkLocal": { + "optionType": "global", + "value": "fe80::1" + }, + "prefix": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.13/24" + } + } + ] + } + ] + }, + "name": "LocalInternetAccessforGuestUsersInterface", + "description": "LocalInternetAccessforGuestUsersInterface" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn InterfaceEthernet Parcel by ethernetId for service feature profile", + "operationId": "GetLanVpnInterfaceEthernetParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn InterfaceEthernet Parcel for service feature profile", + "operationId": "EditLanVpnInterfaceEthernetParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceLanVpnInterfaceEthernetParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn InterfaceEthernet Parcel for service feature profile", + "operationId": "DeleteLanVpnInterfaceEthernetForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceEthernet associated DhcpServer Parcels for service feature profile", + "operationId": "GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelsForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceEthernet associated DhcpServer Parcel by dhcpServerId for service feature profile", + "operationId": "GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpnInterfaceEthernet parcel and a DhcpServer Parcel association for service feature profile", + "operationId": "EditLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpnInterfaceEthernet and a DhcpServer Parcel association for service feature profile", + "operationId": "DeleteLanVpnInterfaceEthernetAndDhcpServerAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceSvi Parcels for service LanVpn Parcel", + "operationId": "GetInterfaceSviParcelsForServiceLanVpn", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read,Feature Profile > Service > Lan/Vpn-write" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a LanVpn InterfaceSvi parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceSviParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Svi Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceLanVpnInterfaceSviParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn InterfaceSvi Parcel by sviId for service feature profile", + "operationId": "GetLanVpnInterfaceSviParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn InterfaceSvi Parcel for service feature profile", + "operationId": "EditLanVpnInterfaceSviParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Lan Vpn Interface Svi Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceLanVpnInterfaceSviParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn InterfaceSvi Parcel for service feature profile", + "operationId": "DeleteLanVpnInterfaceSviForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceSvi associated DhcpServer Parcels for service feature profile", + "operationId": "GetLanVpnInterfaceSviAssociatedDhcpServerParcelsForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-read" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpnInterfaceSvi associated DhcpServer Parcel by dhcpServerId for service feature profile", + "operationId": "GetLanVpnInterfaceSviAssociatedDhcpServerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpnInterfaceSvi parcel and a DhcpServer Parcel association for service feature profile", + "operationId": "EditLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpnInterfaceSvi and a DhcpServer Parcel association for service feature profile", + "operationId": "DeleteLanVpnInterfaceSviAndDhcpServerAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dhcpServerId", + "in": "path", + "description": "DhcpServer Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn associated Routing Bgp Parcels for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingBgpParcelsForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a lanvpn parcel with a routingbgp Parcel for service feature profile", + "operationId": "CreateLanVpnAndRoutingBgpParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Lan Vpn Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn parcel associated RoutingBgp Parcel by bgpId for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingBgpParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn parcel and a RoutingBgp Parcel association for service feature profile", + "operationId": "EditLanVpnAndRoutingBgpParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn parcel and a RoutingBgp Parcel association for service feature profile", + "operationId": "DeleteLanVpnAndRoutingBgpAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn associated Routing Ospf Parcels for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingOspfParcelsForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a lanvpn parcel with a routingospf Parcel for service feature profile", + "operationId": "CreateLanVpnAndRoutingOspfParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Lan Vpn Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get LanVpn parcel associated RoutingOspf Parcel by ospfId for service feature profile", + "operationId": "GetLanVpnAssociatedRoutingOspfParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Routing Ospf Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a LanVpn parcel and a RoutingOspf Parcel association for service feature profile", + "operationId": "EditLanVpnAndRoutingOspfParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Routing Ospf ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a LanVpn parcel and a RoutingOspf Parcel association for service feature profile", + "operationId": "DeleteLanVpnAndRoutingOspfAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Routing Ospf Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a LanVpnInterfaceEthernet parcel with a DhcpServer Parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a LanVpnInterfaceSvi parcel with a DhcpServer Parcel for service feature profile", + "operationId": "CreateLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sviId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "DhcpServer Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Lan/Vpn/Interface/Svi-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcels for Service feature profile", + "operationId": "GetRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Routing Bgp Profile Parcel for Service feature profile", + "operationId": "CreateRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcel by parcelId for Service feature profile", + "operationId": "GetRoutingBgpProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Routing Bgp Profile Parcel for Service feature profile", + "operationId": "EditRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Routing Bgp Profile Parcel for Service feature profile", + "operationId": "DeleteRoutingBgpProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Ospf Profile Parcels for Service feature profile", + "operationId": "GetRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Routing Ospf Profile Parcel for Service feature profile", + "operationId": "CreateRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceOspfParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Ospf Profile Parcel by parcelId for Service feature profile", + "operationId": "GetRoutingOspfProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Routing Ospf Profile Parcel for Service feature profile", + "operationId": "EditRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Ospf Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceOspfParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Routing Ospf Profile Parcel for Service feature profile", + "operationId": "DeleteRoutingOspfProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ospfId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Routing/Ospf-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/switchport": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Switchport Parcels for service feature profile", + "operationId": "GetSwitchportParcelsForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a switchport Parcel to a service feature profile", + "operationId": "CedgeServiceProfileSwitchportParcelRestfulResource", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Feature Profile Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SwitchPortParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Switchport Parcel by switchportId for service feature profile", + "operationId": "GetSwitchportParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "switchportId", + "in": "path", + "description": "Switchport Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Switchport Parcel association for service feature profile", + "operationId": "EditSwitchportParcelAssociationForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "switchportId", + "in": "path", + "description": "Switchport ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Switchport Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SwitchPortParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Switchport Parcel for service feature profile", + "operationId": "DeleteSwitchportProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "switchportId", + "in": "path", + "description": "Switchport Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Switchport-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wirelesslan Profile Parcels for Service feature profile", + "operationId": "GetWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Wirelesslan Profile Parcel for Service feature profile", + "operationId": "CreateWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wirelesslan Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "wirelessParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-write" + } + }, + "/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wirelesslan Profile Parcel by parcelId for Service feature profile", + "operationId": "GetWirelesslanProfileParcelByParcelIdForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wirelesslanId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Wirelesslan Profile Parcel for Service feature profile", + "operationId": "EditWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wirelesslanId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wirelesslan Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "wirelessParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Wirelesslan Profile Parcel for Service feature profile", + "operationId": "DeleteWirelesslanProfileParcelForService", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "wirelesslanId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Service > Wirelesslan-write" + } + }, + "/v1/feature-profile/sdwan/system": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanSystemFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN System Feature Profile", + "operationId": "CreateSdwanSystemFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-write" + } + }, + "/v1/feature-profile/sdwan/system/aaa/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Aaa Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemAaaParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/banner/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Banner Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemBannerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/basic/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Basic Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemBasicParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/bfd/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Bfd Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemBfdParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/global/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a Cedge System Global Parcel Schema by Schema Type", + "operationId": "GetCedgeSystemGlobalParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/logging/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Logging Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemLoggingParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/ntp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Ntp Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemNtpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/omp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Omp Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemOmpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/snmp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Snmp Parcel Schema by Schema Type", + "operationId": "GetSdwanSystemSnmpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN System Feature Profile with systemId", + "operationId": "GetSdwanSystemFeatureProfileByProfileId", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN System Feature Profile", + "operationId": "EditSdwanSystemFeatureProfile", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanSystemFeatureProfile", + "parameters": [ + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/aaa": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Aaa Profile Parcels for System feature profile", + "operationId": "GetAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Aaa Profile Parcel for System feature profile", + "operationId": "CreateAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Aaa Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "CedgeSystemAAAParcelConfig": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Aaa Profile Parcel by parcelId for System feature profile", + "operationId": "GetAaaProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "aaaId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Aaa Profile Parcel for System feature profile", + "operationId": "EditAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "aaaId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Aaa Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "CedgeSystemAAAParcelConfig": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Aaa Profile Parcel for System feature profile", + "operationId": "DeleteAaaProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "aaaId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Aaa-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/banner": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Banner Profile Parcels for System feature profile", + "operationId": "GetBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Banner Profile Parcel for System feature profile", + "operationId": "CreateBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Banner Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SystemBannerParcelGlobalDefault": { + }, + "SystemBannerParcelVariable": { + }, + "SystemBannerParcelDefaultGlobal": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Banner Profile Parcel by parcelId for System feature profile", + "operationId": "GetBannerProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bannerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Banner Profile Parcel for System feature profile", + "operationId": "EditBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bannerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Banner Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SystemBannerParcelGlobalDefault": { + }, + "SystemBannerParcelVariable": { + }, + "SystemBannerParcelDefaultGlobal": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Banner Profile Parcel for System feature profile", + "operationId": "DeleteBannerProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bannerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Banner-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/basic": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Basic Profile Parcels for System feature profile", + "operationId": "GetBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Basic Profile Parcel for System feature profile", + "operationId": "CreateBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_basic_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Basic Profile Parcel by parcelId for System feature profile", + "operationId": "GetBasicProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "basicId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Basic Profile Parcel for System feature profile", + "operationId": "EditBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "basicId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Basic Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_basic_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Basic Profile Parcel for System feature profile", + "operationId": "DeleteBasicProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "basicId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Basic-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/bfd": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Bfd Profile Parcels for System feature profile", + "operationId": "GetBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Bfd Profile Parcel for System feature profile", + "operationId": "CreateBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Bfd Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SystemBfdParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Bfd Profile Parcel by parcelId for System feature profile", + "operationId": "GetBfdProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bfdId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Bfd Profile Parcel for System feature profile", + "operationId": "EditBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bfdId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Bfd Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SystemBfdParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Bfd Profile Parcel for System feature profile", + "operationId": "DeleteBfdProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bfdId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Bfd-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/global": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Global Profile Parcels for System feature profile", + "operationId": "GetGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Global Profile Parcel for System feature profile", + "operationId": "CreateGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_Globalsettings_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post request example": { + "description": "post request example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Global Profile Parcel by parcelId for System feature profile", + "operationId": "GetGlobalProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "globalId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Global Profile Parcel for System feature profile", + "operationId": "EditGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "globalId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Global Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_Globalsettings_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Global Profile Parcel for System feature profile", + "operationId": "DeleteGlobalProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "globalId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Global-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/logging": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Logging Profile Parcels for System feature profile", + "operationId": "GetLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Logging Profile Parcel for System feature profile", + "operationId": "CreateLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Logging Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_Logging_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Logging Profile Parcel by parcelId for System feature profile", + "operationId": "GetLoggingProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "loggingId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Logging Profile Parcel for System feature profile", + "operationId": "EditLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "loggingId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Logging Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_Logging_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Logging Profile Parcel for System feature profile", + "operationId": "DeleteLoggingProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "loggingId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Logging-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/ntp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Ntp Profile Parcels for System feature profile", + "operationId": "GetNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Ntp Profile Parcel for System feature profile", + "operationId": "CreateNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ntp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "ntp_parcel_post1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Ntp Profile Parcel by parcelId for System feature profile", + "operationId": "GetNtpProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ntpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Ntp Profile Parcel for System feature profile", + "operationId": "EditNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ntpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Ntp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + }, + "ntp_parcel_put1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Ntp Profile Parcel for System feature profile", + "operationId": "DeleteNtpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ntpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Ntp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/omp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Omp Profile Parcels for System feature profile", + "operationId": "GetOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Omp Profile Parcel for System feature profile", + "operationId": "CreateOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Omp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_omp_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Omp Profile Parcel by parcelId for System feature profile", + "operationId": "GetOmpProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ompId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Omp Profile Parcel for System feature profile", + "operationId": "EditOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ompId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Omp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_System_omp_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Omp Profile Parcel for System feature profile", + "operationId": "DeleteOmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ompId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Omp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/snmp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Snmp Profile Parcels for System feature profile", + "operationId": "GetSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Snmp Profile Parcel for System feature profile", + "operationId": "CreateSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Snmp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SNMPParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-write" + } + }, + "/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Snmp Profile Parcel by parcelId for System feature profile", + "operationId": "GetSnmpProfileParcelByParcelIdForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "snmpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Snmp Profile Parcel for System feature profile", + "operationId": "EditSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "snmpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Snmp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "SNMPParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Snmp Profile Parcel for System feature profile", + "operationId": "DeleteSnmpProfileParcelForSystem", + "parameters": [ + { + "name": "systemId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "snmpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > System > Snmp-write" + } + }, + "/v1/feature-profile/sdwan/transport": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get all SDWAN Feature Profiles with giving Family and profile type", + "operationId": "GetSdwanTransportFeatureProfiles", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "Pagination offset", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Pagination limit", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a SDWAN Transport Feature Profile", + "operationId": "CreateSdwanTransportFeatureProfile", + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-write" + } + }, + "/v1/feature-profile/sdwan/transport/cellular-controller/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport CellularController Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportCellularControllerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/cellular-profile/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport CellularProfile Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportCellularProfileParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport ManagementVpn InterfaceEthernet Schema by Schema Type", + "operationId": "GetSdwanTransportManagementVpnInterfaceEthernetParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/management/vpn/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport ManagementVpn Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportManagementVpnParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/routing/bgp/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport RoutingBgp Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportRoutingBgpParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/tracker/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport Tracker Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportTrackerParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport WanVpn CellularInterface Schema by Schema Type", + "operationId": "GetSdwanTransportWanVpnCellularInterfaceParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport WanVpn InterfaceEthernet Schema by Schema Type", + "operationId": "GetSdwanTransportWanVpnInterfaceEthernetParcelSchemaBySchema", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/wan/vpn/schema": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport WanVpn Parcel Schema by Schema Type", + "operationId": "GetSdwanTransportWanVpnParcelSchemaBySchemaType", + "parameters": [ + { + "name": "schemaType", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "post", + "put" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get a SDWAN Transport Feature Profile with transportId", + "operationId": "GetSdwanTransportFeatureProfileByProfileId", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Edit a SDWAN Transport Feature Profile", + "operationId": "EditSdwanTransportFeatureProfile", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile Id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "SDWAN Feature profile", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "FeatureProfile-System-ConfigGroup1-NY": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete Feature Profile", + "operationId": "DeleteSdwanTransportFeatureProfile", + "parameters": [ + { + "name": "transportId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Controller Profile Parcels for Transport feature profile", + "operationId": "GetCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Cellular Controller Profile Parcel for Transport feature profile", + "operationId": "CreateCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Controller Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_CellularController_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Controller Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetCellularControllerProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Cellular Controller Profile Parcel for Transport feature profile", + "operationId": "EditCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Controller Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_CellularController_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Cellular Controller Profile Parcel for Transport feature profile", + "operationId": "DeleteCellularControllerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get CellularController associated Cellular Profile Parcels for transport feature profile", + "operationId": "GetCellularControllerAssociatedCellularProfileParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a cellularcontroller parcel with a cellularprofile Parcel for transport feature profile", + "operationId": "CreateCellularControllerAndCellularProfileParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Cellular Controller Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get CellularController parcel associated CellularProfile Parcel by cellularProfileId for transport feature profile", + "operationId": "GetCellularControllerAssociatedCellularProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Cellular Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a CellularController parcel and a CellularProfile Parcel association for transport feature profile", + "operationId": "EditCellularControllerAndCellularProfileParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Cellular Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a CellularController parcel and a CellularProfile Parcel association for transport feature profile", + "operationId": "DeleteCellularControllerAndCellularProfileAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularControllerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Cellular Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Controller-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Profile Profile Parcels for Transport feature profile", + "operationId": "GetCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Cellular Profile Profile Parcel for Transport feature profile", + "operationId": "CreateCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_CellularProfile_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Cellular Profile Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetCellularProfileProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Cellular Profile Profile Parcel for Transport feature profile", + "operationId": "EditCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Cellular Profile Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_CellularProfile_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Cellular Profile Profile Parcel for Transport feature profile", + "operationId": "DeleteCellularProfileProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularProfileId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Cellular Profile-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Management Vpn Profile Parcels for Transport feature profile", + "operationId": "GetManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Management Vpn Profile Parcel for Transport feature profile", + "operationId": "CreateManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_Management_Vpn_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Management Vpn Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetManagementVpnProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Management Vpn Profile Parcel for Transport feature profile", + "operationId": "EditManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_Management_Vpn_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Management Vpn Profile Parcel for Transport feature profile", + "operationId": "DeleteManagementVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceEthernet Parcels for transport ManagementVpn Parcel", + "operationId": "GetInterfaceEthernetParcelsForTransportManagementVpn", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a ManagementVpn InterfaceEthernet parcel for transport feature profile", + "operationId": "CreateManagementVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "TransportManagementVpnInterfaceEthernetParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get ManagementVpn InterfaceEthernet Parcel by ethernetId for transport feature profile", + "operationId": "GetManagementVpnInterfaceEthernetParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a ManagementVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "EditManagementVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Management Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "TransportManagementVpnInterfaceEthernetParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": { + "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a ManagementVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "DeleteManagementVpnInterfaceEthernetForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Management/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcels for Transport feature profile", + "operationId": "GetRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Routing Bgp Profile Parcel for Transport feature profile", + "operationId": "CreateRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Routing Bgp Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetRoutingBgpProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Routing Bgp Profile Parcel for Transport feature profile", + "operationId": "EditRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "ServiceBgpParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Routing Bgp Profile Parcel for Transport feature profile", + "operationId": "DeleteRoutingBgpProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Routing/Bgp-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/tracker": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Tracker Profile Parcels for Transport feature profile", + "operationId": "GetTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Tracker Profile Parcel for Transport feature profile", + "operationId": "CreateTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_Tracker_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Tracker Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetTrackerProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Tracker Profile Parcel for Transport feature profile", + "operationId": "EditTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_Tracker_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Tracker Profile Parcel for Transport feature profile", + "operationId": "DeleteTrackerProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wan Vpn Profile Parcels for Transport feature profile", + "operationId": "GetWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a Wan Vpn Profile Parcel for Transport feature profile", + "operationId": "CreateWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_Wan_Vpn_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "post response example": { + "description": "post response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Wan Vpn Profile Parcel by parcelId for Transport feature profile", + "operationId": "GetWanVpnProfileParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a Wan Vpn Profile Parcel for Transport feature profile", + "operationId": "EditWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "Cedge_CG1_Transport_Wan_Vpn_parcel1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a Wan Vpn Profile Parcel for Transport feature profile", + "operationId": "DeleteWanVpnProfileParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get Interface Cellular Parcels for transport Wan Vpn Parcel", + "operationId": "GetInterfaceCellularParcelsForTransportWanVpn", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a wanvpn Cellular interface Parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceCellularParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "WanVpn Interface Cellular Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "TransportWanVpnInterfaceCellularParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "parcelId": { + "description": "parcelId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceCellular associated Tracker Parcels for transport feature profile", + "operationId": "GetWanVpnInterfaceCellularAssociatedTrackerParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-read" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceCellular associated Tracker Parcel by trackerId for transport feature profile", + "operationId": "GetWanVpnInterfaceCellularAssociatedTrackerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-read,Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpnInterfaceCellular parcel and a Tracker Parcel association for transport feature profile", + "operationId": "EditWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpnInterfaceCellular and a Tracker Parcel association for transport feature profile", + "operationId": "DeleteWanVpnInterfaceCellularAndTrackerAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get wanvpn Cellular interface Parcel by intfId for transport feature profile", + "operationId": "GetWanVpnInterfaceCellularParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "intfId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a wanvpn Cellular Interface Parcel for transport feature profile", + "operationId": "EditWanVpnInterfaceCellularParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "intfId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "WanVpn Cellular Interface Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "TransportWanVpnInterfaceCellularParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "parcelId": { + "description": "parcelId", + "value": "some uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a wanvpn Cellular interface Parcel for transport feature profile", + "operationId": "DeleteWanVpnInterfaceCellularForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "intfId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get InterfaceEthernet Parcels for transport WanVpn Parcel", + "operationId": "GetInterfaceEthernetParcelsForTransportWanVpn", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Create a WanVpn InterfaceEthernet parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "TransportWanVpnInterfaceEthernetParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "WanVpn Interface Ethernet Parcel For Transport Feature Profile": { + "description": "WanVpn Interface Ethernet Parcel For Transport Feature Profile", + "value": { + "data": { + "shutdown": { + "optionType": "global", + "value": false + }, + "interfaceName": { + "optionType": "variable", + "variableName": "{{wan_int_0}}" + }, + "description": { + "optionType": "global", + "value": "WAN Interface - Internet" + }, + "blockNonSourceIp": { + "optionType": "default", + "value": false + }, + "autoDetectBandwidth": { + "optionType": "default", + "value": false + }, + "tunnelInterface": { + "optionType": "global", + "value": true + }, + "tunnel": { + "perTunnelQos": { + "optionType": "default", + "value": false + }, + "color": { + "optionType": "default", + "value": "mpls" + }, + "restrict": { + "optionType": "default", + "value": false + }, + "group": { + "optionType": "default" + }, + "border": { + "optionType": "default", + "value": false + }, + "maxControlConnections": { + "optionType": "default" + }, + "vBondAsStunServer": { + "optionType": "default", + "value": false + }, + "excludeControllerGroupList": { + "optionType": "default" + }, + "vManageConnectionPreference": { + "optionType": "default", + "value": 5 + }, + "portHop": { + "optionType": "default", + "value": true + }, + "lowBandwidthLink": { + "optionType": "default", + "value": false + }, + "tunnelTcpMss": { + "optionType": "default" + }, + "clearDontFragment": { + "optionType": "default", + "value": false + }, + "ctsSgtPropagation": { + "optionType": "default", + "value": false + }, + "networkBroadcast": { + "optionType": "default", + "value": false + } + }, + "allowService": { + "all": { + "optionType": "default", + "value": false + }, + "bgp": { + "optionType": "default", + "value": false + }, + "dhcp": { + "optionType": "default", + "value": true + }, + "ntp": { + "optionType": "default", + "value": true + }, + "ssh": { + "optionType": "default", + "value": true + }, + "dns": { + "optionType": "default", + "value": true + }, + "icmp": { + "optionType": "default", + "value": true + }, + "https": { + "optionType": "default", + "value": true + }, + "ospf": { + "optionType": "default", + "value": false + }, + "stun": { + "optionType": "default", + "value": false + }, + "snmp": { + "optionType": "default", + "value": false + }, + "netconf": { + "optionType": "default", + "value": false + }, + "bfd": { + "optionType": "default", + "value": false + } + }, + "nat": { + "optionType": "default", + "value": false + }, + "intfIpAddress": { + "static": { + "staticIpV4AddressPrimary": { + "ipAddress": { + "optionType": "global", + "value": "3.3.3.3" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + "staticIpV4AddressSecondary": [ + { + "ipAddress": { + "optionType": "global", + "value": "1.1.1.1" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + }, + { + "ipAddress": { + "optionType": "global", + "value": "2.2.2.2" + }, + "subnetMask": { + "optionType": "global", + "value": "255.255.255.0" + } + } + ] + } + }, + "dhcpHelper": { + "optionType": "global", + "value": [ + "1.2.3.4" + ] + }, + "intfIpV6Address": { + "static": { + "primaryIpV6Address": { + "address": { + "optionType": "global", + "value": "1:1:1:1:1:1:192.168.12.1/24" + } + } + } + }, + "natIpv6": { + "optionType": "global", + "value": true + }, + "natAttributesIpv6": { + "nat64": { + "optionType": "global", + "value": false + }, + "nat66": { + "optionType": "global", + "value": true + }, + "staticNat66": [ + { + "sourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.5/24" + }, + "translatedSourcePrefix": { + "optionType": "global", + "value": "0:0:0:0:0:0:192.168.12.6/24" + }, + "sourceVpnId": { + "optionType": "global", + "value": 0 + } + } + ] + }, + "encapsulation": [ + { + "encap": { + "optionType": "global", + "value": "ipsec" + }, + "weight": { + "optionType": "default", + "value": 1 + }, + "preference": { + "optionType": "default" + } + } + ] + }, + "name": "Internet", + "description": "Internet" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpn InterfaceEthernet Parcel by ethernetId for transport feature profile", + "operationId": "GetWanVpnInterfaceEthernetParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "EditWanVpnInterfaceEthernetParcelForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Wan Vpn Interface Ethernet Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "TransportWanVpnInterfaceEthernetParcelGlobalDefault": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "put response example": { + "description": "put response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpn InterfaceEthernet Parcel for transport feature profile", + "operationId": "DeleteWanVpnInterfaceEthernetForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceEthernet associated Tracker Parcels for transport feature profile", + "operationId": "GetWanVpnInterfaceEthernetAssociatedTrackerParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpnInterfaceEthernet associated Tracker Parcel by trackerId for transport feature profile", + "operationId": "GetWanVpnInterfaceEthernetAssociatedTrackerParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpnInterfaceEthernet parcel and a Tracker Parcel association for transport feature profile", + "operationId": "EditWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpnInterfaceEthernet and a Tracker Parcel association for transport feature profile", + "operationId": "DeleteWanVpnInterfaceEthernetAndTrackerAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "trackerId", + "in": "path", + "description": "Tracker Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpn associated Routing Bgp Parcels for transport feature profile", + "operationId": "GetWanVpnAssociatedRoutingBgpParcelsForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Feature Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a wanvpn parcel with a routingbgp Parcel for transport feature profile", + "operationId": "CreateWanVpnAndRoutingBgpParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Wan Vpn Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}": { + "get": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Get WanVpn parcel associated RoutingBgp Parcel by bgpId for transport feature profile", + "operationId": "GetWanVpnAssociatedRoutingBgpParcelByParcelIdForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "examples": { + "get response example": { + "description": "get response example", + "value": "refer to schema for documentation and example" + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-read" + }, + "put": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Update a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile", + "operationId": "EditWanVpnAndRoutingBgpParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Routing Bgp Profile Parcel", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + }, + "delete": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Delete a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile", + "operationId": "DeleteWanVpnAndRoutingBgpAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnId", + "in": "path", + "description": "Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bgpId", + "in": "path", + "description": "Routing Bgp Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a WanVpnInterfaceCellular parcel with a Tracker Parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cellularId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Template Deploy-write,Feature Profile > Transport > Wan/Vpn > Interface/Cellular > Tracker-write" + } + }, + "/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker": { + "post": { + "tags": [ + "Configuration - Feature Profile (SDWAN)" + ], + "description": "Associate a WanVpnInterfaceEthernet parcel with a Tracker Parcel for transport feature profile", + "operationId": "CreateWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport", + "parameters": [ + { + "name": "transportId", + "in": "path", + "description": "Feature Profile ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "vpnParcelId", + "in": "path", + "description": "VPN Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ethernetId", + "in": "path", + "description": "Interface Profile Parcel ID", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Tracker Profile Parcel Id", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + }, + "examples": { + "example_1": { + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write" + } + }, + "/webex/datacenter": { + "post": { + "tags": [ + "System - Cloud Service Webex" + ], + "description": "TEMP-Insert webex data center details manually for test setup", + "operationId": "getWebexDataCenters", + "requestBody": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": { + "config": { + "version": "1.0.0", + "revision": "20210412.b444544", + "items": [ + { + "region": { + "name": "eu-central-2", + "id": 11 + }, + "prefixes": { + "owned": [ + "23.89.96.0/20", + "170.72.0.0/21", + "170.72.8.0/21" + ] + } + }, + { + "region": { + "name": "ap-east-1", + "id": 22 + }, + "prefixes": { + "owned": [ + "114.29.200.0/23" + ] + } + } + ] + }, + "ETag": "vmanagemockwebexetag" + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "delete": { + "tags": [ + "System - Cloud Service" + ], + "description": "Delete webex data center data in DB", + "operationId": "deleteWebexDataCenters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/webex/datacenter/sync": { + "post": { + "tags": [ + "System - Cloud Service" + ], + "description": "TEMP-Update webex data center data in DB with data from Webex API", + "operationId": "updateWebexDataCenters", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/webex/datacenter/syncstatus": { + "get": { + "tags": [ + "System - Cloud Service Webex" + ], + "description": "Get webex data center sync status from DB", + "operationId": "getWebexDataCentersSyncStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + }, + "put": { + "tags": [ + "System - Cloud Service" + ], + "description": "Set webex data center sync needed to false", + "operationId": "setWebexDataCentersSyncStatus", + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "object" + }, + "examples": { + "Webex Data Centers": { + "description": "Webex Data Centers", + "value": {} + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/workflow": { + "get": { + "tags": [ + "Workflow - Management" + ], + "description": "List all workflows for the given tenant", + "operationId": "getWorkflows", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Workflow type", + "schema": { + "type": "string" + } + }, + { + "name": "id", + "in": "query", + "description": "Workflow id", + "schema": { + "type": "string" + } + }, + { + "name": "group-id", + "in": "query", + "description": "group id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + }, + "examples": { + "Workflows": { + "description": "Workflows", + "value": { + "workflows": [] + } + } + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-read,Workflows-write" + }, + "put": { + "tags": [ + "Workflow - Management" + ], + "description": "Saves the workflow", + "operationId": "saveWorkflow", + "requestBody": { + "description": "Request to save already created workflow with given user context", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Workflow": { + "description": "Workflow", + "value": { + "id": "3f4aa8c0-1342-4a7d-846d-a9b209925d29", + "type": "ux_user_workflow", + "userContext": { + "key1": "value1" + }, + "activities": { + "activity-1": { + "type": "ux_user_workflow", + "userContext": { + "key1": "value1" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write" + }, + "post": { + "tags": [ + "Workflow - Management" + ], + "description": "Creates a workflow in the system", + "operationId": "createWorkflow", + "requestBody": { + "description": "Request to create workflow with given user context", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "Workflow": { + "description": "Workflow", + "value": { + "type": "ux_user_workflow", + "userContext": { + "key1": "value1" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write" + }, + "delete": { + "tags": [ + "Workflow - Management" + ], + "description": "Deletes the workflow", + "operationId": "deleteWorkflow", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Workflow id", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request to delete the workflow", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "x-roles-required": "Workflows-write" + } + } + }, + "components": { + "schemas": { + "AckUplodFile": { + "type": "object", + "properties": { + "data": { + "type": "string", + "format": "binary" + } + } + }, + "AdvancedRadioSetting": { + "type": "object", + "properties": { + "channelPowerSettings": { + "$ref": "#/components/schemas/ChannelPowerSettings" + }, + "countryRegionSettings": { + "$ref": "#/components/schemas/CountryRegionSettings" + } + } + }, + "ApiReKeyDevice": { + "type": "object", + "properties": { + "deviceId": { + "type": "string" + } + } + }, + "ApiReKeyDeviceList": { + "type": "object", + "properties": { + "deviceList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiReKeyDevice" + } + } + } + }, + "AwsIamCredentials": { + "type": "object", + "properties": { + "externalId": { + "type": "string" + }, + "roleArn": { + "type": "string" + } + } + }, + "AwsKeyCredentials": { + "type": "object", + "properties": { + "apiKey": { + "type": "string" + }, + "secretKey": { + "type": "string" + } + } + }, + "AzureCredentials": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "cloudTenantId": { + "type": "string" + }, + "secretKey": { + "type": "string" + }, + "subscriptionId": { + "type": "string" + } + } + }, + "Banner": { + "type": "object", + "properties": { + "loginMessage": { + "type": "string" + }, + "motd": { + "type": "string" + } + } + }, + "Bfd": { + "type": "object", + "properties": { + "bfdTimerOnTransportTunnels": { + "$ref": "#/components/schemas/BfdTimerOnTransportTunnels" + }, + "dscpForBfdPackets": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pollInterval": { + "type": "integer", + "format": "int32" + } + } + }, + "BfdTimerOnTransportTunnels": { + "type": "object", + "properties": { + "bizInternetTimer": { + "$ref": "#/components/schemas/BizInternetTimer" + }, + "lteTimer": { + "$ref": "#/components/schemas/LteTimer" + }, + "mplsTimer": { + "$ref": "#/components/schemas/MplsTimer" + }, + "publicInternetTimer": { + "$ref": "#/components/schemas/PublicInternetTimer" + } + } + }, + "BizInternetTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "Cellular": { + "required": [ + "name", + "primarySlot", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "simSlot0": { + "$ref": "#/components/schemas/SimSlotConfig" + }, + "simSlot1": { + "$ref": "#/components/schemas/SimSlotConfig" + }, + "primarySlot": { + "maximum": 1, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "wanConfig": { + "pattern": "(^Active$|^Standby$)", + "type": "string" + } + } + } + ] + }, + "CellularProfile": { + "type": "object", + "properties": { + "apn": { + "type": "string" + }, + "authMethod": { + "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", + "type": "string" + }, + "id": { + "maximum": 16, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "password": { + "type": "string" + }, + "pdnType": { + "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", + "type": "string" + }, + "userName": { + "type": "string" + } + } + }, + "CertificateStates": { + "type": "object", + "properties": { + "certificateTypes": { + "type": "string" + } + }, + "description": "This is valid Certificate States " + }, + "CertificateValidity": { + "type": "object", + "properties": { + "certificateValidity": { + "type": "string" + } + }, + "description": "This is Certificate Validity " + }, + "ChannelPowerSettings": { + "type": "object", + "properties": { + "radioBand2Dot4Ghz": { + "$ref": "#/components/schemas/RadioBandSetting_2_4G" + }, + "radioBand5Ghz": { + "$ref": "#/components/schemas/RadioBandSetting_5G" + } + } + }, + "ConfigGroup": { + "required": [ + "name", + "solution", + "state", + "version" + ], + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "User who last created this.", + "readOnly": true + }, + "createdOn": { + "type": "integer", + "description": "Timestamp of creation", + "format": "int64", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the Config Group.", + "example": "Config group for west coast retail stores" + }, + "devices": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "description": "System generated unique identifier of the Config Group in UUID format.", + "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" + }, + "lastUpdatedBy": { + "type": "string", + "description": "User who last updated this.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "integer", + "description": "Timestamp of last update", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the Config Group. Must be unique.", + "example": "West coast retail stores" + }, + "numberOfDevices": { + "type": "integer", + "format": "int64" + }, + "numberOfDevicesUpToDate": { + "type": "integer", + "format": "int64" + }, + "profiles": { + "type": "array", + "description": "List of devices UUIDs associated with this config group", + "example": "West coast retail store devices", + "items": { + "$ref": "#/components/schemas/FeatureProfile" + } + }, + "solution": { + "type": "string", + "description": "Specify one of the device platform solution", + "example": "Mobility", + "enum": [ + "mobility", + "sdwan", + "common" + ] + }, + "source": { + "type": "string", + "description": "Source of config-group", + "example": "retail_workflow" + }, + "state": { + "type": "string", + "description": "Config Group Deployment state", + "example": "Config Group Deployment state.Initial state Deployed " + }, + "version": { + "type": "integer", + "description": "Config Group Version Flag", + "format": "int64" + } + } + }, + "ConnectToNtpServer": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string" + }, + "vpn": { + "type": "string" + } + } + }, + "ControlStatus": { + "type": "object", + "properties": { + "controlDown": { + "type": "integer", + "format": "int32" + }, + "controlUp": { + "type": "integer", + "format": "int32" + }, + "partial": { + "type": "integer", + "format": "int32" + } + } + }, + "CorporateWifi": { + "type": "object", + "properties": { + "corporateWlan": { + "type": "boolean" + }, + "radiusServer": { + "$ref": "#/components/schemas/RadiusServer" + }, + "securityAuthType": { + "pattern": "(WPA2-PSK_AES|WPA2-Enterprise)", + "type": "string" + }, + "ssid": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "visibility": { + "type": "boolean" + }, + "wpaPskKey": { + "type": "string" + } + } + }, + "CountryRegionSettings": { + "type": "object", + "properties": { + "countryRegion": { + "type": "string" + }, + "regulatoryDomain": { + "pattern": "(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)", + "type": "string" + } + } + }, + "CreateDeviceParams": { + "type": "object", + "properties": { + "deviceIP": { + "type": "string" + }, + "generateCSR": { + "type": "boolean" + }, + "password": { + "type": "string" + }, + "personality": { + "type": "string" + }, + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "CreateTenantModel": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "getvBondAddress": { + "type": "string" + }, + "getvSmarts": { + "type": "array", + "items": { + "type": "string" + } + }, + "idpMetadata": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "oldIdpMetadata": { + "type": "string" + }, + "orgName": { + "type": "string" + }, + "spMetadata": { + "type": "string" + }, + "subDomain": { + "type": "string" + }, + "wanEdgeForecast": { + "type": "string" + } + } + }, + "DHCPPool": { + "required": [ + "leaseTimeDay", + "leaseTimeHour", + "leaseTimeMin", + "poolNetwork" + ], + "type": "object", + "properties": { + "leaseTimeDay": { + "maximum": 365, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "leaseTimeHour": { + "maximum": 23, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "leaseTimeMin": { + "maximum": 59, + "minimum": 0, + "type": "integer", + "format": "int32" + }, + "poolNetwork": { + "type": "string" + } + } + }, + "DataCenter": { + "type": "object", + "properties": { + "dcPersonality": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Node" + } + }, + "mgmtIPAddress": { + "type": "string" + }, + "name": { + "type": "string" + }, + "nmsPersonality": { + "type": "string" + }, + "password": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "DataCenterRegistration": { + "type": "object", + "properties": { + "clusterEncKey": { + "type": "string" + }, + "clusterEnvKey": { + "type": "string", + "writeOnly": true + }, + "dataCenters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataCenter" + } + }, + "disasterRecoverySettings": { + "$ref": "#/components/schemas/DisasterRecoverySettings" + }, + "host": { + "$ref": "#/components/schemas/Host" + }, + "vbonds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Node" + } + }, + "vmanageRootCA": { + "type": "string" + } + } + }, + "DeleteTenantBulkModel": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "tenantIdList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DeleteTenantModel": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + } + }, + "Device": { + "type": "object", + "properties": { + "deviceType": { + "type": "string" + }, + "systemIp": { + "type": "string" + }, + "uuid": { + "type": "string" + } + }, + "description": "API model encapsulating device information" + }, + "DeviceHealthDetails": { + "type": "object", + "properties": { + "bfd_sessions": { + "type": "integer", + "format": "int32" + }, + "bfd_sessions_up": { + "type": "integer", + "format": "int32" + }, + "board_serial_number": { + "type": "string" + }, + "chassis_number": { + "type": "string" + }, + "connected_vmanages": { + "type": "array", + "items": { + "type": "string" + } + }, + "controlConnectionsToVsmat": { + "$ref": "#/components/schemas/DeviceHealthDetails" + }, + "control_connections": { + "type": "integer", + "format": "int32" + }, + "control_connections_up": { + "type": "integer", + "format": "int32" + }, + "cpu_load": { + "type": "number", + "format": "double" + }, + "device_groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "device_model": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "expected_vsmart_connections": { + "type": "integer", + "format": "int32" + }, + "has_geo_data": { + "type": "boolean" + }, + "health": { + "type": "string", + "enum": [ + "red", + "yellow", + "green" + ] + }, + "latitude": { + "type": "string" + }, + "local_system_ip": { + "type": "string" + }, + "location": { + "type": "string" + }, + "longitude": { + "type": "string" + }, + "memory_utilization": { + "type": "number", + "format": "double" + }, + "name": { + "type": "string" + }, + "omp_peers": { + "type": "integer", + "format": "int64" + }, + "omp_peers_up": { + "type": "integer", + "format": "int64" + }, + "personality": { + "type": "string" + }, + "qoe": { + "type": "integer", + "format": "int32" + }, + "reachability": { + "type": "string" + }, + "site_id": { + "type": "string" + }, + "software_version": { + "type": "string" + }, + "system_ip": { + "type": "string" + }, + "uptime_date": { + "type": "integer", + "format": "int64" + }, + "uuid": { + "type": "string" + }, + "vpn_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "vsmart_control_connections": { + "type": "integer", + "format": "int32" + } + } + }, + "DeviceIP": { + "type": "object", + "properties": { + "deviceIp": { + "type": "string" + } + }, + "description": "This is the valid DeviceIP" + }, + "DeviceModel": { + "type": "object", + "properties": { + "deviceModel": { + "type": "string" + } + }, + "description": "This is the valid DeviceModel " + }, + "DeviceType": { + "type": "object", + "properties": { + "deviceType": { + "type": "string" + } + }, + "description": "This is valid device type " + }, + "DeviceUuid": { + "type": "object", + "properties": { + "deviceUuid": { + "type": "string" + } + }, + "description": "This is valid DeviceUuid" + }, + "DevicesHealth": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceHealthDetails" + } + }, + "header": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "total_devices": { + "type": "integer", + "format": "int32" + } + } + }, + "DevicesHealthOverview": { + "type": "object", + "properties": { + "fair": { + "type": "integer", + "format": "int32" + }, + "good": { + "type": "integer", + "format": "int32" + }, + "poor": { + "type": "integer", + "format": "int32" + } + } + }, + "DisasterRecoverySettings": { + "type": "object", + "properties": { + "delayThreshold": { + "type": "integer", + "format": "int32" + }, + "drPaused": { + "type": "boolean" + }, + "ignoredIndexes": { + "type": "array", + "items": { + "type": "string" + } + }, + "interval": { + "type": "integer", + "format": "int32" + }, + "intervalModified": { + "type": "boolean" + }, + "pauseDR": { + "$ref": "#/components/schemas/DisasterRecoverySettings" + }, + "pauseReplication": { + "type": "boolean" + }, + "startTime": { + "type": "string" + } + } + }, + "DomainDetail": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "resolvedIp": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EntityOwnershipInfo": { + "type": "object", + "properties": { + "bucket": { + "type": "string" + }, + "entityName": { + "type": "string" + }, + "owner": { + "type": "string" + } + } + }, + "EquinixCredentials": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + } + } + }, + "EquinixLocationInfo": { + "type": "object", + "properties": { + "eqBillingAccountInfoList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiCloudEdgeBillingAccountInfo" + } + }, + "eqNEInfo": { + "$ref": "#/components/schemas/EquinixNEInfo" + }, + "metroCode": { + "type": "string" + }, + "metroName": { + "type": "string" + }, + "networkRegion": { + "type": "string" + }, + "siteCode": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "EquinixNEInfo": { + "type": "object", + "properties": { + "imageNameList": { + "type": "array", + "items": { + "type": "string" + } + }, + "productSizeList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EquinixPartnerPort": { + "type": "object", + "properties": { + "authorizationKey": { + "type": "string" + }, + "companyUid": { + "type": "string" + }, + "connectType": { + "type": "string" + }, + "productUid": { + "type": "string" + }, + "speed": { + "type": "string" + }, + "vxcId": { + "type": "string" + }, + "vxcPermitted": { + "type": "boolean" + } + } + }, + "Ethernet": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "ethernetInterfaceList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EthernetInterface" + } + } + } + } + ] + }, + "EthernetInterface": { + "type": "object", + "properties": { + "adminState": { + "pattern": "(enabled|disabled)", + "type": "string" + }, + "corporateLan": { + "type": "boolean" + }, + "interfaceName": { + "type": "string" + }, + "ipAssignment": { + "pattern": "(dynamic|static)", + "type": "string" + }, + "portType": { + "pattern": "(LAN|WAN)", + "type": "string" + }, + "staticIpAddress": { + "type": "string" + }, + "staticIpAddressSubnetMask": { + "type": "string" + }, + "staticRouteIp": { + "type": "string" + }, + "wanConfiguration": { + "pattern": "(Active)", + "type": "string" + } + } + }, + "EventName": { + "type": "object", + "properties": { + "eventName": { + "type": "string" + } + }, + "description": "This is valid eventName" + }, + "FeatureProfile": { + "required": [ + "name", + "solution", + "type" + ], + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "User who last created this.", + "readOnly": true + }, + "createdOn": { + "type": "integer", + "description": "Timestamp of creation", + "format": "int64", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the feature Profile.", + "example": "Profile file description" + }, + "id": { + "type": "string", + "description": "System generated unique identifier of the feature profile in UUID format.", + "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" + }, + "lastUpdatedBy": { + "type": "string", + "description": "User who last updated this.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "integer", + "description": "Timestamp of last update", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the feature Profile. Must be unique.", + "example": "system feature profile" + }, + "solution": { + "type": "string", + "description": "Solution of the feature Profile.", + "example": "sdwan" + }, + "type": { + "type": "string", + "description": "Type of the feature Profile.", + "example": "system" + } + }, + "description": "List of devices UUIDs associated with this config group", + "example": "West coast retail store devices" + }, + "GcpCredentials": { + "type": "object", + "properties": { + "client_email": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "cloudTenantId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "privateKeyData": { + "type": "string" + }, + "private_key": { + "type": "string" + }, + "private_key_id": { + "type": "string" + }, + "project_id": { + "type": "string" + } + } + }, + "GlobalSettings": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "basicName": { + "type": "string" + }, + "basicDescription": { + "type": "string" + }, + "ntpServer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectToNtpServer" + } + }, + "systems": { + "$ref": "#/components/schemas/Systems" + }, + "banner": { + "$ref": "#/components/schemas/Banner" + }, + "loginAccessToRouter": { + "$ref": "#/components/schemas/LoginAccessToRouter" + }, + "bfd": { + "$ref": "#/components/schemas/Bfd" + }, + "omp": { + "$ref": "#/components/schemas/OMP" + }, + "ipSecSecurity": { + "$ref": "#/components/schemas/IpSecSecurity" + }, + "loggingSystemMessages": { + "$ref": "#/components/schemas/LoggingSystemMessages" + } + } + } + ] + }, + "GroupId": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + } + }, + "description": "This is the valid GroupId" + }, + "GuestWifi": { + "type": "object", + "properties": { + "securityAuthType": { + "pattern": "(OPEN|WPA2-PSK_AES)", + "type": "string" + }, + "ssid": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "visibility": { + "type": "boolean" + }, + "wpaPskKey": { + "type": "string" + } + } + }, + "Header": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HeaderElement" + } + }, + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "HeaderElement": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "parameterCount": { + "type": "integer", + "format": "int32" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NameValuePair" + } + }, + "value": { + "type": "string" + } + } + }, + "Host": { + "type": "object", + "properties": { + "dataCenterName": { + "type": "string" + }, + "dcPersonality": { + "type": "string" + }, + "ifname": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "name": { + "type": "string" + }, + "serialno": { + "type": "string" + } + } + }, + "IkePhase": { + "required": [ + "cipherSuite" + ], + "type": "object", + "properties": { + "cipherSuite": { + "pattern": "(aes128-cbc-sha1|aes256-cbc-sha1|aes128-cbc-sha2|aes256-cbc-sha2)", + "type": "string" + }, + "diffeHellmanGroup": { + "pattern": "(14|15|16|19|20|21)", + "type": "string" + }, + "ikeVersion": { + "maximum": 2, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "rekeyTimer": { + "maximum": 1209600, + "minimum": 300, + "type": "integer", + "format": "int32" + } + } + }, + "IpSecPolicy": { + "required": [ + "ikePhase1", + "ikePhase2CipherSuite" + ], + "type": "object", + "properties": { + "ikePhase1": { + "$ref": "#/components/schemas/IkePhase" + }, + "ikePhase2CipherSuite": { + "pattern": "(aes128-sha1|aes256-cbc-sha1|aes256-gcm|null-sha|aes256-cbc-sha256|aes256-cbc-sha384|aes256-cbc-sha512)", + "type": "string" + }, + "preset": { + "type": "string" + } + } + }, + "IpSecSecurity": { + "type": "object", + "properties": { + "authenticationType": { + "pattern": "(ah-sha1-hmac|sha1-hmac)", + "type": "string" + }, + "ipSecPairwiseKeying": { + "type": "string" + }, + "rekeyTime": { + "type": "integer", + "format": "int32" + }, + "replayWindow": { + "type": "integer", + "format": "int32" + } + } + }, + "LicenseUplodFile": { + "type": "object", + "properties": { + "data": { + "type": "string" + }, + "name": { + "type": "string", + "format": "binary" + } + } + }, + "LoggingSystemMessages": { + "type": "object", + "properties": { + "maxFileSize": { + "type": "integer", + "format": "int32" + }, + "priority": { + "type": "string" + }, + "rotations": { + "type": "integer", + "format": "int32" + } + } + }, + "LoginAccessToRouter": { + "type": "object", + "properties": { + "authenticationOrder": { + "type": "string" + }, + "localPassword": { + "type": "string" + }, + "localUser": { + "type": "string" + } + } + }, + "LteTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "MegaportCredentials": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "MegaportLocationInfo": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "country": { + "type": "string" + }, + "liveDate": { + "type": "string" + }, + "market": { + "type": "string" + }, + "metroName": { + "type": "string" + }, + "mpMVEInfo": { + "$ref": "#/components/schemas/MegaportMVEInfo" + }, + "networkRegion": { + "type": "string" + }, + "siteCode": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "MegaportMVEInfo": { + "type": "object", + "properties": { + "imageNameList": { + "type": "array", + "items": { + "type": "string" + } + }, + "productSizeList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MegaportPartnerPort": { + "type": "object", + "properties": { + "authorizationKey": { + "type": "string" + }, + "companyUid": { + "type": "string" + }, + "connectType": { + "type": "string" + }, + "productUid": { + "type": "string" + }, + "speed": { + "type": "string" + }, + "vxcId": { + "type": "string" + }, + "vxcPermitted": { + "type": "boolean" + } + } + }, + "MplsTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "MultiCloudAccountInfo": { + "type": "object", + "properties": { + "accountCredentials": { + "type": "string" + }, + "accountId": { + "type": "string" + }, + "accountName": { + "type": "string" + }, + "awsCloudGatewayWithTvpcEnabled": { + "type": "boolean" + }, + "awsIamCredentials": { + "$ref": "#/components/schemas/AwsIamCredentials" + }, + "awsKeyCredentials": { + "$ref": "#/components/schemas/AwsKeyCredentials" + }, + "azO365Enabled": { + "type": "boolean" + }, + "azureCredentials": { + "$ref": "#/components/schemas/AzureCredentials" + }, + "clientEmail": { + "type": "string" + }, + "cloudGatewayEnabled": { + "type": "boolean" + }, + "cloudType": { + "type": "string" + }, + "credType": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gcpBillingId": { + "type": "string" + }, + "gcpCredentials": { + "$ref": "#/components/schemas/GcpCredentials" + }, + "hostVpcEnabled": { + "type": "boolean" + }, + "orgName": { + "type": "string" + }, + "privateKeyId": { + "type": "string" + }, + "regionList": { + "type": "array", + "items": { + "type": "string" + } + }, + "serviceDiscoveryEnabled": { + "type": "boolean" + }, + "vnetEnabled": { + "type": "boolean" + } + } + }, + "MultiCloudEdgeAccountInfo": { + "type": "object", + "properties": { + "accountCredentials": { + "type": "string" + }, + "credType": { + "type": "string" + }, + "description": { + "type": "string" + }, + "edgeAccountId": { + "type": "string" + }, + "edgeAccountName": { + "type": "string" + }, + "edgeBillingAccountInfo": { + "$ref": "#/components/schemas/MultiCloudEdgeBillingAccountInfo" + }, + "edgeLocationInfoList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiCloudEdgeLocationInfo" + } + }, + "edgePartnerPortsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiCloudEdgePartnerPort" + } + }, + "edgeType": { + "type": "string" + }, + "equinixCredentials": { + "$ref": "#/components/schemas/EquinixCredentials" + }, + "megaportCredentials": { + "$ref": "#/components/schemas/MegaportCredentials" + }, + "orgName": { + "type": "string" + }, + "regionList": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MultiCloudEdgeBillingAccountInfo": { + "type": "object", + "properties": { + "edgeBillingAccountId": { + "type": "string" + }, + "edgeBillingAccountName": { + "type": "string" + }, + "edgeType": { + "type": "string" + } + } + }, + "MultiCloudEdgeLocationInfo": { + "type": "object", + "properties": { + "edgeType": { + "type": "string" + }, + "eqLocationInfo": { + "$ref": "#/components/schemas/EquinixLocationInfo" + }, + "locationId": { + "type": "string" + }, + "locationName": { + "type": "string" + }, + "mpLocationInfo": { + "$ref": "#/components/schemas/MegaportLocationInfo" + } + } + }, + "MultiCloudEdgePartnerPort": { + "type": "object", + "properties": { + "cloudType": { + "type": "string" + }, + "edgeType": { + "type": "string" + }, + "eqPartnerPort": { + "$ref": "#/components/schemas/EquinixPartnerPort" + }, + "locationId": { + "type": "string" + }, + "mpPartnerPort": { + "$ref": "#/components/schemas/MegaportPartnerPort" + }, + "name": { + "type": "string" + } + } + }, + "NATRule": { + "required": [ + "description", + "inPort", + "insideIp", + "interface", + "outPort", + "protocol" + ], + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "inPort": { + "maximum": 65535, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "insideIp": { + "type": "string" + }, + "interface": { + "type": "string" + }, + "outPort": { + "maximum": 65535, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "protocol": { + "pattern": "^udp$|^tcp$|^icmp$", + "type": "string" + } + } + }, + "NameValuePair": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "NetworkProtocol": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "DHCPPool": { + "$ref": "#/components/schemas/DHCPPool" + }, + "DNSSettings": { + "type": "string" + }, + "NTPSettings": { + "maxItems": 4, + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "NATRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NATRule" + } + }, + "NTPInherit": { + "type": "boolean" + } + } + } + ] + }, + "Node": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "name": { + "type": "string" + }, + "password": { + "type": "string" + }, + "serialno": { + "type": "string" + }, + "status": { + "type": "string" + }, + "username": { + "type": "string" + }, + "uuid": { + "type": "string" + } + } + }, + "NwpiDomainMonitor": { + "type": "object", + "properties": { + "clientIp": { + "type": "string" + }, + "deviceToDomainId": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/UuidToDomainId" + } + }, + "domainAppGrp": { + "type": "string" + }, + "domainAppVis": { + "type": "string" + }, + "domainList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDetail" + } + }, + "traceId": { + "type": "string" + } + } + }, + "OMP": { + "type": "object", + "properties": { + "advertisementInterval": { + "type": "integer", + "format": "int32" + }, + "advertisements": { + "pattern": "(IPv4|BGP|OSPF|Connected|Static)", + "type": "string" + }, + "ecmpLimit": { + "type": "integer", + "format": "int32" + }, + "eorTimer": { + "type": "integer", + "format": "int32" + }, + "gracefulRestart": { + "type": "integer", + "format": "int32" + }, + "holdTime": { + "type": "integer", + "format": "int32" + }, + "pathsAdvertisedPerPrefix": { + "type": "integer", + "format": "int32" + } + } + }, + "OnDemandQueueEntry": { + "type": "object", + "properties": { + "complete": { + "type": "boolean" + }, + "completionTime": { + "type": "integer", + "format": "int64" + }, + "creationTime": { + "type": "integer", + "format": "int64" + }, + "data_type": { + "type": "string", + "enum": [ + "DPI", + "ConnectionEvents" + ] + }, + "device_id": { + "type": "string" + }, + "end_time": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "startProcessingTime": { + "type": "integer", + "format": "int64" + }, + "start_time": { + "type": "integer", + "format": "int64" + }, + "status": { + "type": "string", + "enum": [ + "QUEUED", + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "tenant_id": { + "type": "string" + }, + "time_period": { + "type": "string", + "enum": [ + "LAST_N_HOURS", + "CUSTOM" + ] + }, + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "PartnerType": { + "type": "object", + "properties": { + "partnerType": { + "type": "string", + "enum": [ + "aci", + "dnac", + "wcm", + "mdp" + ] + } + }, + "description": "This is valid Partner Type", + "example": "dnac" + }, + "PolicyRule": { + "type": "object", + "properties": { + "action": { + "pattern": "(drop|pass)", + "type": "string" + }, + "destIp": { + "type": "string" + }, + "destPort": { + "type": "integer", + "format": "int32" + }, + "protocolType": { + "type": "array", + "items": { + "type": "string" + } + }, + "sourceIp": { + "type": "string" + }, + "sourcePort": { + "type": "integer", + "format": "int32" + } + } + }, + "ProfileParcel": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "User who last created this.", + "readOnly": true + }, + "createdOn": { + "type": "integer", + "description": "Timestamp of creation", + "format": "int64", + "readOnly": true + }, + "id": { + "type": "string", + "description": "System generated unique identifier of the Profile Parcel in UUID format.", + "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" + }, + "lastUpdatedBy": { + "type": "string", + "description": "User who last updated this.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "integer", + "description": "Timestamp of last update", + "format": "int64", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the Profile Parcel. Must be unique.", + "example": "Wifi profile Parcel" + }, + "type": { + "type": "string", + "description": "type", + "example": "wifi", + "enum": [ + "cellular", + "wifi", + "ethernet", + "globalSettings", + "networkProtocol", + "securityPolicy", + "vpn" + ] + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Variable" + } + } + }, + "discriminator": { + "propertyName": "type" + } + }, + "PropertyDefinition": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "samples": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string" + } + } + }, + "PublicInternetTimer": { + "type": "object", + "properties": { + "dscp": { + "type": "integer", + "format": "int32" + }, + "helloInterval": { + "type": "integer", + "format": "int32" + }, + "multiplier": { + "type": "integer", + "format": "int32" + }, + "pathMtu": { + "type": "string" + } + } + }, + "QueueEntries": { + "type": "object", + "properties": { + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OnDemandQueueEntry" + } + } + } + }, + "QueueProperties": { + "type": "object", + "properties": { + "current_size": { + "type": "integer", + "format": "int32" + }, + "max_size": { + "type": "integer", + "format": "int32" + }, + "tenant_current_size": { + "type": "integer", + "format": "int32" + }, + "tenant_max_size": { + "type": "integer", + "format": "int32" + } + } + }, + "RadioBandSetting_2_4G": { + "type": "object", + "properties": { + "band": { + "pattern": "(RADIO_2_DOT_4_GHZ)", + "type": "string" + }, + "channel": { + "pattern": "(auto|1|2|3|4|5|6|7|8|9|10|11)", + "type": "string" + }, + "channelWidth": { + "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ)", + "type": "string" + }, + "transmitPower": { + "pattern": "(auto|1|2|3|4|5|6|7)", + "type": "string" + } + } + }, + "RadioBandSetting_5G": { + "type": "object", + "properties": { + "band": { + "pattern": "(RADIO_5_GHZ)", + "type": "string" + }, + "channel": { + "pattern": "(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)", + "type": "string" + }, + "channelWidth": { + "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)", + "type": "string" + }, + "transmitPower": { + "pattern": "(auto|1|2|3|4|5|6|7)", + "type": "string" + } + } + }, + "RadiusServer": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "secret": { + "type": "string" + } + } + }, + "ResourceGroup": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "deviceIPs": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "deviceIps": { + "uniqueItems": true, + "type": "array", + "writeOnly": true, + "items": { + "type": "string" + } + }, + "id": { + "type": "object" + }, + "mgmtSytemIpsMap": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "siteIds": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "uuidSytemIpsMap": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SSIDConfig": { + "type": "object", + "properties": { + "qosSettings": { + "pattern": "(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)", + "type": "string" + }, + "securityAuthType": { + "pattern": "(OPEN|WPA2-PSK_AES)", + "type": "string" + }, + "ssid": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "visibility": { + "type": "boolean" + }, + "wpaPskKey": { + "type": "string" + } + } + }, + "SchemaDefinition": { + "type": "object", + "properties": { + "countOfUniqueuVertexAndEdgeObjectsCreated": { + "type": "integer", + "format": "int32" + }, + "countOfVertexAndEdgesRegisteredWithDeviceDataManager": { + "type": "integer", + "format": "int32" + }, + "vertexDefinitionsForDataCollection": { + "type": "array", + "items": { + "type": "string" + } + }, + "vertexDefinitionsFoundInDBWithData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VertexDefinition" + } + }, + "vertexDefinitionsFoundInDBWithoutData": { + "type": "array", + "items": { + "type": "string" + } + }, + "vertexDefinitionsNotFoundInDB": { + "type": "array", + "items": { + "type": "string" + } + }, + "vertexDefinitionsNotRegisteredWithDeviceDataManager": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SecurityPolicy": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "policyName": { + "type": "string" + }, + "defaultAction": { + "pattern": "(drop|pass)", + "type": "string" + }, + "policyRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + ] + }, + "SimSlotConfig": { + "required": [ + "attachProfileId", + "profileList", + "slotNumber" + ], + "type": "object", + "properties": { + "attachProfileId": { + "maximum": 16, + "minimum": 1, + "type": "integer", + "format": "int32" + }, + "carrierName": { + "type": "string" + }, + "dataProfileIdList": { + "maxItems": 16, + "minItems": 1, + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "profileList": { + "maxItems": 16, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/CellularProfile" + } + }, + "slotNumber": { + "maximum": 1, + "minimum": 0, + "type": "integer", + "format": "int32" + } + } + }, + "SiteHealth": { + "type": "object", + "properties": { + "fullConnectivity": { + "type": "integer", + "format": "int32" + }, + "noConnectivity": { + "type": "integer", + "format": "int32" + }, + "partialConnectivity": { + "type": "integer", + "format": "int32" + } + } + }, + "SiteToSiteVpn": { + "required": [ + "localInterface", + "localPrivateSubnet", + "preSharedSecret", + "remotePrivateSubnets", + "remotePublicIp" + ], + "type": "object", + "properties": { + "localInterface": { + "pattern": "(^Cellular1/0$|^GigabitEthernet0/0$)", + "type": "string" + }, + "localPrivateSubnet": { + "type": "string" + }, + "name": { + "type": "string" + }, + "preSharedSecret": { + "type": "string" + }, + "remotePrivateSubnets": { + "type": "string" + }, + "remotePublicIp": { + "type": "string" + }, + "tunnelDnsAddress": { + "type": "string" + } + } + }, + "SmartAccountModel": { + "type": "object", + "properties": { + "env": { + "type": "string" + }, + "organization_name": { + "type": "string" + }, + "password": { + "type": "string" + }, + "username": { + "type": "string" + }, + "validity_string": { + "type": "string" + } + } + }, + "SoftwareUploadFile": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + }, + "file": { + "type": "string", + "format": "binary" + } + } + }, + "StatisticsProcessingCounters": { + "type": "object", + "properties": { + "counters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatsTypeProcessingCounters" + } + } + } + }, + "StatsTypeProcessingCounters": { + "type": "object", + "properties": { + "compressed_size": { + "type": "integer", + "format": "int64" + }, + "files_number": { + "type": "integer", + "format": "int64" + }, + "processing_time": { + "type": "integer", + "format": "int64" + }, + "records_number": { + "type": "integer", + "format": "int64" + }, + "stats_type": { + "type": "string" + }, + "uncompressed_size": { + "type": "integer", + "format": "int64" + } + } + }, + "Systems": { + "type": "object", + "properties": { + "consoleBaudRate": { + "type": "string" + }, + "description": { + "type": "string" + }, + "deviceGroup": { + "type": "string" + }, + "gpsLatitude": { + "type": "string" + }, + "gpsLongitude": { + "type": "string" + }, + "hostName": { + "type": "string" + }, + "location": { + "type": "string" + }, + "onDemandTunnel": { + "type": "string" + }, + "onDemandTunnelIdleTimeout": { + "type": "integer", + "format": "int32" + }, + "portHopping": { + "type": "string" + }, + "portOffset": { + "type": "integer", + "format": "int32" + }, + "siteId": { + "type": "string" + }, + "systemIp": { + "type": "string" + }, + "timeZone": { + "type": "string" + } + } + }, + "TagRestfulResource": { + "type": "object", + "properties": { + "allGroups": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "valueType": { + "type": "string", + "enum": [ + "ARRAY", + "OBJECT", + "STRING", + "NUMBER", + "TRUE", + "FALSE", + "NULL" + ] + } + } + } + } + } + }, + "TenantStatus": { + "type": "object", + "properties": { + "controlStatus": { + "$ref": "#/components/schemas/ControlStatus" + }, + "getvEdgeHealth": { + "$ref": "#/components/schemas/VEdgeHealth" + }, + "getvSmartStatus": { + "$ref": "#/components/schemas/VSmartStatus" + }, + "siteHealth": { + "$ref": "#/components/schemas/SiteHealth" + }, + "tenantId": { + "type": "string" + }, + "tenantName": { + "type": "string" + } + } + }, + "TenantStatusListModel": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TenantStatus" + } + }, + "header": { + "$ref": "#/components/schemas/Header" + } + } + }, + "ThreadPoolDefinition": { + "type": "object", + "properties": { + "consumerClass": { + "type": "string" + }, + "consumerMethod": { + "type": "string" + }, + "threadPoolName": { + "type": "string" + }, + "threadPoolSize": { + "type": "integer", + "format": "int32" + } + } + }, + "ThreadPoolsDefinition": { + "type": "object", + "properties": { + "threadPools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ThreadPoolDefinition" + } + }, + "totalThreadCount": { + "type": "integer", + "format": "int32" + } + } + }, + "UpdateTenantModel": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "getvBondAddress": { + "type": "string" + }, + "getvSmarts": { + "type": "array", + "items": { + "type": "string" + } + }, + "idpMetadata": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "oldIdpMetadata": { + "type": "string" + }, + "spMetadata": { + "type": "string" + }, + "subDomain": { + "type": "string" + }, + "wanEdgeForecast": { + "type": "string" + } + } + }, + "UpdateTenantvSmartModel": { + "type": "object", + "properties": { + "destvSmartUuid": { + "type": "string" + }, + "srcvSmartUuid": { + "type": "string" + } + } + }, + "Uuid": { + "type": "object", + "properties": { + "uuid": { + "type": "string" + } + }, + "description": "This is valid uuid" + }, + "UuidToDomainId": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UuidToDomainIdMapping" + } + } + } + }, + "UuidToDomainIdMapping": { + "type": "object", + "properties": { + "domainId": { + "type": "integer", + "format": "int32" + }, + "uuid": { + "type": "string" + } + } + }, + "VEdgeBootstrapConfig": { + "type": "object", + "properties": { + "bootstrapConfigType": { + "type": "string" + }, + "uuid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VEdgeHealth": { + "type": "object", + "properties": { + "error": { + "type": "integer", + "format": "int32" + }, + "normal": { + "type": "integer", + "format": "int32" + }, + "warning": { + "type": "integer", + "format": "int32" + } + } + }, + "VPNID": { + "type": "object", + "properties": { + "vpn": { + "type": "string" + } + }, + "description": "This is the valid list of VPN-IDs" + }, + "VResourceGroupNameModel": { + "type": "object", + "properties": { + "VResourceGroupName": { + "type": "string" + } + } + }, + "VSmartStatus": { + "type": "object", + "properties": { + "down": { + "type": "integer", + "format": "int32" + }, + "up": { + "type": "integer", + "format": "int32" + } + } + }, + "Variable": { + "required": [ + "jsonPath", + "varName" + ], + "type": "object", + "properties": { + "jsonPath": { + "type": "string" + }, + "varName": { + "type": "string" + } + } + }, + "VertexDefinition": { + "type": "object", + "properties": { + "inEdges": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "outEdges": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyDefinition" + } + } + } + }, + "Vpn": { + "required": [ + "name", + "siteToSiteVpn", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "siteToSiteVpn": { + "$ref": "#/components/schemas/SiteToSiteVpn" + }, + "ipSecPolicy": { + "$ref": "#/components/schemas/IpSecPolicy" + } + } + } + ] + }, + "WanSpec": { + "required": [ + "accountId", + "cloudRegion", + "mappedBranches", + "resourceGroup", + "vpn" + ], + "type": "object", + "properties": { + "accountId": { + "type": "string", + "format": "uuid" + }, + "cloudRegion": { + "type": "string" + }, + "mappedBranches": { + "type": "string" + }, + "resourceGroup": { + "type": "string" + }, + "vpn": { + "type": "string" + }, + "wanId": { + "type": "string", + "format": "uuid" + } + } + }, + "Wifi": { + "required": [ + "name", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProfileParcel" + }, + { + "type": "object", + "properties": { + "ssidConfigList": { + "maxItems": 14, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SSIDConfig" + } + }, + "guestWifi": { + "$ref": "#/components/schemas/GuestWifi" + }, + "corporateWifi": { + "$ref": "#/components/schemas/CorporateWifi" + }, + "advancedRadioSetting": { + "$ref": "#/components/schemas/AdvancedRadioSetting" + } + } + } + ] + }, + "uploadHSECAuthFile": { + "type": "object", + "properties": { + "data": { + "type": "string", + "format": "binary" + } + } + } + } + } +} diff --git a/openapi_client/__init__.py b/openapi_client/__init__.py new file mode 100644 index 0000000..4b1ed49 --- /dev/null +++ b/openapi_client/__init__.py @@ -0,0 +1,28 @@ +# flake8: noqa + +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +__version__ = "1.0.0" + +# import ApiClient +from openapi_client.api_client import ApiClient + +# import Configuration +from openapi_client.configuration import Configuration + +# import exceptions +from openapi_client.exceptions import OpenApiException +from openapi_client.exceptions import ApiAttributeError +from openapi_client.exceptions import ApiTypeError +from openapi_client.exceptions import ApiValueError +from openapi_client.exceptions import ApiKeyError +from openapi_client.exceptions import ApiException diff --git a/openapi_client/api/__init__.py b/openapi_client/api/__init__.py new file mode 100644 index 0000000..84362b3 --- /dev/null +++ b/openapi_client/api/__init__.py @@ -0,0 +1,3 @@ +# do not import all apis into this module because that uses a lot of memory and stack frames +# if you need the ability to import all apis from one package, import them with +# from openapi_client.apis import AdministrationAuditLogApi diff --git a/openapi_client/api/administration_audit_log_api.py b/openapi_client/api/administration_audit_log_api.py new file mode 100644 index 0000000..a172815 --- /dev/null +++ b/openapi_client/api/administration_audit_log_api.py @@ -0,0 +1,1614 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class AdministrationAuditLogApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.generate_audit_log_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/severity', + 'operation_id': 'generate_audit_log', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_audit_severity_custom_histogram_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/severity/summary', + 'operation_id': 'get_audit_severity_custom_histogram', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/doccount', + 'operation_id': 'get_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/doccount', + 'operation_id': 'get_count_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_property_aggregation_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/aggregation', + 'operation_id': 'get_post_property_aggregation_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [ + 'body', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_property_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/page', + 'operation_id': 'get_post_stat_bulk_raw_property_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + 'scroll_id', + 'count', + ], + 'required': [ + 'body', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'body': 'body', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_property_aggregation_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/aggregation', + 'operation_id': 'get_property_aggregation_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'input_query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'input_query': + (str,), + }, + 'attribute_map': { + 'input_query': 'inputQuery', + }, + 'location_map': { + 'input_query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_raw_property_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog', + 'operation_id': 'get_raw_property_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [ + 'body', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_property_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/page', + 'operation_id': 'get_stat_bulk_raw_property_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'input_query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'input_query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'input_query': 'inputQuery', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'input_query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/fields', + 'operation_id': 'get_stat_data_fields', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_audit_log_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog', + 'operation_id': 'get_stat_data_raw_audit_log_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'input_query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'input_query': + (str,), + }, + 'attribute_map': { + 'input_query': 'inputQuery', + }, + 'location_map': { + 'input_query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/auditlog/query/fields', + 'operation_id': 'get_stat_query_fields', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def generate_audit_log( + self, + **kwargs + ): + """generate_audit_log # noqa: E501 + + Get audit logs for last 3 hours # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_audit_log(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_audit_log_endpoint.call_with_http_info(**kwargs) + + def get_audit_severity_custom_histogram( + self, + **kwargs + ): + """get_audit_severity_custom_histogram # noqa: E501 + + Get audit log severity histogram # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_audit_severity_custom_histogram(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_audit_severity_custom_histogram_endpoint.call_with_http_info(**kwargs) + + def get_count( + self, + query, + **kwargs + ): + """get_count # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count_endpoint.call_with_http_info(**kwargs) + + def get_count_post( + self, + **kwargs + ): + """get_count_post # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post_endpoint.call_with_http_info(**kwargs) + + def get_post_property_aggregation_data( + self, + body, + **kwargs + ): + """get_post_property_aggregation_data # noqa: E501 + + Get raw property data aggregated with post action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_property_aggregation_data(body, async_req=True) + >>> result = thread.get() + + Args: + body (str): Query filter for getting stat raw data + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['body'] = \ + body + return self.get_post_property_aggregation_data_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_property_data( + self, + body, + **kwargs + ): + """get_post_stat_bulk_raw_property_data # noqa: E501 + + Get raw property data in bulk with post action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_property_data(body, async_req=True) + >>> result = thread.get() + + Args: + body (str): Query filter for getting stat raw data + + Keyword Args: + scroll_id (str): Offset of the query result. [optional] + count (str): Size of the query result. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['body'] = \ + body + return self.get_post_stat_bulk_raw_property_data_endpoint.call_with_http_info(**kwargs) + + def get_property_aggregation_data( + self, + **kwargs + ): + """get_property_aggregation_data # noqa: E501 + + Get raw property data aggregated # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_property_aggregation_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + input_query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_property_aggregation_data_endpoint.call_with_http_info(**kwargs) + + def get_raw_property_data( + self, + body, + **kwargs + ): + """get_raw_property_data # noqa: E501 + + Get raw property data with post action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_raw_property_data(body, async_req=True) + >>> result = thread.get() + + Args: + body (str): Query filter for getting stat raw data + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['body'] = \ + body + return self.get_raw_property_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_property_data( + self, + **kwargs + ): + """get_stat_bulk_raw_property_data # noqa: E501 + + Get raw property data in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_property_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + input_query (str): Query filter. [optional] + scroll_id (str): Offset of the query result. [optional] + count (str): size of the query result. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_property_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields( + self, + **kwargs + ): + """get_stat_data_fields # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_audit_log_data( + self, + **kwargs + ): + """get_stat_data_raw_audit_log_data # noqa: E501 + + Get stat raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_audit_log_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + input_query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_audit_log_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields( + self, + **kwargs + ): + """get_stat_query_fields # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/administration_user_and_group_api.py b/openapi_client/api/administration_user_and_group_api.py new file mode 100644 index 0000000..fac4f0c --- /dev/null +++ b/openapi_client/api/administration_user_and_group_api.py @@ -0,0 +1,4347 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.resource_group import ResourceGroup + + +class AdministrationUserAndGroupApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_colo_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/cologroup', + 'operation_id': 'create_colo_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_group_grid_columns_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/admin/usergroup/definition', + 'operation_id': 'create_group_grid_columns', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_user_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user', + 'operation_id': 'create_user', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_user_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/usergroup', + 'operation_id': 'create_user_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_vpn_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/vpngroup', + 'operation_id': 'create_vpn_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_colo_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/cologroup/{id}', + 'operation_id': 'delete_colo_group', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_user_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/{userName}', + 'operation_id': 'delete_user', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_name', + ], + 'required': [ + 'user_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_name': + (str,), + }, + 'attribute_map': { + 'user_name': 'userName', + }, + 'location_map': { + 'user_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_user_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/usergroup/{userGroupId}', + 'operation_id': 'delete_user_group', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_group_id', + ], + 'required': [ + 'user_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_group_id': + (str,), + }, + 'attribute_map': { + 'user_group_id': 'userGroupId', + }, + 'location_map': { + 'user_group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_vpn_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/vpngroup/{id}', + 'operation_id': 'delete_vpn_group', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_colo_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/cologroup/{id}', + 'operation_id': 'edit_colo_group', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_vpn_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/vpngroup/{id}', + 'operation_id': 'edit_vpn_group', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.find_user_auth_type_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/admin/user/userAuthType', + 'operation_id': 'find_user_auth_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_user_groups_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/admin/usergroup', + 'operation_id': 'find_user_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_user_groups_as_key_value_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/admin/usergroup/keyvalue', + 'operation_id': 'find_user_groups_as_key_value', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_user_role_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/admin/user/role', + 'operation_id': 'find_user_role', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_users_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/admin/user', + 'operation_id': 'find_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_active_sessions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/admin/user/activeSessions', + 'operation_id': 'get_active_sessions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_colo_groups_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/admin/cologroup', + 'operation_id': 'get_colo_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vpn_groups_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/admin/vpngroup', + 'operation_id': 'get_vpn_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.remove_sessions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/admin/user/removeSessions', + 'operation_id': 'remove_sessions', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'request_body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'request_body': + ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + }, + 'attribute_map': { + }, + 'location_map': { + 'request_body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.reset_user_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/reset', + 'operation_id': 'reset_user', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.resource_group_endpoint = _Endpoint( + settings={ + 'response_type': ([ResourceGroup],), + 'auth': [], + 'endpoint_path': '/admin/resourcegroup', + 'operation_id': 'resource_group', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.resource_group1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/admin/resourcegroup/switch', + 'operation_id': 'resource_group1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [ + 'body', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.resource_group2_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/resourcegroup/{groupId}', + 'operation_id': 'resource_group2', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'group_id', + 'resource_group', + ], + 'required': [ + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'group_id': + (str,), + 'resource_group': + (ResourceGroup,), + }, + 'attribute_map': { + 'group_id': 'groupId', + }, + 'location_map': { + 'group_id': 'path', + 'resource_group': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.resource_group3_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/resourcegroup/{groupId}', + 'operation_id': 'resource_group3', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'group_id', + ], + 'required': [ + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'group_id': + (str,), + }, + 'attribute_map': { + 'group_id': 'groupId', + }, + 'location_map': { + 'group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.resource_group4_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/resourcegroup', + 'operation_id': 'resource_group4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'resource_group', + ], + 'required': [ + 'resource_group', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'resource_group': + (ResourceGroup,), + }, + 'attribute_map': { + }, + 'location_map': { + 'resource_group': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.resource_group_name_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/admin/user/resourceGroupName', + 'operation_id': 'resource_group_name', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_admin_password_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/admin/password', + 'operation_id': 'update_admin_password', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_password_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/password/{userName}', + 'operation_id': 'update_password', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_name', + 'body', + ], + 'required': [ + 'user_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'user_name': 'userName', + }, + 'location_map': { + 'user_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_profile_locale_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/profile/locale', + 'operation_id': 'update_profile_locale', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_profile_password_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/profile/password', + 'operation_id': 'update_profile_password', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_user_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/{userName}', + 'operation_id': 'update_user', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_name', + 'body', + ], + 'required': [ + 'user_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'user_name': 'userName', + }, + 'location_map': { + 'user_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_user_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/usergroup/{userGroupId}', + 'operation_id': 'update_user_group', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_group_id', + 'body', + ], + 'required': [ + 'user_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_group_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'user_group_id': 'userGroupId', + }, + 'location_map': { + 'user_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_password_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/admin/user/password/validate', + 'operation_id': 'validate_password', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_colo_group( + self, + **kwargs + ): + """create_colo_group # noqa: E501 + + Add COLO group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_colo_group(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Colocation group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_colo_group_endpoint.call_with_http_info(**kwargs) + + def create_group_grid_columns( + self, + **kwargs + ): + """create_group_grid_columns # noqa: E501 + + Get user groups in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_group_grid_columns(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_group_grid_columns_endpoint.call_with_http_info(**kwargs) + + def create_user( + self, + **kwargs + ): + """create_user # noqa: E501 + + Create a user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_user(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_user_endpoint.call_with_http_info(**kwargs) + + def create_user_group( + self, + **kwargs + ): + """create_user_group # noqa: E501 + + Create user group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_user_group(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_user_group_endpoint.call_with_http_info(**kwargs) + + def create_vpn_group( + self, + **kwargs + ): + """create_vpn_group # noqa: E501 + + Add VPN group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_vpn_group(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPN group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_vpn_group_endpoint.call_with_http_info(**kwargs) + + def delete_colo_group( + self, + id, + **kwargs + ): + """delete_colo_group # noqa: E501 + + Delete COLO group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_colo_group(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Colocation group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_colo_group_endpoint.call_with_http_info(**kwargs) + + def delete_user( + self, + user_name, + **kwargs + ): + """delete_user # noqa: E501 + + Delete user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_user(user_name, async_req=True) + >>> result = thread.get() + + Args: + user_name (str): User name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_name'] = \ + user_name + return self.delete_user_endpoint.call_with_http_info(**kwargs) + + def delete_user_group( + self, + user_group_id, + **kwargs + ): + """delete_user_group # noqa: E501 + + Delete user group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_user_group(user_group_id, async_req=True) + >>> result = thread.get() + + Args: + user_group_id (str): User group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_group_id'] = \ + user_group_id + return self.delete_user_group_endpoint.call_with_http_info(**kwargs) + + def delete_vpn_group( + self, + id, + **kwargs + ): + """delete_vpn_group # noqa: E501 + + Delete VPN group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_vpn_group(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): VPN group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_vpn_group_endpoint.call_with_http_info(**kwargs) + + def edit_colo_group( + self, + id, + **kwargs + ): + """edit_colo_group # noqa: E501 + + Update COLO group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_colo_group(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Colocation group Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Colocation group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_colo_group_endpoint.call_with_http_info(**kwargs) + + def edit_vpn_group( + self, + id, + **kwargs + ): + """edit_vpn_group # noqa: E501 + + Update VPN group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_vpn_group(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): VPN group Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPN group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_vpn_group_endpoint.call_with_http_info(**kwargs) + + def find_user_auth_type( + self, + **kwargs + ): + """find_user_auth_type # noqa: E501 + + Find user authentication type, whether it is SAML enabled # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_user_auth_type(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_user_auth_type_endpoint.call_with_http_info(**kwargs) + + def find_user_groups( + self, + **kwargs + ): + """find_user_groups # noqa: E501 + + Get all user groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_user_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_user_groups_endpoint.call_with_http_info(**kwargs) + + def find_user_groups_as_key_value( + self, + **kwargs + ): + """find_user_groups_as_key_value # noqa: E501 + + Get user groups as key value map # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_user_groups_as_key_value(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_user_groups_as_key_value_endpoint.call_with_http_info(**kwargs) + + def find_user_role( + self, + **kwargs + ): + """find_user_role # noqa: E501 + + Check whether a user has admin role # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_user_role(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_user_role_endpoint.call_with_http_info(**kwargs) + + def find_users( + self, + **kwargs + ): + """find_users # noqa: E501 + + Get all users # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_users(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_users_endpoint.call_with_http_info(**kwargs) + + def get_active_sessions( + self, + **kwargs + ): + """get_active_sessions # noqa: E501 + + Get active sessions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_active_sessions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_active_sessions_endpoint.call_with_http_info(**kwargs) + + def get_colo_groups( + self, + **kwargs + ): + """get_colo_groups # noqa: E501 + + Get COLO groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_colo_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_colo_groups_endpoint.call_with_http_info(**kwargs) + + def get_vpn_groups( + self, + **kwargs + ): + """get_vpn_groups # noqa: E501 + + Get VPN groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vpn_groups_endpoint.call_with_http_info(**kwargs) + + def remove_sessions( + self, + **kwargs + ): + """remove_sessions # noqa: E501 + + Remove sessions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_sessions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + request_body ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.remove_sessions_endpoint.call_with_http_info(**kwargs) + + def reset_user( + self, + **kwargs + ): + """reset_user # noqa: E501 + + Unlock a user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reset_user(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.reset_user_endpoint.call_with_http_info(**kwargs) + + def resource_group( + self, + **kwargs + ): + """resource_group # noqa: E501 + + Get all groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resource_group(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [ResourceGroup] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.resource_group_endpoint.call_with_http_info(**kwargs) + + def resource_group1( + self, + body, + **kwargs + ): + """resource_group1 # noqa: E501 + + Global netadmin switches to a different resource group view # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resource_group1(body, async_req=True) + >>> result = thread.get() + + Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global netadmin switches to a different resource group view + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['body'] = \ + body + return self.resource_group1_endpoint.call_with_http_info(**kwargs) + + def resource_group2( + self, + group_id, + **kwargs + ): + """resource_group2 # noqa: E501 + + Update a group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resource_group2(group_id, async_req=True) + >>> result = thread.get() + + Args: + group_id (str): + + Keyword Args: + resource_group (ResourceGroup): Update group description. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['group_id'] = \ + group_id + return self.resource_group2_endpoint.call_with_http_info(**kwargs) + + def resource_group3( + self, + group_id, + **kwargs + ): + """resource_group3 # noqa: E501 + + Delete a group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resource_group3(group_id, async_req=True) + >>> result = thread.get() + + Args: + group_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['group_id'] = \ + group_id + return self.resource_group3_endpoint.call_with_http_info(**kwargs) + + def resource_group4( + self, + resource_group, + **kwargs + ): + """resource_group4 # noqa: E501 + + Create a group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resource_group4(resource_group, async_req=True) + >>> result = thread.get() + + Args: + resource_group (ResourceGroup): Create a group + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['resource_group'] = \ + resource_group + return self.resource_group4_endpoint.call_with_http_info(**kwargs) + + def resource_group_name( + self, + **kwargs + ): + """resource_group_name # noqa: E501 + + Get the name of the resource group associated with the current logged in user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.resource_group_name(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.resource_group_name_endpoint.call_with_http_info(**kwargs) + + def update_admin_password( + self, + **kwargs + ): + """update_admin_password # noqa: E501 + + Update admin default password # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_admin_password(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_admin_password_endpoint.call_with_http_info(**kwargs) + + def update_password( + self, + user_name, + **kwargs + ): + """update_password # noqa: E501 + + Update user password # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_password(user_name, async_req=True) + >>> result = thread.get() + + Args: + user_name (str): User name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_name'] = \ + user_name + return self.update_password_endpoint.call_with_http_info(**kwargs) + + def update_profile_locale( + self, + **kwargs + ): + """update_profile_locale # noqa: E501 + + Update profile locale # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_profile_locale(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_profile_locale_endpoint.call_with_http_info(**kwargs) + + def update_profile_password( + self, + **kwargs + ): + """update_profile_password # noqa: E501 + + Update profile password # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_profile_password(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_profile_password_endpoint.call_with_http_info(**kwargs) + + def update_user( + self, + user_name, + **kwargs + ): + """update_user # noqa: E501 + + Update user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_user(user_name, async_req=True) + >>> result = thread.get() + + Args: + user_name (str): User name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_name'] = \ + user_name + return self.update_user_endpoint.call_with_http_info(**kwargs) + + def update_user_group( + self, + user_group_id, + **kwargs + ): + """update_user_group # noqa: E501 + + Update user group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_user_group(user_group_id, async_req=True) + >>> result = thread.get() + + Args: + user_group_id (str): User group Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_group_id'] = \ + user_group_id + return self.update_user_group_endpoint.call_with_http_info(**kwargs) + + def validate_password( + self, + **kwargs + ): + """validate_password # noqa: E501 + + Validate user password # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_password(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User password. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.validate_password_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/certificate_management_device_api.py b/openapi_client/api/certificate_management_device_api.py new file mode 100644 index 0000000..22d9386 --- /dev/null +++ b/openapi_client/api/certificate_management_device_api.py @@ -0,0 +1,4050 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class CertificateManagementDeviceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.decommission_enterprise_csr_for_vedge_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/revoke/enterprise/certificate', + 'operation_id': 'decommission_enterprise_csr_for_vedge', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/{uuid}', + 'operation_id': 'delete_configuration', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + 'replace_controller', + 'device_id', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + 'replace_controller': + (bool,), + 'device_id': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + 'replace_controller': 'replaceController', + 'device_id': 'deviceId', + }, + 'location_map': { + 'uuid': 'path', + 'replace_controller': 'query', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.force_sync_root_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/forcesync/rootCert', + 'operation_id': 'force_sync_root_cert', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_csr_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/certificate/generate/csr', + 'operation_id': 'generate_csr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_edge_device_csr_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/certificate/generate/wanedge/csr', + 'operation_id': 'generate_edge_device_csr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_enterprise_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/generate/enterprise/csr/vedge', + 'operation_id': 'generate_enterprise_csr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cert_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/certdetails', + 'operation_id': 'get_cert_details', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_certificate_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/record', + 'operation_id': 'get_certificate_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_certificate_detail_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/stats/detail', + 'operation_id': 'get_certificate_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_certificate_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/stats/summary', + 'operation_id': 'get_certificate_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_csr_view_right_menus_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/csr/details', + 'operation_id': 'get_csr_view_right_menus', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_view_right_menus_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/device/details', + 'operation_id': 'get_device_view_right_menus', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_devices_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/device/list', + 'operation_id': 'get_devices_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_installed_cert_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/certificate/vedge', + 'operation_id': 'get_installed_cert', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_list_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/certificate/list/status', + 'operation_id': 'get_list_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_root_cert_chains_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/certificate/rootcertchains', + 'operation_id': 'get_root_cert_chains', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'action', + ], + 'required': [ + 'action', + ], + 'nullable': [ + ], + 'enum': [ + 'action', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('action',): { + + "GET": "get", + "VERIFY": "verify" + }, + }, + 'openapi_types': { + 'action': + (str,), + }, + 'attribute_map': { + 'action': 'action', + }, + 'location_map': { + 'action': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_root_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/rootcertificate', + 'operation_id': 'get_root_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_view_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/view', + 'operation_id': 'get_view', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getc_edge_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/tokengeneratedlist', + 'operation_id': 'getc_edge_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_edge_csr_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/certificate/vedge/csr', + 'operation_id': 'getv_edge_csr', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_edge_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/vedge/list', + 'operation_id': 'getv_edge_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'model', + 'state', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'model', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('model',): { + + "VEDGE-CLOUD": "vedge-cloud", + "VEDGE-1000": "vedge-1000", + "VEDGE-2000": "vedge-2000", + "VEDGE-100": "vedge-100", + "VEDGE-ISR1100-4G": "vedge-ISR1100-4G", + "VEDGE-ISR1100-4GLTE": "vedge-ISR1100-4GLTE", + "VEDGE-ISR1100X-4G": "vedge-ISR1100X-4G", + "VEDGE-ISR1100-6G": "vedge-ISR1100-6G", + "VEDGE-ISR1100X-6G": "vedge-ISR1100X-6G", + "VEDGE-100-B": "vedge-100-B", + "VEDGE-100-WM": "vedge-100-WM", + "VEDGE-100-M": "vedge-100-M", + "VEDGE-5000": "vEdge-5000", + "VEDGE-CSR-1000V": "vedge-CSR-1000v", + "VEDGE-IR-1101": "vedge-IR-1101", + "VEDGE-IR-1821": "vedge-IR-1821", + "VEDGE-IR-1831": "vedge-IR-1831", + "VEDGE-IR-1833": "vedge-IR-1833", + "VEDGE-IR-1835": "vedge-IR-1835", + "VEDGE-IR-8140H": "vedge-IR-8140H", + "VEDGE-IR-8140H-P": "vedge-IR-8140H-P", + "VEDGE-IR-8340": "vedge-IR-8340", + "VEDGE-ESR-6300": "vedge-ESR-6300", + "VEDGE-ISR-4331": "vedge-ISR-4331", + "VEDGE-ISR-4321": "vedge-ISR-4321", + "VEDGE-ISR-4351": "vedge-ISR-4351", + "VEDGE-ISR-4221": "vedge-ISR-4221", + "VEDGE-IR-1101": "vedge-IR-1101", + "VEDGE-ESR-6300": "vedge-ESR-6300", + "VEDGE-ISR-4331": "vedge-ISR-4331", + "VEDGE-ISR-4321": "vedge-ISR-4321", + "VEDGE-ISR-4351": "vedge-ISR-4351", + "VEDGE-ISR-4221": "vedge-ISR-4221", + "VEDGE-ISR-4221X": "vedge-ISR-4221X", + "VEDGE-ISR-4431": "vedge-ISR-4431", + "VEDGE-ISR-4451-X": "vedge-ISR-4451-X", + "VEDGE-ASR-1001-HX": "vedge-ASR-1001-HX", + "VEDGE-ASR-1002-X": "vedge-ASR-1002-X", + "VEDGE-ASR-1002-HX": "vedge-ASR-1002-HX", + "VEDGE-ASR-1006-X": "vedge-ASR-1006-X", + "VEDGE-C1111-8P": "vedge-C1111-8P", + "VEDGE-C1121X-8P": "vedge-C1121X-8P", + "VEDGE-C1111X-8P": "vedge-C1111X-8P", + "VEDGE-C1111-8PLTELAW": "vedge-C1111-8PLTELAW", + "VEDGE-C1111-8PLTEEA": "vedge-C1111-8PLTEEA", + "VEDGE-C1121-8PLTEPW": "vedge-C1121-8PLTEPW", + "VEDGE-C1111-8PLTELA": "vedge-C1111-8PLTELA", + "VEDGE-C1117-4PLTEEA": "vedge-C1117-4PLTEEA", + "VEDGE-C1126X-8PLTEP": "vedge-C1126X-8PLTEP", + "VEDGE-C1127X-8PLTEP": "vedge-C1127X-8PLTEP", + "VEDGE-C1127X-8PMLTEP": "vedge-C1127X-8PMLTEP", + "VEDGE-C1127-8PMLTEP": "vedge-C1127-8PMLTEP", + "VEDGE-C1117-4PLTELA": "vedge-C1117-4PLTELA", + "VEDGE-ISRV": "vedge-ISRv", + "VEDGE-C8000V": "vedge-C8000V", + "VEDGE-ASR-1001-X": "vedge-ASR-1001-X", + "VEDGE-C1111-4P": "vedge-C1111-4P", + "VEDGE-C1101-4P": "vedge-C1101-4P", + "VEDGE-C1101-4PLTEP": "vedge-C1101-4PLTEP", + "VEDGE-C8500-12X4QC": "vedge-C8500-12X4QC", + "VEDGE-C8500-20X6C": "vedge-C8500-20X6C", + "VEDGE-C8500-12X": "vedge-C8500-12X", + "VEDGE-C8500L-8S4X": "vedge-C8500L-8S4X", + "VEDGE-C1111-8PW": "vedge-C1111-8PW", + "VEDGE-C1111-8PLTEEAW": "vedge-C1111-8PLTEEAW", + "VEDGE-C1111-4PLTEEA": "vedge-C1111-4PLTEEA", + "VEDGE-C1101-4PLTEPW": "vedge-C1101-4PLTEPW", + "VEDGE-C1109-4PLTE2PW": "vedge-C1109-4PLTE2PW", + "VEDGE-C1109-4PLTE2P": "vedge-C1109-4PLTE2P", + "VEDGE-C1121X-8PLTEP": "vedge-C1121X-8PLTEP", + "VEDGE-C1161X-8PLTEP": "vedge-C1161X-8PLTEP", + "VEDGE-C1113-8PMLTEEA": "vedge-C1113-8PMLTEEA", + "VEDGE-C1111-4PLTELA,VEDGE-C1116-4P": "vedge-C1111-4PLTELA,vedge-C1116-4P", + "VEDGE-C1116-4PLTEEA": "vedge-C1116-4PLTEEA", + "VEDGE-C1117-4P": "vedge-C1117-4P", + "VEDGE-C1117-4PM": "vedge-C1117-4PM", + "VEDGE-C1117-4PMLTEEA": "vedge-C1117-4PMLTEEA", + "VSMART": "vsmart", + "VMANAGE": "vmanage", + "VBOND": "vbond", + "VEDGE-ISR-4461": "vedge-ISR-4461", + "VEDGE-C8300-1N1S-4T2X": "vedge-C8300-1N1S-4T2X", + "VEDGE-C8300-1N1S-6T": "vedge-C8300-1N1S-6T", + "VEDGE-C1161X-8P": "vedge-C1161X-8P", + "VEDGE-C8300-2N2S-4T2X": "vedge-C8300-2N2S-4T2X", + "VEDGE-C8300-2N2S-6T": "vedge-C8300-2N2S-6T", + "VEDGE-C8200-1N-4T": "vedge-C8200-1N-4T", + "VEDGE-C8200L-1N-4T": "vedge-C8200L-1N-4T", + "VEDGE-C1161-8P": "vedge-C1161-8P", + "VEDGE-C1126-8PLTEP": "vedge-C1126-8PLTEP", + "VEDGE-C1127-8PLTEP": "vedge-C1127-8PLTEP", + "VEDGE-C1121-4P": "vedge-C1121-4P", + "VEDGE-C1121-4PLTEP": "vedge-C1121-4PLTEP", + "VEDGE-C1128-8PLTEP": "vedge-C1128-8PLTEP", + "VEDGE-C1121X-8PLTEPW": "vedge-C1121X-8PLTEPW", + "VEDGE-C1121-8PLTEP": "vedge-C1121-8PLTEP", + "VEDGE-C1121-8P": "vedge-C1121-8P", + "VEDGE-C1161-8PLTEP": "vedge-C1161-8PLTEP", + "VEDGE-C1113-8PLTEEA": "vedge-C1113-8PLTEEA", + "VEDGE-C1113-8PLTEW": "vedge-C1113-8PLTEW", + "VEDGE-C1111-4PW": "vedge-C1111-4PW", + "VEDGE-C1112-8P": "vedge-C1112-8P", + "VEDGE-C1112-8PLTEEA": "vedge-C1112-8PLTEEA", + "VEDGE-C1112-8PLTEEAWE": "vedge-C1112-8PLTEEAWE", + "VEDGE-C1112-8PWE": "vedge-C1112-8PWE", + "VEDGE-C1113-8P": "vedge-C1113-8P", + "VEDGE-C1113-8PLTEEAW": "vedge-C1113-8PLTEEAW", + "VEDGE-C1113-8PLTELA": "vedge-C1113-8PLTELA", + "VEDGE-C1113-8PLTELAWZ": "vedge-C1113-8PLTELAWZ", + "VEDGE-C1113-8PM": "vedge-C1113-8PM", + "VEDGE-C1113-8PMWE": "vedge-C1113-8PMWE", + "VEDGE-C1113-8PW": "vedge-C1113-8PW", + "VEDGE-C1116-4PLTEEAWE": "vedge-C1116-4PLTEEAWE", + "VEDGE-C1131-8PW": "vedge-C1131-8PW", + "VEDGE-C1131X-8PW": "vedge-C1131X-8PW", + "VEDGE-C1131-8PLTEPW": "vedge-C1131-8PLTEPW", + "VEDGE-C1131X-8PLTEPW": "vedge-C1131X-8PLTEPW", + "VEDGE-C1116-4PWE": "vedge-C1116-4PWE", + "VEDGE-C1117-4PLTEEAW": "vedge-C1117-4PLTEEAW", + "VEDGE-C1117-4PLTELAWZ": "vedge-C1117-4PLTELAWZ", + "VEDGE-C1117-4PMLTEEAWE": "vedge-C1117-4PMLTEEAWE", + "VEDGE-C1117-4PMWE": "vedge-C1117-4PMWE", + "VEDGE-C1117-4PW": "vedge-C1117-4PW", + "VEDGE-C1118-8P": "vedge-C1118-8P", + "VEDGE-C1109-2PLTEGB": "vedge-C1109-2PLTEGB", + "VEDGE-C1109-2PLTEUS": "vedge-C1109-2PLTEUS", + "VEDGE-C1109-2PLTEVZ": "vedge-C1109-2PLTEVZ" + }, + }, + 'openapi_types': { + 'model': + (str,), + 'state': + ([str],), + }, + 'attribute_map': { + 'model': 'model', + 'state': 'state', + }, + 'location_map': { + 'model': 'query', + 'state': 'query', + }, + 'collection_format_map': { + 'state': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_smart_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/vsmart/list', + 'operation_id': 'getv_smart_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.install_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/install/signedCert', + 'operation_id': 'install_certificate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.reset_rsa_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/reset/rsa', + 'operation_id': 'reset_rsa', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.save_root_cert_chain_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/rootcertchains', + 'operation_id': 'save_root_cert_chain', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.save_v_edge_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/save/vedge/list', + 'operation_id': 'save_v_edge_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.setv_edge_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/vedge/list', + 'operation_id': 'setv_edge_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.setv_smart_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/vsmart/list', + 'operation_id': 'setv_smart_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.setv_smart_list1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/mthub/list', + 'operation_id': 'setv_smart_list1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.syncv_bond_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/syncvbond', + 'operation_id': 'syncv_bond', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_jks_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/jks', + 'operation_id': 'update_jks', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def decommission_enterprise_csr_for_vedge( + self, + **kwargs + ): + """decommission_enterprise_csr_for_vedge # noqa: E501 + + Revoking enterprise CSR for hardware vEdge


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.decommission_enterprise_csr_for_vedge(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Revoking CSR for hardware vEdge. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.decommission_enterprise_csr_for_vedge_endpoint.call_with_http_info(**kwargs) + + def delete_configuration( + self, + uuid, + **kwargs + ): + """delete_configuration # noqa: E501 + + Invalidate device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_configuration(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + replace_controller (bool): Replace a vSmart in Multi-tenant setup with a new vSmart. [optional] if omitted the server will use the default value of False + device_id (str): uuid of new vSmart. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.delete_configuration_endpoint.call_with_http_info(**kwargs) + + def force_sync_root_cert( + self, + **kwargs + ): + """force_sync_root_cert # noqa: E501 + + Force sync root certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.force_sync_root_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Singed certificate. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.force_sync_root_cert_endpoint.call_with_http_info(**kwargs) + + def generate_csr( + self, + **kwargs + ): + """generate_csr # noqa: E501 + + Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request for device. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_csr_endpoint.call_with_http_info(**kwargs) + + def generate_edge_device_csr( + self, + **kwargs + ): + """generate_edge_device_csr # noqa: E501 + + Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_edge_device_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request for device. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_edge_device_csr_endpoint.call_with_http_info(**kwargs) + + def generate_enterprise_csr( + self, + **kwargs + ): + """generate_enterprise_csr # noqa: E501 + + Generate CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_enterprise_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request for hardware device. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_enterprise_csr_endpoint.call_with_http_info(**kwargs) + + def get_cert_details( + self, + **kwargs + ): + """get_cert_details # noqa: E501 + + Get cert details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cert_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): parse cert. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cert_details_endpoint.call_with_http_info(**kwargs) + + def get_certificate_data( + self, + **kwargs + ): + """get_certificate_data # noqa: E501 + + Get certificate chain # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_certificate_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_certificate_data_endpoint.call_with_http_info(**kwargs) + + def get_certificate_detail( + self, + **kwargs + ): + """get_certificate_detail # noqa: E501 + + Get certificate detail # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_certificate_detail(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_certificate_detail_endpoint.call_with_http_info(**kwargs) + + def get_certificate_stats( + self, + **kwargs + ): + """get_certificate_stats # noqa: E501 + + Get certificate expiration status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_certificate_stats(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_certificate_stats_endpoint.call_with_http_info(**kwargs) + + def get_csr_view_right_menus( + self, + **kwargs + ): + """get_csr_view_right_menus # noqa: E501 + + Get CSR detail view # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_csr_view_right_menus(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_csr_view_right_menus_endpoint.call_with_http_info(**kwargs) + + def get_device_view_right_menus( + self, + **kwargs + ): + """get_device_view_right_menus # noqa: E501 + + Get device detail view # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_view_right_menus(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_view_right_menus_endpoint.call_with_http_info(**kwargs) + + def get_devices_list( + self, + **kwargs + ): + """get_devices_list # noqa: E501 + + Get vEdge list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_list_endpoint.call_with_http_info(**kwargs) + + def get_installed_cert( + self, + uuid, + **kwargs + ): + """get_installed_cert # noqa: E501 + + Get Installed Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_installed_cert(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_installed_cert_endpoint.call_with_http_info(**kwargs) + + def get_list_status( + self, + **kwargs + ): + """get_list_status # noqa: E501 + + get certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_list_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_list_status_endpoint.call_with_http_info(**kwargs) + + def get_root_cert_chains( + self, + action, + **kwargs + ): + """get_root_cert_chains # noqa: E501 + + Get root cert chain # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_root_cert_chains(action, async_req=True) + >>> result = thread.get() + + Args: + action (str): Action + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['action'] = \ + action + return self.get_root_cert_chains_endpoint.call_with_http_info(**kwargs) + + def get_root_certificate( + self, + **kwargs + ): + """get_root_certificate # noqa: E501 + + Get device root certificate detail view # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_root_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_root_certificate_endpoint.call_with_http_info(**kwargs) + + def get_view( + self, + **kwargs + ): + """get_view # noqa: E501 + + Get certificate UI view # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_view(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_view_endpoint.call_with_http_info(**kwargs) + + def getc_edge_list( + self, + **kwargs + ): + """getc_edge_list # noqa: E501 + + Get cEdge list with tokengenerated list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getc_edge_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getc_edge_list_endpoint.call_with_http_info(**kwargs) + + def getv_edge_csr( + self, + uuid, + **kwargs + ): + """getv_edge_csr # noqa: E501 + + Get vEdge CSR Certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_edge_csr(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.getv_edge_csr_endpoint.call_with_http_info(**kwargs) + + def getv_edge_list( + self, + **kwargs + ): + """getv_edge_list # noqa: E501 + + Get vEdge list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_edge_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + model (str): Device model. [optional] + state ([str]): Device state. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getv_edge_list_endpoint.call_with_http_info(**kwargs) + + def getv_smart_list( + self, + **kwargs + ): + """getv_smart_list # noqa: E501 + + Get vSmart list


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_smart_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getv_smart_list_endpoint.call_with_http_info(**kwargs) + + def install_certificate( + self, + **kwargs + ): + """install_certificate # noqa: E501 + + Install singed certificate


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.install_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Singed certificate. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.install_certificate_endpoint.call_with_http_info(**kwargs) + + def reset_rsa( + self, + **kwargs + ): + """reset_rsa # noqa: E501 + + Register CSR


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reset_rsa(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request for vEdge. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.reset_rsa_endpoint.call_with_http_info(**kwargs) + + def save_root_cert_chain( + self, + **kwargs + ): + """save_root_cert_chain # noqa: E501 + + Save root cert chain


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_root_cert_chain(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Save root cert chain. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_root_cert_chain_endpoint.call_with_http_info(**kwargs) + + def save_v_edge_list( + self, + **kwargs + ): + """save_v_edge_list # noqa: E501 + + Save vEdge device list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_v_edge_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vEdge device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_v_edge_list_endpoint.call_with_http_info(**kwargs) + + def setv_edge_list( + self, + **kwargs + ): + """setv_edge_list # noqa: E501 + + Save vEdge list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setv_edge_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vEdge device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.setv_edge_list_endpoint.call_with_http_info(**kwargs) + + def setv_smart_list( + self, + **kwargs + ): + """setv_smart_list # noqa: E501 + + Save vSmart list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setv_smart_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.setv_smart_list_endpoint.call_with_http_info(**kwargs) + + def setv_smart_list1( + self, + **kwargs + ): + """setv_smart_list1 # noqa: E501 + + Save vSmart list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setv_smart_list1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.setv_smart_list1_endpoint.call_with_http_info(**kwargs) + + def syncv_bond( + self, + **kwargs + ): + """syncv_bond # noqa: E501 + + sync vManage UUID to all vBond # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.syncv_bond(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.syncv_bond_endpoint.call_with_http_info(**kwargs) + + def update_jks( + self, + **kwargs + ): + """update_jks # noqa: E501 + + update JKS


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_jks(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update JKS. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_jks_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/certificate_management_v_manage_api.py b/openapi_client/api/certificate_management_v_manage_api.py new file mode 100644 index 0000000..8ec1402 --- /dev/null +++ b/openapi_client/api/certificate_management_v_manage_api.py @@ -0,0 +1,796 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class CertificateManagementVManageApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.dump_certificate_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/setting/configuration/webserver/certificate/certificate', + 'operation_id': 'dump_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_certificate_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/setting/configuration/webserver/certificate/getcertificate', + 'operation_id': 'get_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/setting/configuration/webserver/certificate', + 'operation_id': 'get_csr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.import_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/setting/configuration/webserver/certificate', + 'operation_id': 'import_certificate', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.rollback_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/setting/configuration/webserver/certificate/rollback', + 'operation_id': 'rollback', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.show_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/setting/configuration/webserver/certificate', + 'operation_id': 'show_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def dump_certificate( + self, + type, + **kwargs + ): + """dump_certificate # noqa: E501 + + Get certificate with alias name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.dump_certificate(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Key alias + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.dump_certificate_endpoint.call_with_http_info(**kwargs) + + def get_certificate( + self, + **kwargs + ): + """get_certificate # noqa: E501 + + Get certificate for alias server # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_certificate_endpoint.call_with_http_info(**kwargs) + + def get_csr( + self, + **kwargs + ): + """get_csr # noqa: E501 + + Generate Certificate Signing Request # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR signing request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_csr_endpoint.call_with_http_info(**kwargs) + + def import_certificate( + self, + **kwargs + ): + """import_certificate # noqa: E501 + + Import a signed web server certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Singed certificate. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.import_certificate_endpoint.call_with_http_info(**kwargs) + + def rollback( + self, + type, + **kwargs + ): + """rollback # noqa: E501 + + Rollback certificate with alias name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.rollback(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Key alias + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.rollback_endpoint.call_with_http_info(**kwargs) + + def show_info( + self, + **kwargs + ): + """show_info # noqa: E501 + + Retrieves Certificate Signing Request information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.show_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.show_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/cluster_management_api.py b/openapi_client/api/cluster_management_api.py new file mode 100644 index 0000000..ef5265e --- /dev/null +++ b/openapi_client/api/cluster_management_api.py @@ -0,0 +1,2652 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ClusterManagementApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_or_update_user_credentials_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/clusterManagement/userCreds', + 'operation_id': 'add_or_update_user_credentials', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_vmanage_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/clusterManagement/setup', + 'operation_id': 'add_vmanage', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.check_if_cluster_locked_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/clusterLocked', + 'operation_id': 'check_if_cluster_locked', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.configure_vmanage_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/clusterManagement/configure', + 'operation_id': 'configure_vmanage', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_vmanage_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/clusterManagement/setup', + 'operation_id': 'edit_vmanage', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cluster_workflow_version_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/clusterManagement/clusterworkflow/version', + 'operation_id': 'get_cluster_workflow_version', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_configured_ip_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/clusterManagement/iplist/{vmanageID}', + 'operation_id': 'get_configured_ip_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vmanage_id', + ], + 'required': [ + 'vmanage_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vmanage_id': + (str,), + }, + 'attribute_map': { + 'vmanage_id': 'vmanageID', + }, + 'location_map': { + 'vmanage_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_connected_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/clusterManagement/connectedDevices/{vmanageIP}', + 'operation_id': 'get_connected_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vmanage_ip', + ], + 'required': [ + 'vmanage_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vmanage_ip': + (str,), + }, + 'attribute_map': { + 'vmanage_ip': 'vmanageIP', + }, + 'location_map': { + 'vmanage_ip': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_connected_devices_per_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/clusterManagement/{tenantId}/connectedDevices/{vmanageIP}', + 'operation_id': 'get_connected_devices_per_tenant', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'vmanage_ip', + ], + 'required': [ + 'tenant_id', + 'vmanage_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'vmanage_ip': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + 'vmanage_ip': 'vmanageIP', + }, + 'location_map': { + 'tenant_id': 'path', + 'vmanage_ip': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenancy_mode_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/tenancy/mode', + 'operation_id': 'get_tenancy_mode', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenants_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/clusterManagement/tenantList', + 'operation_id': 'get_tenants_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_manage_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/vManage/details/{vmanageIP}', + 'operation_id': 'get_v_manage_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vmanage_ip', + ], + 'required': [ + 'vmanage_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vmanage_ip': + (str,), + }, + 'attribute_map': { + 'vmanage_ip': 'vmanageIP', + }, + 'location_map': { + 'vmanage_ip': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.health_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/health/details', + 'operation_id': 'health_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.health_status_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/health/status', + 'operation_id': 'health_status_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.health_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/health/summary', + 'operation_id': 'health_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_cached', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_cached': + (bool,), + }, + 'attribute_map': { + 'is_cached': 'isCached', + }, + 'location_map': { + 'is_cached': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.is_cluster_ready_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/isready', + 'operation_id': 'is_cluster_ready', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_vmanages_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/clusterManagement/list', + 'operation_id': 'list_vmanages', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.node_properties_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/nodeProperties', + 'operation_id': 'node_properties', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.perform_replication_and_rebalance_of_kafka_partitions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/clusterManagement/replicateAndRebalance', + 'operation_id': 'perform_replication_and_rebalance_of_kafka_partitions', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.remove_vmanage_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/clusterManagement/remove', + 'operation_id': 'remove_vmanage', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.set_tenancy_mode_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/clusterManagement/tenancy/mode', + 'operation_id': 'set_tenancy_mode', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def add_or_update_user_credentials( + self, + **kwargs + ): + """add_or_update_user_credentials # noqa: E501 + + Add or update user credentials for cluster operations


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_or_update_user_credentials(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): User credential. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_or_update_user_credentials_endpoint.call_with_http_info(**kwargs) + + def add_vmanage( + self, + **kwargs + ): + """add_vmanage # noqa: E501 + + Add vManage to cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_vmanage(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vManage cluster config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_vmanage_endpoint.call_with_http_info(**kwargs) + + def check_if_cluster_locked( + self, + **kwargs + ): + """check_if_cluster_locked # noqa: E501 + + Check whether cluster is locked


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_if_cluster_locked(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_if_cluster_locked_endpoint.call_with_http_info(**kwargs) + + def configure_vmanage( + self, + **kwargs + ): + """configure_vmanage # noqa: E501 + + Configure vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.configure_vmanage(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vManage server config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.configure_vmanage_endpoint.call_with_http_info(**kwargs) + + def edit_vmanage( + self, + **kwargs + ): + """edit_vmanage # noqa: E501 + + Update vManage cluster info


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_vmanage(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vManage cluster config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edit_vmanage_endpoint.call_with_http_info(**kwargs) + + def get_cluster_workflow_version( + self, + **kwargs + ): + """get_cluster_workflow_version # noqa: E501 + + List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cluster_workflow_version(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cluster_workflow_version_endpoint.call_with_http_info(**kwargs) + + def get_configured_ip_list( + self, + vmanage_id, + **kwargs + ): + """get_configured_ip_list # noqa: E501 + + Get configured IP addresses


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_configured_ip_list(vmanage_id, async_req=True) + >>> result = thread.get() + + Args: + vmanage_id (str): vManage Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vmanage_id'] = \ + vmanage_id + return self.get_configured_ip_list_endpoint.call_with_http_info(**kwargs) + + def get_connected_devices( + self, + vmanage_ip, + **kwargs + ): + """get_connected_devices # noqa: E501 + + Get connected device for vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_connected_devices(vmanage_ip, async_req=True) + >>> result = thread.get() + + Args: + vmanage_ip (str): vManage IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vmanage_ip'] = \ + vmanage_ip + return self.get_connected_devices_endpoint.call_with_http_info(**kwargs) + + def get_connected_devices_per_tenant( + self, + tenant_id, + vmanage_ip, + **kwargs + ): + """get_connected_devices_per_tenant # noqa: E501 + + Get connected device for vManage for a tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_connected_devices_per_tenant(tenant_id, vmanage_ip, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + vmanage_ip (str): vManage IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + kwargs['vmanage_ip'] = \ + vmanage_ip + return self.get_connected_devices_per_tenant_endpoint.call_with_http_info(**kwargs) + + def get_tenancy_mode( + self, + **kwargs + ): + """get_tenancy_mode # noqa: E501 + + Get vManage tenancy mode


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenancy_mode(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenancy_mode_endpoint.call_with_http_info(**kwargs) + + def get_tenants_list( + self, + **kwargs + ): + """get_tenants_list # noqa: E501 + + Get tenant list


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenants_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenants_list_endpoint.call_with_http_info(**kwargs) + + def get_v_manage_details( + self, + vmanage_ip, + **kwargs + ): + """get_v_manage_details # noqa: E501 + + Get vManage detail


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_manage_details(vmanage_ip, async_req=True) + >>> result = thread.get() + + Args: + vmanage_ip (str): vManage IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vmanage_ip'] = \ + vmanage_ip + return self.get_v_manage_details_endpoint.call_with_http_info(**kwargs) + + def health_details( + self, + **kwargs + ): + """health_details # noqa: E501 + + Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.health_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.health_details_endpoint.call_with_http_info(**kwargs) + + def health_status_info( + self, + **kwargs + ): + """health_status_info # noqa: E501 + + Get cluster health check details


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.health_status_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.health_status_info_endpoint.call_with_http_info(**kwargs) + + def health_summary( + self, + **kwargs + ): + """health_summary # noqa: E501 + + Get cluster health check summary


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.health_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + is_cached (bool): Flag to enable cached result. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.health_summary_endpoint.call_with_http_info(**kwargs) + + def is_cluster_ready( + self, + **kwargs + ): + """is_cluster_ready # noqa: E501 + + Is cluster ready


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.is_cluster_ready(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.is_cluster_ready_endpoint.call_with_http_info(**kwargs) + + def list_vmanages( + self, + **kwargs + ): + """list_vmanages # noqa: E501 + + List vManages in the cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_vmanages(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_vmanages_endpoint.call_with_http_info(**kwargs) + + def node_properties( + self, + **kwargs + ): + """node_properties # noqa: E501 + + Get properties of vManage being added to cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.node_properties(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.node_properties_endpoint.call_with_http_info(**kwargs) + + def perform_replication_and_rebalance_of_kafka_partitions( + self, + **kwargs + ): + """perform_replication_and_rebalance_of_kafka_partitions # noqa: E501 + + Initiate replication and rebalance of kafka topics


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.perform_replication_and_rebalance_of_kafka_partitions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.perform_replication_and_rebalance_of_kafka_partitions_endpoint.call_with_http_info(**kwargs) + + def remove_vmanage( + self, + **kwargs + ): + """remove_vmanage # noqa: E501 + + Remove vManage from cluster


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_vmanage(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vManage server info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.remove_vmanage_endpoint.call_with_http_info(**kwargs) + + def set_tenancy_mode( + self, + **kwargs + ): + """set_tenancy_mode # noqa: E501 + + Update vManage tenancy mode # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_tenancy_mode(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenancy mode setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.set_tenancy_mode_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/colocation_api.py b/openapi_client/api/colocation_api.py new file mode 100644 index 0000000..1204c8f --- /dev/null +++ b/openapi_client/api/colocation_api.py @@ -0,0 +1,4560 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ColocationApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.acitvate_cloud_dock_cluster_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/cluster/activate', + 'operation_id': 'acitvate_cloud_dock_cluster', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_name', + ], + 'required': [ + 'cluster_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_name': + (str,), + }, + 'attribute_map': { + 'cluster_name': 'clusterName', + }, + 'location_map': { + 'cluster_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.attach_service_chain_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicechain/attach', + 'operation_id': 'attach_service_chain', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.attach_service_chain1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicechain/autoattach', + 'operation_id': 'attach_service_chain1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.cancel_button_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicechain/cancel', + 'operation_id': 'cancel_button', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.cloud_dock_cluster_preview_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/colocation/cluster/config', + 'operation_id': 'cloud_dock_cluster_preview', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'serial_number', + ], + 'required': [ + 'serial_number', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'serial_number': + (str,), + }, + 'attribute_map': { + 'serial_number': 'serialNumber', + }, + 'location_map': { + 'serial_number': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cloud_dock_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster', + 'operation_id': 'create_cloud_dock_cluster', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.de_acitvate_cloud_dock_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster/deactivate', + 'operation_id': 'de_acitvate_cloud_dock_cluster', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [ + 'cluster_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_cloud_dock_cluster_by_name_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster/{clustername}', + 'operation_id': 'delete_cloud_dock_cluster_by_name', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'clustername', + ], + 'required': [ + 'clustername', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'clustername': + (str,), + }, + 'attribute_map': { + 'clustername': 'clustername', + }, + 'location_map': { + 'clustername': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.detach_service_chain_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicechain/detach', + 'operation_id': 'detach_service_chain', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.dummyccm_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster/activateClusterDummy', + 'operation_id': 'dummyccm', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_name', + ], + 'required': [ + 'cluster_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_name': + (str,), + }, + 'attribute_map': { + 'cluster_name': 'clusterName', + }, + 'location_map': { + 'cluster_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.dummycsp_state_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster/activateClusterDummyState', + 'operation_id': 'dummycsp_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_name', + 'state', + ], + 'required': [ + 'cluster_name', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_name': + (str,), + 'state': + (str,), + }, + 'attribute_map': { + 'cluster_name': 'clusterName', + 'state': 'state', + }, + 'location_map': { + 'cluster_name': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_dock_cluster_detail_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/cluster', + 'operation_id': 'get_cloud_dock_cluster_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_name', + ], + 'required': [ + 'cluster_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_name': + (str,), + }, + 'attribute_map': { + 'cluster_name': 'clusterName', + }, + 'location_map': { + 'cluster_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_dock_cluster_detail_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/cluster/id', + 'operation_id': 'get_cloud_dock_cluster_detail_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [ + 'cluster_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cluster_config_by_cluster_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/cluster/config', + 'operation_id': 'get_cluster_config_by_cluster_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [ + 'cluster_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cluster_details_by_cluster_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/monitor/cluster', + 'operation_id': 'get_cluster_details_by_cluster_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [ + 'cluster_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cluster_port_mapping_by_cluster_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/cluster/portView', + 'operation_id': 'get_cluster_port_mapping_by_cluster_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [ + 'cluster_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_detail_by_device_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/monitor/device', + 'operation_id': 'get_device_detail_by_device_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/servicechain/edge/devices', + 'operation_id': 'get_edge_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_pnf_config_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/pnf/configuration', + 'operation_id': 'get_pnf_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'pnf_serial_number', + 'cluster_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'pnf_serial_number': + (str,), + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'pnf_serial_number': 'pnfSerialNumber', + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'pnf_serial_number': 'query', + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_service_chain_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/monitor/servicechain', + 'operation_id': 'get_service_chain_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + 'user_group_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + 'user_group_name': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + 'user_group_name': 'userGroupName', + }, + 'location_map': { + 'cluster_id': 'query', + 'user_group_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_service_group_by_cluster_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/servicegroup', + 'operation_id': 'get_service_group_by_cluster_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_system_status_by_device_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/device/system', + 'operation_id': 'get_system_status_by_device_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnf_alarm_count_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/vnf/alarms/count', + 'operation_id': 'get_vnf_alarm_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_group', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_group': + (str,), + }, + 'attribute_map': { + 'user_group': 'user_group', + }, + 'location_map': { + 'user_group': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnf_events_count_detail_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/vnf/alarms', + 'operation_id': 'get_vnf_events_count_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_group', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_group': + (str,), + }, + 'attribute_map': { + 'user_group': 'user_group', + }, + 'location_map': { + 'user_group': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnf_events_detail_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/vnf/events', + 'operation_id': 'get_vnf_events_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vnf_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vnf_name': + (str,), + }, + 'attribute_map': { + 'vnf_name': 'vnfName', + }, + 'location_map': { + 'vnf_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnf_interface_detail_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/vnf/interface', + 'operation_id': 'get_vnf_interface_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vnf_name', + 'device_ip', + 'device_class', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vnf_name': + (str,), + 'device_ip': + (str,), + 'device_class': + (str,), + }, + 'attribute_map': { + 'vnf_name': 'vnfName', + 'device_ip': 'deviceIp', + 'device_class': 'deviceClass', + }, + 'location_map': { + 'vnf_name': 'query', + 'device_ip': 'query', + 'device_class': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getpnf_details_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/pnf', + 'operation_id': 'getpnf_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + }, + 'location_map': { + 'cluster_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getpnf_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/servicechain/edge/pnfdevices', + 'operation_id': 'getpnf_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'pnf_device_type', + ], + 'required': [ + 'pnf_device_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'pnf_device_type': + (str,), + }, + 'attribute_map': { + 'pnf_device_type': 'pnfDeviceType', + }, + 'location_map': { + 'pnf_device_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getvnf_by_device_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/device/vnf', + 'operation_id': 'getvnf_by_device_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getvnf_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/monitor/vnf', + 'operation_id': 'getvnf_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + 'user_group_name', + 'vnf_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + 'user_group_name': + (str,), + 'vnf_name': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'clusterId', + 'user_group_name': 'userGroupName', + 'vnf_name': 'vnfName', + }, + 'location_map': { + 'cluster_id': 'query', + 'user_group_name': 'query', + 'vnf_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_network_function_map_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/monitor/networkfunction/listmap', + 'operation_id': 'list_network_function_map', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.rma_cloud_dock_csp_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/cluster/rma', + 'operation_id': 'rma_cloud_dock_csp', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_name', + 'body', + ], + 'required': [ + 'cluster_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_name': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'cluster_name': 'clusterName', + }, + 'location_map': { + 'cluster_name': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_cloud_dock_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster', + 'operation_id': 'update_cloud_dock_cluster', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_csp_to_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/cluster/attached/csp', + 'operation_id': 'update_csp_to_cluster', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.vnf_actions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/monitor/vnf/action', + 'operation_id': 'vnf_actions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'vm_name', + 'device_id', + 'action', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vm_name': + (str,), + 'device_id': + (str,), + 'action': + (str,), + }, + 'attribute_map': { + 'vm_name': 'vmName', + 'device_id': 'deviceId', + 'action': 'action', + }, + 'location_map': { + 'vm_name': 'query', + 'device_id': 'query', + 'action': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def acitvate_cloud_dock_cluster( + self, + cluster_name, + **kwargs + ): + """acitvate_cloud_dock_cluster # noqa: E501 + + Activate a cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.acitvate_cloud_dock_cluster(cluster_name, async_req=True) + >>> result = thread.get() + + Args: + cluster_name (str): Cluster name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_name'] = \ + cluster_name + return self.acitvate_cloud_dock_cluster_endpoint.call_with_http_info(**kwargs) + + def attach_service_chain( + self, + **kwargs + ): + """attach_service_chain # noqa: E501 + + Attach service chain to cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.attach_service_chain(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Attach service chain request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.attach_service_chain_endpoint.call_with_http_info(**kwargs) + + def attach_service_chain1( + self, + **kwargs + ): + """attach_service_chain1 # noqa: E501 + + Attach service chain to cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.attach_service_chain1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Attach service chain request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.attach_service_chain1_endpoint.call_with_http_info(**kwargs) + + def cancel_button( + self, + **kwargs + ): + """cancel_button # noqa: E501 + + Cancel button to cancel configuring devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cancel_button(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cancel configuring devices. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.cancel_button_endpoint.call_with_http_info(**kwargs) + + def cloud_dock_cluster_preview( + self, + serial_number, + **kwargs + ): + """cloud_dock_cluster_preview # noqa: E501 + + Clouddock cluster preview # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cloud_dock_cluster_preview(serial_number, async_req=True) + >>> result = thread.get() + + Args: + serial_number (str): Serial number + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['serial_number'] = \ + serial_number + return self.cloud_dock_cluster_preview_endpoint.call_with_http_info(**kwargs) + + def create_cloud_dock_cluster( + self, + **kwargs + ): + """create_cloud_dock_cluster # noqa: E501 + + Add a new cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cloud_dock_cluster(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cluster config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_cloud_dock_cluster_endpoint.call_with_http_info(**kwargs) + + def de_acitvate_cloud_dock_cluster( + self, + cluster_id, + **kwargs + ): + """de_acitvate_cloud_dock_cluster # noqa: E501 + + Deactivate clouddock cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.de_acitvate_cloud_dock_cluster(cluster_id, async_req=True) + >>> result = thread.get() + + Args: + cluster_id (str): Cluster Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_id'] = \ + cluster_id + return self.de_acitvate_cloud_dock_cluster_endpoint.call_with_http_info(**kwargs) + + def delete_cloud_dock_cluster_by_name( + self, + clustername, + **kwargs + ): + """delete_cloud_dock_cluster_by_name # noqa: E501 + + Delete cluster by name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_cloud_dock_cluster_by_name(clustername, async_req=True) + >>> result = thread.get() + + Args: + clustername (str): Cluster name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['clustername'] = \ + clustername + return self.delete_cloud_dock_cluster_by_name_endpoint.call_with_http_info(**kwargs) + + def detach_service_chain( + self, + **kwargs + ): + """detach_service_chain # noqa: E501 + + Detach service chain # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detach_service_chain(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Detach service chain request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.detach_service_chain_endpoint.call_with_http_info(**kwargs) + + def dummyccm( + self, + cluster_name, + **kwargs + ): + """dummyccm # noqa: E501 + + Activate dummp cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.dummyccm(cluster_name, async_req=True) + >>> result = thread.get() + + Args: + cluster_name (str): Cluster name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_name'] = \ + cluster_name + return self.dummyccm_endpoint.call_with_http_info(**kwargs) + + def dummycsp_state( + self, + cluster_name, + state, + **kwargs + ): + """dummycsp_state # noqa: E501 + + Activate cluster in a state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.dummycsp_state(cluster_name, state, async_req=True) + >>> result = thread.get() + + Args: + cluster_name (str): Cluster name + state (str): Cluster state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_name'] = \ + cluster_name + kwargs['state'] = \ + state + return self.dummycsp_state_endpoint.call_with_http_info(**kwargs) + + def get_cloud_dock_cluster_detail( + self, + cluster_name, + **kwargs + ): + """get_cloud_dock_cluster_detail # noqa: E501 + + Get details of all existing Clusters # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_dock_cluster_detail(cluster_name, async_req=True) + >>> result = thread.get() + + Args: + cluster_name (str): Cluster name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_name'] = \ + cluster_name + return self.get_cloud_dock_cluster_detail_endpoint.call_with_http_info(**kwargs) + + def get_cloud_dock_cluster_detail_by_id( + self, + cluster_id, + **kwargs + ): + """get_cloud_dock_cluster_detail_by_id # noqa: E501 + + Get cluster by Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_dock_cluster_detail_by_id(cluster_id, async_req=True) + >>> result = thread.get() + + Args: + cluster_id (str): Cluster Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_id'] = \ + cluster_id + return self.get_cloud_dock_cluster_detail_by_id_endpoint.call_with_http_info(**kwargs) + + def get_cluster_config_by_cluster_id( + self, + cluster_id, + **kwargs + ): + """get_cluster_config_by_cluster_id # noqa: E501 + + Provide details of devices of clusters # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cluster_config_by_cluster_id(cluster_id, async_req=True) + >>> result = thread.get() + + Args: + cluster_id (str): Cluster Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_id'] = \ + cluster_id + return self.get_cluster_config_by_cluster_id_endpoint.call_with_http_info(**kwargs) + + def get_cluster_details_by_cluster_id( + self, + cluster_id, + **kwargs + ): + """get_cluster_details_by_cluster_id # noqa: E501 + + Provide details of ids of existing clusters # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cluster_details_by_cluster_id(cluster_id, async_req=True) + >>> result = thread.get() + + Args: + cluster_id (str): Cluster Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_id'] = \ + cluster_id + return self.get_cluster_details_by_cluster_id_endpoint.call_with_http_info(**kwargs) + + def get_cluster_port_mapping_by_cluster_id( + self, + cluster_id, + **kwargs + ): + """get_cluster_port_mapping_by_cluster_id # noqa: E501 + + Provide details of port mappings in the cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cluster_port_mapping_by_cluster_id(cluster_id, async_req=True) + >>> result = thread.get() + + Args: + cluster_id (str): Cluster Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_id'] = \ + cluster_id + return self.get_cluster_port_mapping_by_cluster_id_endpoint.call_with_http_info(**kwargs) + + def get_device_detail_by_device_id( + self, + **kwargs + ): + """get_device_detail_by_device_id # noqa: E501 + + List details for Device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_detail_by_device_id(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): Device Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_detail_by_device_id_endpoint.call_with_http_info(**kwargs) + + def get_edge_devices( + self, + **kwargs + ): + """get_edge_devices # noqa: E501 + + Get edge devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_edge_devices_endpoint.call_with_http_info(**kwargs) + + def get_pnf_config( + self, + **kwargs + ): + """get_pnf_config # noqa: E501 + + List configuration of PNF # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pnf_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + pnf_serial_number (str): PNF serial number. [optional] + cluster_id (str): Cluster Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_pnf_config_endpoint.call_with_http_info(**kwargs) + + def get_service_chain_details( + self, + **kwargs + ): + """get_service_chain_details # noqa: E501 + + List all service chain or service chains by Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_service_chain_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cluster_id (str): Cluster Id. [optional] + user_group_name (str): UserGroup Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_service_chain_details_endpoint.call_with_http_info(**kwargs) + + def get_service_group_by_cluster_id( + self, + **kwargs + ): + """get_service_group_by_cluster_id # noqa: E501 + + List all attached serviceGroups to cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_service_group_by_cluster_id(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cluster_id (str): Cluster Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_service_group_by_cluster_id_endpoint.call_with_http_info(**kwargs) + + def get_system_status_by_device_id( + self, + **kwargs + ): + """get_system_status_by_device_id # noqa: E501 + + List all connected VNF to a device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_system_status_by_device_id(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): Device Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_system_status_by_device_id_endpoint.call_with_http_info(**kwargs) + + def get_vnf_alarm_count( + self, + **kwargs + ): + """get_vnf_alarm_count # noqa: E501 + + Get event detail of VNF # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnf_alarm_count(async_req=True) + >>> result = thread.get() + + + Keyword Args: + user_group (str): user group name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vnf_alarm_count_endpoint.call_with_http_info(**kwargs) + + def get_vnf_events_count_detail( + self, + **kwargs + ): + """get_vnf_events_count_detail # noqa: E501 + + Get event detail of VNF # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnf_events_count_detail(async_req=True) + >>> result = thread.get() + + + Keyword Args: + user_group (str): user group name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vnf_events_count_detail_endpoint.call_with_http_info(**kwargs) + + def get_vnf_events_detail( + self, + **kwargs + ): + """get_vnf_events_detail # noqa: E501 + + Get event detail of VNF # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnf_events_detail(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vnf_name (str): VNF name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vnf_events_detail_endpoint.call_with_http_info(**kwargs) + + def get_vnf_interface_detail( + self, + **kwargs + ): + """get_vnf_interface_detail # noqa: E501 + + Get interface detail of VNF # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnf_interface_detail(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vnf_name (str): VNF name. [optional] + device_ip (str): Device IP. [optional] + device_class (str): Device class. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vnf_interface_detail_endpoint.call_with_http_info(**kwargs) + + def getpnf_details( + self, + **kwargs + ): + """getpnf_details # noqa: E501 + + List all PNF by cluster Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getpnf_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cluster_id (str): Cluster Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getpnf_details_endpoint.call_with_http_info(**kwargs) + + def getpnf_devices( + self, + pnf_device_type, + **kwargs + ): + """getpnf_devices # noqa: E501 + + Get PNF edge devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getpnf_devices(pnf_device_type, async_req=True) + >>> result = thread.get() + + Args: + pnf_device_type (str): PNF device type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['pnf_device_type'] = \ + pnf_device_type + return self.getpnf_devices_endpoint.call_with_http_info(**kwargs) + + def getvnf_by_device_id( + self, + **kwargs + ): + """getvnf_by_device_id # noqa: E501 + + List all VNF attached with Device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getvnf_by_device_id(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): Device Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getvnf_by_device_id_endpoint.call_with_http_info(**kwargs) + + def getvnf_details( + self, + **kwargs + ): + """getvnf_details # noqa: E501 + + Provide details of all existing VNF # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getvnf_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cluster_id (str): Cluster Id. [optional] + user_group_name (str): UserGroup Name. [optional] + vnf_name (str): VNF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getvnf_details_endpoint.call_with_http_info(**kwargs) + + def list_network_function_map( + self, + **kwargs + ): + """list_network_function_map # noqa: E501 + + Retrieve network function listing # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_network_function_map(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_network_function_map_endpoint.call_with_http_info(**kwargs) + + def rma_cloud_dock_csp( + self, + cluster_name, + **kwargs + ): + """rma_cloud_dock_csp # noqa: E501 + + RMA operation for CSP device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.rma_cloud_dock_csp(cluster_name, async_req=True) + >>> result = thread.get() + + Args: + cluster_name (str): Cluster name + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cluster_name'] = \ + cluster_name + return self.rma_cloud_dock_csp_endpoint.call_with_http_info(**kwargs) + + def update_cloud_dock_cluster( + self, + **kwargs + ): + """update_cloud_dock_cluster # noqa: E501 + + Update a existing cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_cloud_dock_cluster(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cluster config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_cloud_dock_cluster_endpoint.call_with_http_info(**kwargs) + + def update_csp_to_cluster( + self, + **kwargs + ): + """update_csp_to_cluster # noqa: E501 + + Update attached csp to cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_csp_to_cluster(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSP config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_csp_to_cluster_endpoint.call_with_http_info(**kwargs) + + def vnf_actions( + self, + **kwargs + ): + """vnf_actions # noqa: E501 + + VNF action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.vnf_actions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vm_name (str): VM Name. [optional] + device_id (str): Device Id. [optional] + action (str): Action. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.vnf_actions_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/colocation_service_group_api.py b/openapi_client/api/colocation_service_group_api.py new file mode 100644 index 0000000..44fca59 --- /dev/null +++ b/openapi_client/api/colocation_service_group_api.py @@ -0,0 +1,922 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ColocationServiceGroupApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_service_group_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicegroup', + 'operation_id': 'create_service_group_cluster', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_service_group_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicegroup/{name}', + 'operation_id': 'delete_service_group_cluster', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'name', + ], + 'required': [ + 'name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'name': + (str,), + }, + 'attribute_map': { + 'name': 'name', + }, + 'location_map': { + 'name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_available_chains_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/colocation/servicegroup/servicechains', + 'operation_id': 'get_available_chains', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_default_chain_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/servicegroup/servicechain/default', + 'operation_id': 'get_default_chain', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_service_chain_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/servicegroup', + 'operation_id': 'get_service_chain', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_group_name', + ], + 'required': [ + 'service_group_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_group_name': + (str,), + }, + 'attribute_map': { + 'service_group_name': 'serviceGroupName', + }, + 'location_map': { + 'service_group_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_service_group_in_cluster_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/colocation/servicegroup/attached', + 'operation_id': 'get_service_group_in_cluster', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cluster_id', + 'user_group_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cluster_id': + (str,), + 'user_group_name': + (str,), + }, + 'attribute_map': { + 'cluster_id': 'ClusterId', + 'user_group_name': 'UserGroupName', + }, + 'location_map': { + 'cluster_id': 'query', + 'user_group_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_service_group_cluster_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/colocation/servicegroup', + 'operation_id': 'update_service_group_cluster', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_service_group_cluster( + self, + **kwargs + ): + """create_service_group_cluster # noqa: E501 + + Add new service group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_service_group_cluster(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Service group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_service_group_cluster_endpoint.call_with_http_info(**kwargs) + + def delete_service_group_cluster( + self, + name, + **kwargs + ): + """delete_service_group_cluster # noqa: E501 + + Delete service group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_service_group_cluster(name, async_req=True) + >>> result = thread.get() + + Args: + name (str): Service group name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['name'] = \ + name + return self.delete_service_group_cluster_endpoint.call_with_http_info(**kwargs) + + def get_available_chains( + self, + **kwargs + ): + """get_available_chains # noqa: E501 + + Get all service chains # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_available_chains(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_available_chains_endpoint.call_with_http_info(**kwargs) + + def get_default_chain( + self, + **kwargs + ): + """get_default_chain # noqa: E501 + + Get default service chains # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_default_chain(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_default_chain_endpoint.call_with_http_info(**kwargs) + + def get_service_chain( + self, + service_group_name, + **kwargs + ): + """get_service_chain # noqa: E501 + + Get service chain by name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_service_chain(service_group_name, async_req=True) + >>> result = thread.get() + + Args: + service_group_name (str): Service group name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_group_name'] = \ + service_group_name + return self.get_service_chain_endpoint.call_with_http_info(**kwargs) + + def get_service_group_in_cluster( + self, + **kwargs + ): + """get_service_group_in_cluster # noqa: E501 + + Get service chains in cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_service_group_in_cluster(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cluster_id (str): Cluster Id. [optional] + user_group_name (str): UserGroup Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_service_group_in_cluster_endpoint.call_with_http_info(**kwargs) + + def update_service_group_cluster( + self, + **kwargs + ): + """update_service_group_cluster # noqa: E501 + + Update service group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_service_group_cluster(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Service group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_service_group_cluster_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_advanced_inspection_profile_definition_api.py b/openapi_client/api/configuration_advanced_inspection_profile_definition_api.py new file mode 100644 index 0000000..5746d2f --- /dev/null +++ b/openapi_client/api/configuration_advanced_inspection_profile_definition_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationAdvancedInspectionProfileDefinitionApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile', + 'operation_id': 'create_policy_definition10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition10_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/{id}', + 'operation_id': 'delete_policy_definition10', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition10', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/{id}', + 'operation_id': 'edit_policy_definition10', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile', + 'operation_id': 'get_definitions10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/{id}', + 'operation_id': 'get_policy_definition10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/preview', + 'operation_id': 'preview_policy_definition10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedinspectionprofile/bulk', + 'operation_id': 'save_policy_definition_in_bulk10', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition10( + self, + **kwargs + ): + """create_policy_definition10 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition10_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition10( + self, + id, + **kwargs + ): + """delete_policy_definition10 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition10_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition10( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition10 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition10_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition10( + self, + id, + **kwargs + ): + """edit_policy_definition10 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition10_endpoint.call_with_http_info(**kwargs) + + def get_definitions10( + self, + **kwargs + ): + """get_definitions10 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions10_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition10( + self, + id, + **kwargs + ): + """get_policy_definition10 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition10_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition10( + self, + **kwargs + ): + """preview_policy_definition10 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition10_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id10( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id10 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id10_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk10( + self, + **kwargs + ): + """save_policy_definition_in_bulk10 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk10_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_azure_connect_api.py b/openapi_client/api/configuration_azure_connect_api.py new file mode 100644 index 0000000..1177c5c --- /dev/null +++ b/openapi_client/api/configuration_azure_connect_api.py @@ -0,0 +1,1063 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationAzureConnectApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.authenticate_azure_connect_cred_and_add_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cortex/cloud/authenticate', + 'operation_id': 'authenticate_azure_connect_cred_and_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_wan_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cortex/wanrg', + 'operation_id': 'delete_wan_resource_groups', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cortex/wanrg', + 'operation_id': 'edit_wan_resource_groups', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cortex_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cortex', + 'operation_id': 'get_cortex_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapped_wan_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cortex/map', + 'operation_id': 'get_mapped_wan_resource_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudregion', + ], + 'required': [ + 'accountid', + 'cloudregion', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudregion': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudregion': 'cloudregion', + }, + 'location_map': { + 'accountid': 'query', + 'cloudregion': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cortex/wanrg', + 'operation_id': 'get_wan_resource_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + ], + 'required': [ + 'accountid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + }, + 'location_map': { + 'accountid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_wan_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cortex/wanrg', + 'operation_id': 'save_wan_resource_groups', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.sync_wan_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cortex/sync', + 'operation_id': 'sync_wan_resource_groups', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def authenticate_azure_connect_cred_and_add( + self, + **kwargs + ): + """authenticate_azure_connect_cred_and_add # noqa: E501 + + Authenticate Cloud Account Credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.authenticate_azure_connect_cred_and_add(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Credential. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.authenticate_azure_connect_cred_and_add_endpoint.call_with_http_info(**kwargs) + + def delete_wan_resource_groups( + self, + **kwargs + ): + """delete_wan_resource_groups # noqa: E501 + + Delete WAN Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_resource_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): WAN resource group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_wan_resource_groups_endpoint.call_with_http_info(**kwargs) + + def edit_wan_resource_groups( + self, + **kwargs + ): + """edit_wan_resource_groups # noqa: E501 + + Edit WAN Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_resource_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): WAN resource group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edit_wan_resource_groups_endpoint.call_with_http_info(**kwargs) + + def get_cortex_status( + self, + **kwargs + ): + """get_cortex_status # noqa: E501 + + Get Cortex List # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cortex_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cortex_status_endpoint.call_with_http_info(**kwargs) + + def get_mapped_wan_resource_groups( + self, + accountid, + cloudregion, + **kwargs + ): + """get_mapped_wan_resource_groups # noqa: E501 + + Get Mapped WAN Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapped_wan_resource_groups(accountid, cloudregion, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudregion (str): Cloud region + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudregion'] = \ + cloudregion + return self.get_mapped_wan_resource_groups_endpoint.call_with_http_info(**kwargs) + + def get_wan_resource_groups( + self, + accountid, + **kwargs + ): + """get_wan_resource_groups # noqa: E501 + + Get WAN Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_resource_groups(accountid, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + return self.get_wan_resource_groups_endpoint.call_with_http_info(**kwargs) + + def save_wan_resource_groups( + self, + **kwargs + ): + """save_wan_resource_groups # noqa: E501 + + Create WAN Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_wan_resource_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): WAN resource group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_wan_resource_groups_endpoint.call_with_http_info(**kwargs) + + def sync_wan_resource_groups( + self, + **kwargs + ): + """sync_wan_resource_groups # noqa: E501 + + Sync WAN Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_wan_resource_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): WAN resource group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_wan_resource_groups_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_circuits_api.py b/openapi_client/api/configuration_circuits_api.py new file mode 100644 index 0000000..8df883f --- /dev/null +++ b/openapi_client/api/configuration_circuits_api.py @@ -0,0 +1,552 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationCircuitsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_circuit_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/circuit', + 'operation_id': 'create_circuit', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_circuit_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/networkdesign/circuit/{id}', + 'operation_id': 'delete_circuit', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_circuit_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/networkdesign/circuit/{id}', + 'operation_id': 'edit_circuit', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_circuits_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/circuit', + 'operation_id': 'get_circuits', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_circuit( + self, + **kwargs + ): + """create_circuit # noqa: E501 + + Create network circuits # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_circuit(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network circuit. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_circuit_endpoint.call_with_http_info(**kwargs) + + def delete_circuit( + self, + id, + **kwargs + ): + """delete_circuit # noqa: E501 + + Delete network circuits # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_circuit(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_circuit_endpoint.call_with_http_info(**kwargs) + + def edit_circuit( + self, + id, + **kwargs + ): + """edit_circuit # noqa: E501 + + Edit network circuits # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_circuit(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network circuit. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_circuit_endpoint.call_with_http_info(**kwargs) + + def get_circuits( + self, + **kwargs + ): + """get_circuits # noqa: E501 + + Get network circuits # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_circuits(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_circuits_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_cloud_express_api.py b/openapi_client/api/configuration_cloud_express_api.py new file mode 100644 index 0000000..068da33 --- /dev/null +++ b/openapi_client/api/configuration_cloud_express_api.py @@ -0,0 +1,2153 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationCloudExpressApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_apps_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/manage/apps', + 'operation_id': 'add_apps', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_cloudx_interfaces_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cloudx/interfaces', + 'operation_id': 'add_cloudx_interfaces', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_cloudx_type_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cloudx/addcloudx/{type}', + 'operation_id': 'add_cloudx_type', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'body', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_webex_prefix_lists_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/cloudservices/app/webex', + 'operation_id': 'delete_webex_prefix_lists', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_apps_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cloudx/manage/apps', + 'operation_id': 'edit_apps', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.enable_webex_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/cloudservices/app/webex', + 'operation_id': 'enable_webex', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.enable_webex1_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/cloudservices/app/webex', + 'operation_id': 'enable_webex1', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_apps_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/manage/apps', + 'operation_id': 'get_apps', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_attached_client_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/attachedclient', + 'operation_id': 'get_attached_client_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_attached_dia_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/attacheddia', + 'operation_id': 'get_attached_dia_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_attached_gateway_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/attachedgateway', + 'operation_id': 'get_attached_gateway_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_x_available_apps_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/availableapps', + 'operation_id': 'get_cloud_x_available_apps', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_x_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx', + 'operation_id': 'get_cloud_x_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dia_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/dialist', + 'operation_id': 'get_dia_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_gateway_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/gatewaylist', + 'operation_id': 'get_gateway_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_site_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/clientlist', + 'operation_id': 'get_site_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.site_per_app_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cloudx/status', + 'operation_id': 'site_per_app', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_name', + 'vpn_id', + ], + 'required': [ + 'app_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_name': + (str,), + 'vpn_id': + (int,), + }, + 'attribute_map': { + 'app_name': 'appName', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'app_name': 'query', + 'vpn_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def add_apps( + self, + **kwargs + ): + """add_apps # noqa: E501 + + Add apps and vpns # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_apps(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloudx apps and vpns. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_apps_endpoint.call_with_http_info(**kwargs) + + def add_cloudx_interfaces( + self, + **kwargs + ): + """add_cloudx_interfaces # noqa: E501 + + Enable cloudx gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_cloudx_interfaces(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloudx. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_cloudx_interfaces_endpoint.call_with_http_info(**kwargs) + + def add_cloudx_type( + self, + type, + **kwargs + ): + """add_cloudx_type # noqa: E501 + + Add cloudx gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_cloudx_type(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Cloudx type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloudx. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.add_cloudx_type_endpoint.call_with_http_info(**kwargs) + + def delete_webex_prefix_lists( + self, + **kwargs + ): + """delete_webex_prefix_lists # noqa: E501 + + deleteWebexPrefixLists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_webex_prefix_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): TMP-Cloudx apps and vpns. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_webex_prefix_lists_endpoint.call_with_http_info(**kwargs) + + def edit_apps( + self, + **kwargs + ): + """edit_apps # noqa: E501 + + Edit apps and vpns # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_apps(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloudx apps and vpns. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edit_apps_endpoint.call_with_http_info(**kwargs) + + def enable_webex( + self, + **kwargs + ): + """enable_webex # noqa: E501 + + Add Webex App # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_webex(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloudx apps and vpns. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.enable_webex_endpoint.call_with_http_info(**kwargs) + + def enable_webex1( + self, + **kwargs + ): + """enable_webex1 # noqa: E501 + + Day N- Update Webex App # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_webex1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloudx apps and vpns. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.enable_webex1_endpoint.call_with_http_info(**kwargs) + + def get_apps( + self, + **kwargs + ): + """get_apps # noqa: E501 + + Get apps and vpns # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_apps(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_apps_endpoint.call_with_http_info(**kwargs) + + def get_attached_client_list( + self, + **kwargs + ): + """get_attached_client_list # noqa: E501 + + Get attached client site list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_attached_client_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_attached_client_list_endpoint.call_with_http_info(**kwargs) + + def get_attached_dia_list( + self, + **kwargs + ): + """get_attached_dia_list # noqa: E501 + + Get attached Dia site list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_attached_dia_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_attached_dia_list_endpoint.call_with_http_info(**kwargs) + + def get_attached_gateway_list( + self, + **kwargs + ): + """get_attached_gateway_list # noqa: E501 + + Get attached gateway list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_attached_gateway_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_attached_gateway_list_endpoint.call_with_http_info(**kwargs) + + def get_cloud_x_available_apps( + self, + **kwargs + ): + """get_cloud_x_available_apps # noqa: E501 + + Get CloudX available apps list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_x_available_apps(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_x_available_apps_endpoint.call_with_http_info(**kwargs) + + def get_cloud_x_status( + self, + **kwargs + ): + """get_cloud_x_status # noqa: E501 + + Get CloudX feature list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_x_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_x_status_endpoint.call_with_http_info(**kwargs) + + def get_dia_list( + self, + **kwargs + ): + """get_dia_list # noqa: E501 + + Get Dia site list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dia_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dia_list_endpoint.call_with_http_info(**kwargs) + + def get_gateway_list( + self, + **kwargs + ): + """get_gateway_list # noqa: E501 + + Get gateway list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_gateway_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_gateway_list_endpoint.call_with_http_info(**kwargs) + + def get_site_list( + self, + **kwargs + ): + """get_site_list # noqa: E501 + + Get site list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_site_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_site_list_endpoint.call_with_http_info(**kwargs) + + def site_per_app( + self, + app_name, + **kwargs + ): + """site_per_app # noqa: E501 + + Get sites per application per vpn # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.site_per_app(app_name, async_req=True) + >>> result = thread.get() + + Args: + app_name (str): App name + + Keyword Args: + vpn_id (int): VPN Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['app_name'] = \ + app_name + return self.site_per_app_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_cloud_on_ramp_api.py b/openapi_client/api/configuration_cloud_on_ramp_api.py new file mode 100644 index 0000000..08f7eb7 --- /dev/null +++ b/openapi_client/api/configuration_cloud_on_ramp_api.py @@ -0,0 +1,4193 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationCloudOnRampApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.acquire_resource_pool_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cor/acquireResourcePool', + 'operation_id': 'acquire_resource_pool', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_device_pair_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/devicepair', + 'operation_id': 'add_device_pair', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_transit_vpc_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/transitvpc', + 'operation_id': 'add_transit_vpc', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.authenticate_cloud_on_ramp_cred_and_add_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/cloud/authenticate', + 'operation_id': 'authenticate_cloud_on_ramp_cred_and_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.authenticate_cred_and_update_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/cloud/authenticate', + 'operation_id': 'authenticate_cred_and_update', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_and_map_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor', + 'operation_id': 'create_and_map', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_resource_pool_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cor/createResourcePool', + 'operation_id': 'create_resource_pool', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_ami_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/ami', + 'operation_id': 'get_ami_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudregion', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'cloudregion', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudregion': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudregion': 'cloudregion', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'query', + 'cloudregion': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_accounts_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/cloud/account', + 'operation_id': 'get_cloud_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloudtype', + 'cloud_environment', + ], + 'required': [ + 'cloudtype', + 'cloud_environment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloudtype': + (str,), + 'cloud_environment': + (str,), + }, + 'attribute_map': { + 'cloudtype': 'cloudtype', + 'cloud_environment': 'cloudEnvironment', + }, + 'location_map': { + 'cloudtype': 'query', + 'cloud_environment': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_host_vpc_account_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/cloud/host/accountdetails', + 'operation_id': 'get_cloud_host_vpc_account_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_host_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/hostvpc', + 'operation_id': 'get_cloud_host_vpcs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudregion', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'cloudregion', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudregion': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudregion': 'cloudregion', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'query', + 'cloudregion': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/cloud', + 'operation_id': 'get_cloud_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_mapped_host_accounts_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/cloud/mappedhostaccounts', + 'operation_id': 'get_cloud_mapped_host_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'cloudtype', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_on_ramp_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/device', + 'operation_id': 'get_cloud_on_ramp_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cor_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor', + 'operation_id': 'get_cor_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_external_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/externalId', + 'operation_id': 'get_external_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_host_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/devicepair/hostvpc', + 'operation_id': 'get_host_vpcs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transit_vpc_id', + 'device_pair_id', + ], + 'required': [ + 'transit_vpc_id', + 'device_pair_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transit_vpc_id': + (str,), + 'device_pair_id': + (str,), + }, + 'attribute_map': { + 'transit_vpc_id': 'transitVpcId', + 'device_pair_id': 'devicePairId', + }, + 'location_map': { + 'transit_vpc_id': 'query', + 'device_pair_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapped_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/map', + 'operation_id': 'get_mapped_vpcs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudregion', + ], + 'required': [ + 'accountid', + 'cloudregion', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudregion': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudregion': 'cloudregion', + }, + 'location_map': { + 'accountid': 'query', + 'cloudregion': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_pem_key_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/pem', + 'operation_id': 'get_pem_key_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudregion', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'cloudregion', + 'cloudtype', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudregion': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudregion': 'cloudregion', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'query', + 'cloudregion': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_transit_device_pair_and_host_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/getTransitDevicePairAndHostList', + 'operation_id': 'get_transit_device_pair_and_host_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'cloud_region', + ], + 'required': [ + 'account_id', + 'cloud_region', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'cloud_region': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'cloud_region': 'cloudRegion', + }, + 'location_map': { + 'account_id': 'query', + 'cloud_region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_transit_vpc_supported_size_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/transitvpc/size', + 'operation_id': 'get_transit_vpc_supported_size', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_environment', + 'cloudtype', + ], + 'required': [ + 'cloud_environment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_environment': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'cloud_environment': 'cloudEnvironment', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'cloud_environment': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_transit_vpc_vpn_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/getTransitVpnList', + 'operation_id': 'get_transit_vpc_vpn_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_transit_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/cor/transitvpc', + 'operation_id': 'get_transit_vpcs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'cloudregion', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'cloudregion', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'cloudregion': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'cloudregion': 'cloudregion', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'query', + 'cloudregion': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.map_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/map', + 'operation_id': 'map_vpcs', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.remove_device_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/deleteDevicepair', + 'operation_id': 'remove_device_id', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'transitvpcid', + 'transitvpcname', + 'cloudregion', + 'device_pair_id', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'transitvpcid', + 'transitvpcname', + 'cloudregion', + 'device_pair_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'transitvpcid': + (str,), + 'transitvpcname': + (str,), + 'cloudregion': + (str,), + 'device_pair_id': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'transitvpcid': 'transitvpcid', + 'transitvpcname': 'transitvpcname', + 'cloudregion': 'cloudregion', + 'device_pair_id': 'devicePairId', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'query', + 'transitvpcid': 'query', + 'transitvpcname': 'query', + 'cloudregion': 'query', + 'device_pair_id': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.remove_transit_vpc_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/accountid/{accountid}', + 'operation_id': 'remove_transit_vpc', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'accountid', + 'transitvpcid', + 'cloudregion', + 'cloudtype', + ], + 'required': [ + 'accountid', + 'transitvpcid', + 'cloudregion', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accountid': + (str,), + 'transitvpcid': + (str,), + 'cloudregion': + (str,), + 'cloudtype': + (str,), + }, + 'attribute_map': { + 'accountid': 'accountid', + 'transitvpcid': 'transitvpcid', + 'cloudregion': 'cloudregion', + 'cloudtype': 'cloudtype', + }, + 'location_map': { + 'accountid': 'path', + 'transitvpcid': 'query', + 'cloudregion': 'query', + 'cloudtype': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.scale_down_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cor/scale/down', + 'operation_id': 'scale_down', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.scale_up_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cor/scale/up', + 'operation_id': 'scale_up', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.unmap_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/map', + 'operation_id': 'unmap_vpcs', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_transit_vpc_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/transitvpc', + 'operation_id': 'update_transit_vpc', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_transit_vpc_autoscale_properties_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/cor/transitvpc/autoscale-properties', + 'operation_id': 'update_transit_vpc_autoscale_properties', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def acquire_resource_pool( + self, + **kwargs + ): + """acquire_resource_pool # noqa: E501 + + Acquire IP from resource pool # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.acquire_resource_pool(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Add IP from resource pool request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.acquire_resource_pool_endpoint.call_with_http_info(**kwargs) + + def add_device_pair( + self, + **kwargs + ): + """add_device_pair # noqa: E501 + + Add device pair # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_device_pair(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Add device pair request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_device_pair_endpoint.call_with_http_info(**kwargs) + + def add_transit_vpc( + self, + **kwargs + ): + """add_transit_vpc # noqa: E501 + + Create transit VPC/VNet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_transit_vpc(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPC. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_transit_vpc_endpoint.call_with_http_info(**kwargs) + + def authenticate_cloud_on_ramp_cred_and_add( + self, + **kwargs + ): + """authenticate_cloud_on_ramp_cred_and_add # noqa: E501 + + Authenticate cloud account credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.authenticate_cloud_on_ramp_cred_and_add(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloud account credential. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.authenticate_cloud_on_ramp_cred_and_add_endpoint.call_with_http_info(**kwargs) + + def authenticate_cred_and_update( + self, + **kwargs + ): + """authenticate_cred_and_update # noqa: E501 + + Authenticate and update cloud account credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.authenticate_cred_and_update(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloud account credential. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.authenticate_cred_and_update_endpoint.call_with_http_info(**kwargs) + + def create_and_map( + self, + **kwargs + ): + """create_and_map # noqa: E501 + + Map Host to Transit VPC/VNet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_and_map(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Map host to transit VPC request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_and_map_endpoint.call_with_http_info(**kwargs) + + def create_resource_pool( + self, + **kwargs + ): + """create_resource_pool # noqa: E501 + + Add resource pool # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_resource_pool(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Add resource pool request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_resource_pool_endpoint.call_with_http_info(**kwargs) + + def get_ami_list( + self, + accountid, + cloudregion, + **kwargs + ): + """get_ami_list # noqa: E501 + + Get AMI list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ami_list(accountid, cloudregion, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudregion (str): Cloud region + + Keyword Args: + cloudtype (str): Cloud type. [optional] if omitted the server will use the default value of "AWS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudregion'] = \ + cloudregion + return self.get_ami_list_endpoint.call_with_http_info(**kwargs) + + def get_cloud_accounts( + self, + cloudtype, + cloud_environment, + **kwargs + ): + """get_cloud_accounts # noqa: E501 + + Get cloud accounts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_accounts(cloudtype, cloud_environment, async_req=True) + >>> result = thread.get() + + Args: + cloudtype (str): Cloud type + cloud_environment (str): Cloud environment + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloudtype'] = \ + cloudtype + kwargs['cloud_environment'] = \ + cloud_environment + return self.get_cloud_accounts_endpoint.call_with_http_info(**kwargs) + + def get_cloud_host_vpc_account_details( + self, + **kwargs + ): + """get_cloud_host_vpc_account_details # noqa: E501 + + Get cloud host VPC account details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_host_vpc_account_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_host_vpc_account_details_endpoint.call_with_http_info(**kwargs) + + def get_cloud_host_vpcs( + self, + accountid, + cloudregion, + **kwargs + ): + """get_cloud_host_vpcs # noqa: E501 + + Get host VPC/VNet list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_host_vpcs(accountid, cloudregion, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudregion (str): Cloud region + + Keyword Args: + cloudtype (str): Cloud type. [optional] if omitted the server will use the default value of "AWS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudregion'] = \ + cloudregion + return self.get_cloud_host_vpcs_endpoint.call_with_http_info(**kwargs) + + def get_cloud_list( + self, + **kwargs + ): + """get_cloud_list # noqa: E501 + + Get cloud list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_list_endpoint.call_with_http_info(**kwargs) + + def get_cloud_mapped_host_accounts( + self, + accountid, + cloudtype, + **kwargs + ): + """get_cloud_mapped_host_accounts # noqa: E501 + + Get cloud mapped accounts view # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_mapped_host_accounts(accountid, cloudtype, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudtype (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudtype'] = \ + cloudtype + return self.get_cloud_mapped_host_accounts_endpoint.call_with_http_info(**kwargs) + + def get_cloud_on_ramp_devices( + self, + **kwargs + ): + """get_cloud_on_ramp_devices # noqa: E501 + + Get available device list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_on_ramp_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_on_ramp_devices_endpoint.call_with_http_info(**kwargs) + + def get_cor_status( + self, + **kwargs + ): + """get_cor_status # noqa: E501 + + Get Cloud On Ramp list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cor_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cor_status_endpoint.call_with_http_info(**kwargs) + + def get_external_id( + self, + **kwargs + ): + """get_external_id # noqa: E501 + + Get the vManage external ID for AWS # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_external_id(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_external_id_endpoint.call_with_http_info(**kwargs) + + def get_host_vpcs( + self, + transit_vpc_id, + device_pair_id, + **kwargs + ): + """get_host_vpcs # noqa: E501 + + Get host VPC details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_host_vpcs(transit_vpc_id, device_pair_id, async_req=True) + >>> result = thread.get() + + Args: + transit_vpc_id (str): Transit VPC Id + device_pair_id (str): Device pair Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transit_vpc_id'] = \ + transit_vpc_id + kwargs['device_pair_id'] = \ + device_pair_id + return self.get_host_vpcs_endpoint.call_with_http_info(**kwargs) + + def get_mapped_vpcs( + self, + accountid, + cloudregion, + **kwargs + ): + """get_mapped_vpcs # noqa: E501 + + Get mapped VPC/VNet list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapped_vpcs(accountid, cloudregion, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudregion (str): Cloud region + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudregion'] = \ + cloudregion + return self.get_mapped_vpcs_endpoint.call_with_http_info(**kwargs) + + def get_pem_key_list( + self, + accountid, + cloudregion, + cloudtype, + **kwargs + ): + """get_pem_key_list # noqa: E501 + + Get transit VPC PEM key list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pem_key_list(accountid, cloudregion, cloudtype, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudregion (str): Cloud region + cloudtype (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudregion'] = \ + cloudregion + kwargs['cloudtype'] = \ + cloudtype + return self.get_pem_key_list_endpoint.call_with_http_info(**kwargs) + + def get_transit_device_pair_and_host_list( + self, + account_id, + cloud_region, + **kwargs + ): + """get_transit_device_pair_and_host_list # noqa: E501 + + Get device and host details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transit_device_pair_and_host_list(account_id, cloud_region, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id + cloud_region (str): Cloud region + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + kwargs['cloud_region'] = \ + cloud_region + return self.get_transit_device_pair_and_host_list_endpoint.call_with_http_info(**kwargs) + + def get_transit_vpc_supported_size( + self, + cloud_environment, + **kwargs + ): + """get_transit_vpc_supported_size # noqa: E501 + + Get transit VPC supported size # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transit_vpc_supported_size(cloud_environment, async_req=True) + >>> result = thread.get() + + Args: + cloud_environment (str): Cloud environment + + Keyword Args: + cloudtype (str): Cloud type. [optional] if omitted the server will use the default value of "AWS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_environment'] = \ + cloud_environment + return self.get_transit_vpc_supported_size_endpoint.call_with_http_info(**kwargs) + + def get_transit_vpc_vpn_list( + self, + account_id, + **kwargs + ): + """get_transit_vpc_vpn_list # noqa: E501 + + Get transit VPN list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transit_vpc_vpn_list(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.get_transit_vpc_vpn_list_endpoint.call_with_http_info(**kwargs) + + def get_transit_vpcs( + self, + accountid, + cloudregion, + **kwargs + ): + """get_transit_vpcs # noqa: E501 + + Get transit VPC/VNet list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transit_vpcs(accountid, cloudregion, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + cloudregion (str): Cloud region + + Keyword Args: + cloudtype (str): Cloud type. [optional] if omitted the server will use the default value of "AWS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['cloudregion'] = \ + cloudregion + return self.get_transit_vpcs_endpoint.call_with_http_info(**kwargs) + + def map_vpcs( + self, + **kwargs + ): + """map_vpcs # noqa: E501 + + Map host to transit VPC/VNet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.map_vpcs(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Map host to VPC/VNet. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.map_vpcs_endpoint.call_with_http_info(**kwargs) + + def remove_device_id( + self, + accountid, + transitvpcid, + transitvpcname, + cloudregion, + device_pair_id, + **kwargs + ): + """remove_device_id # noqa: E501 + + Remove device pair # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_device_id(accountid, transitvpcid, transitvpcname, cloudregion, device_pair_id, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + transitvpcid (str): VPC Id + transitvpcname (str): VPC Name + cloudregion (str): Cloud region + device_pair_id (str): Device pair Id + + Keyword Args: + cloudtype (str): Cloud type. [optional] if omitted the server will use the default value of "AWS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['transitvpcid'] = \ + transitvpcid + kwargs['transitvpcname'] = \ + transitvpcname + kwargs['cloudregion'] = \ + cloudregion + kwargs['device_pair_id'] = \ + device_pair_id + return self.remove_device_id_endpoint.call_with_http_info(**kwargs) + + def remove_transit_vpc( + self, + accountid, + transitvpcid, + cloudregion, + **kwargs + ): + """remove_transit_vpc # noqa: E501 + + Delete transit VPC/VNet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_transit_vpc(accountid, transitvpcid, cloudregion, async_req=True) + >>> result = thread.get() + + Args: + accountid (str): Account Id + transitvpcid (str): Cloud VPC Id + cloudregion (str): Cloud region + + Keyword Args: + cloudtype (str): Cloud type. [optional] if omitted the server will use the default value of "AWS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['accountid'] = \ + accountid + kwargs['transitvpcid'] = \ + transitvpcid + kwargs['cloudregion'] = \ + cloudregion + return self.remove_transit_vpc_endpoint.call_with_http_info(**kwargs) + + def scale_down( + self, + **kwargs + ): + """scale_down # noqa: E501 + + Scale down cloud on ramp # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.scale_down(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update VPC. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.scale_down_endpoint.call_with_http_info(**kwargs) + + def scale_up( + self, + **kwargs + ): + """scale_up # noqa: E501 + + Scale up cloud on ramp # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.scale_up(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update VPC. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.scale_up_endpoint.call_with_http_info(**kwargs) + + def unmap_vpcs( + self, + **kwargs + ): + """unmap_vpcs # noqa: E501 + + Unmap host from transit VPC/VNet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unmap_vpcs(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Unmap host to VPC/VNet. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.unmap_vpcs_endpoint.call_with_http_info(**kwargs) + + def update_transit_vpc( + self, + **kwargs + ): + """update_transit_vpc # noqa: E501 + + Update transit VPC/VNet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_transit_vpc(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPC. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_transit_vpc_endpoint.call_with_http_info(**kwargs) + + def update_transit_vpc_autoscale_properties( + self, + **kwargs + ): + """update_transit_vpc_autoscale_properties # noqa: E501 + + Update transit VPC autoscale properties # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_transit_vpc_autoscale_properties(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPC. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_transit_vpc_autoscale_properties_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_configuration_group_api.py b/openapi_client/api/configuration_configuration_group_api.py new file mode 100644 index 0000000..8760548 --- /dev/null +++ b/openapi_client/api/configuration_configuration_group_api.py @@ -0,0 +1,2081 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.config_group import ConfigGroup +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class ConfigurationConfigurationGroupApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_config_group_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/config-group', + 'operation_id': 'create_config_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_config_group_association_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/associate', + 'operation_id': 'create_config_group_association', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'body', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_config_group_device_variables_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/variables', + 'operation_id': 'create_config_group_device_variables', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'body', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_config_group_device_variables1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/variables/schema', + 'operation_id': 'create_config_group_device_variables1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_config_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}', + 'operation_id': 'delete_config_group', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_config_group_association_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/associate', + 'operation_id': 'delete_config_group_association', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'body', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.deploy_config_group_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/deploy', + 'operation_id': 'deploy_config_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'body', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_config_group_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}', + 'operation_id': 'edit_config_group', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'body', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cedge_config_group_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/config-group/schema/sdwan', + 'operation_id': 'get_cedge_config_group_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put", + "ASSOCIATE/POST": "associate/post", + "ASSOCIATE/PUT": "associate/put", + "ASSOCIATE/DELETE": "associate/delete", + "DEPLOY/POST": "deploy/post" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_group_endpoint = _Endpoint( + settings={ + 'response_type': (ConfigGroup,), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}', + 'operation_id': 'get_config_group', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_group_association_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/associate', + 'operation_id': 'get_config_group_association', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_group_by_solution_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/config-group', + 'operation_id': 'get_config_group_by_solution', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'solution', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'solution': + (str,), + }, + 'attribute_map': { + 'solution': 'solution', + }, + 'location_map': { + 'solution': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_group_device_configuration_preview_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/{deviceId}/preview', + 'operation_id': 'get_config_group_device_configuration_preview', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'device_id', + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [ + 'config_group_id', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'device_id': + (str,), + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + 'device_id': 'deviceId', + }, + 'location_map': { + 'config_group_id': 'path', + 'device_id': 'path', + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_config_group_device_variables_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/variables', + 'operation_id': 'get_config_group_device_variables', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'device_id', + 'suggestions', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'device_id': + (str,), + 'suggestions': + (bool,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + 'device_id': 'device-id', + 'suggestions': 'suggestions', + }, + 'location_map': { + 'config_group_id': 'path', + 'device_id': 'query', + 'suggestions': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_config_group_association_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/config-group/{configGroupId}/device/associate', + 'operation_id': 'update_config_group_association', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + 'body', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_config_group( + self, + **kwargs + ): + """create_config_group # noqa: E501 + + Create a new Configuration Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_config_group(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Config Group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_config_group_endpoint.call_with_http_info(**kwargs) + + def create_config_group_association( + self, + config_group_id, + **kwargs + ): + """create_config_group_association # noqa: E501 + + Create associations with device and a config group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_config_group_association(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.create_config_group_association_endpoint.call_with_http_info(**kwargs) + + def create_config_group_device_variables( + self, + config_group_id, + **kwargs + ): + """create_config_group_device_variables # noqa: E501 + + assign values to device variables # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_config_group_device_variables(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): Config Group Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.create_config_group_device_variables_endpoint.call_with_http_info(**kwargs) + + def create_config_group_device_variables1( + self, + config_group_id, + **kwargs + ): + """create_config_group_device_variables1 # noqa: E501 + + assign values to device variables # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_config_group_device_variables1(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): Config Group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.create_config_group_device_variables1_endpoint.call_with_http_info(**kwargs) + + def delete_config_group( + self, + config_group_id, + **kwargs + ): + """delete_config_group # noqa: E501 + + Delete Config Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_config_group(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.delete_config_group_endpoint.call_with_http_info(**kwargs) + + def delete_config_group_association( + self, + config_group_id, + **kwargs + ): + """delete_config_group_association # noqa: E501 + + Delete Config Group Association from devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_config_group_association(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.delete_config_group_association_endpoint.call_with_http_info(**kwargs) + + def deploy_config_group( + self, + config_group_id, + **kwargs + ): + """deploy_config_group # noqa: E501 + + deploy config group to devices


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.deploy_config_group(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): Config Group Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.deploy_config_group_endpoint.call_with_http_info(**kwargs) + + def edit_config_group( + self, + config_group_id, + **kwargs + ): + """edit_config_group # noqa: E501 + + Edit a Configuration Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_config_group(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Config Group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.edit_config_group_endpoint.call_with_http_info(**kwargs) + + def get_cedge_config_group_schema_by_schema_type( + self, + **kwargs + ): + """get_cedge_config_group_schema_by_schema_type # noqa: E501 + + Get a Cedge famiy Configuration Group Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cedge_config_group_schema_by_schema_type(async_req=True) + >>> result = thread.get() + + + Keyword Args: + schema_type (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cedge_config_group_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_config_group( + self, + config_group_id, + **kwargs + ): + """get_config_group # noqa: E501 + + Get a Configuration Group by ID # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_group(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ConfigGroup + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.get_config_group_endpoint.call_with_http_info(**kwargs) + + def get_config_group_association( + self, + config_group_id, + **kwargs + ): + """get_config_group_association # noqa: E501 + + Get devices association with a config group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_group_association(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.get_config_group_association_endpoint.call_with_http_info(**kwargs) + + def get_config_group_by_solution( + self, + **kwargs + ): + """get_config_group_by_solution # noqa: E501 + + Get a Configuration Group by Solution # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_group_by_solution(async_req=True) + >>> result = thread.get() + + + Keyword Args: + solution (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_config_group_by_solution_endpoint.call_with_http_info(**kwargs) + + def get_config_group_device_configuration_preview( + self, + config_group_id, + device_id, + **kwargs + ): + """get_config_group_device_configuration_preview # noqa: E501 + + Get a preview of the configuration for a device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_group_device_configuration_preview(config_group_id, device_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): Config Group Id + device_id (str): Device Id + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + kwargs['device_id'] = \ + device_id + return self.get_config_group_device_configuration_preview_endpoint.call_with_http_info(**kwargs) + + def get_config_group_device_variables( + self, + config_group_id, + **kwargs + ): + """get_config_group_device_variables # noqa: E501 + + Get device variables # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_group_device_variables(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): Config Group Id + + Keyword Args: + device_id (str): Comma separated device id's like d1,d2. [optional] + suggestions (bool): Suggestions for possible values. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.get_config_group_device_variables_endpoint.call_with_http_info(**kwargs) + + def update_config_group_association( + self, + config_group_id, + **kwargs + ): + """update_config_group_association # noqa: E501 + + Move the devices from one config group to another # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_config_group_association(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.update_config_group_association_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_dashboard_status_api.py b/openapi_client/api/configuration_dashboard_status_api.py new file mode 100644 index 0000000..f0178fb --- /dev/null +++ b/openapi_client/api/configuration_dashboard_status_api.py @@ -0,0 +1,1059 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDashboardStatusApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.cancel_pending_tasks_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/status/cancel/{processId}', + 'operation_id': 'cancel_pending_tasks', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_id', + ], + 'required': [ + 'process_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_id': + (str,), + }, + 'attribute_map': { + 'process_id': 'processId', + }, + 'location_map': { + 'process_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.clean_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/status/clean', + 'operation_id': 'clean_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'clean_status', + ], + 'required': [ + 'clean_status', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'clean_status': + (bool,), + }, + 'attribute_map': { + 'clean_status': 'cleanStatus', + }, + 'location_map': { + 'clean_status': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/status/clear', + 'operation_id': 'delete_status', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_id', + ], + 'required': [ + 'process_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_id': + (str,), + }, + 'attribute_map': { + 'process_id': 'processId', + }, + 'location_map': { + 'process_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.find_running_tasks_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/status/tasks', + 'operation_id': 'find_running_tasks', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/status/{actionName}', + 'operation_id': 'find_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'action_name', + ], + 'required': [ + 'action_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'action_name': + (str,), + }, + 'attribute_map': { + 'action_name': 'actionName', + }, + 'location_map': { + 'action_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_active_task_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/status/tasks/activeCount', + 'operation_id': 'get_active_task_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_clean_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/status/tasks/clean', + 'operation_id': 'get_clean_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_id', + ], + 'required': [ + 'process_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_id': + (str,), + }, + 'attribute_map': { + 'process_id': 'processId', + }, + 'location_map': { + 'process_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_device_action_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/status', + 'operation_id': 'update_device_action_status', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def cancel_pending_tasks( + self, + process_id, + **kwargs + ): + """cancel_pending_tasks # noqa: E501 + + Bulk cancel task status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cancel_pending_tasks(process_id, async_req=True) + >>> result = thread.get() + + Args: + process_id (str): Process Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_id'] = \ + process_id + return self.cancel_pending_tasks_endpoint.call_with_http_info(**kwargs) + + def clean_status( + self, + clean_status, + **kwargs + ): + """clean_status # noqa: E501 + + Delete task and status vertex # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.clean_status(clean_status, async_req=True) + >>> result = thread.get() + + Args: + clean_status (bool): Clear status flag + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['clean_status'] = \ + clean_status + return self.clean_status_endpoint.call_with_http_info(**kwargs) + + def delete_status( + self, + process_id, + **kwargs + ): + """delete_status # noqa: E501 + + Delete status of action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_status(process_id, async_req=True) + >>> result = thread.get() + + Args: + process_id (str): Process Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_id'] = \ + process_id + return self.delete_status_endpoint.call_with_http_info(**kwargs) + + def find_running_tasks( + self, + **kwargs + ): + """find_running_tasks # noqa: E501 + + Find running tasks # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_running_tasks(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_running_tasks_endpoint.call_with_http_info(**kwargs) + + def find_status( + self, + action_name, + **kwargs + ): + """find_status # noqa: E501 + + Find status of action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_status(action_name, async_req=True) + >>> result = thread.get() + + Args: + action_name (str): Action name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['action_name'] = \ + action_name + return self.find_status_endpoint.call_with_http_info(**kwargs) + + def get_active_task_count( + self, + **kwargs + ): + """get_active_task_count # noqa: E501 + + Get active task count # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_active_task_count(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_active_task_count_endpoint.call_with_http_info(**kwargs) + + def get_clean_status( + self, + process_id, + **kwargs + ): + """get_clean_status # noqa: E501 + + Delete task and status vertex # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_clean_status(process_id, async_req=True) + >>> result = thread.get() + + Args: + process_id (str): Process Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_id'] = \ + process_id + return self.get_clean_status_endpoint.call_with_http_info(**kwargs) + + def update_device_action_status( + self, + **kwargs + ): + """update_device_action_status # noqa: E501 + + Update device action status. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_device_action_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update device action status. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_device_action_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_actions_api.py b/openapi_client/api/configuration_device_actions_api.py new file mode 100644 index 0000000..8fb32e9 --- /dev/null +++ b/openapi_client/api/configuration_device_actions_api.py @@ -0,0 +1,5159 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_ip import DeviceIP +from openapi_client.model.device_type import DeviceType +from openapi_client.model.group_id import GroupId + + +class ConfigurationDeviceActionsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_filter_vpn_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/filter/vpn', + 'operation_id': 'create_filter_vpn_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_unique_vpn_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/uniquevpnlist', + 'operation_id': 'create_unique_vpn_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_vpn_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/vpn', + 'operation_id': 'create_vpn_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_change_partition_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/changepartition', + 'operation_id': 'generate_change_partition_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([DeviceIP],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_deactivate_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/deactivate', + 'operation_id': 'generate_deactivate_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([DeviceIP],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_device_action_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/list', + 'operation_id': 'generate_device_action_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/install/devices/{deviceType}', + 'operation_id': 'generate_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_type', + 'group_id', + ], + 'required': [ + 'device_type', + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_type': + (DeviceType,), + 'group_id': + (GroupId,), + }, + 'attribute_map': { + 'device_type': 'deviceType', + 'group_id': 'groupId', + }, + 'location_map': { + 'device_type': 'path', + 'group_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_install_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/install', + 'operation_id': 'generate_install_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([DeviceIP],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_reboot_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/reboot/devices/{deviceType}', + 'operation_id': 'generate_reboot_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_type', + 'device_id', + ], + 'required': [ + 'device_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_type': + (DeviceType,), + 'device_id': + (GroupId,), + }, + 'attribute_map': { + 'device_type': 'deviceType', + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_type': 'path', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_reboot_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/reboot', + 'operation_id': 'generate_reboot_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([DeviceIP],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_rediscover_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/rediscover', + 'operation_id': 'generate_rediscover_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_remove_partition_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/removepartition', + 'operation_id': 'generate_remove_partition_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_security_devices_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/security/devices/{policyType}', + 'operation_id': 'generate_security_devices_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_type', + 'group_id', + ], + 'required': [ + 'policy_type', + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + 'policy_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('policy_type',): { + + "ZONEBASEDFW": "zoneBasedFW", + "INTRUSIONPREVENTION": "intrusionPrevention", + "URLFILTERING": "urlFiltering", + "ADVANCEDMALWAREPROTECTION": "advancedMalwareProtection", + "DNSSECURITY": "dnsSecurity", + "SSLDECRYPTION": "sslDecryption" + }, + }, + 'openapi_types': { + 'policy_type': + (str,), + 'group_id': + (GroupId,), + }, + 'attribute_map': { + 'policy_type': 'policyType', + 'group_id': 'groupId', + }, + 'location_map': { + 'policy_type': 'path', + 'group_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ztp_upgrade_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/ztp/upgrade', + 'operation_id': 'get_ztp_upgrade_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ztp_upgrade_config_setting_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/ztp/upgrade/setting', + 'operation_id': 'get_ztp_upgrade_config_setting', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.initiate_image_download_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/image-download', + 'operation_id': 'initiate_image_download', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_amp_api_re_key_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/security/amp/rekey', + 'operation_id': 'process_amp_api_re_key', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_cancel_task_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/cancel', + 'operation_id': 'process_cancel_task', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_change_partition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/changepartition', + 'operation_id': 'process_change_partition', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_deactivate_smu_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/deactivate', + 'operation_id': 'process_deactivate_smu', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_default_partition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/defaultpartition', + 'operation_id': 'process_default_partition', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_delete_amp_api_key_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/security/amp/apikey/{uuid}', + 'operation_id': 'process_delete_amp_api_key', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.process_install_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/install', + 'operation_id': 'process_install', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_lxc_activate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/lxcactivate', + 'operation_id': 'process_lxc_activate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_lxc_delete_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/lxcdelete', + 'operation_id': 'process_lxc_delete', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_lxc_install_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/lxcinstall', + 'operation_id': 'process_lxc_install', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_lxc_reload_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/lxcreload', + 'operation_id': 'process_lxc_reload', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_lxc_reset_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/lxcreset', + 'operation_id': 'process_lxc_reset', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_lxc_upgrade_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/lxcupgrade', + 'operation_id': 'process_lxc_upgrade', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_reboot_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/reboot', + 'operation_id': 'process_reboot', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_remove_partition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/removepartition', + 'operation_id': 'process_remove_partition', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_remove_software_image_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/image-remove', + 'operation_id': 'process_remove_software_image', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_vnf_install_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/vnfinstall', + 'operation_id': 'process_vnf_install', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_ztp_upgrade_config_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/ztp/upgrade', + 'operation_id': 'process_ztp_upgrade_config', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_ztp_upgrade_config_setting_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/ztp/upgrade/setting', + 'operation_id': 'process_ztp_upgrade_config_setting', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.re_discover_all_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/rediscoverall', + 'operation_id': 're_discover_all_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.re_discover_devices_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/rediscover', + 'operation_id': 're_discover_devices', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.test_api_key_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/security/apikey/{uuid}', + 'operation_id': 'test_api_key', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.test_iox_config_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/test/ioxconfig/{deviceIP}', + 'operation_id': 'test_iox_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (DeviceIP,), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.trigger_pending_tasks_monitoring_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/startmonitor', + 'operation_id': 'trigger_pending_tasks_monitoring', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def create_filter_vpn_list( + self, + **kwargs + ): + """create_filter_vpn_list # noqa: E501 + + Get filter VPN list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_filter_vpn_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_filter_vpn_list_endpoint.call_with_http_info(**kwargs) + + def create_unique_vpn_list( + self, + **kwargs + ): + """create_unique_vpn_list # noqa: E501 + + Create unique VPN list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_unique_vpn_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device IPs. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_unique_vpn_list_endpoint.call_with_http_info(**kwargs) + + def create_vpn_list( + self, + **kwargs + ): + """create_vpn_list # noqa: E501 + + Create VPN list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_vpn_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_vpn_list_endpoint.call_with_http_info(**kwargs) + + def generate_change_partition_info( + self, + device_id, + **kwargs + ): + """generate_change_partition_info # noqa: E501 + + Get change partition information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_change_partition_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([DeviceIP]): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.generate_change_partition_info_endpoint.call_with_http_info(**kwargs) + + def generate_deactivate_info( + self, + device_id, + **kwargs + ): + """generate_deactivate_info # noqa: E501 + + Get deactivate partition information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_deactivate_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([DeviceIP]): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.generate_deactivate_info_endpoint.call_with_http_info(**kwargs) + + def generate_device_action_list( + self, + **kwargs + ): + """generate_device_action_list # noqa: E501 + + Get device action list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_action_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_device_action_list_endpoint.call_with_http_info(**kwargs) + + def generate_device_list( + self, + device_type, + group_id, + **kwargs + ): + """generate_device_list # noqa: E501 + + Get list of installed devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_list(device_type, group_id, async_req=True) + >>> result = thread.get() + + Args: + device_type (DeviceType): Device type + group_id (GroupId): Group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_type'] = \ + device_type + kwargs['group_id'] = \ + group_id + return self.generate_device_list_endpoint.call_with_http_info(**kwargs) + + def generate_install_info( + self, + device_id, + **kwargs + ): + """generate_install_info # noqa: E501 + + Generate install info # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_install_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([DeviceIP]): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.generate_install_info_endpoint.call_with_http_info(**kwargs) + + def generate_reboot_device_list( + self, + device_type, + device_id, + **kwargs + ): + """generate_reboot_device_list # noqa: E501 + + Get list of rebooted devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_reboot_device_list(device_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + device_type (DeviceType): Device type + device_id (GroupId): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_type'] = \ + device_type + kwargs['device_id'] = \ + device_id + return self.generate_reboot_device_list_endpoint.call_with_http_info(**kwargs) + + def generate_reboot_info( + self, + device_id, + **kwargs + ): + """generate_reboot_info # noqa: E501 + + Get device reboot information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_reboot_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([DeviceIP]): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.generate_reboot_info_endpoint.call_with_http_info(**kwargs) + + def generate_rediscover_info( + self, + **kwargs + ): + """generate_rediscover_info # noqa: E501 + + Get rediscover operation information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_rediscover_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_rediscover_info_endpoint.call_with_http_info(**kwargs) + + def generate_remove_partition_info( + self, + device_id, + **kwargs + ): + """generate_remove_partition_info # noqa: E501 + + Get remove partition information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_remove_partition_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.generate_remove_partition_info_endpoint.call_with_http_info(**kwargs) + + def generate_security_devices_list( + self, + policy_type, + group_id, + **kwargs + ): + """generate_security_devices_list # noqa: E501 + + Get list of devices by security policy type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_security_devices_list(policy_type, group_id, async_req=True) + >>> result = thread.get() + + Args: + policy_type (str): Policy type + group_id (GroupId): Group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_type'] = \ + policy_type + kwargs['group_id'] = \ + group_id + return self.generate_security_devices_list_endpoint.call_with_http_info(**kwargs) + + def get_ztp_upgrade_config( + self, + **kwargs + ): + """get_ztp_upgrade_config # noqa: E501 + + Get ZTP upgrade configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ztp_upgrade_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_ztp_upgrade_config_endpoint.call_with_http_info(**kwargs) + + def get_ztp_upgrade_config_setting( + self, + **kwargs + ): + """get_ztp_upgrade_config_setting # noqa: E501 + + Get ZTP upgrade configuration setting # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ztp_upgrade_config_setting(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_ztp_upgrade_config_setting_endpoint.call_with_http_info(**kwargs) + + def initiate_image_download( + self, + **kwargs + ): + """initiate_image_download # noqa: E501 + + Intitate image download on the given device. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.initiate_image_download(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Image download request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.initiate_image_download_endpoint.call_with_http_info(**kwargs) + + def process_amp_api_re_key( + self, + **kwargs + ): + """process_amp_api_re_key # noqa: E501 + + Process amp api re-key operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_amp_api_re_key(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): AMP API re-key request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_amp_api_re_key_endpoint.call_with_http_info(**kwargs) + + def process_cancel_task( + self, + **kwargs + ): + """process_cancel_task # noqa: E501 + + Cancel tasks # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_cancel_task(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cancel task payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_cancel_task_endpoint.call_with_http_info(**kwargs) + + def process_change_partition( + self, + **kwargs + ): + """process_change_partition # noqa: E501 + + Process change partition operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_change_partition(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device change partition request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_change_partition_endpoint.call_with_http_info(**kwargs) + + def process_deactivate_smu( + self, + **kwargs + ): + """process_deactivate_smu # noqa: E501 + + Process deactivate operation for smu image # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_deactivate_smu(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device smu image deactivate request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_deactivate_smu_endpoint.call_with_http_info(**kwargs) + + def process_default_partition( + self, + **kwargs + ): + """process_default_partition # noqa: E501 + + Process marking default partition operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_default_partition(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Marking default partition request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_default_partition_endpoint.call_with_http_info(**kwargs) + + def process_delete_amp_api_key( + self, + uuid, + **kwargs + ): + """process_delete_amp_api_key # noqa: E501 + + Process amp api key deletion operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_delete_amp_api_key(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.process_delete_amp_api_key_endpoint.call_with_http_info(**kwargs) + + def process_install( + self, + **kwargs + ): + """process_install # noqa: E501 + + Process an installation operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_install(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Installation payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_install_endpoint.call_with_http_info(**kwargs) + + def process_lxc_activate( + self, + **kwargs + ): + """process_lxc_activate # noqa: E501 + + Process an activation operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_lxc_activate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Activation request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_lxc_activate_endpoint.call_with_http_info(**kwargs) + + def process_lxc_delete( + self, + **kwargs + ): + """process_lxc_delete # noqa: E501 + + Process a delete operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_lxc_delete(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Delete request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_lxc_delete_endpoint.call_with_http_info(**kwargs) + + def process_lxc_install( + self, + **kwargs + ): + """process_lxc_install # noqa: E501 + + Process an installation operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_lxc_install(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Installation request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_lxc_install_endpoint.call_with_http_info(**kwargs) + + def process_lxc_reload( + self, + **kwargs + ): + """process_lxc_reload # noqa: E501 + + Process a reload operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_lxc_reload(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Reload request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_lxc_reload_endpoint.call_with_http_info(**kwargs) + + def process_lxc_reset( + self, + **kwargs + ): + """process_lxc_reset # noqa: E501 + + Process a reset operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_lxc_reset(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Reset request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_lxc_reset_endpoint.call_with_http_info(**kwargs) + + def process_lxc_upgrade( + self, + **kwargs + ): + """process_lxc_upgrade # noqa: E501 + + Process an upgrade operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_lxc_upgrade(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Upgrade request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_lxc_upgrade_endpoint.call_with_http_info(**kwargs) + + def process_reboot( + self, + **kwargs + ): + """process_reboot # noqa: E501 + + Process a reboot operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_reboot(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device reboot request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_reboot_endpoint.call_with_http_info(**kwargs) + + def process_remove_partition( + self, + **kwargs + ): + """process_remove_partition # noqa: E501 + + Process remove partition operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_remove_partition(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device remove partition request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_remove_partition_endpoint.call_with_http_info(**kwargs) + + def process_remove_software_image( + self, + **kwargs + ): + """process_remove_software_image # noqa: E501 + + Process remove software image operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_remove_software_image(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device remove software image request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_remove_software_image_endpoint.call_with_http_info(**kwargs) + + def process_vnf_install( + self, + **kwargs + ): + """process_vnf_install # noqa: E501 + + Process an installation operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_vnf_install(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Installation request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_vnf_install_endpoint.call_with_http_info(**kwargs) + + def process_ztp_upgrade_config( + self, + **kwargs + ): + """process_ztp_upgrade_config # noqa: E501 + + Process ZTP upgrade configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_ztp_upgrade_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): ZTP upgrade config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_ztp_upgrade_config_endpoint.call_with_http_info(**kwargs) + + def process_ztp_upgrade_config_setting( + self, + **kwargs + ): + """process_ztp_upgrade_config_setting # noqa: E501 + + Process ZTP upgrade configuration setting # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_ztp_upgrade_config_setting(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): ZTP upgrade setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_ztp_upgrade_config_setting_endpoint.call_with_http_info(**kwargs) + + def re_discover_all_device( + self, + **kwargs + ): + """re_discover_all_device # noqa: E501 + + Rediscover all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.re_discover_all_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Rediscover device request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.re_discover_all_device_endpoint.call_with_http_info(**kwargs) + + def re_discover_devices( + self, + **kwargs + ): + """re_discover_devices # noqa: E501 + + Rediscover device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.re_discover_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Rediscover device request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.re_discover_devices_endpoint.call_with_http_info(**kwargs) + + def test_api_key( + self, + uuid, + **kwargs + ): + """test_api_key # noqa: E501 + + Get API key from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_api_key(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.test_api_key_endpoint.call_with_http_info(**kwargs) + + def test_iox_config( + self, + device_ip, + **kwargs + ): + """test_iox_config # noqa: E501 + + testIoxConfig # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_iox_config(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (DeviceIP): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.test_iox_config_endpoint.call_with_http_info(**kwargs) + + def trigger_pending_tasks_monitoring( + self, + **kwargs + ): + """trigger_pending_tasks_monitoring # noqa: E501 + + Triggers global monitoring thread # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trigger_pending_tasks_monitoring(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.trigger_pending_tasks_monitoring_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_config_history_api.py b/openapi_client/api/configuration_device_config_history_api.py new file mode 100644 index 0000000..4e7c2b9 --- /dev/null +++ b/openapi_client/api/configuration_device_config_history_api.py @@ -0,0 +1,2037 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDeviceConfigHistoryApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/aggregation', + 'operation_id': 'get_aggregation_data_by_query20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_diff_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/config/diff/list', + 'operation_id': 'get_config_diff', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_id1', + 'config_id2', + ], + 'required': [ + 'config_id1', + 'config_id2', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_id1': + (str,), + 'config_id2': + (str,), + }, + 'attribute_map': { + 'config_id1': 'config_id1', + 'config_id2': 'config_id2', + }, + 'location_map': { + 'config_id1': 'query', + 'config_id2': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/doccount', + 'operation_id': 'get_count22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/doccount', + 'operation_id': 'get_count_post22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/config/{config_id}', + 'operation_id': 'get_device_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_id', + ], + 'required': [ + 'config_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_id': + (str,), + }, + 'attribute_map': { + 'config_id': 'config_id', + }, + 'location_map': { + 'config_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_last_thousand_config_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/config', + 'operation_id': 'get_last_thousand_config_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'query', + ], + 'required': [ + 'device_id', + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'query': 'query', + }, + 'location_map': { + 'device_id': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/page', + 'operation_id': 'get_post_stat_bulk_raw_data20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/page', + 'operation_id': 'get_stat_bulk_raw_data20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/fields', + 'operation_id': 'get_stat_data_fields22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history', + 'operation_id': 'get_stat_data_raw_data19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv20_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/device/history/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history/query/fields', + 'operation_id': 'get_stat_query_fields22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/history', + 'operation_id': 'get_stats_raw_data20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query20( + self, + **kwargs + ): + """get_aggregation_data_by_query20 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query20_endpoint.call_with_http_info(**kwargs) + + def get_config_diff( + self, + config_id1, + config_id2, + **kwargs + ): + """get_config_diff # noqa: E501 + + Get diff of two configs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_diff(config_id1, config_id2, async_req=True) + >>> result = thread.get() + + Args: + config_id1 (str): Config Id one + config_id2 (str): Config Id two + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_id1'] = \ + config_id1 + kwargs['config_id2'] = \ + config_id2 + return self.get_config_diff_endpoint.call_with_http_info(**kwargs) + + def get_count22( + self, + query, + **kwargs + ): + """get_count22 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count22(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count22_endpoint.call_with_http_info(**kwargs) + + def get_count_post22( + self, + **kwargs + ): + """get_count_post22 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post22_endpoint.call_with_http_info(**kwargs) + + def get_device_config( + self, + config_id, + **kwargs + ): + """get_device_config # noqa: E501 + + Get device config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_config(config_id, async_req=True) + >>> result = thread.get() + + Args: + config_id (str): Config Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_id'] = \ + config_id + return self.get_device_config_endpoint.call_with_http_info(**kwargs) + + def get_last_thousand_config_list( + self, + device_id, + query, + **kwargs + ): + """get_last_thousand_config_list # noqa: E501 + + Get device config history # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_last_thousand_config_list(device_id, query, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + query (str): Query filter + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + kwargs['query'] = \ + query + return self.get_last_thousand_config_list_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query19( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query19 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query19_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query19( + self, + **kwargs + ): + """get_post_aggregation_data_by_query19 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query19_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data20( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data20 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data20_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data20( + self, + **kwargs + ): + """get_stat_bulk_raw_data20 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data20_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields22( + self, + **kwargs + ): + """get_stat_data_fields22 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields22_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data19( + self, + **kwargs + ): + """get_stat_data_raw_data19 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data19_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv20( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv20 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv20_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields22( + self, + **kwargs + ): + """get_stat_query_fields22 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields22_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data20( + self, + **kwargs + ): + """get_stats_raw_data20 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data20_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_connectivity_api.py b/openapi_client/api/configuration_device_connectivity_api.py new file mode 100644 index 0000000..542826f --- /dev/null +++ b/openapi_client/api/configuration_device_connectivity_api.py @@ -0,0 +1,292 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDeviceConnectivityApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.invalidate_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/device/invalidate', + 'operation_id': 'invalidate_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.stage_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/device/stage', + 'operation_id': 'stage_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def invalidate_device( + self, + **kwargs + ): + """invalidate_device # noqa: E501 + + invalidate the device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invalidate_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vEdge device info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.invalidate_device_endpoint.call_with_http_info(**kwargs) + + def stage_device( + self, + **kwargs + ): + """stage_device # noqa: E501 + + Stop data traffic to device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stage_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): vEdge device info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.stage_device_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_firmware_update_api.py b/openapi_client/api/configuration_device_firmware_update_api.py new file mode 100644 index 0000000..9562e83 --- /dev/null +++ b/openapi_client/api/configuration_device_firmware_update_api.py @@ -0,0 +1,1027 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDeviceFirmwareUpdateApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.activate_firmware_image_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware/activate', + 'operation_id': 'activate_firmware_image', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_firmware_image_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware/{versionId}', + 'operation_id': 'delete_firmware_image', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_devices_fw_upgrade_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware/devices', + 'operation_id': 'get_devices_fw_upgrade', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_firmware_image_details_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware/{versionId}', + 'operation_id': 'get_firmware_image_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_firmware_images_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware', + 'operation_id': 'get_firmware_images', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.install_firmware_image_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware/install', + 'operation_id': 'install_firmware_image', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_firmware_image_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware', + 'operation_id': 'process_firmware_image', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.remove_firmware_image_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/firmware/remove', + 'operation_id': 'remove_firmware_image', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def activate_firmware_image( + self, + **kwargs + ): + """activate_firmware_image # noqa: E501 + + Activate firmware on device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate_firmware_image(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.activate_firmware_image_endpoint.call_with_http_info(**kwargs) + + def delete_firmware_image( + self, + version_id, + **kwargs + ): + """delete_firmware_image # noqa: E501 + + Delete firmware image package # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_firmware_image(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Firmware image version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.delete_firmware_image_endpoint.call_with_http_info(**kwargs) + + def get_devices_fw_upgrade( + self, + **kwargs + ): + """get_devices_fw_upgrade # noqa: E501 + + Get list of devices that support firmware upgrade # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_fw_upgrade(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_fw_upgrade_endpoint.call_with_http_info(**kwargs) + + def get_firmware_image_details( + self, + version_id, + **kwargs + ): + """get_firmware_image_details # noqa: E501 + + Get firmware image details for a given version # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_firmware_image_details(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Firmware image version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.get_firmware_image_details_endpoint.call_with_http_info(**kwargs) + + def get_firmware_images( + self, + **kwargs + ): + """get_firmware_images # noqa: E501 + + Get list of firmware images in the repository # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_firmware_images(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_firmware_images_endpoint.call_with_http_info(**kwargs) + + def install_firmware_image( + self, + **kwargs + ): + """install_firmware_image # noqa: E501 + + Install firmware on device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.install_firmware_image(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.install_firmware_image_endpoint.call_with_http_info(**kwargs) + + def process_firmware_image( + self, + **kwargs + ): + """process_firmware_image # noqa: E501 + + Upload firmware image package # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_firmware_image(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_firmware_image_endpoint.call_with_http_info(**kwargs) + + def remove_firmware_image( + self, + **kwargs + ): + """remove_firmware_image # noqa: E501 + + Remove firmware on device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_firmware_image(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.remove_firmware_image_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_inventory_api.py b/openapi_client/api/configuration_device_inventory_api.py new file mode 100644 index 0000000..db0313c --- /dev/null +++ b/openapi_client/api/configuration_device_inventory_api.py @@ -0,0 +1,4110 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.certificate_states import CertificateStates +from openapi_client.model.certificate_validity import CertificateValidity +from openapi_client.model.device_ip import DeviceIP +from openapi_client.model.device_uuid import DeviceUuid +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from openapi_client.model.smart_account_model import SmartAccountModel + + +class ConfigurationDeviceInventoryApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.check_self_signed_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/selfsignedcert/iscreated', + 'operation_id': 'check_self_signed_cert', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.claim_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/claimDevices', + 'operation_id': 'claim_devices', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device', + 'operation_id': 'create_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.decommission_vedge_cloud_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/decommission/{uuid}', + 'operation_id': 'decommission_vedge_cloud', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device/{uuid}', + 'operation_id': 'delete_device', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.devices_without_subject_sudi_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/devicesWithoutSubjectSudi', + 'operation_id': 'devices_without_subject_sudi', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device/{uuid}', + 'operation_id': 'edit_device', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + 'body', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.form_post_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device/fileupload', + 'operation_id': 'form_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_bootstrap_config_for_vedge_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/bootstrap/device/{uuid}', + 'operation_id': 'generate_bootstrap_config_for_vedge', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + 'configtype', + 'incl_def_root_cert', + 'version', + ], + 'required': [ + 'uuid', + 'configtype', + 'incl_def_root_cert', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + 'configtype': + (str,), + 'incl_def_root_cert': + (bool,), + 'version': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + 'configtype': 'configtype', + 'incl_def_root_cert': 'inclDefRootCert', + 'version': 'version', + }, + 'location_map': { + 'uuid': 'path', + 'configtype': 'query', + 'incl_def_root_cert': 'query', + 'version': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_bootstrap_config_for_vedges_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/bootstrap/devices', + 'operation_id': 'generate_bootstrap_config_for_vedges', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_generic_bootstrap_config_for_vedges_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/bootstrap/generic/devices', + 'operation_id': 'generate_generic_bootstrap_config_for_vedges', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'wanif', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'wanif': + (str,), + }, + 'attribute_map': { + 'wanif': 'wanif', + }, + 'location_map': { + 'wanif': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_unclaimed_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/unclaimedDevices', + 'operation_id': 'get_all_unclaimed_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bootstrap_config_zip_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/bootstrap/download/{id}', + 'operation_id': 'get_bootstrap_config_zip', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_dock_data_based_on_device_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/type/{deviceCategory}', + 'operation_id': 'get_cloud_dock_data_based_on_device_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_category', + ], + 'required': [ + 'device_category', + ], + 'nullable': [ + ], + 'enum': [ + 'device_category', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('device_category',): { + + "VEDGES": "vedges", + "CONTROLLERS": "controllers" + }, + }, + 'openapi_types': { + 'device_category': + (str,), + }, + 'attribute_map': { + 'device_category': 'deviceCategory', + }, + 'location_map': { + 'device_category': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_dock_default_config_based_on_device_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/type/{deviceCategory}/defaultConfig', + 'operation_id': 'get_cloud_dock_default_config_based_on_device_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_category', + ], + 'required': [ + 'device_category', + ], + 'nullable': [ + ], + 'enum': [ + 'device_category', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('device_category',): { + + "VEDGES": "vedges", + "CONTROLLERS": "controllers" + }, + }, + 'openapi_types': { + 'device_category': + (str,), + }, + 'attribute_map': { + 'device_category': 'deviceCategory', + }, + 'location_map': { + 'device_category': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_controller_v_edge_sync_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/controllers/vedge/status', + 'operation_id': 'get_controller_v_edge_sync_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_devices_details_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/{deviceCategory}', + 'operation_id': 'get_devices_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_category', + 'model', + 'state', + 'uuid', + 'device_ip', + 'validity', + 'family', + ], + 'required': [ + 'device_category', + ], + 'nullable': [ + ], + 'enum': [ + 'model', + 'state', + 'validity', + 'family', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('model',): { + + "VEDGE-CLOUD": "vedge-cloud", + "VEDGE-1000": "vedge-1000", + "VEDGE-2000": "vedge-2000", + "VEDGE-100": "vedge-100", + "VEDGE-ISR1100-4G": "vedge-ISR1100-4G", + "VEDGE-ISR1100-4GLTE": "vedge-ISR1100-4GLTE", + "VEDGE-ISR1100X-4G": "vedge-ISR1100X-4G", + "VEDGE-ISR1100-6G": "vedge-ISR1100-6G", + "VEDGE-ISR1100X-6G": "vedge-ISR1100X-6G", + "VEDGE-100-B": "vedge-100-B", + "VEDGE-100-WM": "vedge-100-WM", + "VEDGE-100-M": "vedge-100-M", + "VEDGE-5000": "vEdge-5000", + "VEDGE-CSR-1000V": "vedge-CSR-1000v", + "VEDGE-IR-1101": "vedge-IR-1101", + "VEDGE-IR-1821": "vedge-IR-1821", + "VEDGE-IR-1831": "vedge-IR-1831", + "VEDGE-IR-1833": "vedge-IR-1833", + "VEDGE-IR-1835": "vedge-IR-1835", + "VEDGE-IR-8140H": "vedge-IR-8140H", + "VEDGE-IR8140H-P": "vedge-IR8140H-P", + "VEDGE-IR-8340": "vedge-IR-8340", + "VEDGE-ESR-6300": "vedge-ESR-6300", + "VEDGE-ISR-4331": "vedge-ISR-4331", + "VEDGE-ISR-4321": "vedge-ISR-4321", + "VEDGE-ISR-4351": "vedge-ISR-4351", + "VEDGE-ISR-4221": "vedge-ISR-4221", + "VEDGE-IR-1101": "vedge-IR-1101", + "VEDGE-ESR-6300": "vedge-ESR-6300", + "VEDGE-ISR-4331": "vedge-ISR-4331", + "VEDGE-ISR-4321": "vedge-ISR-4321", + "VEDGE-ISR-4351": "vedge-ISR-4351", + "VEDGE-ISR-4221": "vedge-ISR-4221", + "VEDGE-ISR-4221X": "vedge-ISR-4221X", + "VEDGE-ISR-4431": "vedge-ISR-4431", + "VEDGE-ISR-4451-X": "vedge-ISR-4451-X", + "VEDGE-ASR-1001-HX": "vedge-ASR-1001-HX", + "VEDGE-ASR-1002-X": "vedge-ASR-1002-X", + "VEDGE-ASR-1002-HX": "vedge-ASR-1002-HX", + "VEDGE-ASR-1006-X": "vedge-ASR-1006-X", + "VEDGE-C1111-8P": "vedge-C1111-8P", + "VEDGE-C1121X-8P": "vedge-C1121X-8P", + "VEDGE-C1111X-8P": "vedge-C1111X-8P", + "VEDGE-C1111-8PLTELAW": "vedge-C1111-8PLTELAW", + "VEDGE-C1111-8PLTEEA": "vedge-C1111-8PLTEEA", + "VEDGE-C1121-8PLTEPW": "vedge-C1121-8PLTEPW", + "VEDGE-C1111-8PLTELA": "vedge-C1111-8PLTELA", + "VEDGE-C1117-4PLTEEA": "vedge-C1117-4PLTEEA", + "VEDGE-C1126X-8PLTEP": "vedge-C1126X-8PLTEP", + "VEDGE-C1127X-8PLTEP": "vedge-C1127X-8PLTEP", + "VEDGE-C1127X-8PMLTEP": "vedge-C1127X-8PMLTEP", + "VEDGE-C1127-8PMLTEP": "vedge-C1127-8PMLTEP", + "VEDGE-C1117-4PLTELA": "vedge-C1117-4PLTELA", + "VEDGE-ISRV": "vedge-ISRv", + "VEDGE-C8000V": "vedge-C8000V", + "VEDGE-ASR-1001-X": "vedge-ASR-1001-X", + "VEDGE-C1111-4P": "vedge-C1111-4P", + "VEDGE-C1101-4P": "vedge-C1101-4P", + "VEDGE-C1101-4PLTEP": "vedge-C1101-4PLTEP", + "VEDGE-C8500-12X4QC": "vedge-C8500-12X4QC", + "VEDGE-C8500-12X": "vedge-C8500-12X", + "VEDGE-C8500L-8S4X": "vedge-C8500L-8S4X", + "VEDGE-C1111-8PW": "vedge-C1111-8PW", + "VEDGE-C1111-8PLTEEAW": "vedge-C1111-8PLTEEAW", + "VEDGE-C1111-4PLTEEA": "vedge-C1111-4PLTEEA", + "VEDGE-C1101-4PLTEPW": "vedge-C1101-4PLTEPW", + "VEDGE-C1109-4PLTE2PW": "vedge-C1109-4PLTE2PW", + "VEDGE-C1109-4PLTE2P": "vedge-C1109-4PLTE2P", + "VEDGE-C1121X-8PLTEP": "vedge-C1121X-8PLTEP", + "VEDGE-C1161X-8PLTEP": "vedge-C1161X-8PLTEP", + "VEDGE-C1113-8PMLTEEA": "vedge-C1113-8PMLTEEA", + "VEDGE-C1111-4PLTELA,VEDGE-C1116-4P": "vedge-C1111-4PLTELA,vedge-C1116-4P", + "VEDGE-C1116-4PLTEEA": "vedge-C1116-4PLTEEA", + "VEDGE-C1117-4P": "vedge-C1117-4P", + "VEDGE-C1117-4PM": "vedge-C1117-4PM", + "VEDGE-C1117-4PMLTEEA": "vedge-C1117-4PMLTEEA", + "VSMART": "vsmart", + "VMANAGE": "vmanage", + "VBOND": "vbond", + "VEDGE-ISR-4461": "vedge-ISR-4461", + "VEDGE-C8300-1N1S-4T2X": "vedge-C8300-1N1S-4T2X", + "VEDGE-C8300-1N1S-6T": "vedge-C8300-1N1S-6T", + "VEDGE-C1161X-8P": "vedge-C1161X-8P", + "VEDGE-C8300-2N2S-4T2X": "vedge-C8300-2N2S-4T2X", + "VEDGE-C8300-2N2S-6T": "vedge-C8300-2N2S-6T", + "VEDGE-C8200-1N-4T": "vedge-C8200-1N-4T", + "VEDGE-C8200L-1N-4T": "vedge-C8200L-1N-4T", + "VEDGE-C1161-8P": "vedge-C1161-8P", + "VEDGE-C1126-8PLTEP": "vedge-C1126-8PLTEP", + "VEDGE-C1127-8PLTEP": "vedge-C1127-8PLTEP", + "VEDGE-C1121-4P": "vedge-C1121-4P", + "VEDGE-C1121-4PLTEP": "vedge-C1121-4PLTEP", + "VEDGE-C1128-8PLTEP": "vedge-C1128-8PLTEP", + "VEDGE-C1121X-8PLTEPW": "vedge-C1121X-8PLTEPW", + "VEDGE-C1121-8PLTEP": "vedge-C1121-8PLTEP", + "VEDGE-C1121-8P": "vedge-C1121-8P", + "VEDGE-C1161-8PLTEP": "vedge-C1161-8PLTEP", + "VEDGE-C1113-8PLTEEA": "vedge-C1113-8PLTEEA", + "VEDGE-C1131-8PW": "vedge-C1131-8PW", + "VEDGE-C1131X-8PW": "vedge-C1131X-8PW", + "VEDGE-C1131-8PLTEPW": "vedge-C1131-8PLTEPW", + "VEDGE-C1131X-8PLTEPW": "vedge-C1131X-8PLTEPW", + "VEDGE-C1113-8PLTEW": "vedge-C1113-8PLTEW", + "VEDGE-C1111-4PW": "vedge-C1111-4PW", + "VEDGE-C1112-8P": "vedge-C1112-8P", + "VEDGE-C1112-8PLTEEA": "vedge-C1112-8PLTEEA", + "VEDGE-C1112-8PLTEEAWE": "vedge-C1112-8PLTEEAWE", + "VEDGE-C1112-8PWE": "vedge-C1112-8PWE", + "VEDGE-C1113-8P": "vedge-C1113-8P", + "VEDGE-C1113-8PLTEEAW": "vedge-C1113-8PLTEEAW", + "VEDGE-C1113-8PLTELA": "vedge-C1113-8PLTELA", + "VEDGE-C1113-8PLTELAWZ": "vedge-C1113-8PLTELAWZ", + "VEDGE-C1113-8PM": "vedge-C1113-8PM", + "VEDGE-C1113-8PMWE": "vedge-C1113-8PMWE", + "VEDGE-C1113-8PW": "vedge-C1113-8PW", + "VEDGE-C1116-4PLTEEAWE": "vedge-C1116-4PLTEEAWE", + "VEDGE-C1116-4PWE": "vedge-C1116-4PWE", + "VEDGE-C1117-4PLTEEAW": "vedge-C1117-4PLTEEAW", + "VEDGE-C1117-4PLTELAWZ": "vedge-C1117-4PLTELAWZ", + "VEDGE-C1117-4PMLTEEAWE": "vedge-C1117-4PMLTEEAWE", + "VEDGE-C1117-4PMWE": "vedge-C1117-4PMWE", + "VEDGE-C1117-4PW": "vedge-C1117-4PW", + "VEDGE-C1118-8P": "vedge-C1118-8P", + "VEDGE-C1109-2PLTEGB": "vedge-C1109-2PLTEGB", + "VEDGE-C1109-2PLTEUS": "vedge-C1109-2PLTEUS", + "VEDGE-C1109-2PLTEVZ": "vedge-C1109-2PLTEVZ" + }, + ('state',): { + + }, + ('validity',): { + + }, + ('family',): { + + "AON": "aon", + "CEDGE": "cedge" + }, + }, + 'openapi_types': { + 'device_category': + (str,), + 'model': + (str,), + 'state': + ([CertificateStates],), + 'uuid': + ([DeviceUuid],), + 'device_ip': + ([DeviceIP],), + 'validity': + ([CertificateValidity],), + 'family': + (str,), + }, + 'attribute_map': { + 'device_category': 'deviceCategory', + 'model': 'model', + 'state': 'state', + 'uuid': 'uuid', + 'device_ip': 'deviceIP', + 'validity': 'validity', + 'family': 'family', + }, + 'location_map': { + 'device_category': 'path', + 'model': 'query', + 'state': 'query', + 'uuid': 'query', + 'device_ip': 'query', + 'validity': 'query', + 'family': 'query', + }, + 'collection_format_map': { + 'state': 'multi', + 'uuid': 'multi', + 'device_ip': 'multi', + 'validity': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_management_system_ip_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/management/systemip', + 'operation_id': 'get_management_system_ip_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_rma_candidates_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/rma/candidates/{deviceType}', + 'operation_id': 'get_rma_candidates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_type', + 'uuid', + ], + 'required': [ + 'device_type', + ], + 'nullable': [ + ], + 'enum': [ + 'device_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('device_type',): { + + "VSMART": "vsmart" + }, + }, + 'openapi_types': { + 'device_type': + (str,), + 'uuid': + (str,), + }, + 'attribute_map': { + 'device_type': 'deviceType', + 'uuid': 'uuid', + }, + 'location_map': { + 'device_type': 'path', + 'uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_root_cert_status_all_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/rootcertchain/status', + 'operation_id': 'get_root_cert_status_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state', + ], + 'required': [ + 'state', + ], + 'nullable': [ + ], + 'enum': [ + 'state', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('state',): { + + "PENDING": "pending", + "DONE": "done" + }, + }, + 'openapi_types': { + 'state': + (str,), + }, + 'attribute_map': { + 'state': 'state', + }, + 'location_map': { + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenant_management_system_ips_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/system/device/tenant/management/systemip', + 'operation_id': 'get_tenant_management_system_ips', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invalidate_vmanage_root_ca_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device/vmanagerootca/{uuid}', + 'operation_id': 'invalidate_vmanage_root_ca', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.migrate_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/migrateDevice/{uuid}', + 'operation_id': 'migrate_device', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.reset_vedge_cloud_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/reset/{uuid}', + 'operation_id': 'reset_vedge_cloud', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.set_life_cycle_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/lifecycle/management/{uuid}', + 'operation_id': 'set_life_cycle', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + 'enable', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + 'enable': + (bool,), + }, + 'attribute_map': { + 'uuid': 'uuid', + 'enable': 'enable', + }, + 'location_map': { + 'uuid': 'path', + 'enable': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.sync_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/smartaccount/sync', + 'operation_id': 'sync_devices', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'smart_account_model', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'smart_account_model': + (SmartAccountModel,), + }, + 'attribute_map': { + }, + 'location_map': { + 'smart_account_model': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.sync_root_cert_chain_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device/sync/rootcertchain', + 'operation_id': 'sync_root_cert_chain', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.update_device_subject_sudi_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/device/updateDeviceSubjectSUDI/{uuid}', + 'operation_id': 'update_device_subject_sudi', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.validate_user_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/smartaccount/authenticate', + 'operation_id': 'validate_user', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'smart_account_model', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'smart_account_model': + (SmartAccountModel,), + }, + 'attribute_map': { + }, + 'location_map': { + 'smart_account_model': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_user1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/device/generate-payg', + 'operation_id': 'validate_user1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def check_self_signed_cert( + self, + **kwargs + ): + """check_self_signed_cert # noqa: E501 + + Whether self signed certificate created # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_self_signed_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_self_signed_cert_endpoint.call_with_http_info(**kwargs) + + def claim_devices( + self, + **kwargs + ): + """claim_devices # noqa: E501 + + Claim the selected unclaimed devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.claim_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Claim device request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.claim_devices_endpoint.call_with_http_info(**kwargs) + + def create_device( + self, + **kwargs + ): + """create_device # noqa: E501 + + Create new device


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Create device request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_device_endpoint.call_with_http_info(**kwargs) + + def decommission_vedge_cloud( + self, + uuid, + **kwargs + ): + """decommission_vedge_cloud # noqa: E501 + + Decomission vEdge device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.decommission_vedge_cloud(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.decommission_vedge_cloud_endpoint.call_with_http_info(**kwargs) + + def delete_device( + self, + uuid, + **kwargs + ): + """delete_device # noqa: E501 + + Delete vEdges # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_device(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.delete_device_endpoint.call_with_http_info(**kwargs) + + def devices_without_subject_sudi( + self, + **kwargs + ): + """devices_without_subject_sudi # noqa: E501 + + retrieve devices without subject sudi # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.devices_without_subject_sudi(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.devices_without_subject_sudi_endpoint.call_with_http_info(**kwargs) + + def edit_device( + self, + uuid, + **kwargs + ): + """edit_device # noqa: E501 + + Edit device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_device(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.edit_device_endpoint.call_with_http_info(**kwargs) + + def form_post( + self, + **kwargs + ): + """form_post # noqa: E501 + + Upload file to vEdge # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.form_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.form_post_endpoint.call_with_http_info(**kwargs) + + def generate_bootstrap_config_for_vedge( + self, + uuid, + configtype, + incl_def_root_cert=True, + **kwargs + ): + """generate_bootstrap_config_for_vedge # noqa: E501 + + Create vEdge device config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_bootstrap_config_for_vedge(uuid, configtype, incl_def_root_cert=True, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + configtype (str): Device config type + incl_def_root_cert (bool): Include default root certs flag. defaults to True, must be one of [True] + + Keyword Args: + version (str): cloud-init format version. [optional] if omitted the server will use the default value of "v1" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + kwargs['configtype'] = \ + configtype + kwargs['incl_def_root_cert'] = \ + incl_def_root_cert + return self.generate_bootstrap_config_for_vedge_endpoint.call_with_http_info(**kwargs) + + def generate_bootstrap_config_for_vedges( + self, + **kwargs + ): + """generate_bootstrap_config_for_vedges # noqa: E501 + + Create bootstrap config for software vEdges # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_bootstrap_config_for_vedges(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device bootstrap type and id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_bootstrap_config_for_vedges_endpoint.call_with_http_info(**kwargs) + + def generate_generic_bootstrap_config_for_vedges( + self, + **kwargs + ): + """generate_generic_bootstrap_config_for_vedges # noqa: E501 + + Create bootstrap config for software vEdges # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_generic_bootstrap_config_for_vedges(async_req=True) + >>> result = thread.get() + + + Keyword Args: + wanif (str): Device WAN interface. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_generic_bootstrap_config_for_vedges_endpoint.call_with_http_info(**kwargs) + + def get_all_unclaimed_devices( + self, + **kwargs + ): + """get_all_unclaimed_devices # noqa: E501 + + Get list of all unclaimed devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_unclaimed_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_unclaimed_devices_endpoint.call_with_http_info(**kwargs) + + def get_bootstrap_config_zip( + self, + id, + **kwargs + ): + """get_bootstrap_config_zip # noqa: E501 + + Download vEdge device config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bootstrap_config_zip(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Bootstrap config id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_bootstrap_config_zip_endpoint.call_with_http_info(**kwargs) + + def get_cloud_dock_data_based_on_device_type( + self, + device_category, + **kwargs + ): + """get_cloud_dock_data_based_on_device_type # noqa: E501 + + Get devices details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_dock_data_based_on_device_type(device_category, async_req=True) + >>> result = thread.get() + + Args: + device_category (str): Device category + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_category'] = \ + device_category + return self.get_cloud_dock_data_based_on_device_type_endpoint.call_with_http_info(**kwargs) + + def get_cloud_dock_default_config_based_on_device_type( + self, + device_category, + **kwargs + ): + """get_cloud_dock_default_config_based_on_device_type # noqa: E501 + + Get devices default config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_dock_default_config_based_on_device_type(device_category, async_req=True) + >>> result = thread.get() + + Args: + device_category (str): Device category + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_category'] = \ + device_category + return self.get_cloud_dock_default_config_based_on_device_type_endpoint.call_with_http_info(**kwargs) + + def get_controller_v_edge_sync_status( + self, + **kwargs + ): + """get_controller_v_edge_sync_status # noqa: E501 + + Get controllers vEdge sync status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_controller_v_edge_sync_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_controller_v_edge_sync_status_endpoint.call_with_http_info(**kwargs) + + def get_devices_details( + self, + device_category, + **kwargs + ): + """get_devices_details # noqa: E501 + + Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_details(device_category, async_req=True) + >>> result = thread.get() + + Args: + device_category (str): Device category + + Keyword Args: + model (str): Device model. [optional] + state ([CertificateStates]): List of states. [optional] + uuid ([DeviceUuid]): List of device uuid. [optional] + device_ip ([DeviceIP]): List of device system IP. [optional] + validity ([CertificateValidity]): List of device validity. [optional] + family (str): The platform family to filter for. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_category'] = \ + device_category + return self.get_devices_details_endpoint.call_with_http_info(**kwargs) + + def get_management_system_ip_info( + self, + **kwargs + ): + """get_management_system_ip_info # noqa: E501 + + Get management system IP mapping # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_management_system_ip_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_management_system_ip_info_endpoint.call_with_http_info(**kwargs) + + def get_rma_candidates( + self, + device_type="vsmart", + **kwargs + ): + """get_rma_candidates # noqa: E501 + + Get RMA candidates by device type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_rma_candidates(device_type="vsmart", async_req=True) + >>> result = thread.get() + + Args: + device_type (str): Device Type. defaults to "vsmart", must be one of ["vsmart"] + + Keyword Args: + uuid (str): Excluded currently selected uuid. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_type'] = \ + device_type + return self.get_rma_candidates_endpoint.call_with_http_info(**kwargs) + + def get_root_cert_status_all( + self, + state, + **kwargs + ): + """get_root_cert_status_all # noqa: E501 + + Get controllers vEdge sync status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_root_cert_status_all(state, async_req=True) + >>> result = thread.get() + + Args: + state (str): Root certificate state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state'] = \ + state + return self.get_root_cert_status_all_endpoint.call_with_http_info(**kwargs) + + def get_tenant_management_system_ips( + self, + **kwargs + ): + """get_tenant_management_system_ips # noqa: E501 + + Get management system IP


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenant_management_system_ips(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenant_management_system_ips_endpoint.call_with_http_info(**kwargs) + + def invalidate_vmanage_root_ca( + self, + uuid, + **kwargs + ): + """invalidate_vmanage_root_ca # noqa: E501 + + Invalidate vManage root CA # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invalidate_vmanage_root_ca(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.invalidate_vmanage_root_ca_endpoint.call_with_http_info(**kwargs) + + def migrate_device( + self, + uuid, + **kwargs + ): + """migrate_device # noqa: E501 + + Migrate device software to vedge/cedge # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.migrate_device(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.migrate_device_endpoint.call_with_http_info(**kwargs) + + def reset_vedge_cloud( + self, + uuid, + **kwargs + ): + """reset_vedge_cloud # noqa: E501 + + Reset vEdge device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reset_vedge_cloud(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.reset_vedge_cloud_endpoint.call_with_http_info(**kwargs) + + def set_life_cycle( + self, + uuid, + **kwargs + ): + """set_life_cycle # noqa: E501 + + Set device lifecycle needed flag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_life_cycle(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + enable (bool): lifecycle needed flag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.set_life_cycle_endpoint.call_with_http_info(**kwargs) + + def sync_devices( + self, + **kwargs + ): + """sync_devices # noqa: E501 + + Sync devices from Smart-Account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + smart_account_model (SmartAccountModel): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_devices_endpoint.call_with_http_info(**kwargs) + + def sync_root_cert_chain( + self, + **kwargs + ): + """sync_root_cert_chain # noqa: E501 + + Sync root certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_root_cert_chain(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_root_cert_chain_endpoint.call_with_http_info(**kwargs) + + def update_device_subject_sudi( + self, + uuid, + **kwargs + ): + """update_device_subject_sudi # noqa: E501 + + update subject sudi value of given device uuid # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_device_subject_sudi(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.update_device_subject_sudi_endpoint.call_with_http_info(**kwargs) + + def validate_user( + self, + **kwargs + ): + """validate_user # noqa: E501 + + Authenticate vSmart user account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_user(async_req=True) + >>> result = thread.get() + + + Keyword Args: + smart_account_model (SmartAccountModel): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.validate_user_endpoint.call_with_http_info(**kwargs) + + def validate_user1( + self, + **kwargs + ): + """validate_user1 # noqa: E501 + + Authenticate vSmart user account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_user1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.validate_user1_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_software_package_api.py b/openapi_client/api/configuration_device_software_package_api.py new file mode 100644 index 0000000..42fb436 --- /dev/null +++ b/openapi_client/api/configuration_device_software_package_api.py @@ -0,0 +1,574 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDeviceSoftwarePackageApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_vnf_package_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/package/custom/vnfPackage', + 'operation_id': 'create_vnf_package', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_config_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/package/custom/file/{uuid}', + 'operation_id': 'edit_config_file', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + 'body', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_file_contents_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/package/custom/file/{uuid}', + 'operation_id': 'get_file_contents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.upload_image_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/package/custom/uploads/{type}', + 'operation_id': 'upload_image_file', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "IMAGE": "image", + "FILE": "file" + }, + }, + 'openapi_types': { + 'type': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_vnf_package( + self, + **kwargs + ): + """create_vnf_package # noqa: E501 + + Create VNF custom package # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_vnf_package(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Custom package. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_vnf_package_endpoint.call_with_http_info(**kwargs) + + def edit_config_file( + self, + uuid, + **kwargs + ): + """edit_config_file # noqa: E501 + + Edit bootstrap file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_config_file(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): File uuid + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Bootstrap file. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.edit_config_file_endpoint.call_with_http_info(**kwargs) + + def get_file_contents( + self, + uuid, + **kwargs + ): + """get_file_contents # noqa: E501 + + Get bootstrap file contents # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_file_contents(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): File uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_file_contents_endpoint.call_with_http_info(**kwargs) + + def upload_image_file( + self, + type, + **kwargs + ): + """upload_image_file # noqa: E501 + + Upload virtual image/bootstrap file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_image_file(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Upload file type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.upload_image_file_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_software_update_api.py b/openapi_client/api/configuration_device_software_update_api.py new file mode 100644 index 0000000..0b1769b --- /dev/null +++ b/openapi_client/api/configuration_device_software_update_api.py @@ -0,0 +1,853 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.software_upload_file_data import SoftwareUploadFileData + + +class ConfigurationDeviceSoftwareUpdateApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.download_package_file_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/package/{fileName}', + 'operation_id': 'download_package_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'file_name', + 'image_type', + ], + 'required': [ + 'file_name', + 'image_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'file_name': + (str,), + 'image_type': + (str,), + }, + 'attribute_map': { + 'file_name': 'fileName', + 'image_type': 'imageType', + }, + 'location_map': { + 'file_name': 'path', + 'image_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_image_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/package/{versionId}/metadata', + 'operation_id': 'edit_image_metadata', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + 'body', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_image_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/package/{versionId}/metadata', + 'operation_id': 'get_image_metadata', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_upload_images_count_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/package/imageCount', + 'operation_id': 'get_upload_images_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'image_type', + ], + 'required': [ + 'image_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'image_type': + ([str],), + }, + 'attribute_map': { + 'image_type': 'imageType', + }, + 'location_map': { + 'image_type': 'query', + }, + 'collection_format_map': { + 'image_type': 'multi', + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.install_pkg_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/package', + 'operation_id': 'install_pkg', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data', + 'file', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data': + (SoftwareUploadFileData,), + 'file': + (file_type,), + }, + 'attribute_map': { + 'data': 'data', + 'file': 'file', + }, + 'location_map': { + 'data': 'form', + 'file': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + self.process_software_image_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/package/{imageType}', + 'operation_id': 'process_software_image', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'image_type', + 'data', + 'file', + ], + 'required': [ + 'image_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'image_type': + (str,), + 'data': + (SoftwareUploadFileData,), + 'file': + (file_type,), + }, + 'attribute_map': { + 'image_type': 'imageType', + 'data': 'data', + 'file': 'file', + }, + 'location_map': { + 'image_type': 'path', + 'data': 'form', + 'file': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + + def download_package_file( + self, + file_name, + image_type="software", + **kwargs + ): + """download_package_file # noqa: E501 + + Download software package file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_package_file(file_name, image_type="software", async_req=True) + >>> result = thread.get() + + Args: + file_name (str): Pakcage file name + image_type (str): Image type. defaults to "software", must be one of ["software"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['file_name'] = \ + file_name + kwargs['image_type'] = \ + image_type + return self.download_package_file_endpoint.call_with_http_info(**kwargs) + + def edit_image_metadata( + self, + version_id, + **kwargs + ): + """edit_image_metadata # noqa: E501 + + Update Package Metadata # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_image_metadata(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Image ID + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.edit_image_metadata_endpoint.call_with_http_info(**kwargs) + + def get_image_metadata( + self, + version_id, + **kwargs + ): + """get_image_metadata # noqa: E501 + + Update Package Metadata # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_image_metadata(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Image ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.get_image_metadata_endpoint.call_with_http_info(**kwargs) + + def get_upload_images_count( + self, + image_type, + **kwargs + ): + """get_upload_images_count # noqa: E501 + + Number of software image presented in vManage repository # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_upload_images_count(image_type, async_req=True) + >>> result = thread.get() + + Args: + image_type ([str]): Image type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['image_type'] = \ + image_type + return self.get_upload_images_count_endpoint.call_with_http_info(**kwargs) + + def install_pkg( + self, + **kwargs + ): + """install_pkg # noqa: E501 + + Install software package # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.install_pkg(async_req=True) + >>> result = thread.get() + + + Keyword Args: + data (SoftwareUploadFileData): [optional] + file (file_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.install_pkg_endpoint.call_with_http_info(**kwargs) + + def process_software_image( + self, + image_type, + **kwargs + ): + """process_software_image # noqa: E501 + + Install software image package # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_software_image(image_type, async_req=True) + >>> result = thread.get() + + Args: + image_type (str): Image type + + Keyword Args: + data (SoftwareUploadFileData): [optional] + file (file_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['image_type'] = \ + image_type + return self.process_software_image_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_ssl_proxy_certificate_management_api.py b/openapi_client/api/configuration_device_ssl_proxy_certificate_management_api.py new file mode 100644 index 0000000..f855e05 --- /dev/null +++ b/openapi_client/api/configuration_device_ssl_proxy_certificate_management_api.py @@ -0,0 +1,3041 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDeviceSSLProxyCertificateManagementApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_wan_edge_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/sslproxy/certificate/wanedge/{deviceId}', + 'operation_id': 'add_wan_edge', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'body', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_ssl_proxy_csr_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/sslproxy/generate/csr/sslproxy', + 'operation_id': 'generate_ssl_proxy_csr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_ssl_proxy_csr_0_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/generate/vmanage/csr', + 'operation_id': 'generate_ssl_proxy_csr_0', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_all_device_certificates_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/devicecertificates', + 'operation_id': 'get_all_device_certificates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_all_device_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/devicecsr', + 'operation_id': 'get_all_device_csr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_certificate_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/certificate', + 'operation_id': 'get_certificate_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_enterprise_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/enterprise/certificate', + 'operation_id': 'get_enterprise_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_proxy_cert_of_edge_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/certificate', + 'operation_id': 'get_proxy_cert_of_edge', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_self_signed_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/certificate/vmanage/selfsignedcert', + 'operation_id': 'get_self_signed_cert', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ssl_proxy_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/csr', + 'operation_id': 'get_ssl_proxy_csr', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ssl_proxy_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/sslproxy/list', + 'operation_id': 'get_ssl_proxy_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_manage_enterprise_root_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/enterprise/rootca', + 'operation_id': 'get_v_manage_enterprise_root_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_manage_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/vmanage/certificate', + 'operation_id': 'getv_manage_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_manage_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/vmanage/csr', + 'operation_id': 'getv_manage_csr', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_manage_root_ca_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/vmanage/rootca', + 'operation_id': 'getv_manage_root_ca', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.renew_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/renew', + 'operation_id': 'renew_certificate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.revoke_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/revoke', + 'operation_id': 'revoke_certificate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.revoke_renew_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/revokerenew', + 'operation_id': 'revoke_renew_certificate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.set_enterprise_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/enterprise/certificate', + 'operation_id': 'set_enterprise_cert', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.set_enterprise_root_ca_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/enterprise/rootca', + 'operation_id': 'set_enterprise_root_ca_cert', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.setv_manage_root_ca_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/vmanage/rootca', + 'operation_id': 'setv_manage_root_ca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.setv_manageintermediate_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/settings/vmanage/certificate', + 'operation_id': 'setv_manageintermediate_cert', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sslproxy/certificate', + 'operation_id': 'update_certificate', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_certificiates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/sslproxy/certificates', + 'operation_id': 'upload_certificiates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + + def add_wan_edge( + self, + device_id, + **kwargs + ): + """add_wan_edge # noqa: E501 + + Add SSL proxy wan edge # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_wan_edge(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cert state. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.add_wan_edge_endpoint.call_with_http_info(**kwargs) + + def generate_ssl_proxy_csr( + self, + **kwargs + ): + """generate_ssl_proxy_csr # noqa: E501 + + CSR request SSL proxy for edge # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_ssl_proxy_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request for edge. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_ssl_proxy_csr_endpoint.call_with_http_info(**kwargs) + + def generate_ssl_proxy_csr_0( + self, + **kwargs + ): + """generate_ssl_proxy_csr_0 # noqa: E501 + + Generate CSR # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_ssl_proxy_csr_0(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_ssl_proxy_csr_0_endpoint.call_with_http_info(**kwargs) + + def get_all_device_certificates( + self, + **kwargs + ): + """get_all_device_certificates # noqa: E501 + + Get certificate for all cEdges # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_device_certificates(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_device_certificates_endpoint.call_with_http_info(**kwargs) + + def get_all_device_csr( + self, + **kwargs + ): + """get_all_device_csr # noqa: E501 + + Get CSR for all cEdges # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_device_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_device_csr_endpoint.call_with_http_info(**kwargs) + + def get_certificate_state( + self, + **kwargs + ): + """get_certificate_state # noqa: E501 + + Get certificate state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_certificate_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_certificate_state_endpoint.call_with_http_info(**kwargs) + + def get_enterprise_certificate( + self, + **kwargs + ): + """get_enterprise_certificate # noqa: E501 + + Get enterprise certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_enterprise_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_enterprise_certificate_endpoint.call_with_http_info(**kwargs) + + def get_proxy_cert_of_edge( + self, + device_id, + **kwargs + ): + """get_proxy_cert_of_edge # noqa: E501 + + Get edge proxy certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_proxy_cert_of_edge(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_proxy_cert_of_edge_endpoint.call_with_http_info(**kwargs) + + def get_self_signed_cert( + self, + **kwargs + ): + """get_self_signed_cert # noqa: E501 + + get self signed certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_self_signed_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_self_signed_cert_endpoint.call_with_http_info(**kwargs) + + def get_ssl_proxy_csr( + self, + device_id, + **kwargs + ): + """get_ssl_proxy_csr # noqa: E501 + + Get SSL proxy CSR # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ssl_proxy_csr(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): device UUID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_ssl_proxy_csr_endpoint.call_with_http_info(**kwargs) + + def get_ssl_proxy_list( + self, + **kwargs + ): + """get_ssl_proxy_list # noqa: E501 + + Get SSL proxy certificate list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ssl_proxy_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_ssl_proxy_list_endpoint.call_with_http_info(**kwargs) + + def get_v_manage_enterprise_root_certificate( + self, + **kwargs + ): + """get_v_manage_enterprise_root_certificate # noqa: E501 + + Get vManage enterprise root certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_manage_enterprise_root_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_v_manage_enterprise_root_certificate_endpoint.call_with_http_info(**kwargs) + + def getv_manage_certificate( + self, + **kwargs + ): + """getv_manage_certificate # noqa: E501 + + Get vManage intermediate certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_manage_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getv_manage_certificate_endpoint.call_with_http_info(**kwargs) + + def getv_manage_csr( + self, + **kwargs + ): + """getv_manage_csr # noqa: E501 + + Get vManage CSR # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_manage_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getv_manage_csr_endpoint.call_with_http_info(**kwargs) + + def getv_manage_root_ca( + self, + **kwargs + ): + """getv_manage_root_ca # noqa: E501 + + Get vManage root certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_manage_root_ca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getv_manage_root_ca_endpoint.call_with_http_info(**kwargs) + + def renew_certificate( + self, + **kwargs + ): + """renew_certificate # noqa: E501 + + Renew device certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.renew_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Renew device certificate request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.renew_certificate_endpoint.call_with_http_info(**kwargs) + + def revoke_certificate( + self, + **kwargs + ): + """revoke_certificate # noqa: E501 + + Revoke device certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.revoke_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Revoke device certificate request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.revoke_certificate_endpoint.call_with_http_info(**kwargs) + + def revoke_renew_certificate( + self, + **kwargs + ): + """revoke_renew_certificate # noqa: E501 + + Revoke and renew device certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.revoke_renew_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Revoke device certificate request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.revoke_renew_certificate_endpoint.call_with_http_info(**kwargs) + + def set_enterprise_cert( + self, + **kwargs + ): + """set_enterprise_cert # noqa: E501 + + Configure enterprise certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_enterprise_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Config enterprise certificate request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.set_enterprise_cert_endpoint.call_with_http_info(**kwargs) + + def set_enterprise_root_ca_cert( + self, + **kwargs + ): + """set_enterprise_root_ca_cert # noqa: E501 + + Set vManage enterprise root certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_enterprise_root_ca_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Set enterprise root CA request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.set_enterprise_root_ca_cert_endpoint.call_with_http_info(**kwargs) + + def setv_manage_root_ca( + self, + **kwargs + ): + """setv_manage_root_ca # noqa: E501 + + Set vManage root certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setv_manage_root_ca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Set vManage root CA request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.setv_manage_root_ca_endpoint.call_with_http_info(**kwargs) + + def setv_manageintermediate_cert( + self, + **kwargs + ): + """setv_manageintermediate_cert # noqa: E501 + + Set vManage root certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setv_manageintermediate_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Set vManage intermediate CA request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.setv_manageintermediate_cert_endpoint.call_with_http_info(**kwargs) + + def update_certificate( + self, + **kwargs + ): + """update_certificate # noqa: E501 + + Upload device certificate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Upload device certificate. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_certificate_endpoint.call_with_http_info(**kwargs) + + def upload_certificiates( + self, + **kwargs + ): + """upload_certificiates # noqa: E501 + + Upload device certificates # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_certificiates(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.upload_certificiates_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_device_template_api.py b/openapi_client/api/configuration_device_template_api.py new file mode 100644 index 0000000..b5d4392 --- /dev/null +++ b/openapi_client/api/configuration_device_template_api.py @@ -0,0 +1,2586 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class ConfigurationDeviceTemplateApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.attach_device_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/attachment', + 'operation_id': 'attach_device_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.check_vbond_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/vbond', + 'operation_id': 'check_vbond', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_input_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/input', + 'operation_id': 'create_device_input', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_input_without_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/exportcsv', + 'operation_id': 'create_input_without_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.detach_device_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/device/config/detach', + 'operation_id': 'detach_device_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.detach_sites_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/template/device/config/detachcloudx', + 'operation_id': 'detach_sites', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_cloudx_config_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/template/device/config/attachcloudx', + 'operation_id': 'edit_cloudx_config', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_attached_config_to_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/attachedconfig', + 'operation_id': 'get_attached_config_to_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'policy_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'policy_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'policy_id': 'policyId', + }, + 'location_map': { + 'device_id': 'query', + 'policy_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_attached_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/config/attached/{masterTemplateId}', + 'operation_id': 'get_attached_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'master_template_id', + ], + 'required': [ + 'master_template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'master_template_id': + (str,), + }, + 'attribute_map': { + 'master_template_id': 'masterTemplateId', + }, + 'location_map': { + 'master_template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_configuration_preview_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/template/device/config/config', + 'operation_id': 'get_device_configuration_preview', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_list_by_master_template_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/config/available/{masterTemplateId}', + 'operation_id': 'get_device_list_by_master_template_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'master_template_id', + ], + 'required': [ + 'master_template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'master_template_id': + (str,), + }, + 'attribute_map': { + 'master_template_id': 'masterTemplateId', + }, + 'location_map': { + 'master_template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_devices_with_duplicate_ip_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/config/duplicateip', + 'operation_id': 'get_devices_with_duplicate_ip', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_devices_with_duplicate_location_name_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/config/duplicatelocationname', + 'operation_id': 'get_devices_with_duplicate_location_name', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_quick_connect_variables_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/quickconnectvariable', + 'operation_id': 'get_quick_connect_variables', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_input_comma_sep_file_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/template/device/config/process/input/file', + 'operation_id': 'process_input_comma_sep_file', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + self.push_cli_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/attachcli', + 'operation_id': 'push_cli_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.push_cloudx_config_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/template/device/config/attachcloudx', + 'operation_id': 'push_cloudx_config', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.push_master_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/attachfeature', + 'operation_id': 'push_master_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.push_master_template1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/config/attachBootStrap', + 'operation_id': 'push_master_template1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/device/config/verify', + 'operation_id': 'validate_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def attach_device_template( + self, + **kwargs + ): + """attach_device_template # noqa: E501 + + Attach device template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.attach_device_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.attach_device_template_endpoint.call_with_http_info(**kwargs) + + def check_vbond( + self, + **kwargs + ): + """check_vbond # noqa: E501 + + Check if vBond is configured


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_vbond(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_vbond_endpoint.call_with_http_info(**kwargs) + + def create_device_input( + self, + **kwargs + ): + """create_device_input # noqa: E501 + + Create device input


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_input(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template device input. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_device_input_endpoint.call_with_http_info(**kwargs) + + def create_input_without_device( + self, + **kwargs + ): + """create_input_without_device # noqa: E501 + + Export the device template to CSV format for given template id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_input_without_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_input_without_device_endpoint.call_with_http_info(**kwargs) + + def detach_device_template( + self, + **kwargs + ): + """detach_device_template # noqa: E501 + + Detach device template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detach_device_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.detach_device_template_endpoint.call_with_http_info(**kwargs) + + def detach_sites( + self, + **kwargs + ): + """detach_sites # noqa: E501 + + Disable enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detach_sites(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CloudX config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.detach_sites_endpoint.call_with_http_info(**kwargs) + + def edit_cloudx_config( + self, + **kwargs + ): + """edit_cloudx_config # noqa: E501 + + Edit already enabled gateways, clients, dias


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_cloudx_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CloudX config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edit_cloudx_config_endpoint.call_with_http_info(**kwargs) + + def get_attached_config_to_device( + self, + device_id, + **kwargs + ): + """get_attached_config_to_device # noqa: E501 + + Get attached config to device


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_attached_config_to_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Model ID + + Keyword Args: + policy_id (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_attached_config_to_device_endpoint.call_with_http_info(**kwargs) + + def get_attached_device_list( + self, + master_template_id, + **kwargs + ): + """get_attached_device_list # noqa: E501 + + Get attached device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_attached_device_list(master_template_id, async_req=True) + >>> result = thread.get() + + Args: + master_template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['master_template_id'] = \ + master_template_id + return self.get_attached_device_list_endpoint.call_with_http_info(**kwargs) + + def get_device_configuration_preview( + self, + **kwargs + ): + """get_device_configuration_preview # noqa: E501 + + Get device configuration


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_configuration_preview(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_configuration_preview_endpoint.call_with_http_info(**kwargs) + + def get_device_list_by_master_template_id( + self, + master_template_id, + **kwargs + ): + """get_device_list_by_master_template_id # noqa: E501 + + Get possible device list by master template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_list_by_master_template_id(master_template_id, async_req=True) + >>> result = thread.get() + + Args: + master_template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['master_template_id'] = \ + master_template_id + return self.get_device_list_by_master_template_id_endpoint.call_with_http_info(**kwargs) + + def get_devices_with_duplicate_ip( + self, + **kwargs + ): + """get_devices_with_duplicate_ip # noqa: E501 + + Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_with_duplicate_ip(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_with_duplicate_ip_endpoint.call_with_http_info(**kwargs) + + def get_devices_with_duplicate_location_name( + self, + **kwargs + ): + """get_devices_with_duplicate_location_name # noqa: E501 + + Detects duplicate system IP from a list of devices


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_with_duplicate_location_name(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_with_duplicate_location_name_endpoint.call_with_http_info(**kwargs) + + def get_quick_connect_variables( + self, + **kwargs + ): + """get_quick_connect_variables # noqa: E501 + + Get connection variables to be configured # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_quick_connect_variables(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device List. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_quick_connect_variables_endpoint.call_with_http_info(**kwargs) + + def process_input_comma_sep_file( + self, + **kwargs + ): + """process_input_comma_sep_file # noqa: E501 + + Process input comma separated file


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_input_comma_sep_file(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_input_comma_sep_file_endpoint.call_with_http_info(**kwargs) + + def push_cli_template( + self, + **kwargs + ): + """push_cli_template # noqa: E501 + + Attach CLI device template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_cli_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.push_cli_template_endpoint.call_with_http_info(**kwargs) + + def push_cloudx_config( + self, + **kwargs + ): + """push_cloudx_config # noqa: E501 + + Enable gateways, clients, dias # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_cloudx_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CloudX config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.push_cloudx_config_endpoint.call_with_http_info(**kwargs) + + def push_master_template( + self, + **kwargs + ): + """push_master_template # noqa: E501 + + Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_master_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.push_master_template_endpoint.call_with_http_info(**kwargs) + + def push_master_template1( + self, + **kwargs + ): + """push_master_template1 # noqa: E501 + + Attach feature device template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_master_template1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.push_master_template1_endpoint.call_with_http_info(**kwargs) + + def validate_template( + self, + **kwargs + ): + """validate_template # noqa: E501 + + Validate full template\"


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.validate_template_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_disaster_recovery_api.py b/openapi_client/api/configuration_disaster_recovery_api.py new file mode 100644 index 0000000..3a7b4c3 --- /dev/null +++ b/openapi_client/api/configuration_disaster_recovery_api.py @@ -0,0 +1,4941 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDisasterRecoveryApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.activate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/activate', + 'operation_id': 'activate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/deregister', + 'operation_id': 'delete', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_dc_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/deleteRemoteDataCenter', + 'operation_id': 'delete_dc', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_local_dc_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/deleteLocalDataCenter', + 'operation_id': 'delete_local_dc', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.disaster_recovery_pause_replication_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/pausereplication', + 'operation_id': 'disaster_recovery_pause_replication', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.disaster_recovery_replication_request_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/disasterrecovery/requestimport', + 'operation_id': 'disaster_recovery_replication_request', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.disaster_recovery_un_pause_replication_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/unpausereplication', + 'operation_id': 'disaster_recovery_un_pause_replication', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/download/backup/{token}/db_bkp.tar.gz', + 'operation_id': 'download', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'token', + ], + 'required': [ + 'token', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'token': + (str,), + }, + 'attribute_map': { + 'token': 'token', + }, + 'location_map': { + 'token': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_replication_data_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/download/{token}/{fileName}', + 'operation_id': 'download_replication_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'token', + 'file_name', + ], + 'required': [ + 'token', + 'file_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'token': + (str,), + 'file_name': + (str,), + }, + 'attribute_map': { + 'token': 'token', + 'file_name': 'fileName', + }, + 'location_map': { + 'token': 'path', + 'file_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/usernames', + 'operation_id': 'get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cluster_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/clusterInfo', + 'operation_id': 'get_cluster_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_db_restore_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/dbrestorestatus', + 'operation_id': 'get_config_db_restore_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/details', + 'operation_id': 'get_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_disaster_recovery_local_replication_schedule_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/schedule', + 'operation_id': 'get_disaster_recovery_local_replication_schedule', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_disaster_recovery_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/drstatus', + 'operation_id': 'get_disaster_recovery_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_history_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/history', + 'operation_id': 'get_history', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_local_data_center_state_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/localdc', + 'operation_id': 'get_local_data_center_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_local_history_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/localLatestHistory', + 'operation_id': 'get_local_history', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_reachability_info_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/validateNodes', + 'operation_id': 'get_reachability_info', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'request_body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'request_body': + ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + }, + 'attribute_map': { + }, + 'location_map': { + 'request_body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_remote_data_center_state_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/remotedc', + 'operation_id': 'get_remote_data_center_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_remote_data_center_version_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/remotedc/swversion', + 'operation_id': 'get_remote_data_center_version', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_remote_dc_members_state_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/disasterrecovery/remoteDcState', + 'operation_id': 'get_remote_dc_members_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getdr_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/status', + 'operation_id': 'getdr_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pause_dr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/pause', + 'operation_id': 'pause_dr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pause_local_arbitrator_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/pauseLocalArbitrator', + 'operation_id': 'pause_local_arbitrator', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pause_local_dc_for_dr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/pauseLocalDC', + 'operation_id': 'pause_local_dc_for_dr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pause_local_dc_replication_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/pauseLocalReplication', + 'operation_id': 'pause_local_dc_replication', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.register_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/register', + 'operation_id': 'register', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.restart_data_center_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/restartDataCenter', + 'operation_id': 'restart_data_center', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.restore_config_db_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/dbrestore', + 'operation_id': 'restore_config_db', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.unpause_dr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/unpause', + 'operation_id': 'unpause_dr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.unpause_local_arbitrator_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/unpauseLocalArbitrator', + 'operation_id': 'unpause_local_arbitrator', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.unpause_local_dc_for_dr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/unpauseLocalDC', + 'operation_id': 'unpause_local_dc_for_dr', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.unpause_local_dc_replication_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/unpauseLocalReplication', + 'operation_id': 'unpause_local_dc_replication', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/password', + 'operation_id': 'update', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/register', + 'operation_id': 'update1', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_disaster_recovery_state_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/disasterrecovery/remotePassword', + 'operation_id': 'update_disaster_recovery_state', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_disaster_recovery_state1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/disasterrecovery/remotedc', + 'operation_id': 'update_disaster_recovery_state1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_dr_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/disasterrecovery/updateDRConfigOnArbitrator', + 'operation_id': 'update_dr_state', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_replication_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/disasterrecovery/updateReplication', + 'operation_id': 'update_replication', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def activate( + self, + **kwargs + ): + """activate # noqa: E501 + + Activate cluster to start working as primary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.activate_endpoint.call_with_http_info(**kwargs) + + def delete( + self, + **kwargs + ): + """delete # noqa: E501 + + Delete disaster recovery # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_endpoint.call_with_http_info(**kwargs) + + def delete_dc( + self, + **kwargs + ): + """delete_dc # noqa: E501 + + Delete data center # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_dc(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_dc_endpoint.call_with_http_info(**kwargs) + + def delete_local_dc( + self, + **kwargs + ): + """delete_local_dc # noqa: E501 + + Delete local data center # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_local_dc(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_local_dc_endpoint.call_with_http_info(**kwargs) + + def disaster_recovery_pause_replication( + self, + **kwargs + ): + """disaster_recovery_pause_replication # noqa: E501 + + Pause DR data replication # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disaster_recovery_pause_replication(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.disaster_recovery_pause_replication_endpoint.call_with_http_info(**kwargs) + + def disaster_recovery_replication_request( + self, + **kwargs + ): + """disaster_recovery_replication_request # noqa: E501 + + Replication Request message sent from primary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disaster_recovery_replication_request(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): DR request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.disaster_recovery_replication_request_endpoint.call_with_http_info(**kwargs) + + def disaster_recovery_un_pause_replication( + self, + **kwargs + ): + """disaster_recovery_un_pause_replication # noqa: E501 + + Un-Pause DR data replication # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disaster_recovery_un_pause_replication(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.disaster_recovery_un_pause_replication_endpoint.call_with_http_info(**kwargs) + + def download( + self, + token, + **kwargs + ): + """download # noqa: E501 + + Downloading stats file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download(token, async_req=True) + >>> result = thread.get() + + Args: + token (str): Token + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['token'] = \ + token + return self.download_endpoint.call_with_http_info(**kwargs) + + def download_replication_data( + self, + token, + file_name, + **kwargs + ): + """download_replication_data # noqa: E501 + + Download replication data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_replication_data(token, file_name, async_req=True) + >>> result = thread.get() + + Args: + token (str): Token + file_name (str): File name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['token'] = \ + token + kwargs['file_name'] = \ + file_name + return self.download_replication_data_endpoint.call_with_http_info(**kwargs) + + def get( + self, + **kwargs + ): + """get # noqa: E501 + + Fetch data centers and vBonds usernames for disaster recovery # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter/vBond password update request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_endpoint.call_with_http_info(**kwargs) + + def get_cluster_info( + self, + **kwargs + ): + """get_cluster_info # noqa: E501 + + Get disaster recovery cluster info # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cluster_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cluster_info_endpoint.call_with_http_info(**kwargs) + + def get_config_db_restore_status( + self, + **kwargs + ): + """get_config_db_restore_status # noqa: E501 + + Config-db restore status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_db_restore_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_config_db_restore_status_endpoint.call_with_http_info(**kwargs) + + def get_details( + self, + **kwargs + ): + """get_details # noqa: E501 + + Get disaster recovery details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_details_endpoint.call_with_http_info(**kwargs) + + def get_disaster_recovery_local_replication_schedule( + self, + **kwargs + ): + """get_disaster_recovery_local_replication_schedule # noqa: E501 + + Get disaster recovery local replication schedule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_disaster_recovery_local_replication_schedule(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_disaster_recovery_local_replication_schedule_endpoint.call_with_http_info(**kwargs) + + def get_disaster_recovery_status( + self, + **kwargs + ): + """get_disaster_recovery_status # noqa: E501 + + Disaster recovery status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_disaster_recovery_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_disaster_recovery_status_endpoint.call_with_http_info(**kwargs) + + def get_history( + self, + **kwargs + ): + """get_history # noqa: E501 + + Get disaster recovery switchover history # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_history(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_history_endpoint.call_with_http_info(**kwargs) + + def get_local_data_center_state( + self, + **kwargs + ): + """get_local_data_center_state # noqa: E501 + + Get local data center details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_local_data_center_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_local_data_center_state_endpoint.call_with_http_info(**kwargs) + + def get_local_history( + self, + **kwargs + ): + """get_local_history # noqa: E501 + + Get disaster recovery local switchover history # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_local_history(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_local_history_endpoint.call_with_http_info(**kwargs) + + def get_reachability_info( + self, + **kwargs + ): + """get_reachability_info # noqa: E501 + + Validate a list of nodes # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_reachability_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + request_body ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Node list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_reachability_info_endpoint.call_with_http_info(**kwargs) + + def get_remote_data_center_state( + self, + **kwargs + ): + """get_remote_data_center_state # noqa: E501 + + Get remote data center details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_remote_data_center_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_remote_data_center_state_endpoint.call_with_http_info(**kwargs) + + def get_remote_data_center_version( + self, + **kwargs + ): + """get_remote_data_center_version # noqa: E501 + + Get remote data center vManage version # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_remote_data_center_version(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_remote_data_center_version_endpoint.call_with_http_info(**kwargs) + + def get_remote_dc_members_state( + self, + **kwargs + ): + """get_remote_dc_members_state # noqa: E501 + + Gets remote data center member state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_remote_dc_members_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_remote_dc_members_state_endpoint.call_with_http_info(**kwargs) + + def getdr_status( + self, + **kwargs + ): + """getdr_status # noqa: E501 + + Get disaster recovery status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getdr_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getdr_status_endpoint.call_with_http_info(**kwargs) + + def pause_dr( + self, + **kwargs + ): + """pause_dr # noqa: E501 + + Pause DR # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pause_dr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.pause_dr_endpoint.call_with_http_info(**kwargs) + + def pause_local_arbitrator( + self, + **kwargs + ): + """pause_local_arbitrator # noqa: E501 + + Pause DR for Local Arbitrator # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pause_local_arbitrator(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.pause_local_arbitrator_endpoint.call_with_http_info(**kwargs) + + def pause_local_dc_for_dr( + self, + **kwargs + ): + """pause_local_dc_for_dr # noqa: E501 + + Pause DR for Local datacenter # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pause_local_dc_for_dr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.pause_local_dc_for_dr_endpoint.call_with_http_info(**kwargs) + + def pause_local_dc_replication( + self, + **kwargs + ): + """pause_local_dc_replication # noqa: E501 + + Pause DR replication for Local datacenter # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pause_local_dc_replication(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.pause_local_dc_replication_endpoint.call_with_http_info(**kwargs) + + def register( + self, + **kwargs + ): + """register # noqa: E501 + + Register data centers for disaster recovery # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.register(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter registration request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.register_endpoint.call_with_http_info(**kwargs) + + def restart_data_center( + self, + **kwargs + ): + """restart_data_center # noqa: E501 + + Restart data center # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.restart_data_center(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter registration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.restart_data_center_endpoint.call_with_http_info(**kwargs) + + def restore_config_db( + self, + **kwargs + ): + """restore_config_db # noqa: E501 + + Signal vManage to initiate configuration-db restore operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.restore_config_db(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Config-db meta payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.restore_config_db_endpoint.call_with_http_info(**kwargs) + + def unpause_dr( + self, + **kwargs + ): + """unpause_dr # noqa: E501 + + Unpause DR # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unpause_dr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.unpause_dr_endpoint.call_with_http_info(**kwargs) + + def unpause_local_arbitrator( + self, + **kwargs + ): + """unpause_local_arbitrator # noqa: E501 + + Unpause DR for Local Arbitrator # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unpause_local_arbitrator(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.unpause_local_arbitrator_endpoint.call_with_http_info(**kwargs) + + def unpause_local_dc_for_dr( + self, + **kwargs + ): + """unpause_local_dc_for_dr # noqa: E501 + + Unpause DR for Local datacenter # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unpause_local_dc_for_dr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.unpause_local_dc_for_dr_endpoint.call_with_http_info(**kwargs) + + def unpause_local_dc_replication( + self, + **kwargs + ): + """unpause_local_dc_replication # noqa: E501 + + Unpause DR replication for local datacenter # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unpause_local_dc_replication(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.unpause_local_dc_replication_endpoint.call_with_http_info(**kwargs) + + def update( + self, + **kwargs + ): + """update # noqa: E501 + + Update data centers and vBonds passwords for disaster recovery # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter/vBond password update request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_endpoint.call_with_http_info(**kwargs) + + def update1( + self, + **kwargs + ): + """update1 # noqa: E501 + + Update data centers for disaster recovery # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter registration request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update1_endpoint.call_with_http_info(**kwargs) + + def update_disaster_recovery_state( + self, + **kwargs + ): + """update_disaster_recovery_state # noqa: E501 + + Update disaster recovery information with updated password to remote data center # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_disaster_recovery_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter registration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_disaster_recovery_state_endpoint.call_with_http_info(**kwargs) + + def update_disaster_recovery_state1( + self, + **kwargs + ): + """update_disaster_recovery_state1 # noqa: E501 + + Update complete disaster recovery information to remote data center # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_disaster_recovery_state1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Datacenter registration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_disaster_recovery_state1_endpoint.call_with_http_info(**kwargs) + + def update_dr_state( + self, + **kwargs + ): + """update_dr_state # noqa: E501 + + Update arbitrator with primary and secondary states cluster # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_dr_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_dr_state_endpoint.call_with_http_info(**kwargs) + + def update_replication( + self, + **kwargs + ): + """update_replication # noqa: E501 + + Update DR replication status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_replication(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Replication status. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_replication_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_downloaded_images_api.py b/openapi_client/api/configuration_downloaded_images_api.py new file mode 100644 index 0000000..f7f66f7 --- /dev/null +++ b/openapi_client/api/configuration_downloaded_images_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationDownloadedImagesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_software_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/downloadedImages', + 'operation_id': 'create_software_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_software_list( + self, + device_id, + **kwargs + ): + """create_software_list # noqa: E501 + + Get images list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_software_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_software_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_feature_certificate_api.py b/openapi_client/api/configuration_feature_certificate_api.py new file mode 100644 index 0000000..419b9c5 --- /dev/null +++ b/openapi_client/api/configuration_feature_certificate_api.py @@ -0,0 +1,803 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationFeatureCertificateApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.gen_device_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/featurecertificate/devicecsr', + 'operation_id': 'gen_device_csr', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/featurecertificate/certificate', + 'operation_id': 'get_device_certificate', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_csr_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/featurecertificate/devicecsr', + 'operation_id': 'get_device_csr', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_feature_ca_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/featurecertificate/syslogconfig', + 'operation_id': 'get_feature_ca_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.install_feature_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/featurecertificate/certificate', + 'operation_id': 'install_feature_certificate', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.revoke_feature_certificate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/featurecertificate/revoke', + 'operation_id': 'revoke_feature_certificate', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def gen_device_csr( + self, + **kwargs + ): + """gen_device_csr # noqa: E501 + + Create CSR for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.gen_device_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): CSR request for cEdge. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.gen_device_csr_endpoint.call_with_http_info(**kwargs) + + def get_device_certificate( + self, + device_id, + **kwargs + ): + """get_device_certificate # noqa: E501 + + Get feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_certificate(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_certificate_endpoint.call_with_http_info(**kwargs) + + def get_device_csr( + self, + device_id, + **kwargs + ): + """get_device_csr # noqa: E501 + + Get CSR from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_csr(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_csr_endpoint.call_with_http_info(**kwargs) + + def get_feature_ca_state( + self, + **kwargs + ): + """get_feature_ca_state # noqa: E501 + + Get Feature CA state


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_feature_ca_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_feature_ca_state_endpoint.call_with_http_info(**kwargs) + + def install_feature_certificate( + self, + **kwargs + ): + """install_feature_certificate # noqa: E501 + + Upload feature cert for cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.install_feature_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Install feature cert request for cEdge. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.install_feature_certificate_endpoint.call_with_http_info(**kwargs) + + def revoke_feature_certificate( + self, + **kwargs + ): + """revoke_feature_certificate # noqa: E501 + + Revoke feature cert from cEdge device


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.revoke_feature_certificate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Revoking feature cert request for cEdge. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.revoke_feature_certificate_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_feature_profile_mobility_api.py b/openapi_client/api/configuration_feature_profile_mobility_api.py new file mode 100644 index 0000000..0fa77cd --- /dev/null +++ b/openapi_client/api/configuration_feature_profile_mobility_api.py @@ -0,0 +1,5219 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.cellular import Cellular +from openapi_client.model.cellular_profile import CellularProfile +from openapi_client.model.ethernet import Ethernet +from openapi_client.model.network_protocol import NetworkProtocol +from openapi_client.model.security_policy import SecurityPolicy +from openapi_client.model.vpn import Vpn +from openapi_client.model.wifi import Wifi + + +class ConfigurationFeatureProfileMobilityApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_basic_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/basic', + 'operation_id': 'create_basic_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'body', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_cellular_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/cellular', + 'operation_id': 'create_cellular_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'cellular_profile', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'cellular_profile': + (CellularProfile,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'cellular_profile': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_ethernet_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/ethernet', + 'operation_id': 'create_ethernet_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'ethernet', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'ethernet': + (Ethernet,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'ethernet': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_network_protocol_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/networkProtocol', + 'operation_id': 'create_network_protocol_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'network_protocol', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'network_protocol': + (NetworkProtocol,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'network_protocol': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_security_policy_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/securityPolicy', + 'operation_id': 'create_security_policy_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'security_policy', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'security_policy': + (SecurityPolicy,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'security_policy': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_vpn_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/vpn', + 'operation_id': 'create_vpn_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'vpn', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'vpn': + (Vpn,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'vpn': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wifi_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/wifi', + 'operation_id': 'create_wifi_profile_parcel_for_mobility', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'wifi', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'wifi': + (Wifi,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'wifi': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_a_cellular_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}', + 'operation_id': 'delete_a_cellular_profile_parcel_for_mobility', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'cellular_id', + ], + 'required': [ + 'profile_id', + 'cellular_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'cellular_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'cellular_id': 'cellularId', + }, + 'location_map': { + 'profile_id': 'path', + 'cellular_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_a_vpn_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}', + 'operation_id': 'delete_a_vpn_profile_parcel_for_mobility', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'vpn_id', + ], + 'required': [ + 'profile_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'profile_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_basic_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}', + 'operation_id': 'delete_basic_profile_parcel_for_mobility', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'parcel_id', + ], + 'required': [ + 'profile_id', + 'parcel_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'parcel_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'parcel_id': 'parcelId', + }, + 'location_map': { + 'profile_id': 'path', + 'parcel_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_ethernet_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}', + 'operation_id': 'delete_ethernet_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'ethernet_id', + ], + 'required': [ + 'profile_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'profile_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_network_protocol_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}', + 'operation_id': 'delete_network_protocol_profile_parcel_for_mobility', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'network_protocol_id', + ], + 'required': [ + 'profile_id', + 'network_protocol_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'network_protocol_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'network_protocol_id': 'networkProtocolId', + }, + 'location_map': { + 'profile_id': 'path', + 'network_protocol_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_security_policy_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}', + 'operation_id': 'delete_security_policy_profile_parcel_for_mobility', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'security_policy_id', + ], + 'required': [ + 'profile_id', + 'security_policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'security_policy_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'security_policy_id': 'securityPolicyId', + }, + 'location_map': { + 'profile_id': 'path', + 'security_policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wifi_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}', + 'operation_id': 'delete_wifi_profile_parcel_for_mobility', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'wifi_id', + ], + 'required': [ + 'profile_id', + 'wifi_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'wifi_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'wifi_id': 'wifiId', + }, + 'location_map': { + 'profile_id': 'path', + 'wifi_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_basic_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}', + 'operation_id': 'edit_basic_profile_parcel_for_mobility', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'parcel_id', + 'body', + ], + 'required': [ + 'profile_id', + 'parcel_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'parcel_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'parcel_id': 'parcelId', + }, + 'location_map': { + 'profile_id': 'path', + 'parcel_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_cellular_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}', + 'operation_id': 'edit_cellular_profile_parcel_for_mobility', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'cellular_id', + 'cellular', + ], + 'required': [ + 'profile_id', + 'cellular_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'cellular_id': + (str,), + 'cellular': + (Cellular,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'cellular_id': 'cellularId', + }, + 'location_map': { + 'profile_id': 'path', + 'cellular_id': 'path', + 'cellular': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_ethernet_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}', + 'operation_id': 'edit_ethernet_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'ethernet_id', + 'body', + ], + 'required': [ + 'profile_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'ethernet_id': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'profile_id': 'path', + 'ethernet_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_network_protocol_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}', + 'operation_id': 'edit_network_protocol_profile_parcel_for_mobility', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'network_protocol_id', + 'network_protocol', + ], + 'required': [ + 'profile_id', + 'network_protocol_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'network_protocol_id': + (str,), + 'network_protocol': + (NetworkProtocol,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'network_protocol_id': 'networkProtocolId', + }, + 'location_map': { + 'profile_id': 'path', + 'network_protocol_id': 'path', + 'network_protocol': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_security_policy_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}', + 'operation_id': 'edit_security_policy_profile_parcel_for_mobility', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'security_policy_id', + 'security_policy', + ], + 'required': [ + 'profile_id', + 'security_policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'security_policy_id': + (str,), + 'security_policy': + (SecurityPolicy,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'security_policy_id': 'securityPolicyId', + }, + 'location_map': { + 'profile_id': 'path', + 'security_policy_id': 'path', + 'security_policy': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_vpn_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}', + 'operation_id': 'edit_vpn_profile_parcel_for_mobility', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'vpn_id', + 'vpn', + ], + 'required': [ + 'profile_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'vpn_id': + (str,), + 'vpn': + (Vpn,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'profile_id': 'path', + 'vpn_id': 'path', + 'vpn': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wifi_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}', + 'operation_id': 'edit_wifi_profile_parcel_for_mobility', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'wifi_id', + 'wifi', + ], + 'required': [ + 'profile_id', + 'wifi_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'wifi_id': + (str,), + 'wifi': + (Wifi,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'wifi_id': 'wifiId', + }, + 'location_map': { + 'profile_id': 'path', + 'wifi_id': 'path', + 'wifi': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_basic_profile_parcel_by_parcel_id_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}', + 'operation_id': 'get_basic_profile_parcel_by_parcel_id_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'parcel_id', + ], + 'required': [ + 'profile_id', + 'parcel_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'parcel_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'parcel_id': 'parcelId', + }, + 'location_map': { + 'profile_id': 'path', + 'parcel_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_basic_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/basic', + 'operation_id': 'get_basic_profile_parcel_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}', + 'operation_id': 'get_cellular_profile_parcel_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'cellular_id', + ], + 'required': [ + 'profile_id', + 'cellular_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'cellular_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'cellular_id': 'cellularId', + }, + 'location_map': { + 'profile_id': 'path', + 'cellular_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_profile_parcel_list_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/cellular', + 'operation_id': 'get_cellular_profile_parcel_list_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ethernet_profile_parcel_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}', + 'operation_id': 'get_ethernet_profile_parcel', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'ethernet_id', + ], + 'required': [ + 'profile_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'profile_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ethernet_profile_parcels_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/ethernet', + 'operation_id': 'get_ethernet_profile_parcels', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mobility_feature_profile_by_global_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}', + 'operation_id': 'get_mobility_feature_profile_by_global_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mobility_global_basic_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/basic/schema', + 'operation_id': 'get_mobility_global_basic_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_network_protocol_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}', + 'operation_id': 'get_network_protocol_profile_parcel_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'network_protocol_id', + ], + 'required': [ + 'profile_id', + 'network_protocol_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'network_protocol_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'network_protocol_id': 'networkProtocolId', + }, + 'location_map': { + 'profile_id': 'path', + 'network_protocol_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_network_protocol_profile_parcel_list_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/networkProtocol', + 'operation_id': 'get_network_protocol_profile_parcel_list_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_security_policy_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}', + 'operation_id': 'get_security_policy_profile_parcel_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'security_policy_id', + ], + 'required': [ + 'profile_id', + 'security_policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'security_policy_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'security_policy_id': 'securityPolicyId', + }, + 'location_map': { + 'profile_id': 'path', + 'security_policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_security_policy_profile_parcel_list_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/securityPolicy', + 'operation_id': 'get_security_policy_profile_parcel_list_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vpn_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}', + 'operation_id': 'get_vpn_profile_parcel_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'vpn_id', + ], + 'required': [ + 'profile_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'profile_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vpn_profile_parcel_list_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/vpn', + 'operation_id': 'get_vpn_profile_parcel_list_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wifi_profile_parcel_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}', + 'operation_id': 'get_wifi_profile_parcel_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'wifi_id', + ], + 'required': [ + 'profile_id', + 'wifi_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'wifi_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'wifi_id': 'wifiId', + }, + 'location_map': { + 'profile_id': 'path', + 'wifi_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wifi_profile_parcel_list_for_mobility_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/mobility/global/{profileId}/wifi', + 'operation_id': 'get_wifi_profile_parcel_list_for_mobility', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_basic_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_basic_profile_parcel_for_mobility # noqa: E501 + + Create a Basic Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_basic_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Basic Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_basic_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def create_cellular_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_cellular_profile_parcel_for_mobility # noqa: E501 + + Create an cellular Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cellular_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + cellular_profile (CellularProfile): Cellular Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_cellular_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def create_ethernet_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_ethernet_profile_parcel_for_mobility # noqa: E501 + + Create an ethernet Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ethernet_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + ethernet (Ethernet): Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_ethernet_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def create_network_protocol_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_network_protocol_profile_parcel_for_mobility # noqa: E501 + + Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_network_protocol_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + network_protocol (NetworkProtocol): NetworkProtocol Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_network_protocol_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def create_security_policy_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_security_policy_profile_parcel_for_mobility # noqa: E501 + + Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_security_policy_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + security_policy (SecurityPolicy): SecurityPolicy Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_security_policy_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def create_vpn_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_vpn_profile_parcel_for_mobility # noqa: E501 + + Create an Vpn Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_vpn_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + vpn (Vpn): Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_vpn_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def create_wifi_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """create_wifi_profile_parcel_for_mobility # noqa: E501 + + Create an Wifi Profile Parcel for Mobility feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wifi_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + wifi (Wifi): Wifi Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.create_wifi_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def delete_a_cellular_profile_parcel_for_mobility( + self, + profile_id, + cellular_id, + **kwargs + ): + """delete_a_cellular_profile_parcel_for_mobility # noqa: E501 + + Delete a Cellular Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_a_cellular_profile_parcel_for_mobility(profile_id, cellular_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + cellular_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['cellular_id'] = \ + cellular_id + return self.delete_a_cellular_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def delete_a_vpn_profile_parcel_for_mobility( + self, + profile_id, + vpn_id, + **kwargs + ): + """delete_a_vpn_profile_parcel_for_mobility # noqa: E501 + + Delete a Vpn Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_a_vpn_profile_parcel_for_mobility(profile_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['vpn_id'] = \ + vpn_id + return self.delete_a_vpn_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def delete_basic_profile_parcel_for_mobility( + self, + profile_id, + parcel_id, + **kwargs + ): + """delete_basic_profile_parcel_for_mobility # noqa: E501 + + Delete a Basic Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_basic_profile_parcel_for_mobility(profile_id, parcel_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + parcel_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['parcel_id'] = \ + parcel_id + return self.delete_basic_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def delete_ethernet_profile_parcel_for_system( + self, + profile_id, + ethernet_id, + **kwargs + ): + """delete_ethernet_profile_parcel_for_system # noqa: E501 + + Delete a Ethernet Profile Parcel for feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_ethernet_profile_parcel_for_system(profile_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + ethernet_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.delete_ethernet_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_network_protocol_profile_parcel_for_mobility( + self, + profile_id, + network_protocol_id, + **kwargs + ): + """delete_network_protocol_profile_parcel_for_mobility # noqa: E501 + + Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + network_protocol_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['network_protocol_id'] = \ + network_protocol_id + return self.delete_network_protocol_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def delete_security_policy_profile_parcel_for_mobility( + self, + profile_id, + security_policy_id, + **kwargs + ): + """delete_security_policy_profile_parcel_for_mobility # noqa: E501 + + Delete a Security Policy Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + security_policy_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['security_policy_id'] = \ + security_policy_id + return self.delete_security_policy_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def delete_wifi_profile_parcel_for_mobility( + self, + profile_id, + wifi_id, + **kwargs + ): + """delete_wifi_profile_parcel_for_mobility # noqa: E501 + + Delete an Wifi Profile Parcel for Mobility feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wifi_profile_parcel_for_mobility(profile_id, wifi_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + wifi_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['wifi_id'] = \ + wifi_id + return self.delete_wifi_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def edit_basic_profile_parcel_for_mobility( + self, + profile_id, + parcel_id, + **kwargs + ): + """edit_basic_profile_parcel_for_mobility # noqa: E501 + + Update a Basic Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_basic_profile_parcel_for_mobility(profile_id, parcel_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + parcel_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Basic Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['parcel_id'] = \ + parcel_id + return self.edit_basic_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def edit_cellular_profile_parcel_for_mobility( + self, + profile_id, + cellular_id, + **kwargs + ): + """edit_cellular_profile_parcel_for_mobility # noqa: E501 + + Edit an Cellular Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_cellular_profile_parcel_for_mobility(profile_id, cellular_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + cellular_id (str): Profile Parcel ID + + Keyword Args: + cellular (Cellular): Cellular Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['cellular_id'] = \ + cellular_id + return self.edit_cellular_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def edit_ethernet_profile_parcel_for_system( + self, + profile_id, + ethernet_id, + **kwargs + ): + """edit_ethernet_profile_parcel_for_system # noqa: E501 + + Update a Ethernet Profile Parcel for feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_ethernet_profile_parcel_for_system(profile_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + ethernet_id (str): Profile Parcel ID + + Keyword Args: + body (str): Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.edit_ethernet_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_network_protocol_profile_parcel_for_mobility( + self, + profile_id, + network_protocol_id, + **kwargs + ): + """edit_network_protocol_profile_parcel_for_mobility # noqa: E501 + + Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + network_protocol_id (str): Profile Parcel ID + + Keyword Args: + network_protocol (NetworkProtocol): Network Protocol Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['network_protocol_id'] = \ + network_protocol_id + return self.edit_network_protocol_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def edit_security_policy_profile_parcel_for_mobility( + self, + profile_id, + security_policy_id, + **kwargs + ): + """edit_security_policy_profile_parcel_for_mobility # noqa: E501 + + Edit an Security Policy Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + security_policy_id (str): Profile Parcel ID + + Keyword Args: + security_policy (SecurityPolicy): Security Policy Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['security_policy_id'] = \ + security_policy_id + return self.edit_security_policy_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def edit_vpn_profile_parcel_for_mobility( + self, + profile_id, + vpn_id, + **kwargs + ): + """edit_vpn_profile_parcel_for_mobility # noqa: E501 + + Edit an Vpn Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_vpn_profile_parcel_for_mobility(profile_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + vpn (Vpn): Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['vpn_id'] = \ + vpn_id + return self.edit_vpn_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def edit_wifi_profile_parcel_for_mobility( + self, + profile_id, + wifi_id, + **kwargs + ): + """edit_wifi_profile_parcel_for_mobility # noqa: E501 + + Edit an Wifi Profile Parcel for Mobility feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wifi_profile_parcel_for_mobility(profile_id, wifi_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + wifi_id (str): Profile Parcel ID + + Keyword Args: + wifi (Wifi): Wifi Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['wifi_id'] = \ + wifi_id + return self.edit_wifi_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_basic_profile_parcel_by_parcel_id_for_mobility( + self, + profile_id, + parcel_id, + **kwargs + ): + """get_basic_profile_parcel_by_parcel_id_for_mobility # noqa: E501 + + Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_basic_profile_parcel_by_parcel_id_for_mobility(profile_id, parcel_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + parcel_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['parcel_id'] = \ + parcel_id + return self.get_basic_profile_parcel_by_parcel_id_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_basic_profile_parcel_for_mobility( + self, + profile_id, + **kwargs + ): + """get_basic_profile_parcel_for_mobility # noqa: E501 + + Get Basic Profile Parcels for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_basic_profile_parcel_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_basic_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_cellular_profile_parcel_for_mobility( + self, + profile_id, + cellular_id, + **kwargs + ): + """get_cellular_profile_parcel_for_mobility # noqa: E501 + + Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_profile_parcel_for_mobility(profile_id, cellular_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + cellular_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['cellular_id'] = \ + cellular_id + return self.get_cellular_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_cellular_profile_parcel_list_for_mobility( + self, + profile_id, + **kwargs + ): + """get_cellular_profile_parcel_list_for_mobility # noqa: E501 + + Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_profile_parcel_list_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_cellular_profile_parcel_list_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_ethernet_profile_parcel( + self, + profile_id, + ethernet_id, + **kwargs + ): + """get_ethernet_profile_parcel # noqa: E501 + + Get Ethernet Profile Parcels for feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ethernet_profile_parcel(profile_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + ethernet_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.get_ethernet_profile_parcel_endpoint.call_with_http_info(**kwargs) + + def get_ethernet_profile_parcels( + self, + profile_id, + **kwargs + ): + """get_ethernet_profile_parcels # noqa: E501 + + Get Ethernet Profile Parcels for feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ethernet_profile_parcels(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_ethernet_profile_parcels_endpoint.call_with_http_info(**kwargs) + + def get_mobility_feature_profile_by_global_id( + self, + profile_id, + **kwargs + ): + """get_mobility_feature_profile_by_global_id # noqa: E501 + + Get a Mobility Global Feature Profile by profileId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mobility_feature_profile_by_global_id(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_mobility_feature_profile_by_global_id_endpoint.call_with_http_info(**kwargs) + + def get_mobility_global_basic_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_mobility_global_basic_parcel_schema_by_schema_type # noqa: E501 + + Get a Mobility Global Basic Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mobility_global_basic_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_mobility_global_basic_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_network_protocol_profile_parcel_for_mobility( + self, + profile_id, + network_protocol_id, + **kwargs + ): + """get_network_protocol_profile_parcel_for_mobility # noqa: E501 + + Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_protocol_profile_parcel_for_mobility(profile_id, network_protocol_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + network_protocol_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['network_protocol_id'] = \ + network_protocol_id + return self.get_network_protocol_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_network_protocol_profile_parcel_list_for_mobility( + self, + profile_id, + **kwargs + ): + """get_network_protocol_profile_parcel_list_for_mobility # noqa: E501 + + Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_protocol_profile_parcel_list_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_network_protocol_profile_parcel_list_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_security_policy_profile_parcel_for_mobility( + self, + profile_id, + security_policy_id, + **kwargs + ): + """get_security_policy_profile_parcel_for_mobility # noqa: E501 + + Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_security_policy_profile_parcel_for_mobility(profile_id, security_policy_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + security_policy_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['security_policy_id'] = \ + security_policy_id + return self.get_security_policy_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_security_policy_profile_parcel_list_for_mobility( + self, + profile_id, + **kwargs + ): + """get_security_policy_profile_parcel_list_for_mobility # noqa: E501 + + Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_security_policy_profile_parcel_list_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_security_policy_profile_parcel_list_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_vpn_profile_parcel_for_mobility( + self, + profile_id, + vpn_id, + **kwargs + ): + """get_vpn_profile_parcel_for_mobility # noqa: E501 + + Get an Mobility Vpn Profile Parcel for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_profile_parcel_for_mobility(profile_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_vpn_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_vpn_profile_parcel_list_for_mobility( + self, + profile_id, + **kwargs + ): + """get_vpn_profile_parcel_list_for_mobility # noqa: E501 + + Get an Mobility Vpn Profile Parcel list for Mobility Global Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_profile_parcel_list_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_vpn_profile_parcel_list_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_wifi_profile_parcel_for_mobility( + self, + profile_id, + wifi_id, + **kwargs + ): + """get_wifi_profile_parcel_for_mobility # noqa: E501 + + Get an Wifi Profile Parcel for Mobility feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wifi_profile_parcel_for_mobility(profile_id, wifi_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + wifi_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['wifi_id'] = \ + wifi_id + return self.get_wifi_profile_parcel_for_mobility_endpoint.call_with_http_info(**kwargs) + + def get_wifi_profile_parcel_list_for_mobility( + self, + profile_id, + **kwargs + ): + """get_wifi_profile_parcel_list_for_mobility # noqa: E501 + + Get Wifi Profile Parcel List for Mobility feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wifi_profile_parcel_list_for_mobility(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_wifi_profile_parcel_list_for_mobility_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_feature_profile_sdwan_api.py b/openapi_client/api/configuration_feature_profile_sdwan_api.py new file mode 100644 index 0000000..92b242f --- /dev/null +++ b/openapi_client/api/configuration_feature_profile_sdwan_api.py @@ -0,0 +1,33400 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationFeatureProfileSDWANApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.cedge_service_profile_switchport_parcel_restful_resource_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/switchport', + 'operation_id': 'cedge_service_profile_switchport_parcel_restful_resource', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_aaa_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/aaa', + 'operation_id': 'create_aaa_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_banner_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/banner', + 'operation_id': 'create_banner_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_basic_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/basic', + 'operation_id': 'create_basic_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_bfd_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/bfd', + 'operation_id': 'create_bfd_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_cellular_controller_and_cellular_profile_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile', + 'operation_id': 'create_cellular_controller_and_cellular_profile_parcel_association_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + 'body', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_cellular_controller_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller', + 'operation_id': 'create_cellular_controller_profile_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_cellular_profile_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile', + 'operation_id': 'create_cellular_profile_profile_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_dhcp_server_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server', + 'operation_id': 'create_dhcp_server_profile_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_global_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/global', + 'operation_id': 'create_global_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_and_routing_bgp_parcel_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp', + 'operation_id': 'create_lan_vpn_and_routing_bgp_parcel_association_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_and_routing_ospf_parcel_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf', + 'operation_id': 'create_lan_vpn_and_routing_ospf_parcel_association_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server', + 'operation_id': 'create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_parcel_id', + 'ethernet_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_parcel_id', + 'ethernet_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_parcel_id': + (str,), + 'ethernet_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_parcel_id': 'vpnParcelId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_parcel_id': 'path', + 'ethernet_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_interface_ethernet_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet', + 'operation_id': 'create_lan_vpn_interface_ethernet_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server', + 'operation_id': 'create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_parcel_id', + 'svi_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_parcel_id', + 'svi_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_parcel_id': + (str,), + 'svi_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_parcel_id': 'vpnParcelId', + 'svi_id': 'sviId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_parcel_id': 'path', + 'svi_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_interface_svi_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi', + 'operation_id': 'create_lan_vpn_interface_svi_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_lan_vpn_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn', + 'operation_id': 'create_lan_vpn_profile_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_logging_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/logging', + 'operation_id': 'create_logging_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_management_vpn_interface_ethernet_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet', + 'operation_id': 'create_management_vpn_interface_ethernet_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_management_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn', + 'operation_id': 'create_management_vpn_profile_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_ntp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/ntp', + 'operation_id': 'create_ntp_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_omp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/omp', + 'operation_id': 'create_omp_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_routing_bgp_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp', + 'operation_id': 'create_routing_bgp_profile_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_routing_bgp_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp', + 'operation_id': 'create_routing_bgp_profile_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_routing_ospf_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf', + 'operation_id': 'create_routing_ospf_profile_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sdwan_config_profile_parcel_for_cli_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}/config', + 'operation_id': 'create_sdwan_config_profile_parcel_for_cli', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + 'body', + ], + 'required': [ + 'cli_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + }, + 'location_map': { + 'cli_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sdwan_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli', + 'operation_id': 'create_sdwan_feature_profile', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sdwan_other_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other', + 'operation_id': 'create_sdwan_other_feature_profile', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sdwan_service_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service', + 'operation_id': 'create_sdwan_service_feature_profile', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sdwan_system_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system', + 'operation_id': 'create_sdwan_system_feature_profile', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sdwan_transport_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport', + 'operation_id': 'create_sdwan_transport_feature_profile', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_snmp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/snmp', + 'operation_id': 'create_snmp_profile_parcel_for_system', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_thousandeyes_profile_parcel_for_other_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}/thousandeyes', + 'operation_id': 'create_thousandeyes_profile_parcel_for_other', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + 'body', + ], + 'required': [ + 'other_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'other_id': 'otherId', + }, + 'location_map': { + 'other_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tracker_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/tracker', + 'operation_id': 'create_tracker_profile_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wan_vpn_and_routing_bgp_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp', + 'operation_id': 'create_wan_vpn_and_routing_bgp_parcel_association_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker', + 'operation_id': 'create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_parcel_id', + 'cellular_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_parcel_id', + 'cellular_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_parcel_id': + (str,), + 'cellular_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_parcel_id': 'vpnParcelId', + 'cellular_id': 'cellularId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_parcel_id': 'path', + 'cellular_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wan_vpn_interface_cellular_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular', + 'operation_id': 'create_wan_vpn_interface_cellular_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker', + 'operation_id': 'create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_parcel_id', + 'ethernet_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_parcel_id', + 'ethernet_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_parcel_id': + (str,), + 'ethernet_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_parcel_id': 'vpnParcelId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_parcel_id': 'path', + 'ethernet_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wan_vpn_interface_ethernet_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet', + 'operation_id': 'create_wan_vpn_interface_ethernet_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wan_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn', + 'operation_id': 'create_wan_vpn_profile_parcel_for_transport', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_wirelesslan_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan', + 'operation_id': 'create_wirelesslan_profile_parcel_for_service', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_aaa_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}', + 'operation_id': 'delete_aaa_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'aaa_id', + ], + 'required': [ + 'system_id', + 'aaa_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'aaa_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'aaa_id': 'aaaId', + }, + 'location_map': { + 'system_id': 'path', + 'aaa_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_banner_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}', + 'operation_id': 'delete_banner_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'banner_id', + ], + 'required': [ + 'system_id', + 'banner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'banner_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'banner_id': 'bannerId', + }, + 'location_map': { + 'system_id': 'path', + 'banner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_basic_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}', + 'operation_id': 'delete_basic_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'basic_id', + ], + 'required': [ + 'system_id', + 'basic_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'basic_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'basic_id': 'basicId', + }, + 'location_map': { + 'system_id': 'path', + 'basic_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_bfd_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}', + 'operation_id': 'delete_bfd_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'bfd_id', + ], + 'required': [ + 'system_id', + 'bfd_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'bfd_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'bfd_id': 'bfdId', + }, + 'location_map': { + 'system_id': 'path', + 'bfd_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_cellular_controller_and_cellular_profile_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}', + 'operation_id': 'delete_cellular_controller_and_cellular_profile_association_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + 'cellular_profile_id', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + 'cellular_profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + 'cellular_profile_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + 'cellular_profile_id': 'cellularProfileId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + 'cellular_profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_cellular_controller_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}', + 'operation_id': 'delete_cellular_controller_profile_parcel_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_cellular_profile_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}', + 'operation_id': 'delete_cellular_profile_profile_parcel_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_profile_id', + ], + 'required': [ + 'transport_id', + 'cellular_profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_profile_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_profile_id': 'cellularProfileId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_config_profile_parcel_for_cli_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}', + 'operation_id': 'delete_config_profile_parcel_for_cli', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + 'config_id', + ], + 'required': [ + 'cli_id', + 'config_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + 'config_id': + (str,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + 'config_id': 'configId', + }, + 'location_map': { + 'cli_id': 'path', + 'config_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_dhcp_server_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'delete_dhcp_server_profile_parcel_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'dhcp_server_id', + ], + 'required': [ + 'service_id', + 'dhcp_server_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'dhcp_server_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'dhcp_server_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_global_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}', + 'operation_id': 'delete_global_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'global_id', + ], + 'required': [ + 'system_id', + 'global_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'global_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'global_id': 'globalId', + }, + 'location_map': { + 'system_id': 'path', + 'global_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_and_routing_bgp_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}', + 'operation_id': 'delete_lan_vpn_and_routing_bgp_association_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'bgp_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_and_routing_ospf_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}', + 'operation_id': 'delete_lan_vpn_and_routing_ospf_association_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ospf_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ospf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ospf_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ospf_id': 'ospfId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ospf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'dhcp_server_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'dhcp_server_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'dhcp_server_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'dhcp_server_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_interface_ethernet_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'delete_lan_vpn_interface_ethernet_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'dhcp_server_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'dhcp_server_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + 'dhcp_server_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + 'dhcp_server_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_interface_svi_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}', + 'operation_id': 'delete_lan_vpn_interface_svi_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_lan_vpn_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}', + 'operation_id': 'delete_lan_vpn_profile_parcel_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_logging_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}', + 'operation_id': 'delete_logging_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'logging_id', + ], + 'required': [ + 'system_id', + 'logging_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'logging_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'logging_id': 'loggingId', + }, + 'location_map': { + 'system_id': 'path', + 'logging_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_management_vpn_interface_ethernet_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'delete_management_vpn_interface_ethernet_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_management_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}', + 'operation_id': 'delete_management_vpn_profile_parcel_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_ntp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}', + 'operation_id': 'delete_ntp_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'ntp_id', + ], + 'required': [ + 'system_id', + 'ntp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'ntp_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'ntp_id': 'ntpId', + }, + 'location_map': { + 'system_id': 'path', + 'ntp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_omp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}', + 'operation_id': 'delete_omp_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'omp_id', + ], + 'required': [ + 'system_id', + 'omp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'omp_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'omp_id': 'ompId', + }, + 'location_map': { + 'system_id': 'path', + 'omp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_routing_bgp_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}', + 'operation_id': 'delete_routing_bgp_profile_parcel_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'bgp_id', + ], + 'required': [ + 'service_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'service_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_routing_bgp_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}', + 'operation_id': 'delete_routing_bgp_profile_parcel_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'bgp_id', + ], + 'required': [ + 'transport_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'transport_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_routing_ospf_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}', + 'operation_id': 'delete_routing_ospf_profile_parcel_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'ospf_id', + ], + 'required': [ + 'service_id', + 'ospf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'ospf_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'ospf_id': 'ospfId', + }, + 'location_map': { + 'service_id': 'path', + 'ospf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_sdwan_feature_profile_for_cli_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}', + 'operation_id': 'delete_sdwan_feature_profile_for_cli', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + ], + 'required': [ + 'cli_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + }, + 'location_map': { + 'cli_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_sdwan_other_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}', + 'operation_id': 'delete_sdwan_other_feature_profile', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + ], + 'required': [ + 'other_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + }, + 'attribute_map': { + 'other_id': 'otherId', + }, + 'location_map': { + 'other_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_sdwan_service_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}', + 'operation_id': 'delete_sdwan_service_feature_profile', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_sdwan_system_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}', + 'operation_id': 'delete_sdwan_system_feature_profile', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_sdwan_transport_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}', + 'operation_id': 'delete_sdwan_transport_feature_profile', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_snmp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}', + 'operation_id': 'delete_snmp_profile_parcel_for_system', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'snmp_id', + ], + 'required': [ + 'system_id', + 'snmp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'snmp_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'snmp_id': 'snmpId', + }, + 'location_map': { + 'system_id': 'path', + 'snmp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_switchport_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}', + 'operation_id': 'delete_switchport_profile_parcel_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'switchport_id', + ], + 'required': [ + 'service_id', + 'switchport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'switchport_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'switchport_id': 'switchportId', + }, + 'location_map': { + 'service_id': 'path', + 'switchport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_thousandeyes_profile_parcel_for_other_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}', + 'operation_id': 'delete_thousandeyes_profile_parcel_for_other', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + 'thousandeyes_id', + ], + 'required': [ + 'other_id', + 'thousandeyes_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + 'thousandeyes_id': + (str,), + }, + 'attribute_map': { + 'other_id': 'otherId', + 'thousandeyes_id': 'thousandeyesId', + }, + 'location_map': { + 'other_id': 'path', + 'thousandeyes_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_tracker_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}', + 'operation_id': 'delete_tracker_profile_parcel_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'tracker_id', + ], + 'required': [ + 'transport_id', + 'tracker_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'tracker_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'tracker_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wan_vpn_and_routing_bgp_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}', + 'operation_id': 'delete_wan_vpn_and_routing_bgp_association_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'bgp_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wan_vpn_interface_cellular_and_tracker_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}', + 'operation_id': 'delete_wan_vpn_interface_cellular_and_tracker_association_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + 'tracker_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + 'tracker_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'cellular_id': + (str,), + 'tracker_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'cellular_id': 'cellularId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'cellular_id': 'path', + 'tracker_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wan_vpn_interface_cellular_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}', + 'operation_id': 'delete_wan_vpn_interface_cellular_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'intf_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'intf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'intf_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'intf_id': 'intfId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'intf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}', + 'operation_id': 'delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'tracker_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'tracker_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'tracker_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'tracker_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wan_vpn_interface_ethernet_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'delete_wan_vpn_interface_ethernet_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wan_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}', + 'operation_id': 'delete_wan_vpn_profile_parcel_for_transport', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_wirelesslan_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}', + 'operation_id': 'delete_wirelesslan_profile_parcel_for_service', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'wirelesslan_id', + ], + 'required': [ + 'service_id', + 'wirelesslan_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'wirelesslan_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'wirelesslan_id': 'wirelesslanId', + }, + 'location_map': { + 'service_id': 'path', + 'wirelesslan_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_aaa_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}', + 'operation_id': 'edit_aaa_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'aaa_id', + 'body', + ], + 'required': [ + 'system_id', + 'aaa_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'aaa_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'aaa_id': 'aaaId', + }, + 'location_map': { + 'system_id': 'path', + 'aaa_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_banner_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}', + 'operation_id': 'edit_banner_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'banner_id', + 'body', + ], + 'required': [ + 'system_id', + 'banner_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'banner_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'banner_id': 'bannerId', + }, + 'location_map': { + 'system_id': 'path', + 'banner_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_basic_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}', + 'operation_id': 'edit_basic_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'basic_id', + 'body', + ], + 'required': [ + 'system_id', + 'basic_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'basic_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'basic_id': 'basicId', + }, + 'location_map': { + 'system_id': 'path', + 'basic_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_bfd_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}', + 'operation_id': 'edit_bfd_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'bfd_id', + 'body', + ], + 'required': [ + 'system_id', + 'bfd_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'bfd_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'bfd_id': 'bfdId', + }, + 'location_map': { + 'system_id': 'path', + 'bfd_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_cellular_controller_and_cellular_profile_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}', + 'operation_id': 'edit_cellular_controller_and_cellular_profile_parcel_association_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + 'cellular_profile_id', + 'body', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + 'cellular_profile_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + 'cellular_profile_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + 'cellular_profile_id': 'cellularProfileId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + 'cellular_profile_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_cellular_controller_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}', + 'operation_id': 'edit_cellular_controller_profile_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + 'body', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_cellular_profile_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}', + 'operation_id': 'edit_cellular_profile_profile_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_profile_id', + 'body', + ], + 'required': [ + 'transport_id', + 'cellular_profile_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_profile_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_profile_id': 'cellularProfileId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_profile_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_config_profile_parcel_for_cli_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}', + 'operation_id': 'edit_config_profile_parcel_for_cli', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + 'config_id', + 'body', + ], + 'required': [ + 'cli_id', + 'config_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + 'config_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + 'config_id': 'configId', + }, + 'location_map': { + 'cli_id': 'path', + 'config_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_dhcp_server_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'edit_dhcp_server_profile_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'dhcp_server_id', + 'body', + ], + 'required': [ + 'service_id', + 'dhcp_server_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'dhcp_server_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'dhcp_server_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_global_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}', + 'operation_id': 'edit_global_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'global_id', + 'body', + ], + 'required': [ + 'system_id', + 'global_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'global_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'global_id': 'globalId', + }, + 'location_map': { + 'system_id': 'path', + 'global_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_and_routing_bgp_parcel_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}', + 'operation_id': 'edit_lan_vpn_and_routing_bgp_parcel_association_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'bgp_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'bgp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'bgp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'bgp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_and_routing_ospf_parcel_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}', + 'operation_id': 'edit_lan_vpn_and_routing_ospf_parcel_association_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ospf_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ospf_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ospf_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ospf_id': 'ospfId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ospf_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'dhcp_server_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'dhcp_server_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'dhcp_server_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'dhcp_server_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_interface_ethernet_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'edit_lan_vpn_interface_ethernet_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'dhcp_server_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'dhcp_server_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + 'dhcp_server_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + 'dhcp_server_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_interface_svi_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}', + 'operation_id': 'edit_lan_vpn_interface_svi_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_lan_vpn_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}', + 'operation_id': 'edit_lan_vpn_profile_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_logging_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}', + 'operation_id': 'edit_logging_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'logging_id', + 'body', + ], + 'required': [ + 'system_id', + 'logging_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'logging_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'logging_id': 'loggingId', + }, + 'location_map': { + 'system_id': 'path', + 'logging_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_management_vpn_interface_ethernet_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'edit_management_vpn_interface_ethernet_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_management_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}', + 'operation_id': 'edit_management_vpn_profile_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_ntp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}', + 'operation_id': 'edit_ntp_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'ntp_id', + 'body', + ], + 'required': [ + 'system_id', + 'ntp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'ntp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'ntp_id': 'ntpId', + }, + 'location_map': { + 'system_id': 'path', + 'ntp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_omp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}', + 'operation_id': 'edit_omp_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'omp_id', + 'body', + ], + 'required': [ + 'system_id', + 'omp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'omp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'omp_id': 'ompId', + }, + 'location_map': { + 'system_id': 'path', + 'omp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_routing_bgp_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}', + 'operation_id': 'edit_routing_bgp_profile_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'bgp_id', + 'body', + ], + 'required': [ + 'service_id', + 'bgp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'bgp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'service_id': 'path', + 'bgp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_routing_bgp_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}', + 'operation_id': 'edit_routing_bgp_profile_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'bgp_id', + 'body', + ], + 'required': [ + 'transport_id', + 'bgp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'bgp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'transport_id': 'path', + 'bgp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_routing_ospf_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}', + 'operation_id': 'edit_routing_ospf_profile_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'ospf_id', + 'body', + ], + 'required': [ + 'service_id', + 'ospf_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'ospf_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'ospf_id': 'ospfId', + }, + 'location_map': { + 'service_id': 'path', + 'ospf_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_sdwan_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}', + 'operation_id': 'edit_sdwan_feature_profile', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + 'body', + ], + 'required': [ + 'cli_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + }, + 'location_map': { + 'cli_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_sdwan_other_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}', + 'operation_id': 'edit_sdwan_other_feature_profile', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + 'body', + ], + 'required': [ + 'other_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'other_id': 'otherId', + }, + 'location_map': { + 'other_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_sdwan_service_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}', + 'operation_id': 'edit_sdwan_service_feature_profile', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'body', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_sdwan_system_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}', + 'operation_id': 'edit_sdwan_system_feature_profile', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'body', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_sdwan_transport_feature_profile_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}', + 'operation_id': 'edit_sdwan_transport_feature_profile', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'body', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_snmp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}', + 'operation_id': 'edit_snmp_profile_parcel_for_system', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'snmp_id', + 'body', + ], + 'required': [ + 'system_id', + 'snmp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'snmp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'snmp_id': 'snmpId', + }, + 'location_map': { + 'system_id': 'path', + 'snmp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_switchport_parcel_association_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}', + 'operation_id': 'edit_switchport_parcel_association_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'switchport_id', + 'body', + ], + 'required': [ + 'service_id', + 'switchport_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'switchport_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'switchport_id': 'switchportId', + }, + 'location_map': { + 'service_id': 'path', + 'switchport_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_thousandeyes_profile_parcel_for_other_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}', + 'operation_id': 'edit_thousandeyes_profile_parcel_for_other', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + 'thousandeyes_id', + 'body', + ], + 'required': [ + 'other_id', + 'thousandeyes_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + 'thousandeyes_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'other_id': 'otherId', + 'thousandeyes_id': 'thousandeyesId', + }, + 'location_map': { + 'other_id': 'path', + 'thousandeyes_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_tracker_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}', + 'operation_id': 'edit_tracker_profile_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'tracker_id', + 'body', + ], + 'required': [ + 'transport_id', + 'tracker_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'tracker_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'tracker_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_vpn_and_routing_bgp_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}', + 'operation_id': 'edit_wan_vpn_and_routing_bgp_parcel_association_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'bgp_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'bgp_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'bgp_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'bgp_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}', + 'operation_id': 'edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + 'tracker_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + 'tracker_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'cellular_id': + (str,), + 'tracker_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'cellular_id': 'cellularId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'cellular_id': 'path', + 'tracker_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_vpn_interface_cellular_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}', + 'operation_id': 'edit_wan_vpn_interface_cellular_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'intf_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'intf_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'intf_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'intf_id': 'intfId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'intf_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}', + 'operation_id': 'edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'tracker_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'tracker_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'tracker_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'tracker_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_vpn_interface_ethernet_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'edit_wan_vpn_interface_ethernet_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wan_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}', + 'operation_id': 'edit_wan_vpn_profile_parcel_for_transport', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'body', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_wirelesslan_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}', + 'operation_id': 'edit_wirelesslan_profile_parcel_for_service', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'wirelesslan_id', + 'body', + ], + 'required': [ + 'service_id', + 'wirelesslan_id', + ], + 'nullable': [ + 'body', + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'wirelesslan_id': + (str,), + 'body': + (bool, date, datetime, dict, float, int, list, str, none_type,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'wirelesslan_id': 'wirelesslanId', + }, + 'location_map': { + 'service_id': 'path', + 'wirelesslan_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_aaa_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}', + 'operation_id': 'get_aaa_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'aaa_id', + ], + 'required': [ + 'system_id', + 'aaa_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'aaa_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'aaa_id': 'aaaId', + }, + 'location_map': { + 'system_id': 'path', + 'aaa_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aaa_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/aaa', + 'operation_id': 'get_aaa_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_banner_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}', + 'operation_id': 'get_banner_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'banner_id', + ], + 'required': [ + 'system_id', + 'banner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'banner_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'banner_id': 'bannerId', + }, + 'location_map': { + 'system_id': 'path', + 'banner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_banner_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/banner', + 'operation_id': 'get_banner_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_basic_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}', + 'operation_id': 'get_basic_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'basic_id', + ], + 'required': [ + 'system_id', + 'basic_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'basic_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'basic_id': 'basicId', + }, + 'location_map': { + 'system_id': 'path', + 'basic_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_basic_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/basic', + 'operation_id': 'get_basic_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bfd_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}', + 'operation_id': 'get_bfd_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'bfd_id', + ], + 'required': [ + 'system_id', + 'bfd_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'bfd_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'bfd_id': 'bfdId', + }, + 'location_map': { + 'system_id': 'path', + 'bfd_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bfd_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/bfd', + 'operation_id': 'get_bfd_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema', + 'operation_id': 'get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cedge_service_switchport_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/switchport/schema', + 'operation_id': 'get_cedge_service_switchport_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cedge_system_global_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/global/schema', + 'operation_id': 'get_cedge_system_global_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}', + 'operation_id': 'get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + 'cellular_profile_id', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + 'cellular_profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + 'cellular_profile_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + 'cellular_profile_id': 'cellularProfileId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + 'cellular_profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_controller_associated_cellular_profile_parcels_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile', + 'operation_id': 'get_cellular_controller_associated_cellular_profile_parcels_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_controller_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}', + 'operation_id': 'get_cellular_controller_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_controller_id', + ], + 'required': [ + 'transport_id', + 'cellular_controller_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_controller_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_controller_id': 'cellularControllerId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_controller_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_controller_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller', + 'operation_id': 'get_cellular_controller_profile_parcel_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_profile_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}', + 'operation_id': 'get_cellular_profile_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'cellular_profile_id', + ], + 'required': [ + 'transport_id', + 'cellular_profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'cellular_profile_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'cellular_profile_id': 'cellularProfileId', + }, + 'location_map': { + 'transport_id': 'path', + 'cellular_profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_profile_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile', + 'operation_id': 'get_cellular_profile_profile_parcel_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_profile_parcel_by_parcel_id_for_cli_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}', + 'operation_id': 'get_config_profile_parcel_by_parcel_id_for_cli', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + 'config_id', + ], + 'required': [ + 'cli_id', + 'config_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + 'config_id': + (str,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + 'config_id': 'configId', + }, + 'location_map': { + 'cli_id': 'path', + 'config_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_config_profile_parcel_for_cli_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}/config', + 'operation_id': 'get_config_profile_parcel_for_cli', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + ], + 'required': [ + 'cli_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + }, + 'location_map': { + 'cli_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dhcp_server_profile_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'get_dhcp_server_profile_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'dhcp_server_id', + ], + 'required': [ + 'service_id', + 'dhcp_server_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'dhcp_server_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'dhcp_server_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dhcp_server_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server', + 'operation_id': 'get_dhcp_server_profile_parcel_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_global_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}', + 'operation_id': 'get_global_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'global_id', + ], + 'required': [ + 'system_id', + 'global_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'global_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'global_id': 'globalId', + }, + 'location_map': { + 'system_id': 'path', + 'global_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_global_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/global', + 'operation_id': 'get_global_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_interface_cellular_parcels_for_transport_wan_vpn_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular', + 'operation_id': 'get_interface_cellular_parcels_for_transport_wan_vpn', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_interface_ethernet_parcels_for_service_lan_vpn_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet', + 'operation_id': 'get_interface_ethernet_parcels_for_service_lan_vpn', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_interface_ethernet_parcels_for_transport_management_vpn_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet', + 'operation_id': 'get_interface_ethernet_parcels_for_transport_management_vpn', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_interface_ethernet_parcels_for_transport_wan_vpn_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet', + 'operation_id': 'get_interface_ethernet_parcels_for_transport_wan_vpn', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_interface_svi_parcels_for_service_lan_vpn_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi', + 'operation_id': 'get_interface_svi_parcels_for_service_lan_vpn', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}', + 'operation_id': 'get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'bgp_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_associated_routing_bgp_parcels_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp', + 'operation_id': 'get_lan_vpn_associated_routing_bgp_parcels_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}', + 'operation_id': 'get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ospf_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ospf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ospf_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ospf_id': 'ospfId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ospf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_associated_routing_ospf_parcels_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf', + 'operation_id': 'get_lan_vpn_associated_routing_ospf_parcels_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'dhcp_server_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + 'dhcp_server_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'dhcp_server_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'dhcp_server_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server', + 'operation_id': 'get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}', + 'operation_id': 'get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'dhcp_server_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + 'dhcp_server_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + 'dhcp_server_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + 'dhcp_server_id': 'dhcpServerId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + 'dhcp_server_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server', + 'operation_id': 'get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}', + 'operation_id': 'get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + 'svi_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + 'svi_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + 'svi_id': 'sviId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + 'svi_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_profile_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}', + 'operation_id': 'get_lan_vpn_profile_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'vpn_id', + ], + 'required': [ + 'service_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'service_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lan_vpn_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn', + 'operation_id': 'get_lan_vpn_profile_parcel_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_logging_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}', + 'operation_id': 'get_logging_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'logging_id', + ], + 'required': [ + 'system_id', + 'logging_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'logging_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'logging_id': 'loggingId', + }, + 'location_map': { + 'system_id': 'path', + 'logging_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_logging_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/logging', + 'operation_id': 'get_logging_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_management_vpn_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}', + 'operation_id': 'get_management_vpn_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_management_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/management/vpn', + 'operation_id': 'get_management_vpn_profile_parcel_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ntp_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}', + 'operation_id': 'get_ntp_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'ntp_id', + ], + 'required': [ + 'system_id', + 'ntp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'ntp_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'ntp_id': 'ntpId', + }, + 'location_map': { + 'system_id': 'path', + 'ntp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ntp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/ntp', + 'operation_id': 'get_ntp_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_omp_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}', + 'operation_id': 'get_omp_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'omp_id', + ], + 'required': [ + 'system_id', + 'omp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'omp_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'omp_id': 'ompId', + }, + 'location_map': { + 'system_id': 'path', + 'omp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_omp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/omp', + 'operation_id': 'get_omp_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_bgp_profile_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}', + 'operation_id': 'get_routing_bgp_profile_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'bgp_id', + ], + 'required': [ + 'service_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'service_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_bgp_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}', + 'operation_id': 'get_routing_bgp_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'bgp_id', + ], + 'required': [ + 'transport_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'transport_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_bgp_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp', + 'operation_id': 'get_routing_bgp_profile_parcel_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_bgp_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp', + 'operation_id': 'get_routing_bgp_profile_parcel_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_ospf_profile_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}', + 'operation_id': 'get_routing_ospf_profile_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'ospf_id', + ], + 'required': [ + 'service_id', + 'ospf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'ospf_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'ospf_id': 'ospfId', + }, + 'location_map': { + 'service_id': 'path', + 'ospf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_ospf_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf', + 'operation_id': 'get_routing_ospf_profile_parcel_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_feature_profile_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli/{cliId}', + 'operation_id': 'get_sdwan_feature_profile_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cli_id', + ], + 'required': [ + 'cli_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cli_id': + (str,), + }, + 'attribute_map': { + 'cli_id': 'cliId', + }, + 'location_map': { + 'cli_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_feature_profile_by_sdwan_family_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan', + 'operation_id': 'get_sdwan_feature_profile_by_sdwan_family', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_feature_profiles_by_family_and_type_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/cli', + 'operation_id': 'get_sdwan_feature_profiles_by_family_and_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_other_feature_profile_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}', + 'operation_id': 'get_sdwan_other_feature_profile_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + ], + 'required': [ + 'other_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + }, + 'attribute_map': { + 'other_id': 'otherId', + }, + 'location_map': { + 'other_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_other_feature_profiles_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other', + 'operation_id': 'get_sdwan_other_feature_profiles', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_other_thousandeyes_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/thousandeyes/schema', + 'operation_id': 'get_sdwan_other_thousandeyes_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_dhcp_server_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/dhcp-server/schema', + 'operation_id': 'get_sdwan_service_dhcp_server_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_feature_profile_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}', + 'operation_id': 'get_sdwan_service_feature_profile_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_feature_profiles_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service', + 'operation_id': 'get_sdwan_service_feature_profiles', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema', + 'operation_id': 'get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_lan_vpn_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/lan/vpn/schema', + 'operation_id': 'get_sdwan_service_lan_vpn_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_routing_bgp_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/routing/bgp/schema', + 'operation_id': 'get_sdwan_service_routing_bgp_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_routing_ospf_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/routing/ospf/schema', + 'operation_id': 'get_sdwan_service_routing_ospf_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_service_wirelesslan_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/wirelesslan/schema', + 'operation_id': 'get_sdwan_service_wirelesslan_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_aaa_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/aaa/schema', + 'operation_id': 'get_sdwan_system_aaa_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_banner_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/banner/schema', + 'operation_id': 'get_sdwan_system_banner_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_basic_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/basic/schema', + 'operation_id': 'get_sdwan_system_basic_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_bfd_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/bfd/schema', + 'operation_id': 'get_sdwan_system_bfd_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_feature_profile_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}', + 'operation_id': 'get_sdwan_system_feature_profile_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_feature_profiles_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system', + 'operation_id': 'get_sdwan_system_feature_profiles', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_logging_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/logging/schema', + 'operation_id': 'get_sdwan_system_logging_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_ntp_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/ntp/schema', + 'operation_id': 'get_sdwan_system_ntp_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_omp_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/omp/schema', + 'operation_id': 'get_sdwan_system_omp_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_system_snmp_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/snmp/schema', + 'operation_id': 'get_sdwan_system_snmp_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/cellular-controller/schema', + 'operation_id': 'get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/cellular-profile/schema', + 'operation_id': 'get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_feature_profile_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}', + 'operation_id': 'get_sdwan_transport_feature_profile_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_feature_profiles_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport', + 'operation_id': 'get_sdwan_transport_feature_profiles', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema', + 'operation_id': 'get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_management_vpn_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/management/vpn/schema', + 'operation_id': 'get_sdwan_transport_management_vpn_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/routing/bgp/schema', + 'operation_id': 'get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_tracker_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/tracker/schema', + 'operation_id': 'get_sdwan_transport_tracker_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema', + 'operation_id': 'get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema', + 'operation_id': 'get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/wan/vpn/schema', + 'operation_id': 'get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'schema_type', + ], + 'required': [ + 'schema_type', + ], + 'nullable': [ + ], + 'enum': [ + 'schema_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('schema_type',): { + + "POST": "post", + "PUT": "put" + }, + }, + 'openapi_types': { + 'schema_type': + (str,), + }, + 'attribute_map': { + 'schema_type': 'schemaType', + }, + 'location_map': { + 'schema_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_snmp_profile_parcel_by_parcel_id_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}', + 'operation_id': 'get_snmp_profile_parcel_by_parcel_id_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + 'snmp_id', + ], + 'required': [ + 'system_id', + 'snmp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + 'snmp_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + 'snmp_id': 'snmpId', + }, + 'location_map': { + 'system_id': 'path', + 'snmp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_snmp_profile_parcel_for_system_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/system/{systemId}/snmp', + 'operation_id': 'get_snmp_profile_parcel_for_system', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'system_id', + ], + 'required': [ + 'system_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'system_id': + (str,), + }, + 'attribute_map': { + 'system_id': 'systemId', + }, + 'location_map': { + 'system_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_switchport_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}', + 'operation_id': 'get_switchport_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'switchport_id', + ], + 'required': [ + 'service_id', + 'switchport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'switchport_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'switchport_id': 'switchportId', + }, + 'location_map': { + 'service_id': 'path', + 'switchport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_switchport_parcels_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/switchport', + 'operation_id': 'get_switchport_parcels_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_thousandeyes_profile_parcel_by_parcel_id_for_other_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}', + 'operation_id': 'get_thousandeyes_profile_parcel_by_parcel_id_for_other', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + 'thousandeyes_id', + ], + 'required': [ + 'other_id', + 'thousandeyes_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + 'thousandeyes_id': + (str,), + }, + 'attribute_map': { + 'other_id': 'otherId', + 'thousandeyes_id': 'thousandeyesId', + }, + 'location_map': { + 'other_id': 'path', + 'thousandeyes_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_thousandeyes_profile_parcel_for_other_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/other/{otherId}/thousandeyes', + 'operation_id': 'get_thousandeyes_profile_parcel_for_other', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'other_id', + ], + 'required': [ + 'other_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'other_id': + (str,), + }, + 'attribute_map': { + 'other_id': 'otherId', + }, + 'location_map': { + 'other_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tracker_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}', + 'operation_id': 'get_tracker_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'tracker_id', + ], + 'required': [ + 'transport_id', + 'tracker_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'tracker_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'tracker_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tracker_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/tracker', + 'operation_id': 'get_tracker_profile_parcel_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}', + 'operation_id': 'get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'bgp_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'bgp_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'bgp_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'bgp_id': 'bgpId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'bgp_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_associated_routing_bgp_parcels_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp', + 'operation_id': 'get_wan_vpn_associated_routing_bgp_parcels_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}', + 'operation_id': 'get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + 'tracker_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + 'tracker_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'cellular_id': + (str,), + 'tracker_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'cellular_id': 'cellularId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'cellular_id': 'path', + 'tracker_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker', + 'operation_id': 'get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'cellular_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'cellular_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'cellular_id': 'cellularId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'cellular_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}', + 'operation_id': 'get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'intf_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'intf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'intf_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'intf_id': 'intfId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'intf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}', + 'operation_id': 'get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'tracker_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + 'tracker_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + 'tracker_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + 'tracker_id': 'trackerId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + 'tracker_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker', + 'operation_id': 'get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}', + 'operation_id': 'get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + 'ethernet_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + 'ethernet_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + 'ethernet_id': 'ethernetId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + 'ethernet_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_profile_parcel_by_parcel_id_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}', + 'operation_id': 'get_wan_vpn_profile_parcel_by_parcel_id_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + 'vpn_id', + ], + 'required': [ + 'transport_id', + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + 'vpn_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'transport_id': 'path', + 'vpn_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_vpn_profile_parcel_for_transport_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn', + 'operation_id': 'get_wan_vpn_profile_parcel_for_transport', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'transport_id', + ], + 'required': [ + 'transport_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transport_id': + (str,), + }, + 'attribute_map': { + 'transport_id': 'transportId', + }, + 'location_map': { + 'transport_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wirelesslan_profile_parcel_by_parcel_id_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}', + 'operation_id': 'get_wirelesslan_profile_parcel_by_parcel_id_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'wirelesslan_id', + ], + 'required': [ + 'service_id', + 'wirelesslan_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'wirelesslan_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'wirelesslan_id': 'wirelesslanId', + }, + 'location_map': { + 'service_id': 'path', + 'wirelesslan_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wirelesslan_profile_parcel_for_service_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan', + 'operation_id': 'get_wirelesslan_profile_parcel_for_service', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + ], + 'required': [ + 'service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + }, + 'location_map': { + 'service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def cedge_service_profile_switchport_parcel_restful_resource( + self, + service_id, + **kwargs + ): + """cedge_service_profile_switchport_parcel_restful_resource # noqa: E501 + + Create a switchport Parcel to a service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cedge_service_profile_switchport_parcel_restful_resource(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Feature Profile Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.cedge_service_profile_switchport_parcel_restful_resource_endpoint.call_with_http_info(**kwargs) + + def create_aaa_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_aaa_profile_parcel_for_system # noqa: E501 + + Create a Aaa Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_aaa_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Aaa Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_aaa_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_banner_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_banner_profile_parcel_for_system # noqa: E501 + + Create a Banner Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_banner_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Banner Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_banner_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_basic_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_basic_profile_parcel_for_system # noqa: E501 + + Create a Basic Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_basic_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Basic Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_basic_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_bfd_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_bfd_profile_parcel_for_system # noqa: E501 + + Create a Bfd Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bfd_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Bfd Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_bfd_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_cellular_controller_and_cellular_profile_parcel_association_for_transport( + self, + transport_id, + cellular_controller_id, + **kwargs + ): + """create_cellular_controller_and_cellular_profile_parcel_association_for_transport # noqa: E501 + + Associate a cellularcontroller parcel with a cellularprofile Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Cellular Controller Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Cellular Profile Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + return self.create_cellular_controller_and_cellular_profile_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_cellular_controller_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """create_cellular_controller_profile_parcel_for_transport # noqa: E501 + + Create a Cellular Controller Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cellular_controller_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Cellular Controller Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.create_cellular_controller_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_cellular_profile_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """create_cellular_profile_profile_parcel_for_transport # noqa: E501 + + Create a Cellular Profile Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cellular_profile_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Cellular Profile Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.create_cellular_profile_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_dhcp_server_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """create_dhcp_server_profile_parcel_for_service # noqa: E501 + + Create a Dhcp Server Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dhcp_server_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Dhcp Server Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.create_dhcp_server_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def create_global_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_global_profile_parcel_for_system # noqa: E501 + + Create a Global Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_global_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Global Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_global_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_and_routing_bgp_parcel_association_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """create_lan_vpn_and_routing_bgp_parcel_association_for_service # noqa: E501 + + Associate a lanvpn parcel with a routingbgp Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Lan Vpn Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_lan_vpn_and_routing_bgp_parcel_association_for_service_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_and_routing_ospf_parcel_association_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """create_lan_vpn_and_routing_ospf_parcel_association_for_service # noqa: E501 + + Associate a lanvpn parcel with a routingospf Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Lan Vpn Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Ospf Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_lan_vpn_and_routing_ospf_parcel_association_for_service_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport( + self, + service_id, + vpn_parcel_id, + ethernet_id, + **kwargs + ): + """create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport # noqa: E501 + + Associate a LanVpnInterfaceEthernet parcel with a DhcpServer Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_parcel_id (str): VPN Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): DhcpServer Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_parcel_id'] = \ + vpn_parcel_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_interface_ethernet_parcel_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """create_lan_vpn_interface_ethernet_parcel_for_service # noqa: E501 + + Create a LanVpn InterfaceEthernet parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Lan Vpn Interface Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_lan_vpn_interface_ethernet_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport( + self, + service_id, + vpn_parcel_id, + svi_id, + **kwargs + ): + """create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport # noqa: E501 + + Associate a LanVpnInterfaceSvi parcel with a DhcpServer Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_parcel_id, svi_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_parcel_id (str): VPN Profile Parcel ID + svi_id (str): Interface Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): DhcpServer Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_parcel_id'] = \ + vpn_parcel_id + kwargs['svi_id'] = \ + svi_id + return self.create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_interface_svi_parcel_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """create_lan_vpn_interface_svi_parcel_for_service # noqa: E501 + + Create a LanVpn InterfaceSvi parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Lan Vpn Interface Svi Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_lan_vpn_interface_svi_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def create_lan_vpn_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """create_lan_vpn_profile_parcel_for_service # noqa: E501 + + Create a Lan Vpn Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lan_vpn_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Lan Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.create_lan_vpn_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def create_logging_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_logging_profile_parcel_for_system # noqa: E501 + + Create a Logging Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_logging_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Logging Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_logging_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_management_vpn_interface_ethernet_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """create_management_vpn_interface_ethernet_parcel_for_transport # noqa: E501 + + Create a ManagementVpn InterfaceEthernet parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Management Vpn Interface Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_management_vpn_interface_ethernet_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_management_vpn_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """create_management_vpn_profile_parcel_for_transport # noqa: E501 + + Create a Management Vpn Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_management_vpn_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Management Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.create_management_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_ntp_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_ntp_profile_parcel_for_system # noqa: E501 + + Create a Ntp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ntp_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Ntp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_ntp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_omp_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_omp_profile_parcel_for_system # noqa: E501 + + Create a Omp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Omp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_omp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_routing_bgp_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """create_routing_bgp_profile_parcel_for_service # noqa: E501 + + Create a Routing Bgp Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_routing_bgp_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.create_routing_bgp_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def create_routing_bgp_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """create_routing_bgp_profile_parcel_for_transport # noqa: E501 + + Create a Routing Bgp Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_routing_bgp_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.create_routing_bgp_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_routing_ospf_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """create_routing_ospf_profile_parcel_for_service # noqa: E501 + + Create a Routing Ospf Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_routing_ospf_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Ospf Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.create_routing_ospf_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def create_sdwan_config_profile_parcel_for_cli( + self, + cli_id, + **kwargs + ): + """create_sdwan_config_profile_parcel_for_cli # noqa: E501 + + Create a config Profile Parcel for cli feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sdwan_config_profile_parcel_for_cli(cli_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): cli config Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + return self.create_sdwan_config_profile_parcel_for_cli_endpoint.call_with_http_info(**kwargs) + + def create_sdwan_feature_profile( + self, + **kwargs + ): + """create_sdwan_feature_profile # noqa: E501 + + Create a SDWAN Feature Profile with profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sdwan_feature_profile(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_sdwan_feature_profile_endpoint.call_with_http_info(**kwargs) + + def create_sdwan_other_feature_profile( + self, + **kwargs + ): + """create_sdwan_other_feature_profile # noqa: E501 + + Create a SDWAN Other Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sdwan_other_feature_profile(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_sdwan_other_feature_profile_endpoint.call_with_http_info(**kwargs) + + def create_sdwan_service_feature_profile( + self, + **kwargs + ): + """create_sdwan_service_feature_profile # noqa: E501 + + Create a SDWAN Service Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sdwan_service_feature_profile(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_sdwan_service_feature_profile_endpoint.call_with_http_info(**kwargs) + + def create_sdwan_system_feature_profile( + self, + **kwargs + ): + """create_sdwan_system_feature_profile # noqa: E501 + + Create a SDWAN System Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sdwan_system_feature_profile(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_sdwan_system_feature_profile_endpoint.call_with_http_info(**kwargs) + + def create_sdwan_transport_feature_profile( + self, + **kwargs + ): + """create_sdwan_transport_feature_profile # noqa: E501 + + Create a SDWAN Transport Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sdwan_transport_feature_profile(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_sdwan_transport_feature_profile_endpoint.call_with_http_info(**kwargs) + + def create_snmp_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """create_snmp_profile_parcel_for_system # noqa: E501 + + Create a Snmp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_snmp_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Snmp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.create_snmp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def create_thousandeyes_profile_parcel_for_other( + self, + other_id, + **kwargs + ): + """create_thousandeyes_profile_parcel_for_other # noqa: E501 + + Create a Thousandeyes Profile Parcel for Other feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_thousandeyes_profile_parcel_for_other(other_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Thousandeyes Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + return self.create_thousandeyes_profile_parcel_for_other_endpoint.call_with_http_info(**kwargs) + + def create_tracker_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """create_tracker_profile_parcel_for_transport # noqa: E501 + + Create a Tracker Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tracker_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Tracker Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.create_tracker_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wan_vpn_and_routing_bgp_parcel_association_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """create_wan_vpn_and_routing_bgp_parcel_association_for_transport # noqa: E501 + + Associate a wanvpn parcel with a routingbgp Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Wan Vpn Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_wan_vpn_and_routing_bgp_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport( + self, + transport_id, + vpn_parcel_id, + cellular_id, + **kwargs + ): + """create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport # noqa: E501 + + Associate a WanVpnInterfaceCellular parcel with a Tracker Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, cellular_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_parcel_id (str): VPN Profile Parcel ID + cellular_id (str): Interface Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Tracker Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_parcel_id'] = \ + vpn_parcel_id + kwargs['cellular_id'] = \ + cellular_id + return self.create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wan_vpn_interface_cellular_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """create_wan_vpn_interface_cellular_parcel_for_transport # noqa: E501 + + Create a wanvpn Cellular interface Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): VPN Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): WanVpn Interface Cellular Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_wan_vpn_interface_cellular_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport( + self, + transport_id, + vpn_parcel_id, + ethernet_id, + **kwargs + ): + """create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport # noqa: E501 + + Associate a WanVpnInterfaceEthernet parcel with a Tracker Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_parcel_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_parcel_id (str): VPN Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Tracker Profile Parcel Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_parcel_id'] = \ + vpn_parcel_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wan_vpn_interface_ethernet_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """create_wan_vpn_interface_ethernet_parcel_for_transport # noqa: E501 + + Create a WanVpn InterfaceEthernet parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Wan Vpn Interface Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.create_wan_vpn_interface_ethernet_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wan_vpn_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """create_wan_vpn_profile_parcel_for_transport # noqa: E501 + + Create a Wan Vpn Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_vpn_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Wan Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.create_wan_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def create_wirelesslan_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """create_wirelesslan_profile_parcel_for_service # noqa: E501 + + Create a Wirelesslan Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wirelesslan_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Wirelesslan Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.create_wirelesslan_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_aaa_profile_parcel_for_system( + self, + system_id, + aaa_id, + **kwargs + ): + """delete_aaa_profile_parcel_for_system # noqa: E501 + + Delete a Aaa Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_aaa_profile_parcel_for_system(system_id, aaa_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + aaa_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['aaa_id'] = \ + aaa_id + return self.delete_aaa_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_banner_profile_parcel_for_system( + self, + system_id, + banner_id, + **kwargs + ): + """delete_banner_profile_parcel_for_system # noqa: E501 + + Delete a Banner Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_banner_profile_parcel_for_system(system_id, banner_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + banner_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['banner_id'] = \ + banner_id + return self.delete_banner_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_basic_profile_parcel_for_system( + self, + system_id, + basic_id, + **kwargs + ): + """delete_basic_profile_parcel_for_system # noqa: E501 + + Delete a Basic Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_basic_profile_parcel_for_system(system_id, basic_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + basic_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['basic_id'] = \ + basic_id + return self.delete_basic_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_bfd_profile_parcel_for_system( + self, + system_id, + bfd_id, + **kwargs + ): + """delete_bfd_profile_parcel_for_system # noqa: E501 + + Delete a Bfd Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_bfd_profile_parcel_for_system(system_id, bfd_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + bfd_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['bfd_id'] = \ + bfd_id + return self.delete_bfd_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_cellular_controller_and_cellular_profile_association_for_transport( + self, + transport_id, + cellular_controller_id, + cellular_profile_id, + **kwargs + ): + """delete_cellular_controller_and_cellular_profile_association_for_transport # noqa: E501 + + Delete a CellularController parcel and a CellularProfile Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_cellular_controller_and_cellular_profile_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Profile Parcel ID + cellular_profile_id (str): Cellular Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + kwargs['cellular_profile_id'] = \ + cellular_profile_id + return self.delete_cellular_controller_and_cellular_profile_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_cellular_controller_profile_parcel_for_transport( + self, + transport_id, + cellular_controller_id, + **kwargs + ): + """delete_cellular_controller_profile_parcel_for_transport # noqa: E501 + + Delete a Cellular Controller Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + return self.delete_cellular_controller_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_cellular_profile_profile_parcel_for_transport( + self, + transport_id, + cellular_profile_id, + **kwargs + ): + """delete_cellular_profile_profile_parcel_for_transport # noqa: E501 + + Delete a Cellular Profile Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_profile_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_profile_id'] = \ + cellular_profile_id + return self.delete_cellular_profile_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_config_profile_parcel_for_cli( + self, + cli_id, + config_id, + **kwargs + ): + """delete_config_profile_parcel_for_cli # noqa: E501 + + Delete a config Profile Parcel for cli feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_config_profile_parcel_for_cli(cli_id, config_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile ID + config_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + kwargs['config_id'] = \ + config_id + return self.delete_config_profile_parcel_for_cli_endpoint.call_with_http_info(**kwargs) + + def delete_dhcp_server_profile_parcel_for_service( + self, + service_id, + dhcp_server_id, + **kwargs + ): + """delete_dhcp_server_profile_parcel_for_service # noqa: E501 + + Delete a Dhcp Server Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + dhcp_server_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.delete_dhcp_server_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_global_profile_parcel_for_system( + self, + system_id, + global_id, + **kwargs + ): + """delete_global_profile_parcel_for_system # noqa: E501 + + Delete a Global Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_global_profile_parcel_for_system(system_id, global_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + global_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['global_id'] = \ + global_id + return self.delete_global_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_and_routing_bgp_association_for_service( + self, + service_id, + vpn_id, + bgp_id, + **kwargs + ): + """delete_lan_vpn_and_routing_bgp_association_for_service # noqa: E501 + + Delete a LanVpn parcel and a RoutingBgp Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_and_routing_bgp_association_for_service(service_id, vpn_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + bgp_id (str): Routing Bgp Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['bgp_id'] = \ + bgp_id + return self.delete_lan_vpn_and_routing_bgp_association_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_and_routing_ospf_association_for_service( + self, + service_id, + vpn_id, + ospf_id, + **kwargs + ): + """delete_lan_vpn_and_routing_ospf_association_for_service # noqa: E501 + + Delete a LanVpn parcel and a RoutingOspf Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_and_routing_ospf_association_for_service(service_id, vpn_id, ospf_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ospf_id (str): Routing Ospf Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ospf_id'] = \ + ospf_id + return self.delete_lan_vpn_and_routing_ospf_association_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport( + self, + service_id, + vpn_id, + ethernet_id, + dhcp_server_id, + **kwargs + ): + """delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport # noqa: E501 + + Delete a LanVpnInterfaceEthernet and a DhcpServer Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + dhcp_server_id (str): DhcpServer Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_interface_ethernet_for_service( + self, + service_id, + vpn_id, + ethernet_id, + **kwargs + ): + """delete_lan_vpn_interface_ethernet_for_service # noqa: E501 + + Delete a LanVpn InterfaceEthernet Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_interface_ethernet_for_service(service_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.delete_lan_vpn_interface_ethernet_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport( + self, + service_id, + vpn_id, + svi_id, + dhcp_server_id, + **kwargs + ): + """delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport # noqa: E501 + + Delete a LanVpnInterfaceSvi and a DhcpServer Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + svi_id (str): Interface Profile Parcel ID + dhcp_server_id (str): DhcpServer Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_interface_svi_for_service( + self, + service_id, + vpn_id, + svi_id, + **kwargs + ): + """delete_lan_vpn_interface_svi_for_service # noqa: E501 + + Delete a LanVpn InterfaceSvi Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_interface_svi_for_service(service_id, vpn_id, svi_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + svi_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + return self.delete_lan_vpn_interface_svi_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_lan_vpn_profile_parcel_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """delete_lan_vpn_profile_parcel_for_service # noqa: E501 + + Delete a Lan Vpn Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_lan_vpn_profile_parcel_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.delete_lan_vpn_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_logging_profile_parcel_for_system( + self, + system_id, + logging_id, + **kwargs + ): + """delete_logging_profile_parcel_for_system # noqa: E501 + + Delete a Logging Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_logging_profile_parcel_for_system(system_id, logging_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + logging_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['logging_id'] = \ + logging_id + return self.delete_logging_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_management_vpn_interface_ethernet_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """delete_management_vpn_interface_ethernet_for_transport # noqa: E501 + + Delete a ManagementVpn InterfaceEthernet Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_management_vpn_interface_ethernet_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.delete_management_vpn_interface_ethernet_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_management_vpn_profile_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """delete_management_vpn_profile_parcel_for_transport # noqa: E501 + + Delete a Management Vpn Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_management_vpn_profile_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.delete_management_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_ntp_profile_parcel_for_system( + self, + system_id, + ntp_id, + **kwargs + ): + """delete_ntp_profile_parcel_for_system # noqa: E501 + + Delete a Ntp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_ntp_profile_parcel_for_system(system_id, ntp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + ntp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['ntp_id'] = \ + ntp_id + return self.delete_ntp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_omp_profile_parcel_for_system( + self, + system_id, + omp_id, + **kwargs + ): + """delete_omp_profile_parcel_for_system # noqa: E501 + + Delete a Omp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_omp_profile_parcel_for_system(system_id, omp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + omp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['omp_id'] = \ + omp_id + return self.delete_omp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_routing_bgp_profile_parcel_for_service( + self, + service_id, + bgp_id, + **kwargs + ): + """delete_routing_bgp_profile_parcel_for_service # noqa: E501 + + Delete a Routing Bgp Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_routing_bgp_profile_parcel_for_service(service_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + bgp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['bgp_id'] = \ + bgp_id + return self.delete_routing_bgp_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_routing_bgp_profile_parcel_for_transport( + self, + transport_id, + bgp_id, + **kwargs + ): + """delete_routing_bgp_profile_parcel_for_transport # noqa: E501 + + Delete a Routing Bgp Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + bgp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['bgp_id'] = \ + bgp_id + return self.delete_routing_bgp_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_routing_ospf_profile_parcel_for_service( + self, + service_id, + ospf_id, + **kwargs + ): + """delete_routing_ospf_profile_parcel_for_service # noqa: E501 + + Delete a Routing Ospf Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_routing_ospf_profile_parcel_for_service(service_id, ospf_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + ospf_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['ospf_id'] = \ + ospf_id + return self.delete_routing_ospf_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_sdwan_feature_profile_for_cli( + self, + cli_id, + **kwargs + ): + """delete_sdwan_feature_profile_for_cli # noqa: E501 + + Delete Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_sdwan_feature_profile_for_cli(cli_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + return self.delete_sdwan_feature_profile_for_cli_endpoint.call_with_http_info(**kwargs) + + def delete_sdwan_other_feature_profile( + self, + other_id, + **kwargs + ): + """delete_sdwan_other_feature_profile # noqa: E501 + + Delete Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_sdwan_other_feature_profile(other_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + return self.delete_sdwan_other_feature_profile_endpoint.call_with_http_info(**kwargs) + + def delete_sdwan_service_feature_profile( + self, + service_id, + **kwargs + ): + """delete_sdwan_service_feature_profile # noqa: E501 + + Delete Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_sdwan_service_feature_profile(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.delete_sdwan_service_feature_profile_endpoint.call_with_http_info(**kwargs) + + def delete_sdwan_system_feature_profile( + self, + system_id, + **kwargs + ): + """delete_sdwan_system_feature_profile # noqa: E501 + + Delete Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_sdwan_system_feature_profile(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.delete_sdwan_system_feature_profile_endpoint.call_with_http_info(**kwargs) + + def delete_sdwan_transport_feature_profile( + self, + transport_id, + **kwargs + ): + """delete_sdwan_transport_feature_profile # noqa: E501 + + Delete Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_sdwan_transport_feature_profile(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.delete_sdwan_transport_feature_profile_endpoint.call_with_http_info(**kwargs) + + def delete_snmp_profile_parcel_for_system( + self, + system_id, + snmp_id, + **kwargs + ): + """delete_snmp_profile_parcel_for_system # noqa: E501 + + Delete a Snmp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_snmp_profile_parcel_for_system(system_id, snmp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + snmp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['snmp_id'] = \ + snmp_id + return self.delete_snmp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def delete_switchport_profile_parcel_for_service( + self, + service_id, + switchport_id, + **kwargs + ): + """delete_switchport_profile_parcel_for_service # noqa: E501 + + Delete a Switchport Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_switchport_profile_parcel_for_service(service_id, switchport_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + switchport_id (str): Switchport Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['switchport_id'] = \ + switchport_id + return self.delete_switchport_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def delete_thousandeyes_profile_parcel_for_other( + self, + other_id, + thousandeyes_id, + **kwargs + ): + """delete_thousandeyes_profile_parcel_for_other # noqa: E501 + + Delete a Thousandeyes Profile Parcel for Other feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile ID + thousandeyes_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + kwargs['thousandeyes_id'] = \ + thousandeyes_id + return self.delete_thousandeyes_profile_parcel_for_other_endpoint.call_with_http_info(**kwargs) + + def delete_tracker_profile_parcel_for_transport( + self, + transport_id, + tracker_id, + **kwargs + ): + """delete_tracker_profile_parcel_for_transport # noqa: E501 + + Delete a Tracker Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tracker_profile_parcel_for_transport(transport_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + tracker_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['tracker_id'] = \ + tracker_id + return self.delete_tracker_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wan_vpn_and_routing_bgp_association_for_transport( + self, + transport_id, + vpn_id, + bgp_id, + **kwargs + ): + """delete_wan_vpn_and_routing_bgp_association_for_transport # noqa: E501 + + Delete a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_vpn_and_routing_bgp_association_for_transport(transport_id, vpn_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + bgp_id (str): Routing Bgp Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['bgp_id'] = \ + bgp_id + return self.delete_wan_vpn_and_routing_bgp_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wan_vpn_interface_cellular_and_tracker_association_for_transport( + self, + transport_id, + vpn_id, + cellular_id, + tracker_id, + **kwargs + ): + """delete_wan_vpn_interface_cellular_and_tracker_association_for_transport # noqa: E501 + + Delete a WanVpnInterfaceCellular and a Tracker Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_vpn_interface_cellular_and_tracker_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + cellular_id (str): Interface Profile Parcel ID + tracker_id (str): Tracker Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['cellular_id'] = \ + cellular_id + kwargs['tracker_id'] = \ + tracker_id + return self.delete_wan_vpn_interface_cellular_and_tracker_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wan_vpn_interface_cellular_for_transport( + self, + transport_id, + vpn_id, + intf_id, + **kwargs + ): + """delete_wan_vpn_interface_cellular_for_transport # noqa: E501 + + Delete a wanvpn Cellular interface Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_vpn_interface_cellular_for_transport(transport_id, vpn_id, intf_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + intf_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['intf_id'] = \ + intf_id + return self.delete_wan_vpn_interface_cellular_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + tracker_id, + **kwargs + ): + """delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport # noqa: E501 + + Delete a WanVpnInterfaceEthernet and a Tracker Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + tracker_id (str): Tracker Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + kwargs['tracker_id'] = \ + tracker_id + return self.delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wan_vpn_interface_ethernet_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """delete_wan_vpn_interface_ethernet_for_transport # noqa: E501 + + Delete a WanVpn InterfaceEthernet Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_vpn_interface_ethernet_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.delete_wan_vpn_interface_ethernet_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wan_vpn_profile_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """delete_wan_vpn_profile_parcel_for_transport # noqa: E501 + + Delete a Wan Vpn Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.delete_wan_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def delete_wirelesslan_profile_parcel_for_service( + self, + service_id, + wirelesslan_id, + **kwargs + ): + """delete_wirelesslan_profile_parcel_for_service # noqa: E501 + + Delete a Wirelesslan Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + wirelesslan_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['wirelesslan_id'] = \ + wirelesslan_id + return self.delete_wirelesslan_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_aaa_profile_parcel_for_system( + self, + system_id, + aaa_id, + **kwargs + ): + """edit_aaa_profile_parcel_for_system # noqa: E501 + + Update a Aaa Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_aaa_profile_parcel_for_system(system_id, aaa_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + aaa_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Aaa Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['aaa_id'] = \ + aaa_id + return self.edit_aaa_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_banner_profile_parcel_for_system( + self, + system_id, + banner_id, + **kwargs + ): + """edit_banner_profile_parcel_for_system # noqa: E501 + + Update a Banner Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_banner_profile_parcel_for_system(system_id, banner_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + banner_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Banner Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['banner_id'] = \ + banner_id + return self.edit_banner_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_basic_profile_parcel_for_system( + self, + system_id, + basic_id, + **kwargs + ): + """edit_basic_profile_parcel_for_system # noqa: E501 + + Update a Basic Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_basic_profile_parcel_for_system(system_id, basic_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + basic_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Basic Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['basic_id'] = \ + basic_id + return self.edit_basic_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_bfd_profile_parcel_for_system( + self, + system_id, + bfd_id, + **kwargs + ): + """edit_bfd_profile_parcel_for_system # noqa: E501 + + Update a Bfd Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_bfd_profile_parcel_for_system(system_id, bfd_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + bfd_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Bfd Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['bfd_id'] = \ + bfd_id + return self.edit_bfd_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_cellular_controller_and_cellular_profile_parcel_association_for_transport( + self, + transport_id, + cellular_controller_id, + cellular_profile_id, + **kwargs + ): + """edit_cellular_controller_and_cellular_profile_parcel_association_for_transport # noqa: E501 + + Update a CellularController parcel and a CellularProfile Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_cellular_controller_and_cellular_profile_parcel_association_for_transport(transport_id, cellular_controller_id, cellular_profile_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Profile Parcel ID + cellular_profile_id (str): Cellular Profile ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Cellular Profile Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + kwargs['cellular_profile_id'] = \ + cellular_profile_id + return self.edit_cellular_controller_and_cellular_profile_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_cellular_controller_profile_parcel_for_transport( + self, + transport_id, + cellular_controller_id, + **kwargs + ): + """edit_cellular_controller_profile_parcel_for_transport # noqa: E501 + + Update a Cellular Controller Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_cellular_controller_profile_parcel_for_transport(transport_id, cellular_controller_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Cellular Controller Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + return self.edit_cellular_controller_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_cellular_profile_profile_parcel_for_transport( + self, + transport_id, + cellular_profile_id, + **kwargs + ): + """edit_cellular_profile_profile_parcel_for_transport # noqa: E501 + + Update a Cellular Profile Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_cellular_profile_profile_parcel_for_transport(transport_id, cellular_profile_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_profile_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Cellular Profile Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_profile_id'] = \ + cellular_profile_id + return self.edit_cellular_profile_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_config_profile_parcel_for_cli( + self, + cli_id, + config_id, + **kwargs + ): + """edit_config_profile_parcel_for_cli # noqa: E501 + + Update a config Profile Parcel for cli feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_config_profile_parcel_for_cli(cli_id, config_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile ID + config_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): cli config Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + kwargs['config_id'] = \ + config_id + return self.edit_config_profile_parcel_for_cli_endpoint.call_with_http_info(**kwargs) + + def edit_dhcp_server_profile_parcel_for_service( + self, + service_id, + dhcp_server_id, + **kwargs + ): + """edit_dhcp_server_profile_parcel_for_service # noqa: E501 + + Update a Dhcp Server Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_dhcp_server_profile_parcel_for_service(service_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + dhcp_server_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Dhcp Server Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.edit_dhcp_server_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_global_profile_parcel_for_system( + self, + system_id, + global_id, + **kwargs + ): + """edit_global_profile_parcel_for_system # noqa: E501 + + Update a Global Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_global_profile_parcel_for_system(system_id, global_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + global_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Global Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['global_id'] = \ + global_id + return self.edit_global_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_and_routing_bgp_parcel_association_for_service( + self, + service_id, + vpn_id, + bgp_id, + **kwargs + ): + """edit_lan_vpn_and_routing_bgp_parcel_association_for_service # noqa: E501 + + Update a LanVpn parcel and a RoutingBgp Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_and_routing_bgp_parcel_association_for_service(service_id, vpn_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + bgp_id (str): Routing Bgp ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['bgp_id'] = \ + bgp_id + return self.edit_lan_vpn_and_routing_bgp_parcel_association_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_and_routing_ospf_parcel_association_for_service( + self, + service_id, + vpn_id, + ospf_id, + **kwargs + ): + """edit_lan_vpn_and_routing_ospf_parcel_association_for_service # noqa: E501 + + Update a LanVpn parcel and a RoutingOspf Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_and_routing_ospf_parcel_association_for_service(service_id, vpn_id, ospf_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ospf_id (str): Routing Ospf ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Ospf Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ospf_id'] = \ + ospf_id + return self.edit_lan_vpn_and_routing_ospf_parcel_association_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport( + self, + service_id, + vpn_id, + ethernet_id, + dhcp_server_id, + **kwargs + ): + """edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport # noqa: E501 + + Update a LanVpnInterfaceEthernet parcel and a DhcpServer Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + dhcp_server_id (str): DhcpServer ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): DhcpServer Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_interface_ethernet_parcel_for_service( + self, + service_id, + vpn_id, + ethernet_id, + **kwargs + ): + """edit_lan_vpn_interface_ethernet_parcel_for_service # noqa: E501 + + Update a LanVpn InterfaceEthernet Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_interface_ethernet_parcel_for_service(service_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Lan Vpn Interface Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.edit_lan_vpn_interface_ethernet_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport( + self, + service_id, + vpn_id, + svi_id, + dhcp_server_id, + **kwargs + ): + """edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport # noqa: E501 + + Update a LanVpnInterfaceSvi parcel and a DhcpServer Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(service_id, vpn_id, svi_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + svi_id (str): Interface Profile Parcel ID + dhcp_server_id (str): DhcpServer ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): DhcpServer Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_interface_svi_parcel_for_service( + self, + service_id, + vpn_id, + svi_id, + **kwargs + ): + """edit_lan_vpn_interface_svi_parcel_for_service # noqa: E501 + + Update a LanVpn InterfaceSvi Parcel for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_interface_svi_parcel_for_service(service_id, vpn_id, svi_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + svi_id (str): Interface ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Lan Vpn Interface Svi Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + return self.edit_lan_vpn_interface_svi_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_lan_vpn_profile_parcel_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """edit_lan_vpn_profile_parcel_for_service # noqa: E501 + + Update a Lan Vpn Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_lan_vpn_profile_parcel_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Lan Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.edit_lan_vpn_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_logging_profile_parcel_for_system( + self, + system_id, + logging_id, + **kwargs + ): + """edit_logging_profile_parcel_for_system # noqa: E501 + + Update a Logging Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_logging_profile_parcel_for_system(system_id, logging_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + logging_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Logging Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['logging_id'] = \ + logging_id + return self.edit_logging_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_management_vpn_interface_ethernet_parcel_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """edit_management_vpn_interface_ethernet_parcel_for_transport # noqa: E501 + + Update a ManagementVpn InterfaceEthernet Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_management_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Management Vpn Interface Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.edit_management_vpn_interface_ethernet_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_management_vpn_profile_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """edit_management_vpn_profile_parcel_for_transport # noqa: E501 + + Update a Management Vpn Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_management_vpn_profile_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Management Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.edit_management_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_ntp_profile_parcel_for_system( + self, + system_id, + ntp_id, + **kwargs + ): + """edit_ntp_profile_parcel_for_system # noqa: E501 + + Update a Ntp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_ntp_profile_parcel_for_system(system_id, ntp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + ntp_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Ntp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['ntp_id'] = \ + ntp_id + return self.edit_ntp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_omp_profile_parcel_for_system( + self, + system_id, + omp_id, + **kwargs + ): + """edit_omp_profile_parcel_for_system # noqa: E501 + + Update a Omp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_omp_profile_parcel_for_system(system_id, omp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + omp_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Omp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['omp_id'] = \ + omp_id + return self.edit_omp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_routing_bgp_profile_parcel_for_service( + self, + service_id, + bgp_id, + **kwargs + ): + """edit_routing_bgp_profile_parcel_for_service # noqa: E501 + + Update a Routing Bgp Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_routing_bgp_profile_parcel_for_service(service_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + bgp_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['bgp_id'] = \ + bgp_id + return self.edit_routing_bgp_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_routing_bgp_profile_parcel_for_transport( + self, + transport_id, + bgp_id, + **kwargs + ): + """edit_routing_bgp_profile_parcel_for_transport # noqa: E501 + + Update a Routing Bgp Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_routing_bgp_profile_parcel_for_transport(transport_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + bgp_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['bgp_id'] = \ + bgp_id + return self.edit_routing_bgp_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_routing_ospf_profile_parcel_for_service( + self, + service_id, + ospf_id, + **kwargs + ): + """edit_routing_ospf_profile_parcel_for_service # noqa: E501 + + Update a Routing Ospf Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_routing_ospf_profile_parcel_for_service(service_id, ospf_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + ospf_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Ospf Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['ospf_id'] = \ + ospf_id + return self.edit_routing_ospf_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_sdwan_feature_profile( + self, + cli_id, + **kwargs + ): + """edit_sdwan_feature_profile # noqa: E501 + + Edit a SDWAN Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_sdwan_feature_profile(cli_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + return self.edit_sdwan_feature_profile_endpoint.call_with_http_info(**kwargs) + + def edit_sdwan_other_feature_profile( + self, + other_id, + **kwargs + ): + """edit_sdwan_other_feature_profile # noqa: E501 + + Edit a SDWAN Other Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_sdwan_other_feature_profile(other_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + return self.edit_sdwan_other_feature_profile_endpoint.call_with_http_info(**kwargs) + + def edit_sdwan_service_feature_profile( + self, + service_id, + **kwargs + ): + """edit_sdwan_service_feature_profile # noqa: E501 + + Edit a SDWAN Service Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_sdwan_service_feature_profile(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.edit_sdwan_service_feature_profile_endpoint.call_with_http_info(**kwargs) + + def edit_sdwan_system_feature_profile( + self, + system_id, + **kwargs + ): + """edit_sdwan_system_feature_profile # noqa: E501 + + Edit a SDWAN System Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_sdwan_system_feature_profile(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.edit_sdwan_system_feature_profile_endpoint.call_with_http_info(**kwargs) + + def edit_sdwan_transport_feature_profile( + self, + transport_id, + **kwargs + ): + """edit_sdwan_transport_feature_profile # noqa: E501 + + Edit a SDWAN Transport Feature Profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_sdwan_transport_feature_profile(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile Id + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): SDWAN Feature profile. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.edit_sdwan_transport_feature_profile_endpoint.call_with_http_info(**kwargs) + + def edit_snmp_profile_parcel_for_system( + self, + system_id, + snmp_id, + **kwargs + ): + """edit_snmp_profile_parcel_for_system # noqa: E501 + + Update a Snmp Profile Parcel for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_snmp_profile_parcel_for_system(system_id, snmp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + snmp_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Snmp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['snmp_id'] = \ + snmp_id + return self.edit_snmp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def edit_switchport_parcel_association_for_service( + self, + service_id, + switchport_id, + **kwargs + ): + """edit_switchport_parcel_association_for_service # noqa: E501 + + Update a Switchport Parcel association for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_switchport_parcel_association_for_service(service_id, switchport_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + switchport_id (str): Switchport ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Switchport Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['switchport_id'] = \ + switchport_id + return self.edit_switchport_parcel_association_for_service_endpoint.call_with_http_info(**kwargs) + + def edit_thousandeyes_profile_parcel_for_other( + self, + other_id, + thousandeyes_id, + **kwargs + ): + """edit_thousandeyes_profile_parcel_for_other # noqa: E501 + + Update a Thousandeyes Profile Parcel for Other feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_thousandeyes_profile_parcel_for_other(other_id, thousandeyes_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile ID + thousandeyes_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Thousandeyes Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + kwargs['thousandeyes_id'] = \ + thousandeyes_id + return self.edit_thousandeyes_profile_parcel_for_other_endpoint.call_with_http_info(**kwargs) + + def edit_tracker_profile_parcel_for_transport( + self, + transport_id, + tracker_id, + **kwargs + ): + """edit_tracker_profile_parcel_for_transport # noqa: E501 + + Update a Tracker Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_tracker_profile_parcel_for_transport(transport_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + tracker_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Tracker Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['tracker_id'] = \ + tracker_id + return self.edit_tracker_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wan_vpn_and_routing_bgp_parcel_association_for_transport( + self, + transport_id, + vpn_id, + bgp_id, + **kwargs + ): + """edit_wan_vpn_and_routing_bgp_parcel_association_for_transport # noqa: E501 + + Update a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_vpn_and_routing_bgp_parcel_association_for_transport(transport_id, vpn_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + bgp_id (str): Routing Bgp ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Routing Bgp Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['bgp_id'] = \ + bgp_id + return self.edit_wan_vpn_and_routing_bgp_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport( + self, + transport_id, + vpn_id, + cellular_id, + tracker_id, + **kwargs + ): + """edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport # noqa: E501 + + Update a WanVpnInterfaceCellular parcel and a Tracker Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(transport_id, vpn_id, cellular_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + cellular_id (str): Interface Profile Parcel ID + tracker_id (str): Tracker ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Tracker Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['cellular_id'] = \ + cellular_id + kwargs['tracker_id'] = \ + tracker_id + return self.edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wan_vpn_interface_cellular_parcel_for_transport( + self, + transport_id, + vpn_id, + intf_id, + **kwargs + ): + """edit_wan_vpn_interface_cellular_parcel_for_transport # noqa: E501 + + Update a wanvpn Cellular Interface Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_vpn_interface_cellular_parcel_for_transport(transport_id, vpn_id, intf_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + intf_id (str): Interface ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): WanVpn Cellular Interface Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['intf_id'] = \ + intf_id + return self.edit_wan_vpn_interface_cellular_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + tracker_id, + **kwargs + ): + """edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport # noqa: E501 + + Update a WanVpnInterfaceEthernet parcel and a Tracker Parcel association for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(transport_id, vpn_id, ethernet_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + tracker_id (str): Tracker ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Tracker Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool, date, datetime, dict, float, int, list, str, none_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + kwargs['tracker_id'] = \ + tracker_id + return self.edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wan_vpn_interface_ethernet_parcel_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """edit_wan_vpn_interface_ethernet_parcel_for_transport # noqa: E501 + + Update a WanVpn InterfaceEthernet Parcel for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_vpn_interface_ethernet_parcel_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Wan Vpn Interface Ethernet Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.edit_wan_vpn_interface_ethernet_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wan_vpn_profile_parcel_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """edit_wan_vpn_profile_parcel_for_transport # noqa: E501 + + Update a Wan Vpn Profile Parcel for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wan_vpn_profile_parcel_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Wan Vpn Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.edit_wan_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def edit_wirelesslan_profile_parcel_for_service( + self, + service_id, + wirelesslan_id, + **kwargs + ): + """edit_wirelesslan_profile_parcel_for_service # noqa: E501 + + Update a Wirelesslan Profile Parcel for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_wirelesslan_profile_parcel_for_service(service_id, wirelesslan_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + wirelesslan_id (str): Profile Parcel ID + + Keyword Args: + body (bool, date, datetime, dict, float, int, list, str, none_type): Wirelesslan Profile Parcel. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['wirelesslan_id'] = \ + wirelesslan_id + return self.edit_wirelesslan_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def get_aaa_profile_parcel_by_parcel_id_for_system( + self, + system_id, + aaa_id, + **kwargs + ): + """get_aaa_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Aaa Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aaa_profile_parcel_by_parcel_id_for_system(system_id, aaa_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + aaa_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['aaa_id'] = \ + aaa_id + return self.get_aaa_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_aaa_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_aaa_profile_parcel_for_system # noqa: E501 + + Get Aaa Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aaa_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_aaa_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_banner_profile_parcel_by_parcel_id_for_system( + self, + system_id, + banner_id, + **kwargs + ): + """get_banner_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Banner Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_banner_profile_parcel_by_parcel_id_for_system(system_id, banner_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + banner_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['banner_id'] = \ + banner_id + return self.get_banner_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_banner_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_banner_profile_parcel_for_system # noqa: E501 + + Get Banner Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_banner_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_banner_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_basic_profile_parcel_by_parcel_id_for_system( + self, + system_id, + basic_id, + **kwargs + ): + """get_basic_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Basic Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_basic_profile_parcel_by_parcel_id_for_system(system_id, basic_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + basic_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['basic_id'] = \ + basic_id + return self.get_basic_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_basic_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_basic_profile_parcel_for_system # noqa: E501 + + Get Basic Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_basic_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_basic_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_bfd_profile_parcel_by_parcel_id_for_system( + self, + system_id, + bfd_id, + **kwargs + ): + """get_bfd_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Bfd Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bfd_profile_parcel_by_parcel_id_for_system(system_id, bfd_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + bfd_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['bfd_id'] = \ + bfd_id + return self.get_bfd_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_bfd_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_bfd_profile_parcel_for_system # noqa: E501 + + Get Bfd Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bfd_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_bfd_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema( + self, + schema_type, + **kwargs + ): + """get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema # noqa: E501 + + Get a Cedge Service LanVpn InterfaceSvi Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema_endpoint.call_with_http_info(**kwargs) + + def get_cedge_service_switchport_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_cedge_service_switchport_parcel_schema_by_schema_type # noqa: E501 + + Get a Cedge Service Switchport Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cedge_service_switchport_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_cedge_service_switchport_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_cedge_system_global_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_cedge_system_global_parcel_schema_by_schema_type # noqa: E501 + + Get a Cedge System Global Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cedge_system_global_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_cedge_system_global_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + cellular_controller_id, + cellular_profile_id, + **kwargs + ): + """get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get CellularController parcel associated CellularProfile Parcel by cellularProfileId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_controller_id, cellular_profile_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Profile Parcel ID + cellular_profile_id (str): Cellular Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + kwargs['cellular_profile_id'] = \ + cellular_profile_id + return self.get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_cellular_controller_associated_cellular_profile_parcels_for_transport( + self, + transport_id, + cellular_controller_id, + **kwargs + ): + """get_cellular_controller_associated_cellular_profile_parcels_for_transport # noqa: E501 + + Get CellularController associated Cellular Profile Parcels for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_controller_associated_cellular_profile_parcels_for_transport(transport_id, cellular_controller_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + return self.get_cellular_controller_associated_cellular_profile_parcels_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_cellular_controller_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + cellular_controller_id, + **kwargs + ): + """get_cellular_controller_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get Cellular Controller Profile Parcel by parcelId for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_controller_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_controller_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_controller_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_controller_id'] = \ + cellular_controller_id + return self.get_cellular_controller_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_cellular_controller_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """get_cellular_controller_profile_parcel_for_transport # noqa: E501 + + Get Cellular Controller Profile Parcels for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_controller_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_cellular_controller_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_cellular_profile_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + cellular_profile_id, + **kwargs + ): + """get_cellular_profile_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get Cellular Profile Profile Parcel by parcelId for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_profile_profile_parcel_by_parcel_id_for_transport(transport_id, cellular_profile_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + cellular_profile_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['cellular_profile_id'] = \ + cellular_profile_id + return self.get_cellular_profile_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_cellular_profile_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """get_cellular_profile_profile_parcel_for_transport # noqa: E501 + + Get Cellular Profile Profile Parcels for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_profile_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_cellular_profile_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_config_profile_parcel_by_parcel_id_for_cli( + self, + cli_id, + config_id, + **kwargs + ): + """get_config_profile_parcel_by_parcel_id_for_cli # noqa: E501 + + Get config Profile Parcel by configId for cli feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_profile_parcel_by_parcel_id_for_cli(cli_id, config_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile ID + config_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + kwargs['config_id'] = \ + config_id + return self.get_config_profile_parcel_by_parcel_id_for_cli_endpoint.call_with_http_info(**kwargs) + + def get_config_profile_parcel_for_cli( + self, + cli_id, + **kwargs + ): + """get_config_profile_parcel_for_cli # noqa: E501 + + Get config Profile Parcels for cli feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_config_profile_parcel_for_cli(cli_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + return self.get_config_profile_parcel_for_cli_endpoint.call_with_http_info(**kwargs) + + def get_dhcp_server_profile_parcel_by_parcel_id_for_service( + self, + service_id, + dhcp_server_id, + **kwargs + ): + """get_dhcp_server_profile_parcel_by_parcel_id_for_service # noqa: E501 + + Get Dhcp Server Profile Parcel by parcelId for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dhcp_server_profile_parcel_by_parcel_id_for_service(service_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + dhcp_server_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.get_dhcp_server_profile_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_dhcp_server_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """get_dhcp_server_profile_parcel_for_service # noqa: E501 + + Get Dhcp Server Profile Parcels for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dhcp_server_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_dhcp_server_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def get_global_profile_parcel_by_parcel_id_for_system( + self, + system_id, + global_id, + **kwargs + ): + """get_global_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Global Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_global_profile_parcel_by_parcel_id_for_system(system_id, global_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + global_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['global_id'] = \ + global_id + return self.get_global_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_global_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_global_profile_parcel_for_system # noqa: E501 + + Get Global Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_global_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_global_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_interface_cellular_parcels_for_transport_wan_vpn( + self, + transport_id, + vpn_id, + **kwargs + ): + """get_interface_cellular_parcels_for_transport_wan_vpn # noqa: E501 + + Get Interface Cellular Parcels for transport Wan Vpn Parcel # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_interface_cellular_parcels_for_transport_wan_vpn(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_interface_cellular_parcels_for_transport_wan_vpn_endpoint.call_with_http_info(**kwargs) + + def get_interface_ethernet_parcels_for_service_lan_vpn( + self, + service_id, + vpn_id, + **kwargs + ): + """get_interface_ethernet_parcels_for_service_lan_vpn # noqa: E501 + + Get InterfaceEthernet Parcels for service LanVpn Parcel # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_interface_ethernet_parcels_for_service_lan_vpn(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_interface_ethernet_parcels_for_service_lan_vpn_endpoint.call_with_http_info(**kwargs) + + def get_interface_ethernet_parcels_for_transport_management_vpn( + self, + transport_id, + vpn_id, + **kwargs + ): + """get_interface_ethernet_parcels_for_transport_management_vpn # noqa: E501 + + Get InterfaceEthernet Parcels for transport ManagementVpn Parcel # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_interface_ethernet_parcels_for_transport_management_vpn(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_interface_ethernet_parcels_for_transport_management_vpn_endpoint.call_with_http_info(**kwargs) + + def get_interface_ethernet_parcels_for_transport_wan_vpn( + self, + transport_id, + vpn_id, + **kwargs + ): + """get_interface_ethernet_parcels_for_transport_wan_vpn # noqa: E501 + + Get InterfaceEthernet Parcels for transport WanVpn Parcel # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_interface_ethernet_parcels_for_transport_wan_vpn(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_interface_ethernet_parcels_for_transport_wan_vpn_endpoint.call_with_http_info(**kwargs) + + def get_interface_svi_parcels_for_service_lan_vpn( + self, + service_id, + vpn_id, + **kwargs + ): + """get_interface_svi_parcels_for_service_lan_vpn # noqa: E501 + + Get InterfaceSvi Parcels for service LanVpn Parcel # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_interface_svi_parcels_for_service_lan_vpn(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_interface_svi_parcels_for_service_lan_vpn_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service( + self, + service_id, + vpn_id, + bgp_id, + **kwargs + ): + """get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service # noqa: E501 + + Get LanVpn parcel associated RoutingBgp Parcel by bgpId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service(service_id, vpn_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + bgp_id (str): Routing Bgp Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['bgp_id'] = \ + bgp_id + return self.get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_associated_routing_bgp_parcels_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """get_lan_vpn_associated_routing_bgp_parcels_for_service # noqa: E501 + + Get LanVpn associated Routing Bgp Parcels for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_associated_routing_bgp_parcels_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_lan_vpn_associated_routing_bgp_parcels_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service( + self, + service_id, + vpn_id, + ospf_id, + **kwargs + ): + """get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service # noqa: E501 + + Get LanVpn parcel associated RoutingOspf Parcel by ospfId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service(service_id, vpn_id, ospf_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ospf_id (str): Routing Ospf Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ospf_id'] = \ + ospf_id + return self.get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_associated_routing_ospf_parcels_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """get_lan_vpn_associated_routing_ospf_parcels_for_service # noqa: E501 + + Get LanVpn associated Routing Ospf Parcels for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_associated_routing_ospf_parcels_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_lan_vpn_associated_routing_ospf_parcels_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport( + self, + service_id, + vpn_id, + ethernet_id, + dhcp_server_id, + **kwargs + ): + """get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport # noqa: E501 + + Get LanVpnInterfaceEthernet associated DhcpServer Parcel by dhcpServerId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport(service_id, vpn_id, ethernet_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + dhcp_server_id (str): DhcpServer Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport( + self, + service_id, + vpn_id, + ethernet_id, + **kwargs + ): + """get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport # noqa: E501 + + Get LanVpnInterfaceEthernet associated DhcpServer Parcels for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport(service_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + ethernet_id (str): Interface Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service( + self, + service_id, + vpn_id, + ethernet_id, + **kwargs + ): + """get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service # noqa: E501 + + Get LanVpn InterfaceEthernet Parcel by ethernetId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service(service_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport( + self, + service_id, + vpn_id, + svi_id, + dhcp_server_id, + **kwargs + ): + """get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport # noqa: E501 + + Get LanVpnInterfaceSvi associated DhcpServer Parcel by dhcpServerId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport(service_id, vpn_id, svi_id, dhcp_server_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + svi_id (str): Interface Profile Parcel ID + dhcp_server_id (str): DhcpServer Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + kwargs['dhcp_server_id'] = \ + dhcp_server_id + return self.get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport( + self, + service_id, + vpn_id, + svi_id, + **kwargs + ): + """get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport # noqa: E501 + + Get LanVpnInterfaceSvi associated DhcpServer Parcels for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport(service_id, vpn_id, svi_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + svi_id (str): Interface Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + return self.get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service( + self, + service_id, + vpn_id, + svi_id, + **kwargs + ): + """get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service # noqa: E501 + + Get LanVpn InterfaceSvi Parcel by sviId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service(service_id, vpn_id, svi_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + svi_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['svi_id'] = \ + svi_id + return self.get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_profile_parcel_by_parcel_id_for_service( + self, + service_id, + vpn_id, + **kwargs + ): + """get_lan_vpn_profile_parcel_by_parcel_id_for_service # noqa: E501 + + Get Lan Vpn Profile Parcel by parcelId for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_profile_parcel_by_parcel_id_for_service(service_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_lan_vpn_profile_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_lan_vpn_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """get_lan_vpn_profile_parcel_for_service # noqa: E501 + + Get Lan Vpn Profile Parcels for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lan_vpn_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_lan_vpn_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def get_logging_profile_parcel_by_parcel_id_for_system( + self, + system_id, + logging_id, + **kwargs + ): + """get_logging_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Logging Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_logging_profile_parcel_by_parcel_id_for_system(system_id, logging_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + logging_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['logging_id'] = \ + logging_id + return self.get_logging_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_logging_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_logging_profile_parcel_for_system # noqa: E501 + + Get Logging Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_logging_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_logging_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport # noqa: E501 + + Get ManagementVpn InterfaceEthernet Parcel by ethernetId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_management_vpn_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """get_management_vpn_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get Management Vpn Profile Parcel by parcelId for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_management_vpn_profile_parcel_by_parcel_id_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_management_vpn_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_management_vpn_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """get_management_vpn_profile_parcel_for_transport # noqa: E501 + + Get Management Vpn Profile Parcels for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_management_vpn_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_management_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_ntp_profile_parcel_by_parcel_id_for_system( + self, + system_id, + ntp_id, + **kwargs + ): + """get_ntp_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Ntp Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ntp_profile_parcel_by_parcel_id_for_system(system_id, ntp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + ntp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['ntp_id'] = \ + ntp_id + return self.get_ntp_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_ntp_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_ntp_profile_parcel_for_system # noqa: E501 + + Get Ntp Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ntp_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_ntp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_omp_profile_parcel_by_parcel_id_for_system( + self, + system_id, + omp_id, + **kwargs + ): + """get_omp_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Omp Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_omp_profile_parcel_by_parcel_id_for_system(system_id, omp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + omp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['omp_id'] = \ + omp_id + return self.get_omp_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_omp_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_omp_profile_parcel_for_system # noqa: E501 + + Get Omp Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_omp_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_omp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_routing_bgp_profile_parcel_by_parcel_id_for_service( + self, + service_id, + bgp_id, + **kwargs + ): + """get_routing_bgp_profile_parcel_by_parcel_id_for_service # noqa: E501 + + Get Routing Bgp Profile Parcel by parcelId for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_bgp_profile_parcel_by_parcel_id_for_service(service_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + bgp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['bgp_id'] = \ + bgp_id + return self.get_routing_bgp_profile_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_routing_bgp_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + bgp_id, + **kwargs + ): + """get_routing_bgp_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get Routing Bgp Profile Parcel by parcelId for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_bgp_profile_parcel_by_parcel_id_for_transport(transport_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + bgp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['bgp_id'] = \ + bgp_id + return self.get_routing_bgp_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_routing_bgp_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """get_routing_bgp_profile_parcel_for_service # noqa: E501 + + Get Routing Bgp Profile Parcels for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_bgp_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_routing_bgp_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def get_routing_bgp_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """get_routing_bgp_profile_parcel_for_transport # noqa: E501 + + Get Routing Bgp Profile Parcels for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_bgp_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_routing_bgp_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_routing_ospf_profile_parcel_by_parcel_id_for_service( + self, + service_id, + ospf_id, + **kwargs + ): + """get_routing_ospf_profile_parcel_by_parcel_id_for_service # noqa: E501 + + Get Routing Ospf Profile Parcel by parcelId for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_ospf_profile_parcel_by_parcel_id_for_service(service_id, ospf_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + ospf_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['ospf_id'] = \ + ospf_id + return self.get_routing_ospf_profile_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_routing_ospf_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """get_routing_ospf_profile_parcel_for_service # noqa: E501 + + Get Routing Ospf Profile Parcels for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_ospf_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_routing_ospf_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_feature_profile_by_profile_id( + self, + cli_id, + **kwargs + ): + """get_sdwan_feature_profile_by_profile_id # noqa: E501 + + Get a SDWAN Feature Profile with Cli profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_feature_profile_by_profile_id(cli_id, async_req=True) + >>> result = thread.get() + + Args: + cli_id (str): Feature Profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cli_id'] = \ + cli_id + return self.get_sdwan_feature_profile_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_feature_profile_by_sdwan_family( + self, + **kwargs + ): + """get_sdwan_feature_profile_by_sdwan_family # noqa: E501 + + Get all SDWAN Feature Profiles # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_feature_profile_by_sdwan_family(async_req=True) + >>> result = thread.get() + + + Keyword Args: + offset (int): Pagination offset. [optional] + limit (int): Pagination limit. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sdwan_feature_profile_by_sdwan_family_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_feature_profiles_by_family_and_type( + self, + **kwargs + ): + """get_sdwan_feature_profiles_by_family_and_type # noqa: E501 + + Get all SDWAN Feature Profiles with giving Family and profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_feature_profiles_by_family_and_type(async_req=True) + >>> result = thread.get() + + + Keyword Args: + offset (int): Pagination offset. [optional] + limit (int): Pagination limit. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sdwan_feature_profiles_by_family_and_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_other_feature_profile_by_profile_id( + self, + other_id, + **kwargs + ): + """get_sdwan_other_feature_profile_by_profile_id # noqa: E501 + + Get a SDWAN Other Feature Profile with otherId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_other_feature_profile_by_profile_id(other_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + return self.get_sdwan_other_feature_profile_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_other_feature_profiles( + self, + **kwargs + ): + """get_sdwan_other_feature_profiles # noqa: E501 + + Get all SDWAN Feature Profiles with giving Family and profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_other_feature_profiles(async_req=True) + >>> result = thread.get() + + + Keyword Args: + offset (int): Pagination offset. [optional] + limit (int): Pagination limit. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sdwan_other_feature_profiles_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_other_thousandeyes_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_other_thousandeyes_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Other Thousandeyes Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_other_thousandeyes_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_other_thousandeyes_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_dhcp_server_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_service_dhcp_server_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Service DhcpServer Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_dhcp_server_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_service_dhcp_server_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_feature_profile_by_profile_id( + self, + service_id, + **kwargs + ): + """get_sdwan_service_feature_profile_by_profile_id # noqa: E501 + + Get a SDWAN Service Feature Profile with serviceId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_feature_profile_by_profile_id(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_sdwan_service_feature_profile_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_feature_profiles( + self, + **kwargs + ): + """get_sdwan_service_feature_profiles # noqa: E501 + + Get all SDWAN Feature Profiles with giving Family and profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_feature_profiles(async_req=True) + >>> result = thread.get() + + + Keyword Args: + offset (int): Pagination offset. [optional] + limit (int): Pagination limit. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sdwan_service_feature_profiles_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema( + self, + schema_type, + **kwargs + ): + """get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema # noqa: E501 + + Get a SDWAN Service LanVpn InterfaceEthernet Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_lan_vpn_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_service_lan_vpn_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Service LanVpn Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_lan_vpn_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_service_lan_vpn_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_routing_bgp_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_service_routing_bgp_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Service RoutingBgp Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_routing_bgp_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_service_routing_bgp_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_routing_ospf_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_service_routing_ospf_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Service RoutingOspf Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_routing_ospf_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_service_routing_ospf_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_service_wirelesslan_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_service_wirelesslan_parcel_schema_by_schema_type # noqa: E501 + + Get a sdwan Service Wirelesslan Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_service_wirelesslan_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_service_wirelesslan_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_aaa_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_aaa_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Aaa Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_aaa_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_aaa_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_banner_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_banner_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Banner Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_banner_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_banner_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_basic_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_basic_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Basic Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_basic_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_basic_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_bfd_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_bfd_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Bfd Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_bfd_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_bfd_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_feature_profile_by_profile_id( + self, + system_id, + **kwargs + ): + """get_sdwan_system_feature_profile_by_profile_id # noqa: E501 + + Get a SDWAN System Feature Profile with systemId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_feature_profile_by_profile_id(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_sdwan_system_feature_profile_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_feature_profiles( + self, + **kwargs + ): + """get_sdwan_system_feature_profiles # noqa: E501 + + Get all SDWAN Feature Profiles with giving Family and profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_feature_profiles(async_req=True) + >>> result = thread.get() + + + Keyword Args: + offset (int): Pagination offset. [optional] + limit (int): Pagination limit. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sdwan_system_feature_profiles_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_logging_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_logging_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Logging Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_logging_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_logging_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_ntp_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_ntp_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Ntp Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_ntp_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_ntp_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_omp_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_omp_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Omp Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_omp_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_omp_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_system_snmp_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_system_snmp_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN System Snmp Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_system_snmp_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_system_snmp_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Transport CellularController Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Transport CellularProfile Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_feature_profile_by_profile_id( + self, + transport_id, + **kwargs + ): + """get_sdwan_transport_feature_profile_by_profile_id # noqa: E501 + + Get a SDWAN Transport Feature Profile with transportId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_feature_profile_by_profile_id(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_sdwan_transport_feature_profile_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_feature_profiles( + self, + **kwargs + ): + """get_sdwan_transport_feature_profiles # noqa: E501 + + Get all SDWAN Feature Profiles with giving Family and profile type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_feature_profiles(async_req=True) + >>> result = thread.get() + + + Keyword Args: + offset (int): Pagination offset. [optional] + limit (int): Pagination limit. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sdwan_transport_feature_profiles_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema # noqa: E501 + + Get a SDWAN Transport ManagementVpn InterfaceEthernet Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_management_vpn_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_management_vpn_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Transport ManagementVpn Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_management_vpn_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_management_vpn_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Transport RoutingBgp Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_tracker_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_tracker_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Transport Tracker Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_tracker_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_tracker_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema # noqa: E501 + + Get a SDWAN Transport WanVpn CellularInterface Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema # noqa: E501 + + Get a SDWAN Transport WanVpn InterfaceEthernet Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema_endpoint.call_with_http_info(**kwargs) + + def get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type( + self, + schema_type, + **kwargs + ): + """get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type # noqa: E501 + + Get a SDWAN Transport WanVpn Parcel Schema by Schema Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type(schema_type, async_req=True) + >>> result = thread.get() + + Args: + schema_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['schema_type'] = \ + schema_type + return self.get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type_endpoint.call_with_http_info(**kwargs) + + def get_snmp_profile_parcel_by_parcel_id_for_system( + self, + system_id, + snmp_id, + **kwargs + ): + """get_snmp_profile_parcel_by_parcel_id_for_system # noqa: E501 + + Get Snmp Profile Parcel by parcelId for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_snmp_profile_parcel_by_parcel_id_for_system(system_id, snmp_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + snmp_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + kwargs['snmp_id'] = \ + snmp_id + return self.get_snmp_profile_parcel_by_parcel_id_for_system_endpoint.call_with_http_info(**kwargs) + + def get_snmp_profile_parcel_for_system( + self, + system_id, + **kwargs + ): + """get_snmp_profile_parcel_for_system # noqa: E501 + + Get Snmp Profile Parcels for System feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_snmp_profile_parcel_for_system(system_id, async_req=True) + >>> result = thread.get() + + Args: + system_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['system_id'] = \ + system_id + return self.get_snmp_profile_parcel_for_system_endpoint.call_with_http_info(**kwargs) + + def get_switchport_parcel_by_parcel_id_for_service( + self, + service_id, + switchport_id, + **kwargs + ): + """get_switchport_parcel_by_parcel_id_for_service # noqa: E501 + + Get Switchport Parcel by switchportId for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_switchport_parcel_by_parcel_id_for_service(service_id, switchport_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + switchport_id (str): Switchport Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['switchport_id'] = \ + switchport_id + return self.get_switchport_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_switchport_parcels_for_service( + self, + service_id, + **kwargs + ): + """get_switchport_parcels_for_service # noqa: E501 + + Get Switchport Parcels for service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_switchport_parcels_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_switchport_parcels_for_service_endpoint.call_with_http_info(**kwargs) + + def get_thousandeyes_profile_parcel_by_parcel_id_for_other( + self, + other_id, + thousandeyes_id, + **kwargs + ): + """get_thousandeyes_profile_parcel_by_parcel_id_for_other # noqa: E501 + + Get Thousandeyes Profile Parcel by parcelId for Other feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_thousandeyes_profile_parcel_by_parcel_id_for_other(other_id, thousandeyes_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile ID + thousandeyes_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + kwargs['thousandeyes_id'] = \ + thousandeyes_id + return self.get_thousandeyes_profile_parcel_by_parcel_id_for_other_endpoint.call_with_http_info(**kwargs) + + def get_thousandeyes_profile_parcel_for_other( + self, + other_id, + **kwargs + ): + """get_thousandeyes_profile_parcel_for_other # noqa: E501 + + Get Thousandeyes Profile Parcels for Other feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_thousandeyes_profile_parcel_for_other(other_id, async_req=True) + >>> result = thread.get() + + Args: + other_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['other_id'] = \ + other_id + return self.get_thousandeyes_profile_parcel_for_other_endpoint.call_with_http_info(**kwargs) + + def get_tracker_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + tracker_id, + **kwargs + ): + """get_tracker_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get Tracker Profile Parcel by parcelId for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tracker_profile_parcel_by_parcel_id_for_transport(transport_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + tracker_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['tracker_id'] = \ + tracker_id + return self.get_tracker_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_tracker_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """get_tracker_profile_parcel_for_transport # noqa: E501 + + Get Tracker Profile Parcels for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tracker_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_tracker_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + bgp_id, + **kwargs + ): + """get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport # noqa: E501 + + Get WanVpn parcel associated RoutingBgp Parcel by bgpId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport(transport_id, vpn_id, bgp_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + bgp_id (str): Routing Bgp Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['bgp_id'] = \ + bgp_id + return self.get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_associated_routing_bgp_parcels_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """get_wan_vpn_associated_routing_bgp_parcels_for_transport # noqa: E501 + + Get WanVpn associated Routing Bgp Parcels for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_associated_routing_bgp_parcels_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_wan_vpn_associated_routing_bgp_parcels_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + cellular_id, + tracker_id, + **kwargs + ): + """get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport # noqa: E501 + + Get WanVpnInterfaceCellular associated Tracker Parcel by trackerId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport(transport_id, vpn_id, cellular_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + cellular_id (str): Interface Profile Parcel ID + tracker_id (str): Tracker Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['cellular_id'] = \ + cellular_id + kwargs['tracker_id'] = \ + tracker_id + return self.get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport( + self, + transport_id, + vpn_id, + cellular_id, + **kwargs + ): + """get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport # noqa: E501 + + Get WanVpnInterfaceCellular associated Tracker Parcels for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport(transport_id, vpn_id, cellular_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + cellular_id (str): Interface Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['cellular_id'] = \ + cellular_id + return self.get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + intf_id, + **kwargs + ): + """get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport # noqa: E501 + + Get wanvpn Cellular interface Parcel by intfId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport(transport_id, vpn_id, intf_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + intf_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['intf_id'] = \ + intf_id + return self.get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + tracker_id, + **kwargs + ): + """get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport # noqa: E501 + + Get WanVpnInterfaceEthernet associated Tracker Parcel by trackerId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id, tracker_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Profile Parcel ID + tracker_id (str): Tracker Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + kwargs['tracker_id'] = \ + tracker_id + return self.get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport # noqa: E501 + + Get WanVpnInterfaceEthernet associated Tracker Parcels for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Feature Parcel ID + ethernet_id (str): Interface Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + ethernet_id, + **kwargs + ): + """get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport # noqa: E501 + + Get WanVpn InterfaceEthernet Parcel by ethernetId for transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(transport_id, vpn_id, ethernet_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + ethernet_id (str): Interface Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + kwargs['ethernet_id'] = \ + ethernet_id + return self.get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_profile_parcel_by_parcel_id_for_transport( + self, + transport_id, + vpn_id, + **kwargs + ): + """get_wan_vpn_profile_parcel_by_parcel_id_for_transport # noqa: E501 + + Get Wan Vpn Profile Parcel by parcelId for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_profile_parcel_by_parcel_id_for_transport(transport_id, vpn_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + vpn_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + kwargs['vpn_id'] = \ + vpn_id + return self.get_wan_vpn_profile_parcel_by_parcel_id_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wan_vpn_profile_parcel_for_transport( + self, + transport_id, + **kwargs + ): + """get_wan_vpn_profile_parcel_for_transport # noqa: E501 + + Get Wan Vpn Profile Parcels for Transport feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_vpn_profile_parcel_for_transport(transport_id, async_req=True) + >>> result = thread.get() + + Args: + transport_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['transport_id'] = \ + transport_id + return self.get_wan_vpn_profile_parcel_for_transport_endpoint.call_with_http_info(**kwargs) + + def get_wirelesslan_profile_parcel_by_parcel_id_for_service( + self, + service_id, + wirelesslan_id, + **kwargs + ): + """get_wirelesslan_profile_parcel_by_parcel_id_for_service # noqa: E501 + + Get Wirelesslan Profile Parcel by parcelId for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wirelesslan_profile_parcel_by_parcel_id_for_service(service_id, wirelesslan_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + wirelesslan_id (str): Profile Parcel ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + kwargs['wirelesslan_id'] = \ + wirelesslan_id + return self.get_wirelesslan_profile_parcel_by_parcel_id_for_service_endpoint.call_with_http_info(**kwargs) + + def get_wirelesslan_profile_parcel_for_service( + self, + service_id, + **kwargs + ): + """get_wirelesslan_profile_parcel_for_service # noqa: E501 + + Get Wirelesslan Profile Parcels for Service feature profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wirelesslan_profile_parcel_for_service(service_id, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Feature Profile ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['service_id'] = \ + service_id + return self.get_wirelesslan_profile_parcel_for_service_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_fqdn_list_builder_api.py b/openapi_client/api/configuration_fqdn_list_builder_api.py new file mode 100644 index 0000000..49fb6b2 --- /dev/null +++ b/openapi_client/api/configuration_fqdn_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationFQDNListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn', + 'operation_id': 'create_policy_list16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list16_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn/{id}', + 'operation_id': 'delete_policy_list16', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag16_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn', + 'operation_id': 'delete_policy_lists_with_info_tag16', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn/{id}', + 'operation_id': 'edit_policy_list16', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn/{id}', + 'operation_id': 'get_lists_by_id16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists14_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn', + 'operation_id': 'get_policy_lists14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag16_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn/filtered', + 'operation_id': 'get_policy_lists_with_info_tag16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn/preview', + 'operation_id': 'preview_policy_list16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/fqdn/preview/{id}', + 'operation_id': 'preview_policy_list_by_id16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list16( + self, + **kwargs + ): + """create_policy_list16 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list16_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list16( + self, + id, + **kwargs + ): + """delete_policy_list16 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list16_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag16( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag16 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag16_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list16( + self, + id, + **kwargs + ): + """edit_policy_list16 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list16_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id16( + self, + id, + **kwargs + ): + """get_lists_by_id16 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id16_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists14( + self, + **kwargs + ): + """get_policy_lists14 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists14_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag16( + self, + **kwargs + ): + """get_policy_lists_with_info_tag16 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag16_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list16( + self, + **kwargs + ): + """preview_policy_list16 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list16_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id16( + self, + id, + **kwargs + ): + """preview_policy_list_by_id16 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id16_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_general_template_api.py b/openapi_client/api/configuration_general_template_api.py new file mode 100644 index 0000000..fcc5994 --- /dev/null +++ b/openapi_client/api/configuration_general_template_api.py @@ -0,0 +1,2717 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationGeneralTemplateApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.change_template_resource_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/feature/resource-group/{resourceGroupName}/{templateId}', + 'operation_id': 'change_template_resource_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'resource_group_name', + ], + 'required': [ + 'template_id', + 'resource_group_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'resource_group_name': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + 'resource_group_name': 'resourceGroupName', + }, + 'location_map': { + 'template_id': 'path', + 'resource_group_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.clone_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/clone', + 'operation_id': 'clone_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'name', + 'desc', + ], + 'required': [ + 'id', + 'name', + 'desc', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'name': + (str,), + 'desc': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'name': 'name', + 'desc': 'desc', + }, + 'location_map': { + 'id': 'query', + 'name': 'query', + 'desc': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_feature_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature', + 'operation_id': 'create_feature_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_li_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/li', + 'operation_id': 'create_li_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_general_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/feature/{templateId}', + 'operation_id': 'delete_general_template', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_feature_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/{templateId}', + 'operation_id': 'edit_feature_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'body', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_li_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/li/{templateId}', + 'operation_id': 'edit_li_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'body', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_feature_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/feature', + 'operation_id': 'generate_feature_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'summary', + 'offset', + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'summary': + (bool,), + 'offset': + (int,), + 'limit': + (int,), + }, + 'attribute_map': { + 'summary': 'summary', + 'offset': 'offset', + 'limit': 'limit', + }, + 'location_map': { + 'summary': 'query', + 'offset': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_master_template_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/master/{type_name}', + 'operation_id': 'generate_master_template_definition', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type_name', + ], + 'required': [ + 'type_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type_name': + (str,), + }, + 'attribute_map': { + 'type_name': 'type_name', + }, + 'location_map': { + 'type_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_template_by_device_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/feature/{deviceType}', + 'operation_id': 'generate_template_by_device_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_type', + ], + 'required': [ + 'device_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_type': + (str,), + }, + 'attribute_map': { + 'device_type': 'deviceType', + }, + 'location_map': { + 'device_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_template_type_definition_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/feature/types/definition/{type_name}/{version}', + 'operation_id': 'generate_template_type_definition', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type_name', + 'version', + ], + 'required': [ + 'type_name', + 'version', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type_name': + (str,), + 'version': + (str,), + }, + 'attribute_map': { + 'type_name': 'type_name', + 'version': 'version', + }, + 'location_map': { + 'type_name': 'path', + 'version': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_template_types_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/feature/types', + 'operation_id': 'generate_template_types', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "VEDGE": "vedge", + "CEDGE": "cedge", + "ALL": "all", + "DEFAULT": "default" + }, + }, + 'openapi_types': { + 'type': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_default_networks_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/default/networks', + 'operation_id': 'get_default_networks', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_model', + ], + 'required': [ + 'device_model', + ], + 'nullable': [ + ], + 'enum': [ + 'device_model', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('device_model',): { + + "ENCS5400": "vedge-nfvis-ENCS5400", + "C8200-UCPE": "vedge-nfvis-C8200-UCPE", + "C8200-UCPEVM": "vedge-nfvis-C8200-UCPEVM" + }, + }, + 'openapi_types': { + 'device_model': + (str,), + }, + 'attribute_map': { + 'device_model': 'deviceModel', + }, + 'location_map': { + 'device_model': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_templates_attached_to_feature_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/devicetemplates/{templateId}', + 'operation_id': 'get_device_templates_attached_to_feature', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_encrypted_string_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/security/encryptText/encrypt', + 'operation_id': 'get_encrypted_string', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_general_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/object/{templateId}', + 'operation_id': 'get_general_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_network_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/default/networkinterface', + 'operation_id': 'get_network_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_model', + ], + 'required': [ + 'device_model', + ], + 'nullable': [ + ], + 'enum': [ + 'device_model', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('device_model',): { + + "ENCS": "ENCS", + "C8200-UCPE": "C8200-UCPE", + "C8200-UCPEVM": "C8200-UCPEVM" + }, + }, + 'openapi_types': { + 'device_model': + (str,), + }, + 'attribute_map': { + 'device_model': 'deviceModel', + }, + 'location_map': { + 'device_model': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_template_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/feature/definition/{templateId}', + 'operation_id': 'get_template_definition', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_template_for_migration_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/feature/migration', + 'operation_id': 'get_template_for_migration', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_li_template_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/feature/li', + 'operation_id': 'list_li_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def change_template_resource_group( + self, + template_id, + resource_group_name, + **kwargs + ): + """change_template_resource_group # noqa: E501 + + Change template resource group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.change_template_resource_group(template_id, resource_group_name, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + resource_group_name (str): Resrouce group name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + kwargs['resource_group_name'] = \ + resource_group_name + return self.change_template_resource_group_endpoint.call_with_http_info(**kwargs) + + def clone_template( + self, + id, + name, + desc, + **kwargs + ): + """clone_template # noqa: E501 + + Clone a feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.clone_template(id, name, desc, async_req=True) + >>> result = thread.get() + + Args: + id (str): Template Id to clone from + name (str): Name for the cloned template + desc (str): Description for the cloned template + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['name'] = \ + name + kwargs['desc'] = \ + desc + return self.clone_template_endpoint.call_with_http_info(**kwargs) + + def create_feature_template( + self, + **kwargs + ): + """create_feature_template # noqa: E501 + + Create feature template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_feature_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Feature template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_feature_template_endpoint.call_with_http_info(**kwargs) + + def create_li_template( + self, + **kwargs + ): + """create_li_template # noqa: E501 + + Create LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_li_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): LI template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_li_template_endpoint.call_with_http_info(**kwargs) + + def delete_general_template( + self, + template_id, + **kwargs + ): + """delete_general_template # noqa: E501 + + Delete feature template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_general_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.delete_general_template_endpoint.call_with_http_info(**kwargs) + + def edit_feature_template( + self, + template_id, + **kwargs + ): + """edit_feature_template # noqa: E501 + + Update feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_feature_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.edit_feature_template_endpoint.call_with_http_info(**kwargs) + + def edit_li_template( + self, + template_id, + **kwargs + ): + """edit_li_template # noqa: E501 + + Update LI feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_li_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): LI template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.edit_li_template_endpoint.call_with_http_info(**kwargs) + + def generate_feature_template_list( + self, + **kwargs + ): + """generate_feature_template_list # noqa: E501 + + Get feature template list


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_feature_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + summary (bool): Flag to include template definition. [optional] if omitted the server will use the default value of False + offset (int): Pagination offset. [optional] + limit (int): Pagination limit on templateId. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_feature_template_list_endpoint.call_with_http_info(**kwargs) + + def generate_master_template_definition( + self, + type_name, + **kwargs + ): + """generate_master_template_definition # noqa: E501 + + Generate template type definition by device type


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_master_template_definition(type_name, async_req=True) + >>> result = thread.get() + + Args: + type_name (str): Device type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type_name'] = \ + type_name + return self.generate_master_template_definition_endpoint.call_with_http_info(**kwargs) + + def generate_template_by_device_type( + self, + device_type, + **kwargs + ): + """generate_template_by_device_type # noqa: E501 + + Generate template based on device


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_template_by_device_type(device_type, async_req=True) + >>> result = thread.get() + + Args: + device_type (str): Device type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_type'] = \ + device_type + return self.generate_template_by_device_type_endpoint.call_with_http_info(**kwargs) + + def generate_template_type_definition( + self, + type_name, + version, + **kwargs + ): + """generate_template_type_definition # noqa: E501 + + Generate template type definition


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_template_type_definition(type_name, version, async_req=True) + >>> result = thread.get() + + Args: + type_name (str): Feature template type + version (str): Version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type_name'] = \ + type_name + kwargs['version'] = \ + version + return self.generate_template_type_definition_endpoint.call_with_http_info(**kwargs) + + def generate_template_types( + self, + type, + **kwargs + ): + """generate_template_types # noqa: E501 + + Generate template types


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_template_types(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Device type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.generate_template_types_endpoint.call_with_http_info(**kwargs) + + def get_default_networks( + self, + device_model, + **kwargs + ): + """get_default_networks # noqa: E501 + + Get default networks


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_default_networks(device_model, async_req=True) + >>> result = thread.get() + + Args: + device_model (str): Device model + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_model'] = \ + device_model + return self.get_default_networks_endpoint.call_with_http_info(**kwargs) + + def get_device_templates_attached_to_feature( + self, + template_id, + **kwargs + ): + """get_device_templates_attached_to_feature # noqa: E501 + + Get all device templates for this feature template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_templates_attached_to_feature(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Feature template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_device_templates_attached_to_feature_endpoint.call_with_http_info(**kwargs) + + def get_encrypted_string( + self, + **kwargs + ): + """get_encrypted_string # noqa: E501 + + Get Type 6 Encryptedd String for a given value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_encrypted_string(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Type6 Encryption. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_encrypted_string_endpoint.call_with_http_info(**kwargs) + + def get_general_template( + self, + template_id, + **kwargs + ): + """get_general_template # noqa: E501 + + Get template object definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_general_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_general_template_endpoint.call_with_http_info(**kwargs) + + def get_network_interface( + self, + device_model, + **kwargs + ): + """get_network_interface # noqa: E501 + + Get default network interface


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_interface(device_model, async_req=True) + >>> result = thread.get() + + Args: + device_model (str): Device model + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_model'] = \ + device_model + return self.get_network_interface_endpoint.call_with_http_info(**kwargs) + + def get_template_definition( + self, + template_id, + **kwargs + ): + """get_template_definition # noqa: E501 + + Get the configured template definition for given template Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_template_definition(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_template_definition_endpoint.call_with_http_info(**kwargs) + + def get_template_for_migration( + self, + **kwargs + ): + """get_template_for_migration # noqa: E501 + + Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_template_for_migration(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_template_for_migration_endpoint.call_with_http_info(**kwargs) + + def list_li_template( + self, + **kwargs + ): + """list_li_template # noqa: E501 + + Get LI feature template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_li_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_li_template_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_identity_service_engine_api.py b/openapi_client/api/configuration_identity_service_engine_api.py new file mode 100644 index 0000000..76d97cb --- /dev/null +++ b/openapi_client/api/configuration_identity_service_engine_api.py @@ -0,0 +1,297 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationIdentityServiceEngineApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.delete_all_identity_lists_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/ise/identity/deleteAllLists', + 'operation_id': 'delete_all_identity_lists', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_identity_list_reference_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/ise/identity/referenced/{listType}', + 'operation_id': 'get_identity_list_reference', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'list_type', + ], + 'required': [ + 'list_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'list_type': + (str,), + }, + 'attribute_map': { + 'list_type': 'listType', + }, + 'location_map': { + 'list_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def delete_all_identity_lists( + self, + **kwargs + ): + """delete_all_identity_lists # noqa: E501 + + Delete all identity lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_all_identity_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Delete lists. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_all_identity_lists_endpoint.call_with_http_info(**kwargs) + + def get_identity_list_reference( + self, + list_type, + **kwargs + ): + """get_identity_list_reference # noqa: E501 + + Get all referenced Identity Lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_identity_list_reference(list_type, async_req=True) + >>> result = thread.get() + + Args: + list_type (str): list type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['list_type'] = \ + list_type + return self.get_identity_list_reference_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_ise_server_api.py b/openapi_client/api/configuration_ise_server_api.py new file mode 100644 index 0000000..89a1852 --- /dev/null +++ b/openapi_client/api/configuration_ise_server_api.py @@ -0,0 +1,1760 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationIseServerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.account_activate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/pxgrid/activate', + 'operation_id': 'account_activate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.account_create_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/pxgrid/create', + 'operation_id': 'account_create', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_ise_server_credentials_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials', + 'operation_id': 'add_ise_server_credentials', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.approve_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/pxgrid/approve', + 'operation_id': 'approve', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connect1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/connect', + 'operation_id': 'connect1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_ise_and_px_grid_account_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials/iseandpxgrid', + 'operation_id': 'delete_ise_and_px_grid_account', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_px_grid_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials/pxgrid', + 'operation_id': 'delete_px_grid', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_identity_user_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/ise/identity/usergroups', + 'operation_id': 'get_identity_user_groups', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_identity_users_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/ise/identity/users', + 'operation_id': 'get_identity_users', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_ise_server_credentials_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials', + 'operation_id': 'get_ise_server_credentials', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_p_xgrid_cert_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials/pxgrid/cert', + 'operation_id': 'get_p_xgrid_cert', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_px_grid_account_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials/pxgrid', + 'operation_id': 'get_px_grid_account', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.sync_vsmart_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials/vsmart/sync', + 'operation_id': 'sync_vsmart', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_ise_server_credentials_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/ise/credentials', + 'operation_id': 'update_ise_server_credentials', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def account_activate( + self, + **kwargs + ): + """account_activate # noqa: E501 + + pxGrid Account Activate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.account_activate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.account_activate_endpoint.call_with_http_info(**kwargs) + + def account_create( + self, + **kwargs + ): + """account_create # noqa: E501 + + pxGrid Account Create # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.account_create(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.account_create_endpoint.call_with_http_info(**kwargs) + + def add_ise_server_credentials( + self, + **kwargs + ): + """add_ise_server_credentials # noqa: E501 + + Add Ise server credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_ise_server_credentials(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Config Ise server request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_ise_server_credentials_endpoint.call_with_http_info(**kwargs) + + def approve( + self, + **kwargs + ): + """approve # noqa: E501 + + pxGrid Account Approve with ERS API # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.approve(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.approve_endpoint.call_with_http_info(**kwargs) + + def connect1( + self, + **kwargs + ): + """connect1 # noqa: E501 + + ISE connect # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connect1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.connect1_endpoint.call_with_http_info(**kwargs) + + def delete_ise_and_px_grid_account( + self, + **kwargs + ): + """delete_ise_and_px_grid_account # noqa: E501 + + Delete ISE and PxGrid on vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_ise_and_px_grid_account(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_ise_and_px_grid_account_endpoint.call_with_http_info(**kwargs) + + def delete_px_grid( + self, + **kwargs + ): + """delete_px_grid # noqa: E501 + + Delete PxGrid on vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_px_grid(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_px_grid_endpoint.call_with_http_info(**kwargs) + + def get_identity_user_groups( + self, + **kwargs + ): + """get_identity_user_groups # noqa: E501 + + Get all identity user groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_identity_user_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Get Users. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_identity_user_groups_endpoint.call_with_http_info(**kwargs) + + def get_identity_users( + self, + **kwargs + ): + """get_identity_users # noqa: E501 + + Get all identity users # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_identity_users(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Get Users. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_identity_users_endpoint.call_with_http_info(**kwargs) + + def get_ise_server_credentials( + self, + **kwargs + ): + """get_ise_server_credentials # noqa: E501 + + Get Ise server credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ise_server_credentials(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_ise_server_credentials_endpoint.call_with_http_info(**kwargs) + + def get_p_xgrid_cert( + self, + **kwargs + ): + """get_p_xgrid_cert # noqa: E501 + + getPXgridCert # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_p_xgrid_cert(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_p_xgrid_cert_endpoint.call_with_http_info(**kwargs) + + def get_px_grid_account( + self, + **kwargs + ): + """get_px_grid_account # noqa: E501 + + Get PXGrid account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_px_grid_account(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_px_grid_account_endpoint.call_with_http_info(**kwargs) + + def sync_vsmart( + self, + **kwargs + ): + """sync_vsmart # noqa: E501 + + syncVsmart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_vsmart(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_vsmart_endpoint.call_with_http_info(**kwargs) + + def update_ise_server_credentials( + self, + **kwargs + ): + """update_ise_server_credentials # noqa: E501 + + Configure Ise server credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_ise_server_credentials(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Config Ise server request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_ise_server_credentials_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_multi_cloud_api.py b/openapi_client/api/configuration_multi_cloud_api.py new file mode 100644 index 0000000..1a1a143 --- /dev/null +++ b/openapi_client/api/configuration_multi_cloud_api.py @@ -0,0 +1,16107 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class ConfigurationMultiCloudApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_edge_global_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/settings/edge/global', + 'operation_id': 'add_edge_global_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.add_global_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/settings/global', + 'operation_id': 'add_global_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.attach_sites_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}/site', + 'operation_id': 'attach_sites', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'body', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.audit_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/audit', + 'operation_id': 'audit', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.audit_dry_run_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/audit', + 'operation_id': 'audit_dry_run', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'cloud_region', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'cloud_region': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'cloud_region': 'cloudRegion', + }, + 'location_map': { + 'cloud_type': 'query', + 'cloud_region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.clean_up_all_connectivity_gateways_in_local_db_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivitygateway', + 'operation_id': 'clean_up_all_connectivity_gateways_in_local_db', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'deletion_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'deletion_type': + (str,), + }, + 'attribute_map': { + 'deletion_type': 'deletionType', + }, + 'location_map': { + 'deletion_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cgw_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway', + 'operation_id': 'create_cgw', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_connectivity_gateway_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivitygateway', + 'operation_id': 'create_connectivity_gateway', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_device_link_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devicelink/edge', + 'operation_id': 'create_device_link', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_edge_connectivity_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivity/edge', + 'operation_id': 'create_edge_connectivity', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_icgw_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge', + 'operation_id': 'create_icgw', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_virtual_wan_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/vwan', + 'operation_id': 'create_virtual_wan', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_account_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/{accountId}', + 'operation_id': 'delete_account', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_cgw_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}', + 'operation_id': 'delete_cgw', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'delete_all_resources', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'delete_all_resources': + (bool,), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + 'delete_all_resources': 'deleteAllResources', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'delete_all_resources': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_connectivity_gateway_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}', + 'operation_id': 'delete_connectivity_gateway', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_provider', + 'connectivity_gateway_name', + 'connectivity_type', + ], + 'required': [ + 'cloud_provider', + 'connectivity_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_provider': + (str,), + 'connectivity_gateway_name': + (str,), + 'connectivity_type': + (str,), + }, + 'attribute_map': { + 'cloud_provider': 'cloudProvider', + 'connectivity_gateway_name': 'connectivityGatewayName', + 'connectivity_type': 'connectivityType', + }, + 'location_map': { + 'cloud_provider': 'path', + 'connectivity_gateway_name': 'path', + 'connectivity_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_device_link_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devicelink/edge/{deviceLinkName}', + 'operation_id': 'delete_device_link', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_link_name', + ], + 'required': [ + 'device_link_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_link_name': + (str,), + }, + 'attribute_map': { + 'device_link_name': 'deviceLinkName', + }, + 'location_map': { + 'device_link_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_edge_account_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/edge/{accountId}', + 'operation_id': 'delete_edge_account', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_edge_account1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/locations/edge/{edgeType}', + 'operation_id': 'delete_edge_account1', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_edge_connectivity_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivity/edge/{connectionName}', + 'operation_id': 'delete_edge_connectivity', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'connection_name', + ], + 'required': [ + 'connection_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'connection_name': + (str,), + }, + 'attribute_map': { + 'connection_name': 'connectionName', + }, + 'location_map': { + 'connection_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_icgw_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge/{edgeGatewayName}', + 'operation_id': 'delete_icgw', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_gateway_name', + ], + 'required': [ + 'edge_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_gateway_name': + (str,), + }, + 'attribute_map': { + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_gateway_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_virtual_wan_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/vwan/{cloudProvider}/{vWanName}', + 'operation_id': 'delete_virtual_wan', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_provider', + 'v_wan_name', + 'account_id', + 'resource_group', + ], + 'required': [ + 'cloud_provider', + 'v_wan_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_provider': + (str,), + 'v_wan_name': + (str,), + 'account_id': + (str,), + 'resource_group': + (str,), + }, + 'attribute_map': { + 'cloud_provider': 'cloudProvider', + 'v_wan_name': 'vWanName', + 'account_id': 'accountId', + 'resource_group': 'resourceGroup', + }, + 'location_map': { + 'cloud_provider': 'path', + 'v_wan_name': 'path', + 'account_id': 'query', + 'resource_group': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.detach_sites1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}/site', + 'operation_id': 'detach_sites1', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'body', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edge_audit_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/audit/edge', + 'operation_id': 'edge_audit', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'cloud_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_type': + (str,), + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'edge_type': 'query', + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edge_audit_dry_run_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/audit/edge', + 'operation_id': 'edge_audit_dry_run', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'cloud_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_type': + (str,), + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'edge_type': 'query', + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_tag_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/hostvpc/tags', + 'operation_id': 'edit_tag', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_all_cloud_accounts_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/accounts', + 'operation_id': 'get_all_cloud_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'cloud_gateway_enabled', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'cloud_gateway_enabled': + (bool,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'cloud_gateway_enabled': 'cloudGatewayEnabled', + }, + 'location_map': { + 'cloud_type': 'query', + 'cloud_gateway_enabled': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_azure_network_virtual_appliances_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/nvas', + 'operation_id': 'get_azure_network_virtual_appliances', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'accound_id', + 'region', + 'resource_group_name', + 'resource_group_source', + 'vhub_name', + 'vhub_source', + ], + 'required': [ + 'cloud_type', + 'accound_id', + 'region', + 'resource_group_name', + 'resource_group_source', + 'vhub_name', + 'vhub_source', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'accound_id': + (str,), + 'region': + (str,), + 'resource_group_name': + (str,), + 'resource_group_source': + (str,), + 'vhub_name': + (str,), + 'vhub_source': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'accound_id': 'accoundId', + 'region': 'region', + 'resource_group_name': 'resourceGroupName', + 'resource_group_source': 'resourceGroupSource', + 'vhub_name': 'vhubName', + 'vhub_source': 'vhubSource', + }, + 'location_map': { + 'cloud_type': 'query', + 'accound_id': 'query', + 'region': 'query', + 'resource_group_name': 'query', + 'resource_group_source': 'query', + 'vhub_name': 'query', + 'vhub_source': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_azure_nva_sku_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/nvasku', + 'operation_id': 'get_azure_nva_sku_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_azure_resource_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/resourceGroups', + 'operation_id': 'get_azure_resource_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + ], + 'required': [ + 'cloud_type', + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_azure_virtual_hubs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/vhubs', + 'operation_id': 'get_azure_virtual_hubs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'accound_id', + 'region', + 'resource_group_name', + 'resource_group_source', + 'vwan_name', + 'vwan_source', + ], + 'required': [ + 'cloud_type', + 'accound_id', + 'region', + 'resource_group_name', + 'resource_group_source', + 'vwan_name', + 'vwan_source', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'accound_id': + (str,), + 'region': + (str,), + 'resource_group_name': + (str,), + 'resource_group_source': + (str,), + 'vwan_name': + (str,), + 'vwan_source': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'accound_id': 'accoundId', + 'region': 'region', + 'resource_group_name': 'resourceGroupName', + 'resource_group_source': 'resourceGroupSource', + 'vwan_name': 'vwanName', + 'vwan_source': 'vwanSource', + }, + 'location_map': { + 'cloud_type': 'query', + 'accound_id': 'query', + 'region': 'query', + 'resource_group_name': 'query', + 'resource_group_source': 'query', + 'vwan_name': 'query', + 'vwan_source': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_azure_virtual_wans_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/vwans', + 'operation_id': 'get_azure_virtual_wans', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'accound_id', + 'resource_group_name', + 'resource_group_source', + ], + 'required': [ + 'cloud_type', + 'accound_id', + 'resource_group_name', + 'resource_group_source', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'accound_id': + (str,), + 'resource_group_name': + (str,), + 'resource_group_source': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'accound_id': 'accoundId', + 'resource_group_name': 'resourceGroupName', + 'resource_group_source': 'resourceGroupSource', + }, + 'location_map': { + 'cloud_type': 'query', + 'accound_id': 'query', + 'resource_group_name': 'query', + 'resource_group_source': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cgw_associated_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/mapping/{cloudType}', + 'operation_id': 'get_cgw_associated_mappings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'cloud_gateway_name', + 'site_uuid', + ], + 'required': [ + 'cloud_type', + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'cloud_gateway_name': + (str,), + 'site_uuid': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'cloud_gateway_name': 'cloudGatewayName', + 'site_uuid': 'siteUuid', + }, + 'location_map': { + 'cloud_type': 'path', + 'cloud_gateway_name': 'query', + 'site_uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cgw_custom_setting_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgatewaysetting/{cloudGatewayName}', + 'operation_id': 'get_cgw_custom_setting_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cgw_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}', + 'operation_id': 'get_cgw_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cgw_org_resources_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/resource', + 'operation_id': 'get_cgw_org_resources', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cgw_types_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgatewaytype', + 'operation_id': 'get_cgw_types', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cgws_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway', + 'operation_id': 'get_cgws', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + 'region', + 'cloud_gateway_name', + 'connectivity_state', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + 'region': + (str,), + 'cloud_gateway_name': + (str,), + 'connectivity_state': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + 'region': 'region', + 'cloud_gateway_name': 'cloudGatewayName', + 'connectivity_state': 'connectivityState', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + 'region': 'query', + 'cloud_gateway_name': 'query', + 'connectivity_state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_account_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/accounts/{accountId}', + 'operation_id': 'get_cloud_account_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_connected_sites_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connected-sites/{cloudType}', + 'operation_id': 'get_cloud_connected_sites', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'cloud_gateway_name', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'cloud_gateway_name': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_type': 'path', + 'cloud_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_connected_sites1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connected-sites/edge/{edgeType}', + 'operation_id': 'get_cloud_connected_sites1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'edge_gateway_name', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_type': + (str,), + 'edge_gateway_name': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_type': 'path', + 'edge_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devices/{cloudType}', + 'operation_id': 'get_cloud_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'cloud_gateway_name', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'cloud_gateway_name': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_type': 'path', + 'cloud_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_devices1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devices/edge/{edgeType}', + 'operation_id': 'get_cloud_devices1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'edge_gateway_name', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_type': + (str,), + 'edge_gateway_name': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_type': 'path', + 'edge_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_gateways_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateways/{cloudType}', + 'operation_id': 'get_cloud_gateways', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_regions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/regions', + 'operation_id': 'get_cloud_regions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_routers_and_attachments_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudRoutersAndAttachments', + 'operation_id': 'get_cloud_routers_and_attachments', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'region', + 'network', + 'connectivity_gateway_name', + 'cloud_gateway_name', + 'state', + 'refresh', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'region': + (str,), + 'network': + (str,), + 'connectivity_gateway_name': + (str,), + 'cloud_gateway_name': + (str,), + 'state': + (str,), + 'refresh': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'region': 'region', + 'network': 'network', + 'connectivity_gateway_name': 'connectivityGatewayName', + 'cloud_gateway_name': 'cloudGatewayName', + 'state': 'state', + 'refresh': 'refresh', + }, + 'location_map': { + 'account_id': 'query', + 'region': 'query', + 'network': 'query', + 'connectivity_gateway_name': 'query', + 'cloud_gateway_name': 'query', + 'state': 'query', + 'refresh': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_types_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/types', + 'operation_id': 'get_cloud_types', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_widget_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/widget/{cloudType}', + 'operation_id': 'get_cloud_widget', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_connectivity_gateway_creation_options_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivitygatewaycreationoptions', + 'operation_id': 'get_connectivity_gateway_creation_options', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'cloud_type', + 'connectivity_type', + 'refresh', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'cloud_type': + (str,), + 'connectivity_type': + (str,), + 'refresh': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'cloud_type': 'cloudType', + 'connectivity_type': 'connectivityType', + 'refresh': 'refresh', + }, + 'location_map': { + 'account_id': 'query', + 'cloud_type': 'query', + 'connectivity_type': 'query', + 'refresh': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_connectivity_gateways_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivitygateway', + 'operation_id': 'get_connectivity_gateways', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'cloud_type', + 'connectivity_type', + 'connectivity_gateway_name', + 'region', + 'network', + 'state', + 'refresh', + 'edge_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'account_id': + (str,), + 'cloud_type': + (str,), + 'connectivity_type': + (str,), + 'connectivity_gateway_name': + (str,), + 'region': + (str,), + 'network': + (str,), + 'state': + (str,), + 'refresh': + (str,), + 'edge_type': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'cloud_type': 'cloudType', + 'connectivity_type': 'connectivityType', + 'connectivity_gateway_name': 'connectivityGatewayName', + 'region': 'region', + 'network': 'network', + 'state': 'state', + 'refresh': 'refresh', + 'edge_type': 'edgeType', + }, + 'location_map': { + 'account_id': 'query', + 'cloud_type': 'query', + 'connectivity_type': 'query', + 'connectivity_gateway_name': 'query', + 'region': 'query', + 'network': 'query', + 'state': 'query', + 'refresh': 'query', + 'edge_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dashboard_edge_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/dashboard/edge', + 'operation_id': 'get_dashboard_edge_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_default_mapping_values_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map/defaults', + 'operation_id': 'get_default_mapping_values', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_link_metro_speed_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devicelink/metroSpeed/edge', + 'operation_id': 'get_device_link_metro_speed', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_links_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devicelink/edge', + 'operation_id': 'get_device_links', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'device_link_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'device_link_name': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'device_link_name': 'deviceLinkName', + }, + 'location_map': { + 'edge_type': 'query', + 'device_link_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dl_port_speed_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devicelink/edge/portspeed/{edgeType}', + 'operation_id': 'get_dl_port_speed', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_account_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/accounts/edge/{accountId}', + 'operation_id': 'get_edge_account_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_accounts_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/accounts/edge', + 'operation_id': 'get_edge_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_billing_accounts_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}', + 'operation_id': 'get_edge_billing_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'edge_account_id', + 'region', + ], + 'required': [ + 'edge_type', + 'edge_account_id', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'edge_account_id': + (str,), + 'region': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'edge_account_id': 'edgeAccountId', + 'region': 'region', + }, + 'location_map': { + 'edge_type': 'path', + 'edge_account_id': 'path', + 'region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_connectivity_detail_by_name_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivity/edge/{connectivityName}', + 'operation_id': 'get_edge_connectivity_detail_by_name', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'connectivity_name', + ], + 'required': [ + 'connectivity_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'connectivity_name': + (str,), + }, + 'attribute_map': { + 'connectivity_name': 'connectivityName', + }, + 'location_map': { + 'connectivity_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_connectivity_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivity/edge', + 'operation_id': 'get_edge_connectivity_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'connectivity_name', + 'connectivity_type', + 'edge_gateway_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'connectivity_name': + (str,), + 'connectivity_type': + (str,), + 'edge_gateway_name': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'connectivity_name': 'connectivityName', + 'connectivity_type': 'connectivityType', + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_type': 'query', + 'connectivity_name': 'query', + 'connectivity_type': 'query', + 'edge_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_gateways_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateways/edge/{edgeType}', + 'operation_id': 'get_edge_gateways', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_global_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/settings/edge/global', + 'operation_id': 'get_edge_global_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MP": "MP", + "EQ": "EQ" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_locations_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/locations/edge/{edgeType}', + 'operation_id': 'get_edge_locations_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'account_id', + 'region', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'account_id': + (str,), + 'region': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'account_id': 'accountId', + 'region': 'region', + }, + 'location_map': { + 'edge_type': 'path', + 'account_id': 'query', + 'region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_mapping_tags_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map/tags/edge', + 'operation_id': 'get_edge_mapping_tags', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + 'resource_group', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + 'resource_group': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + 'resource_group': 'resourceGroup', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + 'resource_group': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_types_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/types/edge', + 'operation_id': 'get_edge_types', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_wan_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/edge/{edgeType}/device', + 'operation_id': 'get_edge_wan_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_edge_widget_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/widget/edge/{edgeType}', + 'operation_id': 'get_edge_widget', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [ + 'edge_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_global_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/settings/global', + 'operation_id': 'get_global_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_host_vpcs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/hostvpc', + 'operation_id': 'get_host_vpcs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_ids', + 'region', + 'untagged', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_ids': + (str,), + 'region': + (str,), + 'untagged': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_ids': 'accountIds', + 'region': 'region', + 'untagged': 'untagged', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_ids': 'query', + 'region': 'query', + 'untagged': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_icgw_custom_setting_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge/setting/{edgeGatewayName}', + 'operation_id': 'get_icgw_custom_setting_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_gateway_name', + ], + 'required': [ + 'edge_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_gateway_name': + (str,), + }, + 'attribute_map': { + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_gateway_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_icgw_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge/{edgeGatewayName}', + 'operation_id': 'get_icgw_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_gateway_name', + ], + 'required': [ + 'edge_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_gateway_name': + (str,), + }, + 'attribute_map': { + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_gateway_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_icgw_types_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge/types', + 'operation_id': 'get_icgw_types', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_icgws_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge', + 'operation_id': 'get_icgws', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'account_id', + 'region', + 'region_id', + 'resource_state', + 'edge_gateway_name', + 'billing_account_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'account_id': + (str,), + 'region': + (str,), + 'region_id': + (str,), + 'resource_state': + (str,), + 'edge_gateway_name': + (str,), + 'billing_account_id': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'account_id': 'accountId', + 'region': 'region', + 'region_id': 'regionId', + 'resource_state': 'resourceState', + 'edge_gateway_name': 'edgeGatewayName', + 'billing_account_id': 'billingAccountId', + }, + 'location_map': { + 'edge_type': 'query', + 'account_id': 'query', + 'region': 'query', + 'region_id': 'query', + 'resource_state': 'query', + 'edge_gateway_name': 'query', + 'billing_account_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_licenses_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/license/edge', + 'operation_id': 'get_licenses', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'account_id', + 'product_type', + 'refresh', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + 'product_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT" + }, + ('product_type',): { + + "GATEWAY": "GATEWAY", + "CONNECTION": "CONNECTION", + "AWSHC": "AWSHC" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'account_id': + (str,), + 'product_type': + (str,), + 'refresh': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'account_id': 'accountId', + 'product_type': 'productType', + 'refresh': 'refresh', + }, + 'location_map': { + 'edge_type': 'query', + 'account_id': 'query', + 'product_type': 'query', + 'refresh': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapping_matrix_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map', + 'operation_id': 'get_mapping_matrix', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapping_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map/status', + 'operation_id': 'get_mapping_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'region', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'region': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'region': 'region', + }, + 'location_map': { + 'cloud_type': 'query', + 'region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapping_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map/summary', + 'operation_id': 'get_mapping_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_tunnel_status', + 'cloud_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'vpn_tunnel_status': + (bool,), + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'vpn_tunnel_status': 'vpnTunnelStatus', + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'vpn_tunnel_status': 'query', + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapping_tags_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map/tags', + 'operation_id': 'get_mapping_tags', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + }, + 'location_map': { + 'cloud_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mapping_vpns_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map/vpns', + 'operation_id': 'get_mapping_vpns', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_nva_security_rules_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}', + 'operation_id': 'get_nva_security_rules', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'body', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_partner_ports_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/partnerports/edge', + 'operation_id': 'get_partner_ports', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'account_id', + 'cloud_type', + 'connect_type', + 'vxc_permitted', + 'authorization_key', + 'refresh', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'account_id': + (str,), + 'cloud_type': + (str,), + 'connect_type': + (str,), + 'vxc_permitted': + (str,), + 'authorization_key': + (str,), + 'refresh': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'account_id': 'accountId', + 'cloud_type': 'cloudType', + 'connect_type': 'connectType', + 'vxc_permitted': 'vxcPermitted', + 'authorization_key': 'authorizationKey', + 'refresh': 'refresh', + }, + 'location_map': { + 'edge_type': 'query', + 'account_id': 'query', + 'cloud_type': 'query', + 'connect_type': 'query', + 'vxc_permitted': 'query', + 'authorization_key': 'query', + 'refresh': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_port_speed_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}', + 'operation_id': 'get_port_speed', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'edge_account_id', + 'connectivity_type', + 'cloud_type', + 'cloud_account_id', + 'connect_type', + 'connect_sub_type', + 'connectivity_gateway', + 'partner_port', + ], + 'required': [ + 'edge_type', + 'edge_account_id', + 'connectivity_type', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + ('cloud_type',): { + + "AWS": "AWS", + "AZURE": "AZURE", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'edge_account_id': + (str,), + 'connectivity_type': + (str,), + 'cloud_type': + (str,), + 'cloud_account_id': + (str,), + 'connect_type': + (str,), + 'connect_sub_type': + (str,), + 'connectivity_gateway': + (str,), + 'partner_port': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'edge_account_id': 'edgeAccountId', + 'connectivity_type': 'connectivityType', + 'cloud_type': 'cloudType', + 'cloud_account_id': 'cloudAccountId', + 'connect_type': 'connectType', + 'connect_sub_type': 'connectSubType', + 'connectivity_gateway': 'connectivityGateway', + 'partner_port': 'partnerPort', + }, + 'location_map': { + 'edge_type': 'path', + 'edge_account_id': 'path', + 'connectivity_type': 'path', + 'cloud_type': 'query', + 'cloud_account_id': 'query', + 'connect_type': 'query', + 'connect_sub_type': 'query', + 'connectivity_gateway': 'query', + 'partner_port': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/statistics/interface/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_sites_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/site', + 'operation_id': 'get_sites', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'color', + 'attached', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'color': + (str,), + 'attached': + (bool,), + }, + 'attribute_map': { + 'color': 'color', + 'attached': 'attached', + }, + 'location_map': { + 'color': 'query', + 'attached': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sites1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}/site', + 'operation_id': 'get_sites1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'system_ip', + 'site_id', + 'color', + 'vpn_tunnel_status', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'system_ip': + (str,), + 'site_id': + (str,), + 'color': + (str,), + 'vpn_tunnel_status': + (bool,), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + 'system_ip': 'systemIp', + 'site_id': 'siteId', + 'color': 'color', + 'vpn_tunnel_status': 'vpnTunnelStatus', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'system_ip': 'query', + 'site_id': 'query', + 'color': 'query', + 'vpn_tunnel_status': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ssh_key_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/sshkeys', + 'operation_id': 'get_ssh_key_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + 'cloud_region', + ], + 'required': [ + 'cloud_type', + 'account_id', + 'cloud_region', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + 'cloud_region': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + 'cloud_region': 'cloudRegion', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + 'cloud_region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_edge_image_names_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/imagename/edge', + 'operation_id': 'get_supported_edge_image_names', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_edge_instance_size_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/instancesize/edge', + 'operation_id': 'get_supported_edge_instance_size', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + }, + 'location_map': { + 'edge_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_instance_size_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/instancesize', + 'operation_id': 'get_supported_instance_size', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + 'cloud_region', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + 'cloud_region': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + 'cloud_region': 'cloudRegion', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + 'cloud_region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_loopback_cgw_colors_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/loopbackCGWColor/edge', + 'operation_id': 'get_supported_loopback_cgw_colors', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_loopback_transport_colors_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/loopbacktransportcolor/edge', + 'operation_id': 'get_supported_loopback_transport_colors', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_software_image_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/swimages', + 'operation_id': 'get_supported_software_image_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + 'cloud_region', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + 'cloud_region': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + 'cloud_region': 'cloudRegion', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + 'cloud_region': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tunnel_names_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/tunnels/{cloudType}', + 'operation_id': 'get_tunnel_names', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'cloud_gateway_name', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'cloud_gateway_name': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_type': 'path', + 'cloud_gateway_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_hubs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/vhubs', + 'operation_id': 'get_v_hubs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'account_id', + 'resource_group', + 'v_wan_name', + 'v_net_tags', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'account_id': + (str,), + 'resource_group': + (str,), + 'v_wan_name': + (str,), + 'v_net_tags': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'account_id': 'accountId', + 'resource_group': 'resourceGroup', + 'v_wan_name': 'vWanName', + 'v_net_tags': 'vNetTags', + }, + 'location_map': { + 'cloud_type': 'query', + 'account_id': 'query', + 'resource_group': 'query', + 'v_wan_name': 'query', + 'v_net_tags': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_wans_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/vwans', + 'operation_id': 'get_v_wans', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'cloud_type', + 'resource_group', + 'refresh', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'cloud_type': + (str,), + 'resource_group': + (str,), + 'refresh': + (str,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'cloud_type': 'cloudType', + 'resource_group': 'resourceGroup', + 'refresh': 'refresh', + }, + 'location_map': { + 'account_id': 'query', + 'cloud_type': 'query', + 'resource_group': 'query', + 'refresh': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vpc_tags_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/hostvpc/tags', + 'operation_id': 'get_vpc_tags', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_type', + 'region', + 'tag_name', + ], + 'required': [ + 'cloud_type', + ], + 'nullable': [ + ], + 'enum': [ + 'cloud_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('cloud_type',): { + + "AWS": "AWS", + "AWS_GOVCLOUD": "AWS_GOVCLOUD", + "AZURE": "AZURE", + "AZURE_GOVCLOUD": "AZURE_GOVCLOUD", + "GCP": "GCP" + }, + }, + 'openapi_types': { + 'cloud_type': + (str,), + 'region': + (str,), + 'tag_name': + (str,), + }, + 'attribute_map': { + 'cloud_type': 'cloudType', + 'region': 'region', + 'tag_name': 'tagName', + }, + 'location_map': { + 'cloud_type': 'query', + 'region': 'query', + 'tag_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/device', + 'operation_id': 'get_wan_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wan_interface_colors_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/interfacecolor', + 'operation_id': 'get_wan_interface_colors', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.hostvpc_tagging_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/hostvpc/tags', + 'operation_id': 'hostvpc_tagging', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_mapping_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/map', + 'operation_id': 'process_mapping', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.telemetry_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/telemetry', + 'operation_id': 'telemetry', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tunnel_scaling_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}/site', + 'operation_id': 'tunnel_scaling', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'body', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.un_tag_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/hostvpc/tags/{tagName}', + 'operation_id': 'un_tag', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'tag_name', + ], + 'required': [ + 'tag_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tag_name': + (str,), + }, + 'attribute_map': { + 'tag_name': 'tagName', + }, + 'location_map': { + 'tag_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_account_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/{accountId}', + 'operation_id': 'update_account', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'body', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_cgw_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/{cloudGatewayName}', + 'operation_id': 'update_cgw', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'body', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_device_link_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/devicelink/edge', + 'operation_id': 'update_device_link', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_edge_account_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/edge/{accountId}', + 'operation_id': 'update_edge_account', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'body', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_edge_connectivity_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/connectivity/edge', + 'operation_id': 'update_edge_connectivity', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_edge_global_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/settings/edge/global', + 'operation_id': 'update_edge_global_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_edge_locations_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/locations/edge/{edgeType}/accountId/{accountId}', + 'operation_id': 'update_edge_locations_info', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_type', + 'account_id', + ], + 'required': [ + 'edge_type', + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + 'edge_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('edge_type',): { + + "MEGAPORT": "MEGAPORT", + "EQUINIX": "EQUINIX" + }, + }, + 'openapi_types': { + 'edge_type': + (str,), + 'account_id': + (str,), + }, + 'attribute_map': { + 'edge_type': 'edgeType', + 'account_id': 'accountId', + }, + 'location_map': { + 'edge_type': 'path', + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_global_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/settings/global', + 'operation_id': 'update_global_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_icgw_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/gateway/edge/{edgeGatewayName}', + 'operation_id': 'update_icgw', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'edge_gateway_name', + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [ + 'edge_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'edge_gateway_name': + (str,), + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + 'edge_gateway_name': 'edgeGatewayName', + }, + 'location_map': { + 'edge_gateway_name': 'path', + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_nva_security_rules_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}', + 'operation_id': 'update_nva_security_rules', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'cloud_gateway_name', + 'body', + ], + 'required': [ + 'cloud_gateway_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'cloud_gateway_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'cloud_gateway_name': 'cloudGatewayName', + }, + 'location_map': { + 'cloud_gateway_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_account_add_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts', + 'operation_id': 'validate_account_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_account_update_credentials_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/{accountId}/credentials', + 'operation_id': 'validate_account_update_credentials', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'body', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_edge_account_add_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/edge', + 'operation_id': 'validate_edge_account_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.validate_edge_account_update_credentials_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/multicloud/accounts/edge/{accountId}/credentials', + 'operation_id': 'validate_edge_account_update_credentials', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'body', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def add_edge_global_settings( + self, + **kwargs + ): + """add_edge_global_settings # noqa: E501 + + Add global settings for Edge provider # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_edge_global_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_edge_global_settings_endpoint.call_with_http_info(**kwargs) + + def add_global_settings( + self, + **kwargs + ): + """add_global_settings # noqa: E501 + + Acquire ip from resource pool # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_global_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_global_settings_endpoint.call_with_http_info(**kwargs) + + def attach_sites( + self, + cloud_gateway_name, + **kwargs + ): + """attach_sites # noqa: E501 + + Attach sites to cloud gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.attach_sites(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Site information. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.attach_sites_endpoint.call_with_http_info(**kwargs) + + def audit( + self, + **kwargs + ): + """audit # noqa: E501 + + Call an audit # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.audit(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audit. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.audit_endpoint.call_with_http_info(**kwargs) + + def audit_dry_run( + self, + **kwargs + ): + """audit_dry_run # noqa: E501 + + Call an audit with dry run # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.audit_dry_run(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud type. [optional] + cloud_region (str): Region. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.audit_dry_run_endpoint.call_with_http_info(**kwargs) + + def clean_up_all_connectivity_gateways_in_local_db( + self, + **kwargs + ): + """clean_up_all_connectivity_gateways_in_local_db # noqa: E501 + + Delete all Connectivity Gateways in local DB # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.clean_up_all_connectivity_gateways_in_local_db(async_req=True) + >>> result = thread.get() + + + Keyword Args: + deletion_type (str): Deletion Type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.clean_up_all_connectivity_gateways_in_local_db_endpoint.call_with_http_info(**kwargs) + + def create_cgw( + self, + **kwargs + ): + """create_cgw # noqa: E501 + + Create cloud gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cgw(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloud gateway. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_cgw_endpoint.call_with_http_info(**kwargs) + + def create_connectivity_gateway( + self, + **kwargs + ): + """create_connectivity_gateway # noqa: E501 + + Create Connectivity gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_connectivity_gateway(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Connectivity gateway. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_connectivity_gateway_endpoint.call_with_http_info(**kwargs) + + def create_device_link( + self, + **kwargs + ): + """create_device_link # noqa: E501 + + Create Device Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_link(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device Link. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_device_link_endpoint.call_with_http_info(**kwargs) + + def create_edge_connectivity( + self, + **kwargs + ): + """create_edge_connectivity # noqa: E501 + + Create Interconnect connectivity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_edge_connectivity(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Edge connectivity. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_edge_connectivity_endpoint.call_with_http_info(**kwargs) + + def create_icgw( + self, + **kwargs + ): + """create_icgw # noqa: E501 + + Create Interconnect Gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_icgw(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Interconnect Gateway. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_icgw_endpoint.call_with_http_info(**kwargs) + + def create_virtual_wan( + self, + **kwargs + ): + """create_virtual_wan # noqa: E501 + + Create Virtual WAN # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_virtual_wan(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Virtual WAN. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_virtual_wan_endpoint.call_with_http_info(**kwargs) + + def delete_account( + self, + account_id, + **kwargs + ): + """delete_account # noqa: E501 + + Delete cloud account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_account(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.delete_account_endpoint.call_with_http_info(**kwargs) + + def delete_cgw( + self, + cloud_gateway_name, + **kwargs + ): + """delete_cgw # noqa: E501 + + Delete cloud gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_cgw(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + delete_all_resources (bool): Optional Flag for deletion of Azure Resource Group, Default: True. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.delete_cgw_endpoint.call_with_http_info(**kwargs) + + def delete_connectivity_gateway( + self, + cloud_provider, + connectivity_gateway_name, + **kwargs + ): + """delete_connectivity_gateway # noqa: E501 + + Delete Connectivity Gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_connectivity_gateway(cloud_provider, connectivity_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_provider (str): Cloud Provider + connectivity_gateway_name (str): Connectivity gateway name + + Keyword Args: + connectivity_type (str): Cloud Connectivity Type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_provider'] = \ + cloud_provider + kwargs['connectivity_gateway_name'] = \ + connectivity_gateway_name + return self.delete_connectivity_gateway_endpoint.call_with_http_info(**kwargs) + + def delete_device_link( + self, + device_link_name, + **kwargs + ): + """delete_device_link # noqa: E501 + + Delete Device Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_device_link(device_link_name, async_req=True) + >>> result = thread.get() + + Args: + device_link_name (str): Device Link Name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_link_name'] = \ + device_link_name + return self.delete_device_link_endpoint.call_with_http_info(**kwargs) + + def delete_edge_account( + self, + account_id, + **kwargs + ): + """delete_edge_account # noqa: E501 + + Delete edge account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_edge_account(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Edge Account Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.delete_edge_account_endpoint.call_with_http_info(**kwargs) + + def delete_edge_account1( + self, + edge_type="MEGAPORT", + **kwargs + ): + """delete_edge_account1 # noqa: E501 + + Delete edge account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_edge_account1(edge_type="MEGAPORT", async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge Type. defaults to "MEGAPORT", must be one of ["MEGAPORT"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.delete_edge_account1_endpoint.call_with_http_info(**kwargs) + + def delete_edge_connectivity( + self, + connection_name, + **kwargs + ): + """delete_edge_connectivity # noqa: E501 + + Delete Interconnect connectivity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_edge_connectivity(connection_name, async_req=True) + >>> result = thread.get() + + Args: + connection_name (str): Edge connectivity name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['connection_name'] = \ + connection_name + return self.delete_edge_connectivity_endpoint.call_with_http_info(**kwargs) + + def delete_icgw( + self, + edge_gateway_name, + **kwargs + ): + """delete_icgw # noqa: E501 + + Delete Interconnect Gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_icgw(edge_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + edge_gateway_name (str): Edge gateway name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_gateway_name'] = \ + edge_gateway_name + return self.delete_icgw_endpoint.call_with_http_info(**kwargs) + + def delete_virtual_wan( + self, + cloud_provider, + v_wan_name, + **kwargs + ): + """delete_virtual_wan # noqa: E501 + + Delete Virtual Wan # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_virtual_wan(cloud_provider, v_wan_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_provider (str): Cloud Provider + v_wan_name (str): Virtual Wan name + + Keyword Args: + account_id (str): Account Id. [optional] + resource_group (str): Resource Group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_provider'] = \ + cloud_provider + kwargs['v_wan_name'] = \ + v_wan_name + return self.delete_virtual_wan_endpoint.call_with_http_info(**kwargs) + + def detach_sites1( + self, + cloud_gateway_name, + **kwargs + ): + """detach_sites1 # noqa: E501 + + Detach sites from cloud gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detach_sites1(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Site information. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.detach_sites1_endpoint.call_with_http_info(**kwargs) + + def edge_audit( + self, + **kwargs + ): + """edge_audit # noqa: E501 + + Call an edge audit # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edge_audit(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + cloud_type (str): Cloud type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edge_audit_endpoint.call_with_http_info(**kwargs) + + def edge_audit_dry_run( + self, + **kwargs + ): + """edge_audit_dry_run # noqa: E501 + + Call an edge audit with dry run # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edge_audit_dry_run(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + cloud_type (str): Cloud type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edge_audit_dry_run_endpoint.call_with_http_info(**kwargs) + + def edit_tag( + self, + **kwargs + ): + """edit_tag # noqa: E501 + + Edit VPCs for a tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPC tag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edit_tag_endpoint.call_with_http_info(**kwargs) + + def get_all_cloud_accounts( + self, + **kwargs + ): + """get_all_cloud_accounts # noqa: E501 + + Get All cloud accounts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_cloud_accounts(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud type. [optional] + cloud_gateway_enabled (bool): Cloud gateway enabled flag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_cloud_accounts_endpoint.call_with_http_info(**kwargs) + + def get_azure_network_virtual_appliances( + self, + cloud_type, + accound_id, + region, + resource_group_name, + resource_group_source, + vhub_name, + vhub_source, + **kwargs + ): + """get_azure_network_virtual_appliances # noqa: E501 + + Discover Azure Virtual NVAs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_azure_network_virtual_appliances(cloud_type, accound_id, region, resource_group_name, resource_group_source, vhub_name, vhub_source, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + accound_id (str): Account ID + region (str): Region + resource_group_name (str): Resource Group Name + resource_group_source (str): Resource Group Source + vhub_name (str): VHUB name + vhub_source (str): VHUB source + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + kwargs['accound_id'] = \ + accound_id + kwargs['region'] = \ + region + kwargs['resource_group_name'] = \ + resource_group_name + kwargs['resource_group_source'] = \ + resource_group_source + kwargs['vhub_name'] = \ + vhub_name + kwargs['vhub_source'] = \ + vhub_source + return self.get_azure_network_virtual_appliances_endpoint.call_with_http_info(**kwargs) + + def get_azure_nva_sku_list( + self, + cloud_type, + **kwargs + ): + """get_azure_nva_sku_list # noqa: E501 + + Get Azure NVA SKUs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_azure_nva_sku_list(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_azure_nva_sku_list_endpoint.call_with_http_info(**kwargs) + + def get_azure_resource_groups( + self, + cloud_type, + account_id, + **kwargs + ): + """get_azure_resource_groups # noqa: E501 + + Discover Azure Resource Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_azure_resource_groups(cloud_type, account_id, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + account_id (str): Account ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + kwargs['account_id'] = \ + account_id + return self.get_azure_resource_groups_endpoint.call_with_http_info(**kwargs) + + def get_azure_virtual_hubs( + self, + cloud_type, + accound_id, + region, + resource_group_name, + resource_group_source, + vwan_name, + vwan_source, + **kwargs + ): + """get_azure_virtual_hubs # noqa: E501 + + Discover Azure Virtual HUBs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_azure_virtual_hubs(cloud_type, accound_id, region, resource_group_name, resource_group_source, vwan_name, vwan_source, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + accound_id (str): Account ID + region (str): Region + resource_group_name (str): Resource Group Name + resource_group_source (str): Resource Group Source + vwan_name (str): VWAN name + vwan_source (str): VWAN source + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + kwargs['accound_id'] = \ + accound_id + kwargs['region'] = \ + region + kwargs['resource_group_name'] = \ + resource_group_name + kwargs['resource_group_source'] = \ + resource_group_source + kwargs['vwan_name'] = \ + vwan_name + kwargs['vwan_source'] = \ + vwan_source + return self.get_azure_virtual_hubs_endpoint.call_with_http_info(**kwargs) + + def get_azure_virtual_wans( + self, + cloud_type, + accound_id, + resource_group_name, + resource_group_source, + **kwargs + ): + """get_azure_virtual_wans # noqa: E501 + + Discover Azure Virtual WANs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_azure_virtual_wans(cloud_type, accound_id, resource_group_name, resource_group_source, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + accound_id (str): Account ID + resource_group_name (str): Resource Group Name + resource_group_source (str): Resource Group Source + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + kwargs['accound_id'] = \ + accound_id + kwargs['resource_group_name'] = \ + resource_group_name + kwargs['resource_group_source'] = \ + resource_group_source + return self.get_azure_virtual_wans_endpoint.call_with_http_info(**kwargs) + + def get_cgw_associated_mappings( + self, + cloud_type, + cloud_gateway_name, + **kwargs + ): + """get_cgw_associated_mappings # noqa: E501 + + Get associated mappings to the CGW # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cgw_associated_mappings(cloud_type, cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + cloud_gateway_name (str): Cloud Gateway Name + + Keyword Args: + site_uuid (str): Site Device UUID. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.get_cgw_associated_mappings_endpoint.call_with_http_info(**kwargs) + + def get_cgw_custom_setting_details( + self, + cloud_gateway_name, + **kwargs + ): + """get_cgw_custom_setting_details # noqa: E501 + + Get cloud gateway custom setting by cloud gateway name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cgw_custom_setting_details(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.get_cgw_custom_setting_details_endpoint.call_with_http_info(**kwargs) + + def get_cgw_details( + self, + cloud_gateway_name, + **kwargs + ): + """get_cgw_details # noqa: E501 + + Get cloud gateway by name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cgw_details(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.get_cgw_details_endpoint.call_with_http_info(**kwargs) + + def get_cgw_org_resources( + self, + cloud_gateway_name, + **kwargs + ): + """get_cgw_org_resources # noqa: E501 + + Get cloud gateways # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cgw_org_resources(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.get_cgw_org_resources_endpoint.call_with_http_info(**kwargs) + + def get_cgw_types( + self, + **kwargs + ): + """get_cgw_types # noqa: E501 + + Get cloud gateway types for specified cloudType # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cgw_types(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cgw_types_endpoint.call_with_http_info(**kwargs) + + def get_cgws( + self, + **kwargs + ): + """get_cgws # noqa: E501 + + Get cloud gateways # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cgws(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud type. [optional] + account_id (str): Account Id. [optional] + region (str): Region. [optional] + cloud_gateway_name (str): Cloud gateway name. [optional] + connectivity_state (str): Connectivity State. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cgws_endpoint.call_with_http_info(**kwargs) + + def get_cloud_account_details( + self, + account_id, + **kwargs + ): + """get_cloud_account_details # noqa: E501 + + Get cloud account by account Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_account_details(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.get_cloud_account_details_endpoint.call_with_http_info(**kwargs) + + def get_cloud_connected_sites( + self, + cloud_type, + **kwargs + ): + """get_cloud_connected_sites # noqa: E501 + + Get sites with connectivity to the cloud by cloud type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_connected_sites(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + cloud_gateway_name (str): Cloud Gateway Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_cloud_connected_sites_endpoint.call_with_http_info(**kwargs) + + def get_cloud_connected_sites1( + self, + edge_type, + **kwargs + ): + """get_cloud_connected_sites1 # noqa: E501 + + Get sites with connectivity to the interconnect gateways by edge type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_connected_sites1(edge_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge type + + Keyword Args: + edge_gateway_name (str): Interconnect Gateway Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_cloud_connected_sites1_endpoint.call_with_http_info(**kwargs) + + def get_cloud_devices( + self, + cloud_type, + **kwargs + ): + """get_cloud_devices # noqa: E501 + + Get cloud devices by cloud type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_devices(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + cloud_gateway_name (str): Cloud Gateway Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_cloud_devices_endpoint.call_with_http_info(**kwargs) + + def get_cloud_devices1( + self, + edge_type, + **kwargs + ): + """get_cloud_devices1 # noqa: E501 + + Get cloud devices by cloud type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_devices1(edge_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge type + + Keyword Args: + edge_gateway_name (str): Edge Gateway Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_cloud_devices1_endpoint.call_with_http_info(**kwargs) + + def get_cloud_gateways( + self, + cloud_type, + **kwargs + ): + """get_cloud_gateways # noqa: E501 + + Get sites with connectivity to the cloud by cloud type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_gateways(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_cloud_gateways_endpoint.call_with_http_info(**kwargs) + + def get_cloud_regions( + self, + **kwargs + ): + """get_cloud_regions # noqa: E501 + + Get cloud regions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_regions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_regions_endpoint.call_with_http_info(**kwargs) + + def get_cloud_routers_and_attachments( + self, + **kwargs + ): + """get_cloud_routers_and_attachments # noqa: E501 + + Get all Cloud Routers and their Attachments # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_routers_and_attachments(async_req=True) + >>> result = thread.get() + + + Keyword Args: + account_id (str): Account Id. [optional] + region (str): Region. [optional] + network (str): Network. [optional] + connectivity_gateway_name (str): Connectivity Gateway Name. [optional] + cloud_gateway_name (str): Cloud Gateway Name. [optional] + state (str): State. [optional] + refresh (str): Refresh. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_routers_and_attachments_endpoint.call_with_http_info(**kwargs) + + def get_cloud_types( + self, + **kwargs + ): + """get_cloud_types # noqa: E501 + + Get cloud types # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_types(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_types_endpoint.call_with_http_info(**kwargs) + + def get_cloud_widget( + self, + cloud_type, + **kwargs + ): + """get_cloud_widget # noqa: E501 + + Get cloud widget by cloud type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_widget(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_cloud_widget_endpoint.call_with_http_info(**kwargs) + + def get_connectivity_gateway_creation_options( + self, + **kwargs + ): + """get_connectivity_gateway_creation_options # noqa: E501 + + Get connectivity gateway creation options # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_connectivity_gateway_creation_options(async_req=True) + >>> result = thread.get() + + + Keyword Args: + account_id (str): Account Id. [optional] + cloud_type (str): Cloud Type. [optional] + connectivity_type (str): Cloud Connectivity Type. [optional] + refresh (str): Refresh. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_connectivity_gateway_creation_options_endpoint.call_with_http_info(**kwargs) + + def get_connectivity_gateways( + self, + **kwargs + ): + """get_connectivity_gateways # noqa: E501 + + Get all Connectivity Gateways # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_connectivity_gateways(async_req=True) + >>> result = thread.get() + + + Keyword Args: + account_id (str): Account Id. [optional] + cloud_type (str): Cloud Type. [optional] + connectivity_type (str): Cloud Connectivity Type. [optional] + connectivity_gateway_name (str): Connectivity Gateway Name. [optional] + region (str): Region. [optional] + network (str): Network. [optional] + state (str): State. [optional] + refresh (str): Refresh. [optional] + edge_type (str): Edge type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_connectivity_gateways_endpoint.call_with_http_info(**kwargs) + + def get_dashboard_edge_info( + self, + **kwargs + ): + """get_dashboard_edge_info # noqa: E501 + + Get interconnect edge gateway dashboard info # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dashboard_edge_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dashboard_edge_info_endpoint.call_with_http_info(**kwargs) + + def get_default_mapping_values( + self, + cloud_type, + **kwargs + ): + """get_default_mapping_values # noqa: E501 + + Get default mapping values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_default_mapping_values(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_default_mapping_values_endpoint.call_with_http_info(**kwargs) + + def get_device_link_metro_speed( + self, + **kwargs + ): + """get_device_link_metro_speed # noqa: E501 + + Get Device Link Metro Speed based on device link config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_link_metro_speed(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device Link. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_link_metro_speed_endpoint.call_with_http_info(**kwargs) + + def get_device_links( + self, + **kwargs + ): + """get_device_links # noqa: E501 + + Get Device Links # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_links(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + device_link_name (str): Device Link Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_links_endpoint.call_with_http_info(**kwargs) + + def get_dl_port_speed( + self, + edge_type, + **kwargs + ): + """get_dl_port_speed # noqa: E501 + + Get supported port speed for Device Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dl_port_speed(edge_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Interconnect Provider + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_dl_port_speed_endpoint.call_with_http_info(**kwargs) + + def get_edge_account_details( + self, + account_id, + **kwargs + ): + """get_edge_account_details # noqa: E501 + + Get edge account by account Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_account_details(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Edge Account Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.get_edge_account_details_endpoint.call_with_http_info(**kwargs) + + def get_edge_accounts( + self, + **kwargs + ): + """get_edge_accounts # noqa: E501 + + Get all Multicloud edge accounts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_accounts(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] if omitted the server will use the default value of "MEGAPORT" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_edge_accounts_endpoint.call_with_http_info(**kwargs) + + def get_edge_billing_accounts( + self, + edge_account_id, + edge_type="EQUINIX", + **kwargs + ): + """get_edge_billing_accounts # noqa: E501 + + Get Edge Billing Accounts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_billing_accounts(edge_account_id, edge_type="EQUINIX", async_req=True) + >>> result = thread.get() + + Args: + edge_account_id (str): Interconnect Provider Account ID + edge_type (str): Interconnect Provider. defaults to "EQUINIX", must be one of ["EQUINIX"] + + Keyword Args: + region (str): Region. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + kwargs['edge_account_id'] = \ + edge_account_id + return self.get_edge_billing_accounts_endpoint.call_with_http_info(**kwargs) + + def get_edge_connectivity_detail_by_name( + self, + connectivity_name, + **kwargs + ): + """get_edge_connectivity_detail_by_name # noqa: E501 + + Get Interconnect Connectivity by name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_connectivity_detail_by_name(connectivity_name, async_req=True) + >>> result = thread.get() + + Args: + connectivity_name (str): IC-GW connectivity name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['connectivity_name'] = \ + connectivity_name + return self.get_edge_connectivity_detail_by_name_endpoint.call_with_http_info(**kwargs) + + def get_edge_connectivity_details( + self, + **kwargs + ): + """get_edge_connectivity_details # noqa: E501 + + Get Interconnect Connectivity details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_connectivity_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + connectivity_name (str): Connectivity Name. [optional] + connectivity_type (str): Connectivity Type. [optional] + edge_gateway_name (str): Interconnect Gateway name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_edge_connectivity_details_endpoint.call_with_http_info(**kwargs) + + def get_edge_gateways( + self, + edge_type, + **kwargs + ): + """get_edge_gateways # noqa: E501 + + Get sites with connectivity to the interconnect gateways by edge type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_gateways(edge_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_edge_gateways_endpoint.call_with_http_info(**kwargs) + + def get_edge_global_settings( + self, + edge_type, + **kwargs + ): + """get_edge_global_settings # noqa: E501 + + Get edge global settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_global_settings(edge_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_edge_global_settings_endpoint.call_with_http_info(**kwargs) + + def get_edge_locations_info( + self, + edge_type="MEGAPORT", + **kwargs + ): + """get_edge_locations_info # noqa: E501 + + Get Edge Locations # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_locations_info(edge_type="MEGAPORT", async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge Type. defaults to "MEGAPORT", must be one of ["MEGAPORT"] + + Keyword Args: + account_id (str): Edge Account Id. [optional] + region (str): Region. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_edge_locations_info_endpoint.call_with_http_info(**kwargs) + + def get_edge_mapping_tags( + self, + cloud_type, + **kwargs + ): + """get_edge_mapping_tags # noqa: E501 + + Get default Interconnect mapping tag values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_mapping_tags(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + account_id (str): Cloud Account Id. [optional] + resource_group (str): Resource Group. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_edge_mapping_tags_endpoint.call_with_http_info(**kwargs) + + def get_edge_types( + self, + **kwargs + ): + """get_edge_types # noqa: E501 + + Get edge types # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_types(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_edge_types_endpoint.call_with_http_info(**kwargs) + + def get_edge_wan_devices( + self, + edge_type="MEGAPORT", + **kwargs + ): + """get_edge_wan_devices # noqa: E501 + + Get available WAN edge devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_wan_devices(edge_type="MEGAPORT", async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge Type. defaults to "MEGAPORT", must be one of ["MEGAPORT"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_edge_wan_devices_endpoint.call_with_http_info(**kwargs) + + def get_edge_widget( + self, + edge_type, + **kwargs + ): + """get_edge_widget # noqa: E501 + + Get Interconnect Edge widget by edge type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_edge_widget(edge_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Edge type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + return self.get_edge_widget_endpoint.call_with_http_info(**kwargs) + + def get_global_settings( + self, + cloud_type, + **kwargs + ): + """get_global_settings # noqa: E501 + + Get global settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_global_settings(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_global_settings_endpoint.call_with_http_info(**kwargs) + + def get_host_vpcs( + self, + cloud_type, + **kwargs + ): + """get_host_vpcs # noqa: E501 + + Get tagged, untagged, or all Host VPCs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_host_vpcs(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + account_ids (str): Account Id. [optional] + region (str): Region. [optional] + untagged (str): Untagged flag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_host_vpcs_endpoint.call_with_http_info(**kwargs) + + def get_icgw_custom_setting_details( + self, + edge_gateway_name, + **kwargs + ): + """get_icgw_custom_setting_details # noqa: E501 + + Get Interconnect Gateway custom setting by Interconnect Gateway name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_icgw_custom_setting_details(edge_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + edge_gateway_name (str): Edge gateway name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_gateway_name'] = \ + edge_gateway_name + return self.get_icgw_custom_setting_details_endpoint.call_with_http_info(**kwargs) + + def get_icgw_details( + self, + edge_gateway_name, + **kwargs + ): + """get_icgw_details # noqa: E501 + + Get Interconnect Gateway by name # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_icgw_details(edge_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + edge_gateway_name (str): Edge gateway name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_gateway_name'] = \ + edge_gateway_name + return self.get_icgw_details_endpoint.call_with_http_info(**kwargs) + + def get_icgw_types( + self, + **kwargs + ): + """get_icgw_types # noqa: E501 + + Get Interconnect Gateway type for specified Edge Provider # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_icgw_types(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_icgw_types_endpoint.call_with_http_info(**kwargs) + + def get_icgws( + self, + **kwargs + ): + """get_icgws # noqa: E501 + + Get Interconnect Gateways # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_icgws(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + account_id (str): Account Id. [optional] + region (str): Region. [optional] + region_id (str): Region Id. [optional] + resource_state (str): Resource State. [optional] + edge_gateway_name (str): Edge gateway name. [optional] + billing_account_id (str): billing Account Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_icgws_endpoint.call_with_http_info(**kwargs) + + def get_licenses( + self, + **kwargs + ): + """get_licenses # noqa: E501 + + Get License Info for Edge Gateways/Connections # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_licenses(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] if omitted the server will use the default value of "MEGAPORT" + account_id (str): Edge Account Id. [optional] + product_type (str): product Type. [optional] + refresh (str): Refresh License Cache from Megaport. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_licenses_endpoint.call_with_http_info(**kwargs) + + def get_mapping_matrix( + self, + cloud_type, + **kwargs + ): + """get_mapping_matrix # noqa: E501 + + Get default mapping values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapping_matrix(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_mapping_matrix_endpoint.call_with_http_info(**kwargs) + + def get_mapping_status( + self, + **kwargs + ): + """get_mapping_status # noqa: E501 + + Get mapping status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapping_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud type. [optional] + region (str): Region. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_mapping_status_endpoint.call_with_http_info(**kwargs) + + def get_mapping_summary( + self, + **kwargs + ): + """get_mapping_summary # noqa: E501 + + Get mapping summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapping_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vpn_tunnel_status (bool): VPN tunnel status. [optional] + cloud_type (str): Cloud type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_mapping_summary_endpoint.call_with_http_info(**kwargs) + + def get_mapping_tags( + self, + cloud_type, + **kwargs + ): + """get_mapping_tags # noqa: E501 + + Get default mapping values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapping_tags(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_mapping_tags_endpoint.call_with_http_info(**kwargs) + + def get_mapping_vpns( + self, + **kwargs + ): + """get_mapping_vpns # noqa: E501 + + Get default mapping values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mapping_vpns(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_mapping_vpns_endpoint.call_with_http_info(**kwargs) + + def get_nva_security_rules( + self, + cloud_gateway_name, + **kwargs + ): + """get_nva_security_rules # noqa: E501 + + Get NVA Security Rules # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_nva_security_rules(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Get NVA security Rules. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.get_nva_security_rules_endpoint.call_with_http_info(**kwargs) + + def get_partner_ports( + self, + **kwargs + ): + """get_partner_ports # noqa: E501 + + Get partner ports # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_partner_ports(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] + account_id (str): Edge Account Id. [optional] + cloud_type (str): Cloud Type. [optional] + connect_type (str): Connect Type filter. [optional] + vxc_permitted (str): VXC Permitted on the port. [optional] + authorization_key (str): authorization Key. [optional] + refresh (str): Refresh. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_partner_ports_endpoint.call_with_http_info(**kwargs) + + def get_port_speed( + self, + edge_type, + edge_account_id, + connectivity_type, + **kwargs + ): + """get_port_speed # noqa: E501 + + Get supported port speed # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_port_speed(edge_type, edge_account_id, connectivity_type, async_req=True) + >>> result = thread.get() + + Args: + edge_type (str): Interconnect Provider + edge_account_id (str): Interconnect Provider Account ID + connectivity_type (str): Interconnect Connectivity Type + + Keyword Args: + cloud_type (str): Cloud Service Provider. [optional] + cloud_account_id (str): Cloud Service Provider Account ID. [optional] + connect_type (str): Connection Type filter. [optional] + connect_sub_type (str): Connection Sub-Type filter. [optional] + connectivity_gateway (str): Connectivity Gateway. [optional] + partner_port (str): partnerPort. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + kwargs['edge_account_id'] = \ + edge_account_id + kwargs['connectivity_type'] = \ + connectivity_type + return self.get_port_speed_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query25( + self, + **kwargs + ): + """get_post_aggregation_data_by_query25 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query25_endpoint.call_with_http_info(**kwargs) + + def get_sites( + self, + **kwargs + ): + """get_sites # noqa: E501 + + Get available sites # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sites(async_req=True) + >>> result = thread.get() + + + Keyword Args: + color (str): Color. [optional] + attached (bool): Is endpoint attached. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sites_endpoint.call_with_http_info(**kwargs) + + def get_sites1( + self, + cloud_gateway_name, + **kwargs + ): + """get_sites1 # noqa: E501 + + Get sites attached to CGW # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sites1(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + system_ip (str): System IP. [optional] + site_id (str): Site Id. [optional] + color (str): Color. [optional] + vpn_tunnel_status (bool): Fetch vpnTunnelStatus. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.get_sites1_endpoint.call_with_http_info(**kwargs) + + def get_ssh_key_list( + self, + cloud_type, + account_id, + cloud_region, + **kwargs + ): + """get_ssh_key_list # noqa: E501 + + Get SSH keys # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ssh_key_list(cloud_type, account_id, cloud_region, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + account_id (str): Account Id + cloud_region (str): Region + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + kwargs['account_id'] = \ + account_id + kwargs['cloud_region'] = \ + cloud_region + return self.get_ssh_key_list_endpoint.call_with_http_info(**kwargs) + + def get_supported_edge_image_names( + self, + **kwargs + ): + """get_supported_edge_image_names # noqa: E501 + + Get Edge provider supported images # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_edge_image_names(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] if omitted the server will use the default value of "MEGAPORT" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_supported_edge_image_names_endpoint.call_with_http_info(**kwargs) + + def get_supported_edge_instance_size( + self, + **kwargs + ): + """get_supported_edge_instance_size # noqa: E501 + + Get Edge provider supported size # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_edge_instance_size(async_req=True) + >>> result = thread.get() + + + Keyword Args: + edge_type (str): Edge type. [optional] if omitted the server will use the default value of "MEGAPORT" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_supported_edge_instance_size_endpoint.call_with_http_info(**kwargs) + + def get_supported_instance_size( + self, + cloud_type, + **kwargs + ): + """get_supported_instance_size # noqa: E501 + + Get Transit VPC supported size # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_instance_size(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): + + Keyword Args: + account_id (str): [optional] + cloud_region (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_supported_instance_size_endpoint.call_with_http_info(**kwargs) + + def get_supported_loopback_cgw_colors( + self, + **kwargs + ): + """get_supported_loopback_cgw_colors # noqa: E501 + + Get Edge Loopback CGW supported colors # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_loopback_cgw_colors(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_supported_loopback_cgw_colors_endpoint.call_with_http_info(**kwargs) + + def get_supported_loopback_transport_colors( + self, + **kwargs + ): + """get_supported_loopback_transport_colors # noqa: E501 + + Get Edge Loopback Tunnel supported colors # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_loopback_transport_colors(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_supported_loopback_transport_colors_endpoint.call_with_http_info(**kwargs) + + def get_supported_software_image_list( + self, + cloud_type, + **kwargs + ): + """get_supported_software_image_list # noqa: E501 + + Get software image list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_software_image_list(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + account_id (str): Account Id. [optional] + cloud_region (str): Region. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_supported_software_image_list_endpoint.call_with_http_info(**kwargs) + + def get_tunnel_names( + self, + cloud_type, + **kwargs + ): + """get_tunnel_names # noqa: E501 + + Get tunnel names # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tunnel_names(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + cloud_gateway_name (str): Cloud gateway name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_tunnel_names_endpoint.call_with_http_info(**kwargs) + + def get_v_hubs( + self, + **kwargs + ): + """get_v_hubs # noqa: E501 + + Get Virtual Hubs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_hubs(async_req=True) + >>> result = thread.get() + + + Keyword Args: + cloud_type (str): Cloud Type. [optional] + account_id (str): Account Id. [optional] + resource_group (str): Resource Group. [optional] + v_wan_name (str): VWan Name. [optional] + v_net_tags (str): VNet Tags. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_v_hubs_endpoint.call_with_http_info(**kwargs) + + def get_v_wans( + self, + **kwargs + ): + """get_v_wans # noqa: E501 + + Get Virtual Wans # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_wans(async_req=True) + >>> result = thread.get() + + + Keyword Args: + account_id (str): Account Id. [optional] + cloud_type (str): Cloud Type. [optional] + resource_group (str): Resource Group. [optional] + refresh (str): Refresh. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_v_wans_endpoint.call_with_http_info(**kwargs) + + def get_vpc_tags( + self, + cloud_type, + **kwargs + ): + """get_vpc_tags # noqa: E501 + + Get vpc tags # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpc_tags(cloud_type, async_req=True) + >>> result = thread.get() + + Args: + cloud_type (str): Cloud type + + Keyword Args: + region (str): Region. [optional] + tag_name (str): Tag name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_type'] = \ + cloud_type + return self.get_vpc_tags_endpoint.call_with_http_info(**kwargs) + + def get_wan_devices( + self, + **kwargs + ): + """get_wan_devices # noqa: E501 + + Get available WAN edge devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_wan_devices_endpoint.call_with_http_info(**kwargs) + + def get_wan_interface_colors( + self, + **kwargs + ): + """get_wan_interface_colors # noqa: E501 + + Get WAN interface colors # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wan_interface_colors(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_wan_interface_colors_endpoint.call_with_http_info(**kwargs) + + def hostvpc_tagging( + self, + **kwargs + ): + """hostvpc_tagging # noqa: E501 + + Tag a VPC # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.hostvpc_tagging(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPC tag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.hostvpc_tagging_endpoint.call_with_http_info(**kwargs) + + def process_mapping( + self, + **kwargs + ): + """process_mapping # noqa: E501 + + Process intent of connecting VPNs with VPCs through cloud gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_mapping(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): VPC mapping. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_mapping_endpoint.call_with_http_info(**kwargs) + + def telemetry( + self, + **kwargs + ): + """telemetry # noqa: E501 + + reports telemetry data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.telemetry(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): telemetry. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.telemetry_endpoint.call_with_http_info(**kwargs) + + def tunnel_scaling( + self, + cloud_gateway_name, + **kwargs + ): + """tunnel_scaling # noqa: E501 + + Update tunnel scaling and accelerated vpn parameter for a branch endpoint # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tunnel_scaling(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Site information. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.tunnel_scaling_endpoint.call_with_http_info(**kwargs) + + def un_tag( + self, + tag_name, + **kwargs + ): + """un_tag # noqa: E501 + + Delete a tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.un_tag(tag_name, async_req=True) + >>> result = thread.get() + + Args: + tag_name (str): Tag name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tag_name'] = \ + tag_name + return self.un_tag_endpoint.call_with_http_info(**kwargs) + + def update_account( + self, + account_id, + **kwargs + ): + """update_account # noqa: E501 + + Update multicloud account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_account(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Multicloud account info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.update_account_endpoint.call_with_http_info(**kwargs) + + def update_cgw( + self, + cloud_gateway_name, + **kwargs + ): + """update_cgw # noqa: E501 + + Update cloud gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_cgw(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloud gateway. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.update_cgw_endpoint.call_with_http_info(**kwargs) + + def update_device_link( + self, + **kwargs + ): + """update_device_link # noqa: E501 + + Update Device Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_device_link(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device Link. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_device_link_endpoint.call_with_http_info(**kwargs) + + def update_edge_account( + self, + account_id, + **kwargs + ): + """update_edge_account # noqa: E501 + + Update Multicloud edge account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_edge_account(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Multicloud Edge Account Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Multicloud edge account info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.update_edge_account_endpoint.call_with_http_info(**kwargs) + + def update_edge_connectivity( + self, + **kwargs + ): + """update_edge_connectivity # noqa: E501 + + Update Interconnect connectivity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_edge_connectivity(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Edge connectivity. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_edge_connectivity_endpoint.call_with_http_info(**kwargs) + + def update_edge_global_settings( + self, + **kwargs + ): + """update_edge_global_settings # noqa: E501 + + Update edge global settings for Edge provider # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_edge_global_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_edge_global_settings_endpoint.call_with_http_info(**kwargs) + + def update_edge_locations_info( + self, + account_id, + edge_type="MEGAPORT", + **kwargs + ): + """update_edge_locations_info # noqa: E501 + + Update Edge Locations # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_edge_locations_info(account_id, edge_type="MEGAPORT", async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Edge Account Id + edge_type (str): Edge Type. defaults to "MEGAPORT", must be one of ["MEGAPORT"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_type'] = \ + edge_type + kwargs['account_id'] = \ + account_id + return self.update_edge_locations_info_endpoint.call_with_http_info(**kwargs) + + def update_global_settings( + self, + **kwargs + ): + """update_global_settings # noqa: E501 + + Update ip in resource pool # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_global_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_global_settings_endpoint.call_with_http_info(**kwargs) + + def update_icgw( + self, + edge_gateway_name, + **kwargs + ): + """update_icgw # noqa: E501 + + Update Interconnect Gateway # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_icgw(edge_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + edge_gateway_name (str): Edge gateway name + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['edge_gateway_name'] = \ + edge_gateway_name + return self.update_icgw_endpoint.call_with_http_info(**kwargs) + + def update_nva_security_rules( + self, + cloud_gateway_name, + **kwargs + ): + """update_nva_security_rules # noqa: E501 + + Update NVA Security Rules # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_nva_security_rules(cloud_gateway_name, async_req=True) + >>> result = thread.get() + + Args: + cloud_gateway_name (str): Cloud gateway name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update NVA security Rules. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['cloud_gateway_name'] = \ + cloud_gateway_name + return self.update_nva_security_rules_endpoint.call_with_http_info(**kwargs) + + def validate_account_add( + self, + **kwargs + ): + """validate_account_add # noqa: E501 + + Authenticate cloud account credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_account_add(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Multicloud account info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.validate_account_add_endpoint.call_with_http_info(**kwargs) + + def validate_account_update_credentials( + self, + account_id, + **kwargs + ): + """validate_account_update_credentials # noqa: E501 + + Update multicloud account credential # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_account_update_credentials(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Multicloud account info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.validate_account_update_credentials_endpoint.call_with_http_info(**kwargs) + + def validate_edge_account_add( + self, + **kwargs + ): + """validate_edge_account_add # noqa: E501 + + Authenticate edge account credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_edge_account_add(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Multicloud edge account info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.validate_edge_account_add_endpoint.call_with_http_info(**kwargs) + + def validate_edge_account_update_credentials( + self, + account_id, + **kwargs + ): + """validate_edge_account_update_credentials # noqa: E501 + + Update Multicloud edge account credential # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_edge_account_update_credentials(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Multicloud Edge Account Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Multicloud edge account info. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.validate_edge_account_update_credentials_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_multidomain_policy_api.py b/openapi_client/api/configuration_multidomain_policy_api.py new file mode 100644 index 0000000..208b495 --- /dev/null +++ b/openapi_client/api/configuration_multidomain_policy_api.py @@ -0,0 +1,1897 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationMultidomainPolicyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_internal_policy_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/policies/mdpconfig', + 'operation_id': 'add_internal_policy', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.attach_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/attachDevices/{nmsId}', + 'operation_id': 'attach_devices', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + 'body', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.detach_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/detachDevices/{nmsId}', + 'operation_id': 'detach_devices', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + 'body', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.disconnect_from_mdp_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/mdp/disconnect/{nmsId}', + 'operation_id': 'disconnect_from_mdp', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_attached_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/attachDevices/{nmsId}', + 'operation_id': 'edit_attached_devices', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + 'body', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_mdp_onboarding_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/mdp/onboard/status', + 'operation_id': 'get_mdp_onboarding_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.offboard_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/mdp/onboard/{nmsId}', + 'operation_id': 'offboard', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.onboard_mdp_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/onboard', + 'operation_id': 'onboard_mdp', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.retrieve_mdp_attached_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/mdp/attachDevices/{nmsId}', + 'operation_id': 'retrieve_mdp_attached_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.retrieve_mdp_config_object_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/mdp/policies/mdpconfig/{deviceId}', + 'operation_id': 'retrieve_mdp_config_object', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.retrieve_mdp_policies_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/mdp/policies/{nmsId}', + 'operation_id': 'retrieve_mdp_policies', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.retrieve_mdp_supported_devices__endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/mdp/devices/{nmsId}', + 'operation_id': 'retrieve_mdp_supported_devices_', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_onboarding_payload_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/onboard/{nmsId}', + 'operation_id': 'update_onboarding_payload', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + 'body', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_policy_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/mdp/policies/{nmsId}', + 'operation_id': 'update_policy_status', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + 'body', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def add_internal_policy( + self, + **kwargs + ): + """add_internal_policy # noqa: E501 + + Add internal policy from vmanage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_internal_policy(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): addInternalPolicy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_internal_policy_endpoint.call_with_http_info(**kwargs) + + def attach_devices( + self, + nms_id, + **kwargs + ): + """attach_devices # noqa: E501 + + Share devices with MDP # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.attach_devices(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): deviceList. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.attach_devices_endpoint.call_with_http_info(**kwargs) + + def detach_devices( + self, + nms_id, + **kwargs + ): + """detach_devices # noqa: E501 + + Disconnect devices from mpd controller # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detach_devices(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): deviceList. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.detach_devices_endpoint.call_with_http_info(**kwargs) + + def disconnect_from_mdp( + self, + nms_id, + **kwargs + ): + """disconnect_from_mdp # noqa: E501 + + disconnect from mpd controller # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disconnect_from_mdp(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.disconnect_from_mdp_endpoint.call_with_http_info(**kwargs) + + def edit_attached_devices( + self, + nms_id, + **kwargs + ): + """edit_attached_devices # noqa: E501 + + Edit attached devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_attached_devices(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): deviceList. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.edit_attached_devices_endpoint.call_with_http_info(**kwargs) + + def get_mdp_onboarding_status( + self, + **kwargs + ): + """get_mdp_onboarding_status # noqa: E501 + + Get MDP onboarding status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mdp_onboarding_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_mdp_onboarding_status_endpoint.call_with_http_info(**kwargs) + + def offboard( + self, + nms_id, + **kwargs + ): + """offboard # noqa: E501 + + offboard the mdp application # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.offboard(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.offboard_endpoint.call_with_http_info(**kwargs) + + def onboard_mdp( + self, + **kwargs + ): + """onboard_mdp # noqa: E501 + + Start MDP onboarding operation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.onboard_mdp(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Onboard. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.onboard_mdp_endpoint.call_with_http_info(**kwargs) + + def retrieve_mdp_attached_devices( + self, + nms_id, + **kwargs + ): + """retrieve_mdp_attached_devices # noqa: E501 + + Retrieve MDP attached devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.retrieve_mdp_attached_devices(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.retrieve_mdp_attached_devices_endpoint.call_with_http_info(**kwargs) + + def retrieve_mdp_config_object( + self, + device_id, + **kwargs + ): + """retrieve_mdp_config_object # noqa: E501 + + Retrieve MDP ConfigObject # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.retrieve_mdp_config_object(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.retrieve_mdp_config_object_endpoint.call_with_http_info(**kwargs) + + def retrieve_mdp_policies( + self, + nms_id, + **kwargs + ): + """retrieve_mdp_policies # noqa: E501 + + Retrieve MDP policies # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.retrieve_mdp_policies(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.retrieve_mdp_policies_endpoint.call_with_http_info(**kwargs) + + def retrieve_mdp_supported_devices_( + self, + nms_id, + **kwargs + ): + """retrieve_mdp_supported_devices_ # noqa: E501 + + Retrieve MDP supported devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.retrieve_mdp_supported_devices_(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.retrieve_mdp_supported_devices__endpoint.call_with_http_info(**kwargs) + + def update_onboarding_payload( + self, + nms_id, + **kwargs + ): + """update_onboarding_payload # noqa: E501 + + update MDP onboarding document # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_onboarding_payload(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Onboard. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.update_onboarding_payload_endpoint.call_with_http_info(**kwargs) + + def update_policy_status( + self, + nms_id, + **kwargs + ): + """update_policy_status # noqa: E501 + + update policy status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_policy_status(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): policyList. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.update_policy_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_network_design_api.py b/openapi_client/api/configuration_network_design_api.py new file mode 100644 index 0000000..a46c36c --- /dev/null +++ b/openapi_client/api/configuration_network_design_api.py @@ -0,0 +1,1960 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationNetworkDesignApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.acquire_attach_lock_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/lock/{profileId}', + 'operation_id': 'acquire_attach_lock', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.acquire_edit_lock_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/lock/edit', + 'operation_id': 'acquire_edit_lock', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_network_design_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign', + 'operation_id': 'create_network_design', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_network_design_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign', + 'operation_id': 'edit_network_design', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_profile_config_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/status', + 'operation_id': 'get_device_profile_config_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_profile_config_status_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/status/{profileId}', + 'operation_id': 'get_device_profile_config_status_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_profile_task_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/task/count', + 'operation_id': 'get_device_profile_task_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_profile_task_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/task/status', + 'operation_id': 'get_device_profile_task_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_profile_task_status_by_profile_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/task/status/{profileId}', + 'operation_id': 'get_device_profile_task_status_by_profile_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_global_parameters_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/global/parameters', + 'operation_id': 'get_global_parameters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_network_design_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign', + 'operation_id': 'get_network_design', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_service_profile_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/serviceProfileConfig/{profileId}', + 'operation_id': 'get_service_profile_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'device_model', + ], + 'required': [ + 'profile_id', + 'device_model', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'device_model': + (str,), + }, + 'attribute_map': { + 'profile_id': 'profileId', + 'device_model': 'deviceModel', + }, + 'location_map': { + 'profile_id': 'path', + 'device_model': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.push_device_profile_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/attachment/{profileId}', + 'operation_id': 'push_device_profile_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'profile_id', + 'body', + ], + 'required': [ + 'profile_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'profile_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'profile_id': 'profileId', + }, + 'location_map': { + 'profile_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.push_network_design_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/attachment', + 'operation_id': 'push_network_design', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.run_my_test_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/mytest/{name}', + 'operation_id': 'run_my_test', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'name', + ], + 'required': [ + 'name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'name': + (str,), + }, + 'attribute_map': { + 'name': 'name', + }, + 'location_map': { + 'name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def acquire_attach_lock( + self, + profile_id, + **kwargs + ): + """acquire_attach_lock # noqa: E501 + + Get the service profile config for a given device profile id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.acquire_attach_lock(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Device profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.acquire_attach_lock_endpoint.call_with_http_info(**kwargs) + + def acquire_edit_lock( + self, + **kwargs + ): + """acquire_edit_lock # noqa: E501 + + Acquire edit lock # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.acquire_edit_lock(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.acquire_edit_lock_endpoint.call_with_http_info(**kwargs) + + def create_network_design( + self, + **kwargs + ): + """create_network_design # noqa: E501 + + Create network design # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_network_design(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network design payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_network_design_endpoint.call_with_http_info(**kwargs) + + def edit_network_design( + self, + id, + **kwargs + ): + """edit_network_design # noqa: E501 + + Edit network segment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_network_design(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network design payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_network_design_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_config_status( + self, + **kwargs + ): + """get_device_profile_config_status # noqa: E501 + + Get device profile configuration status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_config_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_profile_config_status_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_config_status_by_profile_id( + self, + profile_id, + **kwargs + ): + """get_device_profile_config_status_by_profile_id # noqa: E501 + + Get device profile configuration status by profile Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_config_status_by_profile_id(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Device profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_device_profile_config_status_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_task_count( + self, + **kwargs + ): + """get_device_profile_task_count # noqa: E501 + + Get device profile configuration task count # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_task_count(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_profile_task_count_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_task_status( + self, + **kwargs + ): + """get_device_profile_task_status # noqa: E501 + + Get device profile configuration task status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_task_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_profile_task_status_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_task_status_by_profile_id( + self, + profile_id, + **kwargs + ): + """get_device_profile_task_status_by_profile_id # noqa: E501 + + Get device profile configuration status by profile Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_task_status_by_profile_id(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Device profile Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.get_device_profile_task_status_by_profile_id_endpoint.call_with_http_info(**kwargs) + + def get_global_parameters( + self, + **kwargs + ): + """get_global_parameters # noqa: E501 + + Get global parameter templates # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_global_parameters(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_global_parameters_endpoint.call_with_http_info(**kwargs) + + def get_network_design( + self, + **kwargs + ): + """get_network_design # noqa: E501 + + Get existing network design # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_design(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_network_design_endpoint.call_with_http_info(**kwargs) + + def get_service_profile_config( + self, + profile_id, + device_model, + **kwargs + ): + """get_service_profile_config # noqa: E501 + + Get the service profile config for a given device profile id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_service_profile_config(profile_id, device_model, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Device profile Id + device_model (str): Device model + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + kwargs['device_model'] = \ + device_model + return self.get_service_profile_config_endpoint.call_with_http_info(**kwargs) + + def push_device_profile_template( + self, + profile_id, + **kwargs + ): + """push_device_profile_template # noqa: E501 + + Attach to device profile # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_device_profile_template(profile_id, async_req=True) + >>> result = thread.get() + + Args: + profile_id (str): Device profile Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['profile_id'] = \ + profile_id + return self.push_device_profile_template_endpoint.call_with_http_info(**kwargs) + + def push_network_design( + self, + **kwargs + ): + """push_network_design # noqa: E501 + + Attach network design # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_network_design(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.push_network_design_endpoint.call_with_http_info(**kwargs) + + def run_my_test( + self, + name, + **kwargs + ): + """run_my_test # noqa: E501 + + Get all device templates for this feature template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.run_my_test(name, async_req=True) + >>> result = thread.get() + + Args: + name (str): Test bane + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['name'] = \ + name + return self.run_my_test_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_network_design_templates_api.py b/openapi_client/api/configuration_network_design_templates_api.py new file mode 100644 index 0000000..5582bda --- /dev/null +++ b/openapi_client/api/configuration_network_design_templates_api.py @@ -0,0 +1,816 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationNetworkDesignTemplatesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.edit_device_profile_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/networkdesign/profile/template/{templateId}', + 'operation_id': 'edit_device_profile_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'body', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_global_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/networkdesign/global/template/{templateId}', + 'operation_id': 'edit_global_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'body', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_profile_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/template', + 'operation_id': 'generate_profile_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_profile_feature_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/feature', + 'operation_id': 'get_device_profile_feature_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_profile_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/profile/template/{templateId}', + 'operation_id': 'get_device_profile_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_global_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/networkdesign/global/template/{templateId}', + 'operation_id': 'get_global_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def edit_device_profile_template( + self, + template_id, + **kwargs + ): + """edit_device_profile_template # noqa: E501 + + Edit device profile template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_device_profile_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.edit_device_profile_template_endpoint.call_with_http_info(**kwargs) + + def edit_global_template( + self, + template_id, + **kwargs + ): + """edit_global_template # noqa: E501 + + Edit global template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_global_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Global template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.edit_global_template_endpoint.call_with_http_info(**kwargs) + + def generate_profile_template_list( + self, + **kwargs + ): + """generate_profile_template_list # noqa: E501 + + Generate profile template list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_profile_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_profile_template_list_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_feature_template_list( + self, + **kwargs + ): + """get_device_profile_feature_template_list # noqa: E501 + + Generate device profile template list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_feature_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_profile_feature_template_list_endpoint.call_with_http_info(**kwargs) + + def get_device_profile_template( + self, + template_id, + **kwargs + ): + """get_device_profile_template # noqa: E501 + + Get device profile template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_profile_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_device_profile_template_endpoint.call_with_http_info(**kwargs) + + def get_global_template( + self, + template_id, + **kwargs + ): + """get_global_template # noqa: E501 + + Get global template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_global_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_global_template_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_access_list_definition_builder_api.py b/openapi_client/api/configuration_policy_access_list_definition_builder_api.py new file mode 100644 index 0000000..be18902 --- /dev/null +++ b/openapi_client/api/configuration_policy_access_list_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyAccessListDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl', + 'operation_id': 'create_policy_definition8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition8_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/{id}', + 'operation_id': 'delete_policy_definition8', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition8', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/{id}', + 'operation_id': 'edit_policy_definition8', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl', + 'operation_id': 'get_definitions8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/{id}', + 'operation_id': 'get_policy_definition8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/preview', + 'operation_id': 'preview_policy_definition8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/acl/bulk', + 'operation_id': 'save_policy_definition_in_bulk8', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition8( + self, + **kwargs + ): + """create_policy_definition8 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition8_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition8( + self, + id, + **kwargs + ): + """delete_policy_definition8 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition8_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition8( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition8 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition8_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition8( + self, + id, + **kwargs + ): + """edit_policy_definition8 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition8_endpoint.call_with_http_info(**kwargs) + + def get_definitions8( + self, + **kwargs + ): + """get_definitions8 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions8_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition8( + self, + id, + **kwargs + ): + """get_policy_definition8 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition8_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition8( + self, + **kwargs + ): + """preview_policy_definition8 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition8_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id8( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id8 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id8_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk8( + self, + **kwargs + ): + """save_policy_definition_in_bulk8 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk8_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_amp_definition_builder_api.py b/openapi_client/api/configuration_policy_amp_definition_builder_api.py new file mode 100644 index 0000000..c5aed0d --- /dev/null +++ b/openapi_client/api/configuration_policy_amp_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyAMPDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection', + 'operation_id': 'create_policy_definition11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition11_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/{id}', + 'operation_id': 'delete_policy_definition11', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition11', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/{id}', + 'operation_id': 'edit_policy_definition11', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection', + 'operation_id': 'get_definitions11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/{id}', + 'operation_id': 'get_policy_definition11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/preview', + 'operation_id': 'preview_policy_definition11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/advancedMalwareProtection/bulk', + 'operation_id': 'save_policy_definition_in_bulk11', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition11( + self, + **kwargs + ): + """create_policy_definition11 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition11_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition11( + self, + id, + **kwargs + ): + """delete_policy_definition11 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition11_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition11( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition11 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition11_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition11( + self, + id, + **kwargs + ): + """edit_policy_definition11 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition11_endpoint.call_with_http_info(**kwargs) + + def get_definitions11( + self, + **kwargs + ): + """get_definitions11 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions11_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition11( + self, + id, + **kwargs + ): + """get_policy_definition11 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition11_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition11( + self, + **kwargs + ): + """preview_policy_definition11 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition11_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id11( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id11 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id11_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk11( + self, + **kwargs + ): + """save_policy_definition_in_bulk11 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk11_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_app_probe_class_list_builder_api.py b/openapi_client/api/configuration_policy_app_probe_class_list_builder_api.py new file mode 100644 index 0000000..0e63958 --- /dev/null +++ b/openapi_client/api/configuration_policy_app_probe_class_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyAppProbeClassListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe', + 'operation_id': 'create_policy_list4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list4_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe/{id}', + 'operation_id': 'delete_policy_list4', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag4_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe', + 'operation_id': 'delete_policy_lists_with_info_tag4', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe/{id}', + 'operation_id': 'edit_policy_list4', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe/{id}', + 'operation_id': 'get_lists_by_id4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists4_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe', + 'operation_id': 'get_policy_lists4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag4_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe/filtered', + 'operation_id': 'get_policy_lists_with_info_tag4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe/preview', + 'operation_id': 'preview_policy_list4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/appprobe/preview/{id}', + 'operation_id': 'preview_policy_list_by_id4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list4( + self, + **kwargs + ): + """create_policy_list4 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list4_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list4( + self, + id, + **kwargs + ): + """delete_policy_list4 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list4_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag4( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag4 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag4_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list4( + self, + id, + **kwargs + ): + """edit_policy_list4 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list4_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id4( + self, + id, + **kwargs + ): + """get_lists_by_id4 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id4_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists4( + self, + **kwargs + ): + """get_policy_lists4 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists4_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag4( + self, + **kwargs + ): + """get_policy_lists_with_info_tag4 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag4_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list4( + self, + **kwargs + ): + """preview_policy_list4 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list4_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id4( + self, + id, + **kwargs + ): + """preview_policy_list_by_id4 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id4_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_app_route_definition_builder_api.py b/openapi_client/api/configuration_policy_app_route_definition_builder_api.py new file mode 100644 index 0000000..113608b --- /dev/null +++ b/openapi_client/api/configuration_policy_app_route_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyAppRouteDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute', + 'operation_id': 'create_policy_definition12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition12_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/{id}', + 'operation_id': 'delete_policy_definition12', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition12', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/{id}', + 'operation_id': 'edit_policy_definition12', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute', + 'operation_id': 'get_definitions12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/{id}', + 'operation_id': 'get_policy_definition12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/preview', + 'operation_id': 'preview_policy_definition12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/approute/bulk', + 'operation_id': 'save_policy_definition_in_bulk12', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition12( + self, + **kwargs + ): + """create_policy_definition12 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition12_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition12( + self, + id, + **kwargs + ): + """delete_policy_definition12 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition12_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition12( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition12 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition12_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition12( + self, + id, + **kwargs + ): + """edit_policy_definition12 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition12_endpoint.call_with_http_info(**kwargs) + + def get_definitions12( + self, + **kwargs + ): + """get_definitions12 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions12_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition12( + self, + id, + **kwargs + ): + """get_policy_definition12 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition12_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition12( + self, + **kwargs + ): + """preview_policy_definition12 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition12_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id12( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id12 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id12_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk12( + self, + **kwargs + ): + """save_policy_definition_in_bulk12 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk12_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_application_list_builder_api.py b/openapi_client/api/configuration_policy_application_list_builder_api.py new file mode 100644 index 0000000..0cc8f59 --- /dev/null +++ b/openapi_client/api/configuration_policy_application_list_builder_api.py @@ -0,0 +1,2356 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyApplicationListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp', + 'operation_id': 'create_policy_list22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_policy_list3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/app', + 'operation_id': 'create_policy_list3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list22_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp/{id}', + 'operation_id': 'delete_policy_list22', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_list3_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/app/{id}', + 'operation_id': 'delete_policy_list3', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag22_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp', + 'operation_id': 'delete_policy_lists_with_info_tag22', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag3_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/app', + 'operation_id': 'delete_policy_lists_with_info_tag3', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp/{id}', + 'operation_id': 'edit_policy_list22', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_list3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/app/{id}', + 'operation_id': 'edit_policy_list3', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp/{id}', + 'operation_id': 'get_lists_by_id22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lists_by_id3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/app/{id}', + 'operation_id': 'get_lists_by_id3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists19_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp', + 'operation_id': 'get_policy_lists19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists3_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/app', + 'operation_id': 'get_policy_lists3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag22_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp/filtered', + 'operation_id': 'get_policy_lists_with_info_tag22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag3_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/app/filtered', + 'operation_id': 'get_policy_lists_with_info_tag3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp/preview', + 'operation_id': 'preview_policy_list22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/app/preview', + 'operation_id': 'preview_policy_list3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localapp/preview/{id}', + 'operation_id': 'preview_policy_list_by_id22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list_by_id3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/app/preview/{id}', + 'operation_id': 'preview_policy_list_by_id3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list22( + self, + **kwargs + ): + """create_policy_list22 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list22_endpoint.call_with_http_info(**kwargs) + + def create_policy_list3( + self, + **kwargs + ): + """create_policy_list3 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list3_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list22( + self, + id, + **kwargs + ): + """delete_policy_list22 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list22_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list3( + self, + id, + **kwargs + ): + """delete_policy_list3 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list3_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag22( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag22 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag22_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag3( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag3 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag3_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list22( + self, + id, + **kwargs + ): + """edit_policy_list22 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list22_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list3( + self, + id, + **kwargs + ): + """edit_policy_list3 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list3_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id22( + self, + id, + **kwargs + ): + """get_lists_by_id22 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id22_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id3( + self, + id, + **kwargs + ): + """get_lists_by_id3 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id3_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists19( + self, + **kwargs + ): + """get_policy_lists19 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists19_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists3( + self, + **kwargs + ): + """get_policy_lists3 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists3_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag22( + self, + **kwargs + ): + """get_policy_lists_with_info_tag22 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag22_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag3( + self, + **kwargs + ): + """get_policy_lists_with_info_tag3 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag3_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list22( + self, + **kwargs + ): + """preview_policy_list22 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list22_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list3( + self, + **kwargs + ): + """preview_policy_list3 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list3_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id22( + self, + id, + **kwargs + ): + """preview_policy_list_by_id22 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id22_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id3( + self, + id, + **kwargs + ): + """preview_policy_list_by_id3 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id3_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_as_path_list_builder_api.py b/openapi_client/api/configuration_policy_as_path_list_builder_api.py new file mode 100644 index 0000000..8f178a8 --- /dev/null +++ b/openapi_client/api/configuration_policy_as_path_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyASPathListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath', + 'operation_id': 'create_policy_list5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list5_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath/{id}', + 'operation_id': 'delete_policy_list5', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag5_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath', + 'operation_id': 'delete_policy_lists_with_info_tag5', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath/{id}', + 'operation_id': 'edit_policy_list5', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath/{id}', + 'operation_id': 'get_lists_by_id5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists5_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath', + 'operation_id': 'get_policy_lists5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag5_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath/filtered', + 'operation_id': 'get_policy_lists_with_info_tag5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath/preview', + 'operation_id': 'preview_policy_list5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/aspath/preview/{id}', + 'operation_id': 'preview_policy_list_by_id5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list5( + self, + **kwargs + ): + """create_policy_list5 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list5_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list5( + self, + id, + **kwargs + ): + """delete_policy_list5 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list5_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag5( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag5 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag5_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list5( + self, + id, + **kwargs + ): + """edit_policy_list5 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list5_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id5( + self, + id, + **kwargs + ): + """get_lists_by_id5 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id5_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists5( + self, + **kwargs + ): + """get_policy_lists5 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists5_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag5( + self, + **kwargs + ): + """get_policy_lists_with_info_tag5 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag5_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list5( + self, + **kwargs + ): + """preview_policy_list5 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list5_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id5( + self, + id, + **kwargs + ): + """preview_policy_list_by_id5 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id5_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_cflowd_definition_builder_api.py b/openapi_client/api/configuration_policy_cflowd_definition_builder_api.py new file mode 100644 index 0000000..130e7ae --- /dev/null +++ b/openapi_client/api/configuration_policy_cflowd_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyCflowdDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd', + 'operation_id': 'create_policy_definition13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition13_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/{id}', + 'operation_id': 'delete_policy_definition13', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition13', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/{id}', + 'operation_id': 'edit_policy_definition13', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd', + 'operation_id': 'get_definitions13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/{id}', + 'operation_id': 'get_policy_definition13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/preview', + 'operation_id': 'preview_policy_definition13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/cflowd/bulk', + 'operation_id': 'save_policy_definition_in_bulk13', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition13( + self, + **kwargs + ): + """create_policy_definition13 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition13_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition13( + self, + id, + **kwargs + ): + """delete_policy_definition13 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition13_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition13( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition13 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition13_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition13( + self, + id, + **kwargs + ): + """edit_policy_definition13 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition13_endpoint.call_with_http_info(**kwargs) + + def get_definitions13( + self, + **kwargs + ): + """get_definitions13 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions13_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition13( + self, + id, + **kwargs + ): + """get_policy_definition13 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition13_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition13( + self, + **kwargs + ): + """preview_policy_definition13 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition13_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id13( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id13 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id13_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk13( + self, + **kwargs + ): + """save_policy_definition_in_bulk13 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk13_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_cloud_application_builder_api.py b/openapi_client/api/configuration_policy_cloud_application_builder_api.py new file mode 100644 index 0000000..b95aad6 --- /dev/null +++ b/openapi_client/api/configuration_policy_cloud_application_builder_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyCloudApplicationBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_cloud_discovered_apps_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/clouddiscoveredapp', + 'operation_id': 'get_cloud_discovered_apps', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_cloud_discovered_apps( + self, + **kwargs + ): + """get_cloud_discovered_apps # noqa: E501 + + Get all cloud discovered applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_discovered_apps(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_discovered_apps_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_color_list_builder_api.py b/openapi_client/api/configuration_policy_color_list_builder_api.py new file mode 100644 index 0000000..881483c --- /dev/null +++ b/openapi_client/api/configuration_policy_color_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyColorListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/color', + 'operation_id': 'create_policy_list6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list6_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/color/{id}', + 'operation_id': 'delete_policy_list6', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag6_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/color', + 'operation_id': 'delete_policy_lists_with_info_tag6', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/color/{id}', + 'operation_id': 'edit_policy_list6', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/color/{id}', + 'operation_id': 'get_lists_by_id6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists6_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/color', + 'operation_id': 'get_policy_lists6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag6_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/color/filtered', + 'operation_id': 'get_policy_lists_with_info_tag6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/color/preview', + 'operation_id': 'preview_policy_list6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/color/preview/{id}', + 'operation_id': 'preview_policy_list_by_id6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list6( + self, + **kwargs + ): + """create_policy_list6 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list6_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list6( + self, + id, + **kwargs + ): + """delete_policy_list6 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list6_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag6( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag6 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag6_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list6( + self, + id, + **kwargs + ): + """edit_policy_list6 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list6_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id6( + self, + id, + **kwargs + ): + """get_lists_by_id6 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id6_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists6( + self, + **kwargs + ): + """get_policy_lists6 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists6_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag6( + self, + **kwargs + ): + """get_policy_lists_with_info_tag6 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag6_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list6( + self, + **kwargs + ): + """preview_policy_list6 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list6_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id6( + self, + id, + **kwargs + ): + """preview_policy_list_by_id6 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id6_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_community_list_builder_api.py b/openapi_client/api/configuration_policy_community_list_builder_api.py new file mode 100644 index 0000000..b601507 --- /dev/null +++ b/openapi_client/api/configuration_policy_community_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyCommunityListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/community', + 'operation_id': 'create_policy_list7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list7_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/community/{id}', + 'operation_id': 'delete_policy_list7', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag7_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/community', + 'operation_id': 'delete_policy_lists_with_info_tag7', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/community/{id}', + 'operation_id': 'edit_policy_list7', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/community/{id}', + 'operation_id': 'get_lists_by_id7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists7_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/community', + 'operation_id': 'get_policy_lists7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag7_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/community/filtered', + 'operation_id': 'get_policy_lists_with_info_tag7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/community/preview', + 'operation_id': 'preview_policy_list7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/community/preview/{id}', + 'operation_id': 'preview_policy_list_by_id7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list7( + self, + **kwargs + ): + """create_policy_list7 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list7_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list7( + self, + id, + **kwargs + ): + """delete_policy_list7 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list7_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag7( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag7 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag7_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list7( + self, + id, + **kwargs + ): + """edit_policy_list7 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list7_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id7( + self, + id, + **kwargs + ): + """get_lists_by_id7 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id7_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists7( + self, + **kwargs + ): + """get_policy_lists7 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists7_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag7( + self, + **kwargs + ): + """get_policy_lists_with_info_tag7 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag7_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list7( + self, + **kwargs + ): + """preview_policy_list7 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list7_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id7( + self, + id, + **kwargs + ): + """preview_policy_list_by_id7 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id7_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_control_definition_builder_api.py b/openapi_client/api/configuration_policy_control_definition_builder_api.py new file mode 100644 index 0000000..1e240bc --- /dev/null +++ b/openapi_client/api/configuration_policy_control_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyControlDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control', + 'operation_id': 'create_policy_definition14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition14_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/{id}', + 'operation_id': 'delete_policy_definition14', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition14', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/{id}', + 'operation_id': 'edit_policy_definition14', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control', + 'operation_id': 'get_definitions14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/{id}', + 'operation_id': 'get_policy_definition14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/preview', + 'operation_id': 'preview_policy_definition14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/control/bulk', + 'operation_id': 'save_policy_definition_in_bulk14', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition14( + self, + **kwargs + ): + """create_policy_definition14 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition14_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition14( + self, + id, + **kwargs + ): + """delete_policy_definition14 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition14_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition14( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition14 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition14_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition14( + self, + id, + **kwargs + ): + """edit_policy_definition14 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition14_endpoint.call_with_http_info(**kwargs) + + def get_definitions14( + self, + **kwargs + ): + """get_definitions14 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions14_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition14( + self, + id, + **kwargs + ): + """get_policy_definition14 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition14_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition14( + self, + **kwargs + ): + """preview_policy_definition14 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition14_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id14( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id14 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id14_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk14( + self, + **kwargs + ): + """save_policy_definition_in_bulk14 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk14_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_custom_application_builder_api.py b/openapi_client/api/configuration_policy_custom_application_builder_api.py new file mode 100644 index 0000000..83dbd43 --- /dev/null +++ b/openapi_client/api/configuration_policy_custom_application_builder_api.py @@ -0,0 +1,811 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyCustomApplicationBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_custom_app_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/customapp', + 'operation_id': 'create_custom_app', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_custom_app_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/customapp/{id}', + 'operation_id': 'delete_custom_app', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_custom_app_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/customapp/{id}', + 'operation_id': 'edit_custom_app', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_custom_app_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/customapp/{id}', + 'operation_id': 'get_custom_app_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_custom_apps_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/customapp', + 'operation_id': 'get_custom_apps', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.map_traffic_profiles_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/clouddiscoveredapp', + 'operation_id': 'map_traffic_profiles', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_custom_app( + self, + **kwargs + ): + """create_custom_app # noqa: E501 + + Create a policy custom applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_custom_app(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): App payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_custom_app_endpoint.call_with_http_info(**kwargs) + + def delete_custom_app( + self, + id, + **kwargs + ): + """delete_custom_app # noqa: E501 + + Delete a policy custom applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_custom_app(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_custom_app_endpoint.call_with_http_info(**kwargs) + + def edit_custom_app( + self, + id, + **kwargs + ): + """edit_custom_app # noqa: E501 + + Edit a policy custom applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_custom_app(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): App payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_custom_app_endpoint.call_with_http_info(**kwargs) + + def get_custom_app_by_id( + self, + id, + **kwargs + ): + """get_custom_app_by_id # noqa: E501 + + Get a policy custom applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_custom_app_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_custom_app_by_id_endpoint.call_with_http_info(**kwargs) + + def get_custom_apps( + self, + **kwargs + ): + """get_custom_apps # noqa: E501 + + Get all policy custom applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_custom_apps(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_custom_apps_endpoint.call_with_http_info(**kwargs) + + def map_traffic_profiles( + self, + **kwargs + ): + """map_traffic_profiles # noqa: E501 + + Set SLA class for policy cloud discovered applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.map_traffic_profiles(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): App payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.map_traffic_profiles_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_data_definition_builder_api.py b/openapi_client/api/configuration_policy_data_definition_builder_api.py new file mode 100644 index 0000000..d294dad --- /dev/null +++ b/openapi_client/api/configuration_policy_data_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDataDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data', + 'operation_id': 'create_policy_definition15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition15_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/{id}', + 'operation_id': 'delete_policy_definition15', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition15', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/{id}', + 'operation_id': 'edit_policy_definition15', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data', + 'operation_id': 'get_definitions15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/{id}', + 'operation_id': 'get_policy_definition15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/preview', + 'operation_id': 'preview_policy_definition15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/data/bulk', + 'operation_id': 'save_policy_definition_in_bulk15', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition15( + self, + **kwargs + ): + """create_policy_definition15 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition15_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition15( + self, + id, + **kwargs + ): + """delete_policy_definition15 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition15_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition15( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition15 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition15_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition15( + self, + id, + **kwargs + ): + """edit_policy_definition15 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition15_endpoint.call_with_http_info(**kwargs) + + def get_definitions15( + self, + **kwargs + ): + """get_definitions15 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions15_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition15( + self, + id, + **kwargs + ): + """get_policy_definition15 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition15_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition15( + self, + **kwargs + ): + """preview_policy_definition15 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition15_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id15( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id15 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id15_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk15( + self, + **kwargs + ): + """save_policy_definition_in_bulk15 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk15_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_data_ipv6_prefix_list_builder_api.py b/openapi_client/api/configuration_policy_data_ipv6_prefix_list_builder_api.py new file mode 100644 index 0000000..a603cb7 --- /dev/null +++ b/openapi_client/api/configuration_policy_data_ipv6_prefix_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDataIPV6PrefixListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix', + 'operation_id': 'create_policy_list8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list8_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix/{id}', + 'operation_id': 'delete_policy_list8', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag8_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix', + 'operation_id': 'delete_policy_lists_with_info_tag8', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix/{id}', + 'operation_id': 'edit_policy_list8', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix/{id}', + 'operation_id': 'get_lists_by_id8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists8_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix', + 'operation_id': 'get_policy_lists8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag8_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix/filtered', + 'operation_id': 'get_policy_lists_with_info_tag8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix/preview', + 'operation_id': 'preview_policy_list8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataipv6prefix/preview/{id}', + 'operation_id': 'preview_policy_list_by_id8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list8( + self, + **kwargs + ): + """create_policy_list8 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list8_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list8( + self, + id, + **kwargs + ): + """delete_policy_list8 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list8_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag8( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag8 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag8_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list8( + self, + id, + **kwargs + ): + """edit_policy_list8 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list8_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id8( + self, + id, + **kwargs + ): + """get_lists_by_id8 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id8_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists8( + self, + **kwargs + ): + """get_policy_lists8 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists8_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag8( + self, + **kwargs + ): + """get_policy_lists_with_info_tag8 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag8_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list8( + self, + **kwargs + ): + """preview_policy_list8 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list8_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id8( + self, + id, + **kwargs + ): + """preview_policy_list_by_id8 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id8(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id8_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_data_prefix_all_types_of_lists_builder_api.py b/openapi_client/api/configuration_policy_data_prefix_all_types_of_lists_builder_api.py new file mode 100644 index 0000000..7bff960 --- /dev/null +++ b/openapi_client/api/configuration_policy_data_prefix_all_types_of_lists_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall', + 'operation_id': 'create_policy_list9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list9_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall/{id}', + 'operation_id': 'delete_policy_list9', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag9_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall', + 'operation_id': 'delete_policy_lists_with_info_tag9', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall/{id}', + 'operation_id': 'edit_policy_list9', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall/{id}', + 'operation_id': 'get_lists_by_id9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lists_for_all_data_prefixes_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall', + 'operation_id': 'get_lists_for_all_data_prefixes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag9_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall/filtered', + 'operation_id': 'get_policy_lists_with_info_tag9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall/preview', + 'operation_id': 'preview_policy_list9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixall/preview/{id}', + 'operation_id': 'preview_policy_list_by_id9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list9( + self, + **kwargs + ): + """create_policy_list9 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list9_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list9( + self, + id, + **kwargs + ): + """delete_policy_list9 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list9_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag9( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag9 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag9_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list9( + self, + id, + **kwargs + ): + """edit_policy_list9 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list9_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id9( + self, + id, + **kwargs + ): + """get_lists_by_id9 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id9_endpoint.call_with_http_info(**kwargs) + + def get_lists_for_all_data_prefixes( + self, + **kwargs + ): + """get_lists_for_all_data_prefixes # noqa: E501 + + Get policy lists for all data prefixes # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_for_all_data_prefixes(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_lists_for_all_data_prefixes_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag9( + self, + **kwargs + ): + """get_policy_lists_with_info_tag9 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag9_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list9( + self, + **kwargs + ): + """preview_policy_list9 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list9_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id9( + self, + id, + **kwargs + ): + """preview_policy_list_by_id9 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id9_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py b/openapi_client/api/configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py new file mode 100644 index 0000000..3130e18 --- /dev/null +++ b/openapi_client/api/configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn', + 'operation_id': 'create_policy_list15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list15_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn/{id}', + 'operation_id': 'delete_policy_list15', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag15_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn', + 'operation_id': 'delete_policy_lists_with_info_tag15', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn/{id}', + 'operation_id': 'edit_policy_list15', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_all_data_prefix_and_fqdn_lists_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn', + 'operation_id': 'get_all_data_prefix_and_fqdn_lists', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lists_by_id15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn/{id}', + 'operation_id': 'get_lists_by_id15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag15_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn/filtered', + 'operation_id': 'get_policy_lists_with_info_tag15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn/preview', + 'operation_id': 'preview_policy_list15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefixfqdn/preview/{id}', + 'operation_id': 'preview_policy_list_by_id15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list15( + self, + **kwargs + ): + """create_policy_list15 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list15_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list15( + self, + id, + **kwargs + ): + """delete_policy_list15 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list15_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag15( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag15 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag15_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list15( + self, + id, + **kwargs + ): + """edit_policy_list15 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list15_endpoint.call_with_http_info(**kwargs) + + def get_all_data_prefix_and_fqdn_lists( + self, + **kwargs + ): + """get_all_data_prefix_and_fqdn_lists # noqa: E501 + + Get lists for all all data-prefix(IPv4) and Fqdn lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_data_prefix_and_fqdn_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_data_prefix_and_fqdn_lists_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id15( + self, + id, + **kwargs + ): + """get_lists_by_id15 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id15_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag15( + self, + **kwargs + ): + """get_policy_lists_with_info_tag15 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag15_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list15( + self, + **kwargs + ): + """preview_policy_list15 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list15_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id15( + self, + id, + **kwargs + ): + """preview_policy_list_by_id15 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id15(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id15_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_data_prefix_list_builder_api.py b/openapi_client/api/configuration_policy_data_prefix_list_builder_api.py new file mode 100644 index 0000000..7a17d58 --- /dev/null +++ b/openapi_client/api/configuration_policy_data_prefix_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDataPrefixListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix', + 'operation_id': 'create_policy_list10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list10_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix/{id}', + 'operation_id': 'delete_policy_list10', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag10_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix', + 'operation_id': 'delete_policy_lists_with_info_tag10', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix/{id}', + 'operation_id': 'edit_policy_list10', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix/{id}', + 'operation_id': 'get_lists_by_id10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists9_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix', + 'operation_id': 'get_policy_lists9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag10_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix/filtered', + 'operation_id': 'get_policy_lists_with_info_tag10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix/preview', + 'operation_id': 'preview_policy_list10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/dataprefix/preview/{id}', + 'operation_id': 'preview_policy_list_by_id10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list10( + self, + **kwargs + ): + """create_policy_list10 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list10_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list10( + self, + id, + **kwargs + ): + """delete_policy_list10 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list10_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag10( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag10 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag10_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list10( + self, + id, + **kwargs + ): + """edit_policy_list10 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list10_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id10( + self, + id, + **kwargs + ): + """get_lists_by_id10 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id10_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists9( + self, + **kwargs + ): + """get_policy_lists9 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists9_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag10( + self, + **kwargs + ): + """get_policy_lists_with_info_tag10 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag10_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list10( + self, + **kwargs + ): + """preview_policy_list10 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list10_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id10( + self, + id, + **kwargs + ): + """preview_policy_list_by_id10 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id10(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id10_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_device_access_definition_builder_api.py b/openapi_client/api/configuration_policy_device_access_definition_builder_api.py new file mode 100644 index 0000000..e08a49c --- /dev/null +++ b/openapi_client/api/configuration_policy_device_access_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDeviceAccessDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy', + 'operation_id': 'create_policy_definition16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition16_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/{id}', + 'operation_id': 'delete_policy_definition16', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition16', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/{id}', + 'operation_id': 'edit_policy_definition16', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy', + 'operation_id': 'get_definitions16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/{id}', + 'operation_id': 'get_policy_definition16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/preview', + 'operation_id': 'preview_policy_definition16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicy/bulk', + 'operation_id': 'save_policy_definition_in_bulk16', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition16( + self, + **kwargs + ): + """create_policy_definition16 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition16_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition16( + self, + id, + **kwargs + ): + """delete_policy_definition16 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition16_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition16( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition16 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition16_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition16( + self, + id, + **kwargs + ): + """edit_policy_definition16 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition16_endpoint.call_with_http_info(**kwargs) + + def get_definitions16( + self, + **kwargs + ): + """get_definitions16 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions16_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition16( + self, + id, + **kwargs + ): + """get_policy_definition16 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition16_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition16( + self, + **kwargs + ): + """preview_policy_definition16 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition16_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id16( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id16 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id16(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id16_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk16( + self, + **kwargs + ): + """save_policy_definition_in_bulk16 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk16_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_dial_peer_definition_builder_api.py b/openapi_client/api/configuration_policy_dial_peer_definition_builder_api.py new file mode 100644 index 0000000..9add3a8 --- /dev/null +++ b/openapi_client/api/configuration_policy_dial_peer_definition_builder_api.py @@ -0,0 +1,2384 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyDialPeerDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer', + 'operation_id': 'create_policy_definition25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_policy_definition30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile', + 'operation_id': 'create_policy_definition30', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition25_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/{id}', + 'operation_id': 'delete_policy_definition25', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_definition30_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/{id}', + 'operation_id': 'delete_policy_definition30', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition25', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_multiple_policy_definition30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition30', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/{id}', + 'operation_id': 'edit_policy_definition25', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/{id}', + 'operation_id': 'edit_policy_definition30', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer', + 'operation_id': 'get_definitions25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_definitions30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile', + 'operation_id': 'get_definitions30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/{id}', + 'operation_id': 'get_policy_definition25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/{id}', + 'operation_id': 'get_policy_definition30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/preview', + 'operation_id': 'preview_policy_definition25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/preview', + 'operation_id': 'preview_policy_definition30', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition_by_id30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dialpeer/bulk', + 'operation_id': 'save_policy_definition_in_bulk25', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/srstphoneprofile/bulk', + 'operation_id': 'save_policy_definition_in_bulk30', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition25( + self, + **kwargs + ): + """create_policy_definition25 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition25_endpoint.call_with_http_info(**kwargs) + + def create_policy_definition30( + self, + **kwargs + ): + """create_policy_definition30 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition30_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition25( + self, + id, + **kwargs + ): + """delete_policy_definition25 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition25_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition30( + self, + id, + **kwargs + ): + """delete_policy_definition30 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition30_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition25( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition25 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition25_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition30( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition30 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition30_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition25( + self, + id, + **kwargs + ): + """edit_policy_definition25 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition25_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition30( + self, + id, + **kwargs + ): + """edit_policy_definition30 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition30_endpoint.call_with_http_info(**kwargs) + + def get_definitions25( + self, + **kwargs + ): + """get_definitions25 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions25_endpoint.call_with_http_info(**kwargs) + + def get_definitions30( + self, + **kwargs + ): + """get_definitions30 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions30_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition25( + self, + id, + **kwargs + ): + """get_policy_definition25 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition25_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition30( + self, + id, + **kwargs + ): + """get_policy_definition30 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition30_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition25( + self, + **kwargs + ): + """preview_policy_definition25 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition25_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition30( + self, + **kwargs + ): + """preview_policy_definition30 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition30_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id25( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id25 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id25_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id30( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id30 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id30_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk25( + self, + **kwargs + ): + """save_policy_definition_in_bulk25 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk25_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk30( + self, + **kwargs + ): + """save_policy_definition_in_bulk30 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk30_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_expanded_community_list_builder_api.py b/openapi_client/api/configuration_policy_expanded_community_list_builder_api.py new file mode 100644 index 0000000..8867dcb --- /dev/null +++ b/openapi_client/api/configuration_policy_expanded_community_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyExpandedCommunityListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity', + 'operation_id': 'create_policy_list11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list11_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity/{id}', + 'operation_id': 'delete_policy_list11', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag11_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity', + 'operation_id': 'delete_policy_lists_with_info_tag11', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity/{id}', + 'operation_id': 'edit_policy_list11', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity/{id}', + 'operation_id': 'get_lists_by_id11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists10_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity', + 'operation_id': 'get_policy_lists10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag11_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity/filtered', + 'operation_id': 'get_policy_lists_with_info_tag11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity/preview', + 'operation_id': 'preview_policy_list11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/expandedcommunity/preview/{id}', + 'operation_id': 'preview_policy_list_by_id11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list11( + self, + **kwargs + ): + """create_policy_list11 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list11_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list11( + self, + id, + **kwargs + ): + """delete_policy_list11 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list11_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag11( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag11 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag11_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list11( + self, + id, + **kwargs + ): + """edit_policy_list11 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list11_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id11( + self, + id, + **kwargs + ): + """get_lists_by_id11 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id11_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists10( + self, + **kwargs + ): + """get_policy_lists10 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists10_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag11( + self, + **kwargs + ): + """get_policy_lists_with_info_tag11 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag11_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list11( + self, + **kwargs + ): + """preview_policy_list11 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list11_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id11( + self, + id, + **kwargs + ): + """preview_policy_list_by_id11 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id11(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id11_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_extended_community_list_builder_api.py b/openapi_client/api/configuration_policy_extended_community_list_builder_api.py new file mode 100644 index 0000000..80c7b4b --- /dev/null +++ b/openapi_client/api/configuration_policy_extended_community_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyExtendedCommunityListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity', + 'operation_id': 'create_policy_list12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list12_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity/{id}', + 'operation_id': 'delete_policy_list12', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag12_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity', + 'operation_id': 'delete_policy_lists_with_info_tag12', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity/{id}', + 'operation_id': 'edit_policy_list12', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity/{id}', + 'operation_id': 'get_lists_by_id12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists11_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity', + 'operation_id': 'get_policy_lists11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag12_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity/filtered', + 'operation_id': 'get_policy_lists_with_info_tag12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity/preview', + 'operation_id': 'preview_policy_list12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/extcommunity/preview/{id}', + 'operation_id': 'preview_policy_list_by_id12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list12( + self, + **kwargs + ): + """create_policy_list12 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list12_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list12( + self, + id, + **kwargs + ): + """delete_policy_list12 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list12_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag12( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag12 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag12_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list12( + self, + id, + **kwargs + ): + """edit_policy_list12 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list12_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id12( + self, + id, + **kwargs + ): + """get_lists_by_id12 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id12_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists11( + self, + **kwargs + ): + """get_policy_lists11 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists11_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag12( + self, + **kwargs + ): + """get_policy_lists_with_info_tag12 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag12_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list12( + self, + **kwargs + ): + """preview_policy_list12 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list12_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id12( + self, + id, + **kwargs + ): + """preview_policy_list_by_id12 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id12(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id12_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_fax_protocol_list_builder_api.py b/openapi_client/api/configuration_policy_fax_protocol_list_builder_api.py new file mode 100644 index 0000000..1c4c2f2 --- /dev/null +++ b/openapi_client/api/configuration_policy_fax_protocol_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyFaxProtocolListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol', + 'operation_id': 'create_policy_list13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list13_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol/{id}', + 'operation_id': 'delete_policy_list13', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag13_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol', + 'operation_id': 'delete_policy_lists_with_info_tag13', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol/{id}', + 'operation_id': 'edit_policy_list13', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol/{id}', + 'operation_id': 'get_lists_by_id13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists12_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol', + 'operation_id': 'get_policy_lists12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag13_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol/filtered', + 'operation_id': 'get_policy_lists_with_info_tag13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol/preview', + 'operation_id': 'preview_policy_list13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/faxprotocol/preview/{id}', + 'operation_id': 'preview_policy_list_by_id13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list13( + self, + **kwargs + ): + """create_policy_list13 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list13_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list13( + self, + id, + **kwargs + ): + """delete_policy_list13 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list13_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag13( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag13 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag13_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list13( + self, + id, + **kwargs + ): + """edit_policy_list13 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list13_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id13( + self, + id, + **kwargs + ): + """get_lists_by_id13 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id13_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists12( + self, + **kwargs + ): + """get_policy_lists12 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists12_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag13( + self, + **kwargs + ): + """get_policy_lists_with_info_tag13 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag13_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list13( + self, + **kwargs + ): + """preview_policy_list13 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list13_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id13( + self, + id, + **kwargs + ): + """preview_policy_list_by_id13 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id13(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id13_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_forwarding_class_list_builder_api.py b/openapi_client/api/configuration_policy_forwarding_class_list_builder_api.py new file mode 100644 index 0000000..f0ee01e --- /dev/null +++ b/openapi_client/api/configuration_policy_forwarding_class_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyForwardingClassListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/class', + 'operation_id': 'create_policy_list14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list14_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/class/{id}', + 'operation_id': 'delete_policy_list14', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag14_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/class', + 'operation_id': 'delete_policy_lists_with_info_tag14', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/class/{id}', + 'operation_id': 'edit_policy_list14', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/class/{id}', + 'operation_id': 'get_lists_by_id14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists13_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/class', + 'operation_id': 'get_policy_lists13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag14_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/class/filtered', + 'operation_id': 'get_policy_lists_with_info_tag14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/class/preview', + 'operation_id': 'preview_policy_list14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/class/preview/{id}', + 'operation_id': 'preview_policy_list_by_id14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list14( + self, + **kwargs + ): + """create_policy_list14 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list14_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list14( + self, + id, + **kwargs + ): + """delete_policy_list14 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list14_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag14( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag14 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag14_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list14( + self, + id, + **kwargs + ): + """edit_policy_list14 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list14_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id14( + self, + id, + **kwargs + ): + """get_lists_by_id14 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id14_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists13( + self, + **kwargs + ): + """get_policy_lists13 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists13_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag14( + self, + **kwargs + ): + """get_policy_lists_with_info_tag14 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag14_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list14( + self, + **kwargs + ): + """preview_policy_list14 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list14_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id14( + self, + id, + **kwargs + ): + """preview_policy_list_by_id14 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id14(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id14_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_fxo_port_definition_builder_api.py b/openapi_client/api/configuration_policy_fxo_port_definition_builder_api.py new file mode 100644 index 0000000..e4194ed --- /dev/null +++ b/openapi_client/api/configuration_policy_fxo_port_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyFXOPortDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport', + 'operation_id': 'create_policy_definition26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition26_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/{id}', + 'operation_id': 'delete_policy_definition26', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition26', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/{id}', + 'operation_id': 'edit_policy_definition26', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport', + 'operation_id': 'get_definitions26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/{id}', + 'operation_id': 'get_policy_definition26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/preview', + 'operation_id': 'preview_policy_definition26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxoport/bulk', + 'operation_id': 'save_policy_definition_in_bulk26', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition26( + self, + **kwargs + ): + """create_policy_definition26 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition26_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition26( + self, + id, + **kwargs + ): + """delete_policy_definition26 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition26_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition26( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition26 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition26_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition26( + self, + id, + **kwargs + ): + """edit_policy_definition26 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition26_endpoint.call_with_http_info(**kwargs) + + def get_definitions26( + self, + **kwargs + ): + """get_definitions26 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions26_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition26( + self, + id, + **kwargs + ): + """get_policy_definition26 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition26_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition26( + self, + **kwargs + ): + """preview_policy_definition26 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition26_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id26( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id26 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id26_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk26( + self, + **kwargs + ): + """save_policy_definition_in_bulk26 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk26_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_fxs_port_definition_builder_api.py b/openapi_client/api/configuration_policy_fxs_port_definition_builder_api.py new file mode 100644 index 0000000..60e59b4 --- /dev/null +++ b/openapi_client/api/configuration_policy_fxs_port_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyFXSPortDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport', + 'operation_id': 'create_policy_definition27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition27_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/{id}', + 'operation_id': 'delete_policy_definition27', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition27', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/{id}', + 'operation_id': 'edit_policy_definition27', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport', + 'operation_id': 'get_definitions27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/{id}', + 'operation_id': 'get_policy_definition27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/preview', + 'operation_id': 'preview_policy_definition27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsport/bulk', + 'operation_id': 'save_policy_definition_in_bulk27', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition27( + self, + **kwargs + ): + """create_policy_definition27 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition27_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition27( + self, + id, + **kwargs + ): + """delete_policy_definition27 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition27_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition27( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition27 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition27_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition27( + self, + id, + **kwargs + ): + """edit_policy_definition27 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition27_endpoint.call_with_http_info(**kwargs) + + def get_definitions27( + self, + **kwargs + ): + """get_definitions27 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions27_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition27( + self, + id, + **kwargs + ): + """get_policy_definition27 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition27_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition27( + self, + **kwargs + ): + """preview_policy_definition27 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition27_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id27( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id27 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id27_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk27( + self, + **kwargs + ): + """save_policy_definition_in_bulk27 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk27_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_fxsdid_port_definition_builder_api.py b/openapi_client/api/configuration_policy_fxsdid_port_definition_builder_api.py new file mode 100644 index 0000000..dcbd4c4 --- /dev/null +++ b/openapi_client/api/configuration_policy_fxsdid_port_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyFXSDIDPortDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport', + 'operation_id': 'create_policy_definition28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition28_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/{id}', + 'operation_id': 'delete_policy_definition28', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition28', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/{id}', + 'operation_id': 'edit_policy_definition28', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport', + 'operation_id': 'get_definitions28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/{id}', + 'operation_id': 'get_policy_definition28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/preview', + 'operation_id': 'preview_policy_definition28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/fxsdidport/bulk', + 'operation_id': 'save_policy_definition_in_bulk28', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition28( + self, + **kwargs + ): + """create_policy_definition28 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition28_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition28( + self, + id, + **kwargs + ): + """delete_policy_definition28 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition28_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition28( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition28 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition28_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition28( + self, + id, + **kwargs + ): + """edit_policy_definition28 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition28_endpoint.call_with_http_info(**kwargs) + + def get_definitions28( + self, + **kwargs + ): + """get_definitions28 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions28_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition28( + self, + id, + **kwargs + ): + """get_policy_definition28 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition28_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition28( + self, + **kwargs + ): + """preview_policy_definition28 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition28_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id28( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id28 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id28_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk28( + self, + **kwargs + ): + """save_policy_definition_in_bulk28 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk28_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_geo_location_list_builder_api.py b/openapi_client/api/configuration_policy_geo_location_list_builder_api.py new file mode 100644 index 0000000..b93b51b --- /dev/null +++ b/openapi_client/api/configuration_policy_geo_location_list_builder_api.py @@ -0,0 +1,1317 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyGeoLocationListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation', + 'operation_id': 'create_policy_list17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list17_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/{id}', + 'operation_id': 'delete_policy_list17', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag17_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation', + 'operation_id': 'delete_policy_lists_with_info_tag17', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/{id}', + 'operation_id': 'edit_policy_list17', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_geo_location_lists_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/entries', + 'operation_id': 'get_geo_location_lists', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lists_by_id17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/{id}', + 'operation_id': 'get_lists_by_id17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists15_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation', + 'operation_id': 'get_policy_lists15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag17_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/filtered', + 'operation_id': 'get_policy_lists_with_info_tag17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/preview', + 'operation_id': 'preview_policy_list17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/geolocation/preview/{id}', + 'operation_id': 'preview_policy_list_by_id17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list17( + self, + **kwargs + ): + """create_policy_list17 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list17_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list17( + self, + id, + **kwargs + ): + """delete_policy_list17 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list17_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag17( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag17 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag17_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list17( + self, + id, + **kwargs + ): + """edit_policy_list17 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list17_endpoint.call_with_http_info(**kwargs) + + def get_geo_location_lists( + self, + **kwargs + ): + """get_geo_location_lists # noqa: E501 + + Get list of countries and continents for geo location # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_geo_location_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_geo_location_lists_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id17( + self, + id, + **kwargs + ): + """get_lists_by_id17 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id17_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists15( + self, + **kwargs + ): + """get_policy_lists15 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists15_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag17( + self, + **kwargs + ): + """get_policy_lists_with_info_tag17 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag17_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list17( + self, + **kwargs + ): + """preview_policy_list17 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list17_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id17( + self, + id, + **kwargs + ): + """preview_policy_list_by_id17 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id17_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_hub_and_spoke_definition_builder_api.py b/openapi_client/api/configuration_policy_hub_and_spoke_definition_builder_api.py new file mode 100644 index 0000000..73afbee --- /dev/null +++ b/openapi_client/api/configuration_policy_hub_and_spoke_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke', + 'operation_id': 'create_policy_definition4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition4_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/{id}', + 'operation_id': 'delete_policy_definition4', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition4', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/{id}', + 'operation_id': 'edit_policy_definition4', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke', + 'operation_id': 'get_definitions4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/{id}', + 'operation_id': 'get_policy_definition4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/preview', + 'operation_id': 'preview_policy_definition4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/hubandspoke/bulk', + 'operation_id': 'save_policy_definition_in_bulk4', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition4( + self, + **kwargs + ): + """create_policy_definition4 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition4_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition4( + self, + id, + **kwargs + ): + """delete_policy_definition4 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition4_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition4( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition4 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition4_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition4( + self, + id, + **kwargs + ): + """edit_policy_definition4 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition4_endpoint.call_with_http_info(**kwargs) + + def get_definitions4( + self, + **kwargs + ): + """get_definitions4 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions4_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition4( + self, + id, + **kwargs + ): + """get_policy_definition4 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition4_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition4( + self, + **kwargs + ): + """preview_policy_definition4 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition4_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id4( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id4 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id4(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id4_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk4( + self, + **kwargs + ): + """save_policy_definition_in_bulk4 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk4_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_identity_list_builder_api.py b/openapi_client/api/configuration_policy_identity_list_builder_api.py new file mode 100644 index 0000000..38cbc10 --- /dev/null +++ b/openapi_client/api/configuration_policy_identity_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyIdentityListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity', + 'operation_id': 'create_policy_list18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list18_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/identity/{id}', + 'operation_id': 'delete_policy_list18', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag18_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity', + 'operation_id': 'delete_policy_lists_with_info_tag18', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity/{id}', + 'operation_id': 'edit_policy_list18', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity/{id}', + 'operation_id': 'get_lists_by_id18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists16_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity', + 'operation_id': 'get_policy_lists16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag18_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity/filtered', + 'operation_id': 'get_policy_lists_with_info_tag18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity/preview', + 'operation_id': 'preview_policy_list18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/identity/preview/{id}', + 'operation_id': 'preview_policy_list_by_id18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list18( + self, + **kwargs + ): + """create_policy_list18 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list18_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list18( + self, + id, + **kwargs + ): + """delete_policy_list18 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list18_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag18( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag18 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag18_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list18( + self, + id, + **kwargs + ): + """edit_policy_list18 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list18_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id18( + self, + id, + **kwargs + ): + """get_lists_by_id18 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id18_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists16( + self, + **kwargs + ): + """get_policy_lists16 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists16_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag18( + self, + **kwargs + ): + """get_policy_lists_with_info_tag18 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag18_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list18( + self, + **kwargs + ): + """preview_policy_list18 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list18_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id18( + self, + id, + **kwargs + ): + """preview_policy_list_by_id18 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id18_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_intrusion_prevention_definition_builder_api.py b/openapi_client/api/configuration_policy_intrusion_prevention_definition_builder_api.py new file mode 100644 index 0000000..a238d19 --- /dev/null +++ b/openapi_client/api/configuration_policy_intrusion_prevention_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention', + 'operation_id': 'create_policy_definition18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition18_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/{id}', + 'operation_id': 'delete_policy_definition18', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition18', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/{id}', + 'operation_id': 'edit_policy_definition18', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention', + 'operation_id': 'get_definitions18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/{id}', + 'operation_id': 'get_policy_definition18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/preview', + 'operation_id': 'preview_policy_definition18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/intrusionprevention/bulk', + 'operation_id': 'save_policy_definition_in_bulk18', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition18( + self, + **kwargs + ): + """create_policy_definition18 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition18_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition18( + self, + id, + **kwargs + ): + """delete_policy_definition18 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition18_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition18( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition18 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition18_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition18( + self, + id, + **kwargs + ): + """edit_policy_definition18 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition18_endpoint.call_with_http_info(**kwargs) + + def get_definitions18( + self, + **kwargs + ): + """get_definitions18 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions18_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition18( + self, + id, + **kwargs + ): + """get_policy_definition18 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition18_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition18( + self, + **kwargs + ): + """preview_policy_definition18 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition18_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id18( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id18 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id18(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id18_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk18( + self, + **kwargs + ): + """save_policy_definition_in_bulk18 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk18_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_ips_signature_list_builder_api.py b/openapi_client/api/configuration_policy_ips_signature_list_builder_api.py new file mode 100644 index 0000000..17eebd5 --- /dev/null +++ b/openapi_client/api/configuration_policy_ips_signature_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyIPSSignatureListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature', + 'operation_id': 'create_policy_list19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list19_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature/{id}', + 'operation_id': 'delete_policy_list19', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag19_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature', + 'operation_id': 'delete_policy_lists_with_info_tag19', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature/{id}', + 'operation_id': 'edit_policy_list19', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature/{id}', + 'operation_id': 'get_lists_by_id19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists17_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature', + 'operation_id': 'get_policy_lists17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag19_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature/filtered', + 'operation_id': 'get_policy_lists_with_info_tag19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature/preview', + 'operation_id': 'preview_policy_list19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipssignature/preview/{id}', + 'operation_id': 'preview_policy_list_by_id19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list19( + self, + **kwargs + ): + """create_policy_list19 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list19_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list19( + self, + id, + **kwargs + ): + """delete_policy_list19 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list19_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag19( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag19 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag19_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list19( + self, + id, + **kwargs + ): + """edit_policy_list19 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list19_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id19( + self, + id, + **kwargs + ): + """get_lists_by_id19 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id19_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists17( + self, + **kwargs + ): + """get_policy_lists17 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists17_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag19( + self, + **kwargs + ): + """get_policy_lists_with_info_tag19 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag19_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list19( + self, + **kwargs + ): + """preview_policy_list19 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list19_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id19( + self, + id, + **kwargs + ): + """preview_policy_list_by_id19 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id19_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_ipv6_access_definition_builder_api.py b/openapi_client/api/configuration_policy_ipv6_access_definition_builder_api.py new file mode 100644 index 0000000..44c3aad --- /dev/null +++ b/openapi_client/api/configuration_policy_ipv6_access_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyIPv6AccessDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6', + 'operation_id': 'create_policy_definition9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition9_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/{id}', + 'operation_id': 'delete_policy_definition9', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition9', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/{id}', + 'operation_id': 'edit_policy_definition9', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6', + 'operation_id': 'get_definitions9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/{id}', + 'operation_id': 'get_policy_definition9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/preview', + 'operation_id': 'preview_policy_definition9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/aclv6/bulk', + 'operation_id': 'save_policy_definition_in_bulk9', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition9( + self, + **kwargs + ): + """create_policy_definition9 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition9_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition9( + self, + id, + **kwargs + ): + """delete_policy_definition9 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition9_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition9( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition9 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition9_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition9( + self, + id, + **kwargs + ): + """edit_policy_definition9 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition9_endpoint.call_with_http_info(**kwargs) + + def get_definitions9( + self, + **kwargs + ): + """get_definitions9 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions9_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition9( + self, + id, + **kwargs + ): + """get_policy_definition9 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition9_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition9( + self, + **kwargs + ): + """preview_policy_definition9 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition9_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id9( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id9 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id9(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id9_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk9( + self, + **kwargs + ): + """save_policy_definition_in_bulk9 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk9_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_ipv6_device_access_definition_builder_api.py b/openapi_client/api/configuration_policy_ipv6_device_access_definition_builder_api.py new file mode 100644 index 0000000..4ca80e4 --- /dev/null +++ b/openapi_client/api/configuration_policy_ipv6_device_access_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6', + 'operation_id': 'create_policy_definition17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition17_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/{id}', + 'operation_id': 'delete_policy_definition17', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition17', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/{id}', + 'operation_id': 'edit_policy_definition17', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6', + 'operation_id': 'get_definitions17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/{id}', + 'operation_id': 'get_policy_definition17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/preview', + 'operation_id': 'preview_policy_definition17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/deviceaccesspolicyv6/bulk', + 'operation_id': 'save_policy_definition_in_bulk17', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition17( + self, + **kwargs + ): + """create_policy_definition17 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition17_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition17( + self, + id, + **kwargs + ): + """delete_policy_definition17 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition17_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition17( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition17 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition17_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition17( + self, + id, + **kwargs + ): + """edit_policy_definition17 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition17_endpoint.call_with_http_info(**kwargs) + + def get_definitions17( + self, + **kwargs + ): + """get_definitions17 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions17_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition17( + self, + id, + **kwargs + ): + """get_policy_definition17 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition17_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition17( + self, + **kwargs + ): + """preview_policy_definition17 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition17_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id17( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id17 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id17(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id17_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk17( + self, + **kwargs + ): + """save_policy_definition_in_bulk17 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk17_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_ipv6_prefix_list_builder_api.py b/openapi_client/api/configuration_policy_ipv6_prefix_list_builder_api.py new file mode 100644 index 0000000..eebfe19 --- /dev/null +++ b/openapi_client/api/configuration_policy_ipv6_prefix_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyIPv6PrefixListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix', + 'operation_id': 'create_policy_list20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list20_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix/{id}', + 'operation_id': 'delete_policy_list20', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag20_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix', + 'operation_id': 'delete_policy_lists_with_info_tag20', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix/{id}', + 'operation_id': 'edit_policy_list20', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix/{id}', + 'operation_id': 'get_lists_by_id20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists18_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix', + 'operation_id': 'get_policy_lists18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag20_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix/filtered', + 'operation_id': 'get_policy_lists_with_info_tag20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix/preview', + 'operation_id': 'preview_policy_list20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipv6prefix/preview/{id}', + 'operation_id': 'preview_policy_list_by_id20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list20( + self, + **kwargs + ): + """create_policy_list20 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list20_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list20( + self, + id, + **kwargs + ): + """delete_policy_list20 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list20_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag20( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag20 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag20_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list20( + self, + id, + **kwargs + ): + """edit_policy_list20 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list20_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id20( + self, + id, + **kwargs + ): + """get_lists_by_id20 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id20_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists18( + self, + **kwargs + ): + """get_policy_lists18 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists18_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag20( + self, + **kwargs + ): + """get_policy_lists_with_info_tag20 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag20_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list20( + self, + **kwargs + ): + """preview_policy_list20 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list20_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id20( + self, + id, + **kwargs + ): + """preview_policy_list_by_id20 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id20_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_list_builder_api.py b/openapi_client/api/configuration_policy_list_builder_api.py new file mode 100644 index 0000000..f070247 --- /dev/null +++ b/openapi_client/api/configuration_policy_list_builder_api.py @@ -0,0 +1,398 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_webex_prefix_lists_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/webex', + 'operation_id': 'create_webex_prefix_lists', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_webex_prefix_lists1_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/webex/update', + 'operation_id': 'create_webex_prefix_lists1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_policy_lists_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list', + 'operation_id': 'get_all_policy_lists', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_webex_prefix_lists( + self, + **kwargs + ): + """create_webex_prefix_lists # noqa: E501 + + TEMP-Create Webex policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_webex_prefix_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_webex_prefix_lists_endpoint.call_with_http_info(**kwargs) + + def create_webex_prefix_lists1( + self, + **kwargs + ): + """create_webex_prefix_lists1 # noqa: E501 + + TEMP-Update Webex policy lists from Webex config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_webex_prefix_lists1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_webex_prefix_lists1_endpoint.call_with_http_info(**kwargs) + + def get_all_policy_lists( + self, + **kwargs + ): + """get_all_policy_lists # noqa: E501 + + Get all policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_policy_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_policy_lists_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_local_domain_definition_builder_api.py b/openapi_client/api/configuration_policy_local_domain_definition_builder_api.py new file mode 100644 index 0000000..e446df0 --- /dev/null +++ b/openapi_client/api/configuration_policy_local_domain_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyLocalDomainDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity', + 'operation_id': 'create_policy_definition', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/{id}', + 'operation_id': 'delete_policy_definition', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/{id}', + 'operation_id': 'edit_policy_definition', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity', + 'operation_id': 'get_definitions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/{id}', + 'operation_id': 'get_policy_definition', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/preview', + 'operation_id': 'preview_policy_definition', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/dnssecurity/bulk', + 'operation_id': 'save_policy_definition_in_bulk', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition( + self, + **kwargs + ): + """create_policy_definition # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition( + self, + id, + **kwargs + ): + """delete_policy_definition # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition( + self, + id, + **kwargs + ): + """edit_policy_definition # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition_endpoint.call_with_http_info(**kwargs) + + def get_definitions( + self, + **kwargs + ): + """get_definitions # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition( + self, + id, + **kwargs + ): + """get_policy_definition # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition( + self, + **kwargs + ): + """preview_policy_definition # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk( + self, + **kwargs + ): + """save_policy_definition_in_bulk # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_local_domain_name_list_builder_api.py b/openapi_client/api/configuration_policy_local_domain_name_list_builder_api.py new file mode 100644 index 0000000..355bd64 --- /dev/null +++ b/openapi_client/api/configuration_policy_local_domain_name_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyLocalDomainNameListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain', + 'operation_id': 'create_policy_list23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list23_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain/{id}', + 'operation_id': 'delete_policy_list23', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag23_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain', + 'operation_id': 'delete_policy_lists_with_info_tag23', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain/{id}', + 'operation_id': 'edit_policy_list23', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain/{id}', + 'operation_id': 'get_lists_by_id23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists20_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain', + 'operation_id': 'get_policy_lists20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag23_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain/filtered', + 'operation_id': 'get_policy_lists_with_info_tag23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain/preview', + 'operation_id': 'preview_policy_list23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/localdomain/preview/{id}', + 'operation_id': 'preview_policy_list_by_id23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list23( + self, + **kwargs + ): + """create_policy_list23 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list23_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list23( + self, + id, + **kwargs + ): + """delete_policy_list23 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list23_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag23( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag23 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag23_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list23( + self, + id, + **kwargs + ): + """edit_policy_list23 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list23_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id23( + self, + id, + **kwargs + ): + """get_lists_by_id23 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id23_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists20( + self, + **kwargs + ): + """get_policy_lists20 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists20_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag23( + self, + **kwargs + ): + """get_policy_lists_with_info_tag23 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag23_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list23( + self, + **kwargs + ): + """preview_policy_list23 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list23_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id23( + self, + id, + **kwargs + ): + """preview_policy_list_by_id23 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id23_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_media_profile_list_builder_api.py b/openapi_client/api/configuration_policy_media_profile_list_builder_api.py new file mode 100644 index 0000000..7ea92ca --- /dev/null +++ b/openapi_client/api/configuration_policy_media_profile_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyMediaProfileListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile', + 'operation_id': 'create_policy_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile/{id}', + 'operation_id': 'delete_policy_list', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile', + 'operation_id': 'delete_policy_lists_with_info_tag', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile/{id}', + 'operation_id': 'edit_policy_list', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile/{id}', + 'operation_id': 'get_lists_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile', + 'operation_id': 'get_policy_lists', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile/filtered', + 'operation_id': 'get_policy_lists_with_info_tag', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile/preview', + 'operation_id': 'preview_policy_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mediaprofile/preview/{id}', + 'operation_id': 'preview_policy_list_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list( + self, + **kwargs + ): + """create_policy_list # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list( + self, + id, + **kwargs + ): + """delete_policy_list # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list( + self, + id, + **kwargs + ): + """edit_policy_list # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id( + self, + id, + **kwargs + ): + """get_lists_by_id # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists( + self, + **kwargs + ): + """get_policy_lists # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag( + self, + **kwargs + ): + """get_policy_lists_with_info_tag # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list( + self, + **kwargs + ): + """preview_policy_list # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id( + self, + id, + **kwargs + ): + """preview_policy_list_by_id # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_mesh_definition_builder_api.py b/openapi_client/api/configuration_policy_mesh_definition_builder_api.py new file mode 100644 index 0000000..cfb2456 --- /dev/null +++ b/openapi_client/api/configuration_policy_mesh_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyMeshDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh', + 'operation_id': 'create_policy_definition5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition5_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/{id}', + 'operation_id': 'delete_policy_definition5', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition5', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/{id}', + 'operation_id': 'edit_policy_definition5', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh', + 'operation_id': 'get_definitions5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/{id}', + 'operation_id': 'get_policy_definition5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/preview', + 'operation_id': 'preview_policy_definition5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/mesh/bulk', + 'operation_id': 'save_policy_definition_in_bulk5', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition5( + self, + **kwargs + ): + """create_policy_definition5 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition5_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition5( + self, + id, + **kwargs + ): + """delete_policy_definition5 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition5_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition5( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition5 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition5_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition5( + self, + id, + **kwargs + ): + """edit_policy_definition5 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition5_endpoint.call_with_http_info(**kwargs) + + def get_definitions5( + self, + **kwargs + ): + """get_definitions5 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions5_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition5( + self, + id, + **kwargs + ): + """get_policy_definition5 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition5_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition5( + self, + **kwargs + ): + """preview_policy_definition5 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition5_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id5( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id5 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id5(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id5_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk5( + self, + **kwargs + ): + """save_policy_definition_in_bulk5 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk5_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_mirror_list_builder_api.py b/openapi_client/api/configuration_policy_mirror_list_builder_api.py new file mode 100644 index 0000000..ad44279 --- /dev/null +++ b/openapi_client/api/configuration_policy_mirror_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyMirrorListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror', + 'operation_id': 'create_policy_list24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list24_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror/{id}', + 'operation_id': 'delete_policy_list24', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag24_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror', + 'operation_id': 'delete_policy_lists_with_info_tag24', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror/{id}', + 'operation_id': 'edit_policy_list24', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror/{id}', + 'operation_id': 'get_lists_by_id24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists21_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror', + 'operation_id': 'get_policy_lists21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag24_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror/filtered', + 'operation_id': 'get_policy_lists_with_info_tag24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror/preview', + 'operation_id': 'preview_policy_list24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/mirror/preview/{id}', + 'operation_id': 'preview_policy_list_by_id24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list24( + self, + **kwargs + ): + """create_policy_list24 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list24_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list24( + self, + id, + **kwargs + ): + """delete_policy_list24 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list24_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag24( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag24 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag24_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list24( + self, + id, + **kwargs + ): + """edit_policy_list24 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list24_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id24( + self, + id, + **kwargs + ): + """get_lists_by_id24 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id24_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists21( + self, + **kwargs + ): + """get_policy_lists21 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists21_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag24( + self, + **kwargs + ): + """get_policy_lists_with_info_tag24 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag24_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list24( + self, + **kwargs + ): + """preview_policy_list24 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list24_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id24( + self, + id, + **kwargs + ): + """preview_policy_list_by_id24 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id24_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_modem_passthrough_list_builder_api.py b/openapi_client/api/configuration_policy_modem_passthrough_list_builder_api.py new file mode 100644 index 0000000..28bac0e --- /dev/null +++ b/openapi_client/api/configuration_policy_modem_passthrough_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyModemPassthroughListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough', + 'operation_id': 'create_policy_list25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list25_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough/{id}', + 'operation_id': 'delete_policy_list25', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag25_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough', + 'operation_id': 'delete_policy_lists_with_info_tag25', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough/{id}', + 'operation_id': 'edit_policy_list25', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough/{id}', + 'operation_id': 'get_lists_by_id25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists22_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough', + 'operation_id': 'get_policy_lists22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag25_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough/filtered', + 'operation_id': 'get_policy_lists_with_info_tag25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough/preview', + 'operation_id': 'preview_policy_list25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/modempassthrough/preview/{id}', + 'operation_id': 'preview_policy_list_by_id25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list25( + self, + **kwargs + ): + """create_policy_list25 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list25_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list25( + self, + id, + **kwargs + ): + """delete_policy_list25 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list25_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag25( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag25 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag25_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list25( + self, + id, + **kwargs + ): + """edit_policy_list25 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list25_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id25( + self, + id, + **kwargs + ): + """get_lists_by_id25 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id25_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists22( + self, + **kwargs + ): + """get_policy_lists22 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists22_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag25( + self, + **kwargs + ): + """get_policy_lists_with_info_tag25 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag25_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list25( + self, + **kwargs + ): + """preview_policy_list25 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list25_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id25( + self, + id, + **kwargs + ): + """preview_policy_list_by_id25 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id25(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id25_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_policer_class_list_builder_api.py b/openapi_client/api/configuration_policy_policer_class_list_builder_api.py new file mode 100644 index 0000000..83bf9ae --- /dev/null +++ b/openapi_client/api/configuration_policy_policer_class_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyPolicerClassListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer', + 'operation_id': 'create_policy_list26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list26_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/policer/{id}', + 'operation_id': 'delete_policy_list26', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag26_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer', + 'operation_id': 'delete_policy_lists_with_info_tag26', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer/{id}', + 'operation_id': 'edit_policy_list26', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer/{id}', + 'operation_id': 'get_lists_by_id26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists23_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer', + 'operation_id': 'get_policy_lists23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag26_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer/filtered', + 'operation_id': 'get_policy_lists_with_info_tag26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer/preview', + 'operation_id': 'preview_policy_list26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/policer/preview/{id}', + 'operation_id': 'preview_policy_list_by_id26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list26( + self, + **kwargs + ): + """create_policy_list26 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list26_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list26( + self, + id, + **kwargs + ): + """delete_policy_list26 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list26_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag26( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag26 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag26_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list26( + self, + id, + **kwargs + ): + """edit_policy_list26 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list26_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id26( + self, + id, + **kwargs + ): + """get_lists_by_id26 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id26_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists23( + self, + **kwargs + ): + """get_policy_lists23 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists23_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag26( + self, + **kwargs + ): + """get_policy_lists_with_info_tag26 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag26_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list26( + self, + **kwargs + ): + """preview_policy_list26 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list26_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id26( + self, + id, + **kwargs + ): + """preview_policy_list_by_id26 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id26(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id26_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_port_list_builder_api.py b/openapi_client/api/configuration_policy_port_list_builder_api.py new file mode 100644 index 0000000..ed1f960 --- /dev/null +++ b/openapi_client/api/configuration_policy_port_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyPortListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/port', + 'operation_id': 'create_policy_list27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list27_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/port/{id}', + 'operation_id': 'delete_policy_list27', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag27_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/port', + 'operation_id': 'delete_policy_lists_with_info_tag27', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/port/{id}', + 'operation_id': 'edit_policy_list27', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/port/{id}', + 'operation_id': 'get_lists_by_id27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists24_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/port', + 'operation_id': 'get_policy_lists24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag27_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/port/filtered', + 'operation_id': 'get_policy_lists_with_info_tag27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/port/preview', + 'operation_id': 'preview_policy_list27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/port/preview/{id}', + 'operation_id': 'preview_policy_list_by_id27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list27( + self, + **kwargs + ): + """create_policy_list27 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list27_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list27( + self, + id, + **kwargs + ): + """delete_policy_list27 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list27_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag27( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag27 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag27_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list27( + self, + id, + **kwargs + ): + """edit_policy_list27 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list27_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id27( + self, + id, + **kwargs + ): + """get_lists_by_id27 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id27_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists24( + self, + **kwargs + ): + """get_policy_lists24 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists24_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag27( + self, + **kwargs + ): + """get_policy_lists_with_info_tag27 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag27_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list27( + self, + **kwargs + ): + """preview_policy_list27 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list27_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id27( + self, + id, + **kwargs + ): + """preview_policy_list_by_id27 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id27(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id27_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_prefix_for_all_types_of_lists_builder_api.py b/openapi_client/api/configuration_policy_prefix_for_all_types_of_lists_builder_api.py new file mode 100644 index 0000000..8a02c0f --- /dev/null +++ b/openapi_client/api/configuration_policy_prefix_for_all_types_of_lists_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall', + 'operation_id': 'create_policy_list21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list21_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall/{id}', + 'operation_id': 'delete_policy_list21', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag21_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall', + 'operation_id': 'delete_policy_lists_with_info_tag21', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall/{id}', + 'operation_id': 'edit_policy_list21', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall/{id}', + 'operation_id': 'get_lists_by_id21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_lists_for_all_prefixes_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall', + 'operation_id': 'get_lists_for_all_prefixes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag21_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall/filtered', + 'operation_id': 'get_policy_lists_with_info_tag21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall/preview', + 'operation_id': 'preview_policy_list21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/ipprefixall/preview/{id}', + 'operation_id': 'preview_policy_list_by_id21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list21( + self, + **kwargs + ): + """create_policy_list21 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list21_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list21( + self, + id, + **kwargs + ): + """delete_policy_list21 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list21_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag21( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag21 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag21_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list21( + self, + id, + **kwargs + ): + """edit_policy_list21 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list21_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id21( + self, + id, + **kwargs + ): + """get_lists_by_id21 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id21_endpoint.call_with_http_info(**kwargs) + + def get_lists_for_all_prefixes( + self, + **kwargs + ): + """get_lists_for_all_prefixes # noqa: E501 + + Get lists for all prefixes # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_for_all_prefixes(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_lists_for_all_prefixes_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag21( + self, + **kwargs + ): + """get_policy_lists_with_info_tag21 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag21_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list21( + self, + **kwargs + ): + """preview_policy_list21 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list21_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id21( + self, + id, + **kwargs + ): + """preview_policy_list_by_id21 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id21_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_prefix_list_builder_api.py b/openapi_client/api/configuration_policy_prefix_list_builder_api.py new file mode 100644 index 0000000..e9bf1ef --- /dev/null +++ b/openapi_client/api/configuration_policy_prefix_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyPrefixListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix', + 'operation_id': 'create_policy_list29', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list29_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix/{id}', + 'operation_id': 'delete_policy_list29', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag29_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix', + 'operation_id': 'delete_policy_lists_with_info_tag29', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix/{id}', + 'operation_id': 'edit_policy_list29', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix/{id}', + 'operation_id': 'get_lists_by_id29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists26_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix', + 'operation_id': 'get_policy_lists26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag29_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix/filtered', + 'operation_id': 'get_policy_lists_with_info_tag29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix/preview', + 'operation_id': 'preview_policy_list29', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/prefix/preview/{id}', + 'operation_id': 'preview_policy_list_by_id29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list29( + self, + **kwargs + ): + """create_policy_list29 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list29_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list29( + self, + id, + **kwargs + ): + """delete_policy_list29 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list29_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag29( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag29 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag29_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list29( + self, + id, + **kwargs + ): + """edit_policy_list29 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list29_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id29( + self, + id, + **kwargs + ): + """get_lists_by_id29 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id29_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists26( + self, + **kwargs + ): + """get_policy_lists26 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists26_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag29( + self, + **kwargs + ): + """get_policy_lists_with_info_tag29 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag29_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list29( + self, + **kwargs + ): + """preview_policy_list29 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list29_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id29( + self, + id, + **kwargs + ): + """preview_policy_list_by_id29 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id29_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_priisdn_port_definition_builder_api.py b/openapi_client/api/configuration_policy_priisdn_port_definition_builder_api.py new file mode 100644 index 0000000..5e21b3d --- /dev/null +++ b/openapi_client/api/configuration_policy_priisdn_port_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyPRIISDNPortDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport', + 'operation_id': 'create_policy_definition29', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition29_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/{id}', + 'operation_id': 'delete_policy_definition29', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition29', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/{id}', + 'operation_id': 'edit_policy_definition29', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport', + 'operation_id': 'get_definitions29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/{id}', + 'operation_id': 'get_policy_definition29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/preview', + 'operation_id': 'preview_policy_definition29', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/priisdnport/bulk', + 'operation_id': 'save_policy_definition_in_bulk29', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition29( + self, + **kwargs + ): + """create_policy_definition29 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition29_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition29( + self, + id, + **kwargs + ): + """delete_policy_definition29 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition29_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition29( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition29 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition29_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition29( + self, + id, + **kwargs + ): + """edit_policy_definition29 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition29_endpoint.call_with_http_info(**kwargs) + + def get_definitions29( + self, + **kwargs + ): + """get_definitions29 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions29_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition29( + self, + id, + **kwargs + ): + """get_policy_definition29 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition29_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition29( + self, + **kwargs + ): + """preview_policy_definition29 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition29_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id29( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id29 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id29(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id29_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk29( + self, + **kwargs + ): + """save_policy_definition_in_bulk29 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk29_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_protocol_name_list_builder_api.py b/openapi_client/api/configuration_policy_protocol_name_list_builder_api.py new file mode 100644 index 0000000..a3f9413 --- /dev/null +++ b/openapi_client/api/configuration_policy_protocol_name_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyProtocolNameListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname', + 'operation_id': 'create_policy_list30', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list30_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname/{id}', + 'operation_id': 'delete_policy_list30', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag30_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname', + 'operation_id': 'delete_policy_lists_with_info_tag30', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname/{id}', + 'operation_id': 'edit_policy_list30', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname/{id}', + 'operation_id': 'get_lists_by_id30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists27_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname', + 'operation_id': 'get_policy_lists27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag30_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname/filtered', + 'operation_id': 'get_policy_lists_with_info_tag30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname/preview', + 'operation_id': 'preview_policy_list30', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/protocolname/preview/{id}', + 'operation_id': 'preview_policy_list_by_id30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list30( + self, + **kwargs + ): + """create_policy_list30 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list30_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list30( + self, + id, + **kwargs + ): + """delete_policy_list30 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list30_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag30( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag30 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag30_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list30( + self, + id, + **kwargs + ): + """edit_policy_list30 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list30_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id30( + self, + id, + **kwargs + ): + """get_lists_by_id30 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id30_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists27( + self, + **kwargs + ): + """get_policy_lists27 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists27_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag30( + self, + **kwargs + ): + """get_policy_lists_with_info_tag30 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag30_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list30( + self, + **kwargs + ): + """preview_policy_list30 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list30_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id30( + self, + id, + **kwargs + ): + """preview_policy_list_by_id30 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id30(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id30_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_qos_map_definition_builder_api.py b/openapi_client/api/configuration_policy_qos_map_definition_builder_api.py new file mode 100644 index 0000000..3932590 --- /dev/null +++ b/openapi_client/api/configuration_policy_qos_map_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyQosMapDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap', + 'operation_id': 'create_policy_definition1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/{id}', + 'operation_id': 'delete_policy_definition1', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition1', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/{id}', + 'operation_id': 'edit_policy_definition1', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap', + 'operation_id': 'get_definitions1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/{id}', + 'operation_id': 'get_policy_definition1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/preview', + 'operation_id': 'preview_policy_definition1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/qosmap/bulk', + 'operation_id': 'save_policy_definition_in_bulk1', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition1( + self, + **kwargs + ): + """create_policy_definition1 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition1_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition1( + self, + id, + **kwargs + ): + """delete_policy_definition1 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition1_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition1( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition1 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition1_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition1( + self, + id, + **kwargs + ): + """edit_policy_definition1 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition1_endpoint.call_with_http_info(**kwargs) + + def get_definitions1( + self, + **kwargs + ): + """get_definitions1 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions1_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition1( + self, + id, + **kwargs + ): + """get_policy_definition1 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition1_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition1( + self, + **kwargs + ): + """preview_policy_definition1 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition1_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id1( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id1 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id1_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk1( + self, + **kwargs + ): + """save_policy_definition_in_bulk1 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk1_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_region_list_builder_api.py b/openapi_client/api/configuration_policy_region_list_builder_api.py new file mode 100644 index 0000000..dcc7ba9 --- /dev/null +++ b/openapi_client/api/configuration_policy_region_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyRegionListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list31_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/region', + 'operation_id': 'create_policy_list31', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list31_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/region/{id}', + 'operation_id': 'delete_policy_list31', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag31_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/region', + 'operation_id': 'delete_policy_lists_with_info_tag31', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list31_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/region/{id}', + 'operation_id': 'edit_policy_list31', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id31_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/region/{id}', + 'operation_id': 'get_lists_by_id31', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists28_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/region', + 'operation_id': 'get_policy_lists28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag31_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/region/filtered', + 'operation_id': 'get_policy_lists_with_info_tag31', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list31_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/region/preview', + 'operation_id': 'preview_policy_list31', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id31_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/region/preview/{id}', + 'operation_id': 'preview_policy_list_by_id31', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list31( + self, + **kwargs + ): + """create_policy_list31 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list31(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list31_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list31( + self, + id, + **kwargs + ): + """delete_policy_list31 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list31(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list31_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag31( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag31 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag31(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag31_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list31( + self, + id, + **kwargs + ): + """edit_policy_list31 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list31(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list31_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id31( + self, + id, + **kwargs + ): + """get_lists_by_id31 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id31(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id31_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists28( + self, + **kwargs + ): + """get_policy_lists28 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists28_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag31( + self, + **kwargs + ): + """get_policy_lists_with_info_tag31 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag31(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag31_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list31( + self, + **kwargs + ): + """preview_policy_list31 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list31(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list31_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id31( + self, + id, + **kwargs + ): + """preview_policy_list_by_id31 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id31(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id31_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_rewrite_rule_definition_builder_api.py b/openapi_client/api/configuration_policy_rewrite_rule_definition_builder_api.py new file mode 100644 index 0000000..b23db88 --- /dev/null +++ b/openapi_client/api/configuration_policy_rewrite_rule_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyRewriteRuleDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule', + 'operation_id': 'create_policy_definition19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition19_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/{id}', + 'operation_id': 'delete_policy_definition19', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition19', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/{id}', + 'operation_id': 'edit_policy_definition19', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule', + 'operation_id': 'get_definitions19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/{id}', + 'operation_id': 'get_policy_definition19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/preview', + 'operation_id': 'preview_policy_definition19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/rewriterule/bulk', + 'operation_id': 'save_policy_definition_in_bulk19', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition19( + self, + **kwargs + ): + """create_policy_definition19 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition19_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition19( + self, + id, + **kwargs + ): + """delete_policy_definition19 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition19_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition19( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition19 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition19_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition19( + self, + id, + **kwargs + ): + """edit_policy_definition19 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition19_endpoint.call_with_http_info(**kwargs) + + def get_definitions19( + self, + **kwargs + ): + """get_definitions19 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions19_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition19( + self, + id, + **kwargs + ): + """get_policy_definition19 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition19_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition19( + self, + **kwargs + ): + """preview_policy_definition19 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition19_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id19( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id19 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id19(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id19_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk19( + self, + **kwargs + ): + """save_policy_definition_in_bulk19 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk19_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_secure_internet_gateway_data_centers_builder_api.py b/openapi_client/api/configuration_policy_secure_internet_gateway_data_centers_builder_api.py new file mode 100644 index 0000000..91e1caa --- /dev/null +++ b/openapi_client/api/configuration_policy_secure_internet_gateway_data_centers_builder_api.py @@ -0,0 +1,190 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_sig_data_center_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sig/datacenters/{type}/{tunneltype}/{devicetype}', + 'operation_id': 'get_sig_data_center_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'tunneltype', + 'devicetype', + ], + 'required': [ + 'type', + 'tunneltype', + 'devicetype', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'tunneltype': + (str,), + 'devicetype': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'tunneltype': 'tunneltype', + 'devicetype': 'devicetype', + }, + 'location_map': { + 'type': 'path', + 'tunneltype': 'path', + 'devicetype': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_sig_data_center_list( + self, + type, + tunneltype, + devicetype, + **kwargs + ): + """get_sig_data_center_list # noqa: E501 + + Get list of data centers for zscaler or umbrella # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sig_data_center_list(type, tunneltype, devicetype, async_req=True) + >>> result = thread.get() + + Args: + type (str): Provider type + tunneltype (str): Type of the tunnel ipsec/gre + devicetype (str): Type of the device vedge/cedge + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + kwargs['tunneltype'] = \ + tunneltype + kwargs['devicetype'] = \ + devicetype + return self.get_sig_data_center_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_security_assembler_api.py b/openapi_client/api/configuration_policy_security_assembler_api.py new file mode 100644 index 0000000..718c965 --- /dev/null +++ b/openapi_client/api/configuration_policy_security_assembler_api.py @@ -0,0 +1,297 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicySecurityAssemblerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.preview_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/security', + 'operation_id': 'preview', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/security/{id}', + 'operation_id': 'preview_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def preview( + self, + **kwargs + ): + """preview # noqa: E501 + + Get policy assembly preview # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy assembly. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_endpoint.call_with_http_info(**kwargs) + + def preview_by_id( + self, + id, + **kwargs + ): + """preview_by_id # noqa: E501 + + Get policy assembly preview for feature policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_by_id_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_site_list_builder_api.py b/openapi_client/api/configuration_policy_site_list_builder_api.py new file mode 100644 index 0000000..e331fe3 --- /dev/null +++ b/openapi_client/api/configuration_policy_site_list_builder_api.py @@ -0,0 +1,1317 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicySiteListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_default_site_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/site/defaultsite', + 'operation_id': 'create_default_site_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_list32_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/site', + 'operation_id': 'create_policy_list32', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list32_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/site/{id}', + 'operation_id': 'delete_policy_list32', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag32_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/site', + 'operation_id': 'delete_policy_lists_with_info_tag32', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list32_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/site/{id}', + 'operation_id': 'edit_policy_list32', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id32_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/site/{id}', + 'operation_id': 'get_lists_by_id32', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists29_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/site', + 'operation_id': 'get_policy_lists29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag32_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/site/filtered', + 'operation_id': 'get_policy_lists_with_info_tag32', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list32_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/site/preview', + 'operation_id': 'preview_policy_list32', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id32_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/site/preview/{id}', + 'operation_id': 'preview_policy_list_by_id32', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_default_site_list( + self, + **kwargs + ): + """create_default_site_list # noqa: E501 + + Create default site list for sites missing from centralized policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_default_site_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_default_site_list_endpoint.call_with_http_info(**kwargs) + + def create_policy_list32( + self, + **kwargs + ): + """create_policy_list32 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list32(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list32_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list32( + self, + id, + **kwargs + ): + """delete_policy_list32 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list32(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list32_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag32( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag32 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag32(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag32_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list32( + self, + id, + **kwargs + ): + """edit_policy_list32 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list32(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list32_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id32( + self, + id, + **kwargs + ): + """get_lists_by_id32 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id32(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id32_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists29( + self, + **kwargs + ): + """get_policy_lists29 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists29_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag32( + self, + **kwargs + ): + """get_policy_lists_with_info_tag32 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag32(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag32_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list32( + self, + **kwargs + ): + """preview_policy_list32 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list32(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list32_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id32( + self, + id, + **kwargs + ): + """preview_policy_list_by_id32 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id32(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id32_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_sla_class_list_builder_api.py b/openapi_client/api/configuration_policy_sla_class_list_builder_api.py new file mode 100644 index 0000000..026a04e --- /dev/null +++ b/openapi_client/api/configuration_policy_sla_class_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicySLAClassListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list33_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla', + 'operation_id': 'create_policy_list33', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list33_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/sla/{id}', + 'operation_id': 'delete_policy_list33', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag33_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla', + 'operation_id': 'delete_policy_lists_with_info_tag33', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list33_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla/{id}', + 'operation_id': 'edit_policy_list33', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id33_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla/{id}', + 'operation_id': 'get_lists_by_id33', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists30_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla', + 'operation_id': 'get_policy_lists30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag33_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla/filtered', + 'operation_id': 'get_policy_lists_with_info_tag33', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list33_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla/preview', + 'operation_id': 'preview_policy_list33', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id33_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/sla/preview/{id}', + 'operation_id': 'preview_policy_list_by_id33', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list33( + self, + **kwargs + ): + """create_policy_list33 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list33(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list33_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list33( + self, + id, + **kwargs + ): + """delete_policy_list33 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list33(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list33_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag33( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag33 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag33(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag33_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list33( + self, + id, + **kwargs + ): + """edit_policy_list33 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list33(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list33_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id33( + self, + id, + **kwargs + ): + """get_lists_by_id33 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id33(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id33_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists30( + self, + **kwargs + ): + """get_policy_lists30 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists30_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag33( + self, + **kwargs + ): + """get_policy_lists_with_info_tag33 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag33(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag33_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list33( + self, + **kwargs + ): + """preview_policy_list33 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list33(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list33_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id33( + self, + id, + **kwargs + ): + """preview_policy_list_by_id33 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id33(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id33_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_supervisory_disc_list_builder_api.py b/openapi_client/api/configuration_policy_supervisory_disc_list_builder_api.py new file mode 100644 index 0000000..a6a6f98 --- /dev/null +++ b/openapi_client/api/configuration_policy_supervisory_disc_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicySupervisoryDiscListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list34_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc', + 'operation_id': 'create_policy_list34', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list34_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc/{id}', + 'operation_id': 'delete_policy_list34', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag34_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc', + 'operation_id': 'delete_policy_lists_with_info_tag34', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list34_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc/{id}', + 'operation_id': 'edit_policy_list34', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id34_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc/{id}', + 'operation_id': 'get_lists_by_id34', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists31_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc', + 'operation_id': 'get_policy_lists31', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag34_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc/filtered', + 'operation_id': 'get_policy_lists_with_info_tag34', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list34_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc/preview', + 'operation_id': 'preview_policy_list34', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id34_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/supervisorydisc/preview/{id}', + 'operation_id': 'preview_policy_list_by_id34', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list34( + self, + **kwargs + ): + """create_policy_list34 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list34(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list34_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list34( + self, + id, + **kwargs + ): + """delete_policy_list34 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list34(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list34_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag34( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag34 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag34(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag34_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list34( + self, + id, + **kwargs + ): + """edit_policy_list34 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list34(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list34_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id34( + self, + id, + **kwargs + ): + """get_lists_by_id34 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id34(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id34_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists31( + self, + **kwargs + ): + """get_policy_lists31 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists31(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists31_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag34( + self, + **kwargs + ): + """get_policy_lists_with_info_tag34 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag34(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag34_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list34( + self, + **kwargs + ): + """preview_policy_list34 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list34(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list34_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id34( + self, + id, + **kwargs + ): + """preview_policy_list_by_id34 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id34(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id34_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_threat_grid_api_key_list_api.py b/openapi_client/api/configuration_policy_threat_grid_api_key_list_api.py new file mode 100644 index 0000000..b145a4a --- /dev/null +++ b/openapi_client/api/configuration_policy_threat_grid_api_key_list_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyThreatGridApiKeyListApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list35_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey', + 'operation_id': 'create_policy_list35', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list35_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey/{id}', + 'operation_id': 'delete_policy_list35', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag35_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey', + 'operation_id': 'delete_policy_lists_with_info_tag35', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list35_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey/{id}', + 'operation_id': 'edit_policy_list35', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id35_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey/{id}', + 'operation_id': 'get_lists_by_id35', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists32_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey', + 'operation_id': 'get_policy_lists32', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag35_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey/filtered', + 'operation_id': 'get_policy_lists_with_info_tag35', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list35_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey/preview', + 'operation_id': 'preview_policy_list35', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id35_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tgapikey/preview/{id}', + 'operation_id': 'preview_policy_list_by_id35', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list35( + self, + **kwargs + ): + """create_policy_list35 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list35(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list35_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list35( + self, + id, + **kwargs + ): + """delete_policy_list35 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list35(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list35_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag35( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag35 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag35(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag35_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list35( + self, + id, + **kwargs + ): + """edit_policy_list35 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list35(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list35_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id35( + self, + id, + **kwargs + ): + """get_lists_by_id35 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id35(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id35_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists32( + self, + **kwargs + ): + """get_policy_lists32 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists32(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists32_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag35( + self, + **kwargs + ): + """get_policy_lists_with_info_tag35 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag35(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag35_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list35( + self, + **kwargs + ): + """preview_policy_list35 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list35(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list35_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id35( + self, + id, + **kwargs + ): + """preview_policy_list_by_id35 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id35(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id35_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_tloc_list_builder_api.py b/openapi_client/api/configuration_policy_tloc_list_builder_api.py new file mode 100644 index 0000000..548fef4 --- /dev/null +++ b/openapi_client/api/configuration_policy_tloc_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyTLOCListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list36_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc', + 'operation_id': 'create_policy_list36', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list36_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc/{id}', + 'operation_id': 'delete_policy_list36', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag36_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc', + 'operation_id': 'delete_policy_lists_with_info_tag36', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list36_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc/{id}', + 'operation_id': 'edit_policy_list36', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id36_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc/{id}', + 'operation_id': 'get_lists_by_id36', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists33_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc', + 'operation_id': 'get_policy_lists33', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag36_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc/filtered', + 'operation_id': 'get_policy_lists_with_info_tag36', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list36_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc/preview', + 'operation_id': 'preview_policy_list36', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id36_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/tloc/preview/{id}', + 'operation_id': 'preview_policy_list_by_id36', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list36( + self, + **kwargs + ): + """create_policy_list36 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list36(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list36_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list36( + self, + id, + **kwargs + ): + """delete_policy_list36 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list36(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list36_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag36( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag36 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag36(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag36_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list36( + self, + id, + **kwargs + ): + """edit_policy_list36 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list36(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list36_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id36( + self, + id, + **kwargs + ): + """get_lists_by_id36 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id36(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id36_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists33( + self, + **kwargs + ): + """get_policy_lists33 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists33(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists33_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag36( + self, + **kwargs + ): + """get_policy_lists_with_info_tag36 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag36(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag36_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list36( + self, + **kwargs + ): + """preview_policy_list36 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list36(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list36_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id36( + self, + id, + **kwargs + ): + """preview_policy_list_by_id36 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id36(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id36_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_translation_profile_list_builder_api.py b/openapi_client/api/configuration_policy_translation_profile_list_builder_api.py new file mode 100644 index 0000000..bcfe2fe --- /dev/null +++ b/openapi_client/api/configuration_policy_translation_profile_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyTranslationProfileListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile', + 'operation_id': 'create_policy_list1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile/{id}', + 'operation_id': 'delete_policy_list1', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag1_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile', + 'operation_id': 'delete_policy_lists_with_info_tag1', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile/{id}', + 'operation_id': 'edit_policy_list1', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile/{id}', + 'operation_id': 'get_lists_by_id1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists1_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile', + 'operation_id': 'get_policy_lists1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag1_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile/filtered', + 'operation_id': 'get_policy_lists_with_info_tag1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile/preview', + 'operation_id': 'preview_policy_list1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationprofile/preview/{id}', + 'operation_id': 'preview_policy_list_by_id1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list1( + self, + **kwargs + ): + """create_policy_list1 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list1_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list1( + self, + id, + **kwargs + ): + """delete_policy_list1 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list1_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag1( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag1 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag1_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list1( + self, + id, + **kwargs + ): + """edit_policy_list1 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list1_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id1( + self, + id, + **kwargs + ): + """get_lists_by_id1 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id1_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists1( + self, + **kwargs + ): + """get_policy_lists1 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists1_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag1( + self, + **kwargs + ): + """get_policy_lists_with_info_tag1 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag1_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list1( + self, + **kwargs + ): + """preview_policy_list1 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list1_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id1( + self, + id, + **kwargs + ): + """preview_policy_list_by_id1 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id1_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_translation_rules_list_builder_api.py b/openapi_client/api/configuration_policy_translation_rules_list_builder_api.py new file mode 100644 index 0000000..47217ba --- /dev/null +++ b/openapi_client/api/configuration_policy_translation_rules_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyTranslationRulesListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules', + 'operation_id': 'create_policy_list2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list2_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules/{id}', + 'operation_id': 'delete_policy_list2', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag2_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules', + 'operation_id': 'delete_policy_lists_with_info_tag2', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules/{id}', + 'operation_id': 'edit_policy_list2', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules/{id}', + 'operation_id': 'get_lists_by_id2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists2_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules', + 'operation_id': 'get_policy_lists2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag2_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules/filtered', + 'operation_id': 'get_policy_lists_with_info_tag2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules/preview', + 'operation_id': 'preview_policy_list2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/translationrules/preview/{id}', + 'operation_id': 'preview_policy_list_by_id2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list2( + self, + **kwargs + ): + """create_policy_list2 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list2_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list2( + self, + id, + **kwargs + ): + """delete_policy_list2 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list2_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag2( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag2 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag2_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list2( + self, + id, + **kwargs + ): + """edit_policy_list2 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list2_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id2( + self, + id, + **kwargs + ): + """get_lists_by_id2 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id2_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists2( + self, + **kwargs + ): + """get_policy_lists2 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists2_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag2( + self, + **kwargs + ): + """get_policy_lists_with_info_tag2 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag2_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list2( + self, + **kwargs + ): + """preview_policy_list2 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list2_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id2( + self, + id, + **kwargs + ): + """preview_policy_list_by_id2 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id2_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_trunk_group_list_builder_api.py b/openapi_client/api/configuration_policy_trunk_group_list_builder_api.py new file mode 100644 index 0000000..2732340 --- /dev/null +++ b/openapi_client/api/configuration_policy_trunk_group_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyTrunkGroupListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list37_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup', + 'operation_id': 'create_policy_list37', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list37_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup/{id}', + 'operation_id': 'delete_policy_list37', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag37_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup', + 'operation_id': 'delete_policy_lists_with_info_tag37', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list37_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup/{id}', + 'operation_id': 'edit_policy_list37', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id37_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup/{id}', + 'operation_id': 'get_lists_by_id37', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists34_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup', + 'operation_id': 'get_policy_lists34', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag37_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup/filtered', + 'operation_id': 'get_policy_lists_with_info_tag37', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list37_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup/preview', + 'operation_id': 'preview_policy_list37', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id37_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/trunkgroup/preview/{id}', + 'operation_id': 'preview_policy_list_by_id37', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list37( + self, + **kwargs + ): + """create_policy_list37 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list37(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list37_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list37( + self, + id, + **kwargs + ): + """delete_policy_list37 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list37(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list37_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag37( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag37 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag37(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag37_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list37( + self, + id, + **kwargs + ): + """edit_policy_list37 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list37(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list37_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id37( + self, + id, + **kwargs + ): + """get_lists_by_id37 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id37(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id37_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists34( + self, + **kwargs + ): + """get_policy_lists34 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists34(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists34_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag37( + self, + **kwargs + ): + """get_policy_lists_with_info_tag37 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag37(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag37_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list37( + self, + **kwargs + ): + """preview_policy_list37 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list37(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list37_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id37( + self, + id, + **kwargs + ): + """preview_policy_list_by_id37 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id37(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id37_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_umbrella_data_list_builder_api.py b/openapi_client/api/configuration_policy_umbrella_data_list_builder_api.py new file mode 100644 index 0000000..4ff22b2 --- /dev/null +++ b/openapi_client/api/configuration_policy_umbrella_data_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyUmbrellaDataListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list38_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata', + 'operation_id': 'create_policy_list38', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list38_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata/{id}', + 'operation_id': 'delete_policy_list38', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag38_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata', + 'operation_id': 'delete_policy_lists_with_info_tag38', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list38_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata/{id}', + 'operation_id': 'edit_policy_list38', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id38_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata/{id}', + 'operation_id': 'get_lists_by_id38', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists35_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata', + 'operation_id': 'get_policy_lists35', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag38_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata/filtered', + 'operation_id': 'get_policy_lists_with_info_tag38', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list38_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata/preview', + 'operation_id': 'preview_policy_list38', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id38_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/umbrelladata/preview/{id}', + 'operation_id': 'preview_policy_list_by_id38', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list38( + self, + **kwargs + ): + """create_policy_list38 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list38(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list38_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list38( + self, + id, + **kwargs + ): + """delete_policy_list38 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list38(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list38_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag38( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag38 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag38(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag38_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list38( + self, + id, + **kwargs + ): + """edit_policy_list38 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list38(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list38_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id38( + self, + id, + **kwargs + ): + """get_lists_by_id38 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id38(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id38_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists35( + self, + **kwargs + ): + """get_policy_lists35 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists35(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists35_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag38( + self, + **kwargs + ): + """get_policy_lists_with_info_tag38 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag38(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag38_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list38( + self, + **kwargs + ): + """preview_policy_list38 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list38(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list38_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id38( + self, + id, + **kwargs + ): + """preview_policy_list_by_id38 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id38(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id38_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_url_black_list_builder_api.py b/openapi_client/api/configuration_policy_url_black_list_builder_api.py new file mode 100644 index 0000000..51c58a0 --- /dev/null +++ b/openapi_client/api/configuration_policy_url_black_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyURLBlackListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list39_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist', + 'operation_id': 'create_policy_list39', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list39_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist/{id}', + 'operation_id': 'delete_policy_list39', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag39_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist', + 'operation_id': 'delete_policy_lists_with_info_tag39', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list39_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist/{id}', + 'operation_id': 'edit_policy_list39', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id39_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist/{id}', + 'operation_id': 'get_lists_by_id39', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists36_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist', + 'operation_id': 'get_policy_lists36', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag39_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist/filtered', + 'operation_id': 'get_policy_lists_with_info_tag39', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list39_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist/preview', + 'operation_id': 'preview_policy_list39', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id39_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlblacklist/preview/{id}', + 'operation_id': 'preview_policy_list_by_id39', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list39( + self, + **kwargs + ): + """create_policy_list39 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list39(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list39_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list39( + self, + id, + **kwargs + ): + """delete_policy_list39 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list39(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list39_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag39( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag39 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag39(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag39_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list39( + self, + id, + **kwargs + ): + """edit_policy_list39 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list39(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list39_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id39( + self, + id, + **kwargs + ): + """get_lists_by_id39 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id39(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id39_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists36( + self, + **kwargs + ): + """get_policy_lists36 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists36(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists36_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag39( + self, + **kwargs + ): + """get_policy_lists_with_info_tag39 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag39(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag39_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list39( + self, + **kwargs + ): + """preview_policy_list39 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list39(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list39_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id39( + self, + id, + **kwargs + ): + """preview_policy_list_by_id39 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id39(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id39_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_url_filtering_definition_builder_api.py b/openapi_client/api/configuration_policy_url_filtering_definition_builder_api.py new file mode 100644 index 0000000..9af7003 --- /dev/null +++ b/openapi_client/api/configuration_policy_url_filtering_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyURLFilteringDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering', + 'operation_id': 'create_policy_definition23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition23_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/{id}', + 'operation_id': 'delete_policy_definition23', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition23', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/{id}', + 'operation_id': 'edit_policy_definition23', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering', + 'operation_id': 'get_definitions23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/{id}', + 'operation_id': 'get_policy_definition23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/preview', + 'operation_id': 'preview_policy_definition23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/urlfiltering/bulk', + 'operation_id': 'save_policy_definition_in_bulk23', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition23( + self, + **kwargs + ): + """create_policy_definition23 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition23_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition23( + self, + id, + **kwargs + ): + """delete_policy_definition23 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition23_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition23( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition23 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition23_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition23( + self, + id, + **kwargs + ): + """edit_policy_definition23 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition23_endpoint.call_with_http_info(**kwargs) + + def get_definitions23( + self, + **kwargs + ): + """get_definitions23 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions23_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition23( + self, + id, + **kwargs + ): + """get_policy_definition23 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition23_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition23( + self, + **kwargs + ): + """preview_policy_definition23 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition23_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id23( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id23 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id23(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id23_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk23( + self, + **kwargs + ): + """save_policy_definition_in_bulk23 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk23_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_url_white_list_builder_api.py b/openapi_client/api/configuration_policy_url_white_list_builder_api.py new file mode 100644 index 0000000..d9300b1 --- /dev/null +++ b/openapi_client/api/configuration_policy_url_white_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyURLWhiteListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list40_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist', + 'operation_id': 'create_policy_list40', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list40_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist/{id}', + 'operation_id': 'delete_policy_list40', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag40_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist', + 'operation_id': 'delete_policy_lists_with_info_tag40', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list40_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist/{id}', + 'operation_id': 'edit_policy_list40', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id40_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist/{id}', + 'operation_id': 'get_lists_by_id40', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists37_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist', + 'operation_id': 'get_policy_lists37', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag40_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist/filtered', + 'operation_id': 'get_policy_lists_with_info_tag40', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list40_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist/preview', + 'operation_id': 'preview_policy_list40', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id40_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/urlwhitelist/preview/{id}', + 'operation_id': 'preview_policy_list_by_id40', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list40( + self, + **kwargs + ): + """create_policy_list40 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list40(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list40_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list40( + self, + id, + **kwargs + ): + """delete_policy_list40 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list40(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list40_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag40( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag40 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag40(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag40_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list40( + self, + id, + **kwargs + ): + """edit_policy_list40 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list40(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list40_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id40( + self, + id, + **kwargs + ): + """get_lists_by_id40 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id40(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id40_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists37( + self, + **kwargs + ): + """get_policy_lists37 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists37(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists37_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag40( + self, + **kwargs + ): + """get_policy_lists_with_info_tag40 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag40(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag40_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list40( + self, + **kwargs + ): + """preview_policy_list40 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list40(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list40_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id40( + self, + id, + **kwargs + ): + """preview_policy_list_by_id40 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id40(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id40_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_v_edge_assembler_api.py b/openapi_client/api/configuration_policy_v_edge_assembler_api.py new file mode 100644 index 0000000..4e52535 --- /dev/null +++ b/openapi_client/api/configuration_policy_v_edge_assembler_api.py @@ -0,0 +1,297 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVEdgeAssemblerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.preview1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/vedge', + 'operation_id': 'preview1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_by_id1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/vedge/{id}', + 'operation_id': 'preview_by_id1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def preview1( + self, + **kwargs + ): + """preview1 # noqa: E501 + + Get policy assembly preview # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy assembly. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview1_endpoint.call_with_http_info(**kwargs) + + def preview_by_id1( + self, + id, + **kwargs + ): + """preview_by_id1 # noqa: E501 + + Get policy assembly preview for feature policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_by_id1(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_by_id1_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_v_edge_route_definition_builder_api.py b/openapi_client/api/configuration_policy_v_edge_route_definition_builder_api.py new file mode 100644 index 0000000..bc732b1 --- /dev/null +++ b/openapi_client/api/configuration_policy_v_edge_route_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVEdgeRouteDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute', + 'operation_id': 'create_policy_definition24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition24_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/{id}', + 'operation_id': 'delete_policy_definition24', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition24', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/{id}', + 'operation_id': 'edit_policy_definition24', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute', + 'operation_id': 'get_definitions24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/{id}', + 'operation_id': 'get_policy_definition24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/preview', + 'operation_id': 'preview_policy_definition24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vedgeroute/bulk', + 'operation_id': 'save_policy_definition_in_bulk24', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition24( + self, + **kwargs + ): + """create_policy_definition24 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition24_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition24( + self, + id, + **kwargs + ): + """delete_policy_definition24 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition24_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition24( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition24 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition24_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition24( + self, + id, + **kwargs + ): + """edit_policy_definition24 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition24_endpoint.call_with_http_info(**kwargs) + + def get_definitions24( + self, + **kwargs + ): + """get_definitions24 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions24_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition24( + self, + id, + **kwargs + ): + """get_policy_definition24 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition24_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition24( + self, + **kwargs + ): + """preview_policy_definition24 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition24_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id24( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id24 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id24(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id24_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk24( + self, + **kwargs + ): + """save_policy_definition_in_bulk24 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk24_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_v_smart_assembler_api.py b/openapi_client/api/configuration_policy_v_smart_assembler_api.py new file mode 100644 index 0000000..36e6335 --- /dev/null +++ b/openapi_client/api/configuration_policy_v_smart_assembler_api.py @@ -0,0 +1,297 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVSmartAssemblerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.preview3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/vsmart', + 'operation_id': 'preview3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_by_id3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/vsmart/{id}', + 'operation_id': 'preview_by_id3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def preview3( + self, + **kwargs + ): + """preview3 # noqa: E501 + + Get policy assembly preview # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy assembly. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview3_endpoint.call_with_http_info(**kwargs) + + def preview_by_id3( + self, + id, + **kwargs + ): + """preview_by_id3 # noqa: E501 + + Get policy assembly preview for feature policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_by_id3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_by_id3_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_voice_assembler_api.py b/openapi_client/api/configuration_policy_voice_assembler_api.py new file mode 100644 index 0000000..a42d74b --- /dev/null +++ b/openapi_client/api/configuration_policy_voice_assembler_api.py @@ -0,0 +1,297 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVoiceAssemblerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.preview2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/voice', + 'operation_id': 'preview2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_by_id2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/assembly/voice/{id}', + 'operation_id': 'preview_by_id2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def preview2( + self, + **kwargs + ): + """preview2 # noqa: E501 + + Get policy assembly preview # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy assembly. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview2_endpoint.call_with_http_info(**kwargs) + + def preview_by_id2( + self, + id, + **kwargs + ): + """preview_by_id2 # noqa: E501 + + Get policy assembly preview for feature policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_by_id2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_by_id2_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_vpn_list_builder_api.py b/openapi_client/api/configuration_policy_vpn_list_builder_api.py new file mode 100644 index 0000000..b87b35c --- /dev/null +++ b/openapi_client/api/configuration_policy_vpn_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVPNListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list41_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn', + 'operation_id': 'create_policy_list41', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list41_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn/{id}', + 'operation_id': 'delete_policy_list41', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag41_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn', + 'operation_id': 'delete_policy_lists_with_info_tag41', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list41_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn/{id}', + 'operation_id': 'edit_policy_list41', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id41_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn/{id}', + 'operation_id': 'get_lists_by_id41', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists38_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn', + 'operation_id': 'get_policy_lists38', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag41_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn/filtered', + 'operation_id': 'get_policy_lists_with_info_tag41', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list41_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn/preview', + 'operation_id': 'preview_policy_list41', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id41_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/vpn/preview/{id}', + 'operation_id': 'preview_policy_list_by_id41', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list41( + self, + **kwargs + ): + """create_policy_list41 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list41(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list41_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list41( + self, + id, + **kwargs + ): + """delete_policy_list41 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list41(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list41_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag41( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag41 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag41(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag41_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list41( + self, + id, + **kwargs + ): + """edit_policy_list41 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list41(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list41_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id41( + self, + id, + **kwargs + ): + """get_lists_by_id41 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id41(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id41_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists38( + self, + **kwargs + ): + """get_policy_lists38 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists38(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists38_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag41( + self, + **kwargs + ): + """get_policy_lists_with_info_tag41 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag41(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag41_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list41( + self, + **kwargs + ): + """preview_policy_list41 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list41(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list41_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id41( + self, + id, + **kwargs + ): + """preview_policy_list_by_id41 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id41(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id41_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_vpn_membership_group_definition_builder_api.py b/openapi_client/api/configuration_policy_vpn_membership_group_definition_builder_api.py new file mode 100644 index 0000000..067db5d --- /dev/null +++ b/openapi_client/api/configuration_policy_vpn_membership_group_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup', + 'operation_id': 'create_policy_definition6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition6_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/{id}', + 'operation_id': 'delete_policy_definition6', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition6', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/{id}', + 'operation_id': 'edit_policy_definition6', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup', + 'operation_id': 'get_definitions6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/{id}', + 'operation_id': 'get_policy_definition6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/preview', + 'operation_id': 'preview_policy_definition6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnmembershipgroup/bulk', + 'operation_id': 'save_policy_definition_in_bulk6', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition6( + self, + **kwargs + ): + """create_policy_definition6 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition6_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition6( + self, + id, + **kwargs + ): + """delete_policy_definition6 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition6_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition6( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition6 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition6_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition6( + self, + id, + **kwargs + ): + """edit_policy_definition6 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition6_endpoint.call_with_http_info(**kwargs) + + def get_definitions6( + self, + **kwargs + ): + """get_definitions6 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions6_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition6( + self, + id, + **kwargs + ): + """get_policy_definition6 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition6_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition6( + self, + **kwargs + ): + """preview_policy_definition6 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition6_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id6( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id6 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id6(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id6_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk6( + self, + **kwargs + ): + """save_policy_definition_in_bulk6 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk6_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_vpn_qos_map_definition_builder_api.py b/openapi_client/api/configuration_policy_vpn_qos_map_definition_builder_api.py new file mode 100644 index 0000000..06adedd --- /dev/null +++ b/openapi_client/api/configuration_policy_vpn_qos_map_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyVPNQosMapDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap', + 'operation_id': 'create_policy_definition2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition2_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/{id}', + 'operation_id': 'delete_policy_definition2', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition2', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/{id}', + 'operation_id': 'edit_policy_definition2', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap', + 'operation_id': 'get_definitions2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/{id}', + 'operation_id': 'get_policy_definition2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/preview', + 'operation_id': 'preview_policy_definition2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/vpnqosmap/bulk', + 'operation_id': 'save_policy_definition_in_bulk2', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition2( + self, + **kwargs + ): + """create_policy_definition2 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition2_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition2( + self, + id, + **kwargs + ): + """delete_policy_definition2 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition2_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition2( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition2 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition2_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition2( + self, + id, + **kwargs + ): + """edit_policy_definition2 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition2_endpoint.call_with_http_info(**kwargs) + + def get_definitions2( + self, + **kwargs + ): + """get_definitions2 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions2_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition2( + self, + id, + **kwargs + ): + """get_policy_definition2 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition2_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition2( + self, + **kwargs + ): + """preview_policy_definition2 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition2_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id2( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id2 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id2(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id2_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk2( + self, + **kwargs + ): + """save_policy_definition_in_bulk2 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk2_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_zone_based_firewall_definition_builder_api.py b/openapi_client/api/configuration_policy_zone_based_firewall_definition_builder_api.py new file mode 100644 index 0000000..80a1bbb --- /dev/null +++ b/openapi_client/api/configuration_policy_zone_based_firewall_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw', + 'operation_id': 'create_policy_definition7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition7_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/{id}', + 'operation_id': 'delete_policy_definition7', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition7', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/{id}', + 'operation_id': 'edit_policy_definition7', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw', + 'operation_id': 'get_definitions7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/{id}', + 'operation_id': 'get_policy_definition7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/preview', + 'operation_id': 'preview_policy_definition7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/zonebasedfw/bulk', + 'operation_id': 'save_policy_definition_in_bulk7', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition7( + self, + **kwargs + ): + """create_policy_definition7 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition7_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition7( + self, + id, + **kwargs + ): + """delete_policy_definition7 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition7_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition7( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition7 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition7_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition7( + self, + id, + **kwargs + ): + """edit_policy_definition7 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition7_endpoint.call_with_http_info(**kwargs) + + def get_definitions7( + self, + **kwargs + ): + """get_definitions7 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions7_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition7( + self, + id, + **kwargs + ): + """get_policy_definition7 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition7_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition7( + self, + **kwargs + ): + """preview_policy_definition7 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition7_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id7( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id7 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id7(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id7_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk7( + self, + **kwargs + ): + """save_policy_definition_in_bulk7 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk7_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_policy_zone_list_builder_api.py b/openapi_client/api/configuration_policy_zone_list_builder_api.py new file mode 100644 index 0000000..a4f8bc0 --- /dev/null +++ b/openapi_client/api/configuration_policy_zone_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPolicyZoneListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list42_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone', + 'operation_id': 'create_policy_list42', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list42_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/zone/{id}', + 'operation_id': 'delete_policy_list42', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag42_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone', + 'operation_id': 'delete_policy_lists_with_info_tag42', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list42_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone/{id}', + 'operation_id': 'edit_policy_list42', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id42_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone/{id}', + 'operation_id': 'get_lists_by_id42', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists39_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone', + 'operation_id': 'get_policy_lists39', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag42_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone/filtered', + 'operation_id': 'get_policy_lists_with_info_tag42', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list42_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone/preview', + 'operation_id': 'preview_policy_list42', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id42_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/zone/preview/{id}', + 'operation_id': 'preview_policy_list_by_id42', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list42( + self, + **kwargs + ): + """create_policy_list42 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list42(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list42_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list42( + self, + id, + **kwargs + ): + """delete_policy_list42 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list42(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list42_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag42( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag42 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag42(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag42_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list42( + self, + id, + **kwargs + ): + """edit_policy_list42 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list42(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list42_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id42( + self, + id, + **kwargs + ): + """get_lists_by_id42 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id42(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id42_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists39( + self, + **kwargs + ): + """get_policy_lists39 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists39(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists39_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag42( + self, + **kwargs + ): + """get_policy_lists_with_info_tag42 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag42(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag42_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list42( + self, + **kwargs + ): + """preview_policy_list42 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list42(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list42_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id42( + self, + id, + **kwargs + ): + """preview_policy_list_by_id42 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id42(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id42_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_pre_upgrade_check_status_api.py b/openapi_client/api/configuration_pre_upgrade_check_status_api.py new file mode 100644 index 0000000..9d1bb25 --- /dev/null +++ b/openapi_client/api/configuration_pre_upgrade_check_status_api.py @@ -0,0 +1,162 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class ConfigurationPreUpgradeCheckStatusApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.update_pre_upgrade_check_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/status/preupgrade/check', + 'operation_id': 'update_pre_upgrade_check_status', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def update_pre_upgrade_check_status( + self, + **kwargs + ): + """update_pre_upgrade_check_status # noqa: E501 + + Update pre upgrade check status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_pre_upgrade_check_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_pre_upgrade_check_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_preferred_color_group_list_builder_api.py b/openapi_client/api/configuration_preferred_color_group_list_builder_api.py new file mode 100644 index 0000000..87824e1 --- /dev/null +++ b/openapi_client/api/configuration_preferred_color_group_list_builder_api.py @@ -0,0 +1,1197 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationPreferredColorGroupListBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_list28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup', + 'operation_id': 'create_policy_list28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_list28_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup/{id}', + 'operation_id': 'delete_policy_list28', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_policy_lists_with_info_tag28_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup', + 'operation_id': 'delete_policy_lists_with_info_tag28', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_policy_list28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup/{id}', + 'operation_id': 'edit_policy_list28', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_lists_by_id28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup/{id}', + 'operation_id': 'get_lists_by_id28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists25_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup', + 'operation_id': 'get_policy_lists25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_lists_with_info_tag28_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup/filtered', + 'operation_id': 'get_policy_lists_with_info_tag28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'info_tag', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'info_tag': + (str,), + }, + 'attribute_map': { + 'info_tag': 'infoTag', + }, + 'location_map': { + 'info_tag': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_list28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup/preview', + 'operation_id': 'preview_policy_list28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_list_by_id28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/list/preferredcolorgroup/preview/{id}', + 'operation_id': 'preview_policy_list_by_id28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_policy_list28( + self, + **kwargs + ): + """create_policy_list28 # noqa: E501 + + Create policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_list28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_list28_endpoint.call_with_http_info(**kwargs) + + def delete_policy_list28( + self, + id, + **kwargs + ): + """delete_policy_list28 # noqa: E501 + + Delete policy list entry for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_list28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_list28_endpoint.call_with_http_info(**kwargs) + + def delete_policy_lists_with_info_tag28( + self, + **kwargs + ): + """delete_policy_lists_with_info_tag28 # noqa: E501 + + Delete policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_lists_with_info_tag28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_policy_lists_with_info_tag28_endpoint.call_with_http_info(**kwargs) + + def edit_policy_list28( + self, + id, + **kwargs + ): + """edit_policy_list28 # noqa: E501 + + Edit policy list entries for a specific type of policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_list28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_list28_endpoint.call_with_http_info(**kwargs) + + def get_lists_by_id28( + self, + id, + **kwargs + ): + """get_lists_by_id28 # noqa: E501 + + Get a specific policy list based on the id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_lists_by_id28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_lists_by_id28_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists25( + self, + **kwargs + ): + """get_policy_lists25 # noqa: E501 + + Get policy lists # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists25_endpoint.call_with_http_info(**kwargs) + + def get_policy_lists_with_info_tag28( + self, + **kwargs + ): + """get_policy_lists_with_info_tag28 # noqa: E501 + + Get policy lists with specific info tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_lists_with_info_tag28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + info_tag (str): InfoTag. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_policy_lists_with_info_tag28_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list28( + self, + **kwargs + ): + """preview_policy_list28 # noqa: E501 + + Preview a policy list based on the policy list type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_list28_endpoint.call_with_http_info(**kwargs) + + def preview_policy_list_by_id28( + self, + id, + **kwargs + ): + """preview_policy_list_by_id28 # noqa: E501 + + Preview a specific policy list entry based on id provided # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_list_by_id28(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_list_by_id28_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_quick_connect_api.py b/openapi_client/api/configuration_quick_connect_api.py new file mode 100644 index 0000000..2b9fee7 --- /dev/null +++ b/openapi_client/api/configuration_quick_connect_api.py @@ -0,0 +1,164 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class ConfigurationQuickConnectApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.submit_day0_config_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/config/quickConnect/submitDevices', + 'operation_id': 'submit_day0_config', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def submit_day0_config( + self, + **kwargs + ): + """submit_day0_config # noqa: E501 + + Creates and pushes bootstrap configurations onto day0 devices. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.submit_day0_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.submit_day0_config_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_rule_set_definition_api.py b/openapi_client/api/configuration_rule_set_definition_api.py new file mode 100644 index 0000000..0c9a90b --- /dev/null +++ b/openapi_client/api/configuration_rule_set_definition_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationRuleSetDefinitionApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset', + 'operation_id': 'create_policy_definition20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition20_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/{id}', + 'operation_id': 'delete_policy_definition20', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition20', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/{id}', + 'operation_id': 'edit_policy_definition20', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset', + 'operation_id': 'get_definitions20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/{id}', + 'operation_id': 'get_policy_definition20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/preview', + 'operation_id': 'preview_policy_definition20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ruleset/bulk', + 'operation_id': 'save_policy_definition_in_bulk20', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition20( + self, + **kwargs + ): + """create_policy_definition20 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition20_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition20( + self, + id, + **kwargs + ): + """delete_policy_definition20 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition20_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition20( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition20 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition20_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition20( + self, + id, + **kwargs + ): + """edit_policy_definition20 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition20_endpoint.call_with_http_info(**kwargs) + + def get_definitions20( + self, + **kwargs + ): + """get_definitions20 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions20_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition20( + self, + id, + **kwargs + ): + """get_policy_definition20 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition20_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition20( + self, + **kwargs + ): + """preview_policy_definition20 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition20_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id20( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id20 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id20(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id20_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk20( + self, + **kwargs + ): + """save_policy_definition_in_bulk20 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk20_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_secure_internet_gateway_tunnels_api.py b/openapi_client/api/configuration_secure_internet_gateway_tunnels_api.py new file mode 100644 index 0000000..ae6cbf9 --- /dev/null +++ b/openapi_client/api/configuration_secure_internet_gateway_tunnels_api.py @@ -0,0 +1,168 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSecureInternetGatewayTunnelsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_sig_tunnel_list1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/cloudx/sig_tunnels', + 'operation_id': 'get_sig_tunnel_list1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def get_sig_tunnel_list1( + self, + device_id, + **kwargs + ): + """get_sig_tunnel_list1 # noqa: E501 + + Get Secure Internet Gateway Tunnel List # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sig_tunnel_list1(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sig_tunnel_list1_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_security_group_definition_api.py b/openapi_client/api/configuration_security_group_definition_api.py new file mode 100644 index 0000000..2a1d814 --- /dev/null +++ b/openapi_client/api/configuration_security_group_definition_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSecurityGroupDefinitionApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup', + 'operation_id': 'create_policy_definition21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition21_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/{id}', + 'operation_id': 'delete_policy_definition21', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition21', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/{id}', + 'operation_id': 'edit_policy_definition21', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup', + 'operation_id': 'get_definitions21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/{id}', + 'operation_id': 'get_policy_definition21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/preview', + 'operation_id': 'preview_policy_definition21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/securitygroup/bulk', + 'operation_id': 'save_policy_definition_in_bulk21', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition21( + self, + **kwargs + ): + """create_policy_definition21 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition21_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition21( + self, + id, + **kwargs + ): + """delete_policy_definition21 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition21_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition21( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition21 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition21_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition21( + self, + id, + **kwargs + ): + """edit_policy_definition21 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition21_endpoint.call_with_http_info(**kwargs) + + def get_definitions21( + self, + **kwargs + ): + """get_definitions21 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions21_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition21( + self, + id, + **kwargs + ): + """get_policy_definition21 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition21_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition21( + self, + **kwargs + ): + """preview_policy_definition21 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition21_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id21( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id21 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id21(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id21_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk21( + self, + **kwargs + ): + """save_policy_definition_in_bulk21 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk21_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_security_template_policy_api.py b/openapi_client/api/configuration_security_template_policy_api.py new file mode 100644 index 0000000..16ead9e --- /dev/null +++ b/openapi_client/api/configuration_security_template_policy_api.py @@ -0,0 +1,1334 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_model import DeviceModel + + +class ConfigurationSecurityTemplatePolicyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_security_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/security', + 'operation_id': 'create_security_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_security_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/security/{policyId}', + 'operation_id': 'delete_security_template', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_security_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/security/{policyId}', + 'operation_id': 'edit_security_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_template_with_lenient_lock_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/security/staging/{policyId}', + 'operation_id': 'edit_template_with_lenient_lock', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_security_policy_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/security/summary', + 'operation_id': 'generate_security_policy_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_security_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/security', + 'operation_id': 'generate_security_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'mode', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'mode': + (str,), + }, + 'attribute_map': { + 'mode': 'mode', + }, + 'location_map': { + 'mode': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_list_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/security/devices/{policyId}', + 'operation_id': 'get_device_list_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_security_policy_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/security/devices', + 'operation_id': 'get_security_policy_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_security_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/security/definition/{policyId}', + 'operation_id': 'get_security_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_security_templates_for_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/security/{deviceModel}', + 'operation_id': 'get_security_templates_for_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_model', + ], + 'required': [ + 'device_model', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_model': + (DeviceModel,), + }, + 'attribute_map': { + 'device_model': 'deviceModel', + }, + 'location_map': { + 'device_model': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_security_template( + self, + **kwargs + ): + """create_security_template # noqa: E501 + + Create Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_security_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_security_template_endpoint.call_with_http_info(**kwargs) + + def delete_security_template( + self, + policy_id, + **kwargs + ): + """delete_security_template # noqa: E501 + + Delete Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_security_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.delete_security_template_endpoint.call_with_http_info(**kwargs) + + def edit_security_template( + self, + policy_id, + **kwargs + ): + """edit_security_template # noqa: E501 + + Edit Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_security_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.edit_security_template_endpoint.call_with_http_info(**kwargs) + + def edit_template_with_lenient_lock( + self, + policy_id, + **kwargs + ): + """edit_template_with_lenient_lock # noqa: E501 + + Edit Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_template_with_lenient_lock(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.edit_template_with_lenient_lock_endpoint.call_with_http_info(**kwargs) + + def generate_security_policy_summary( + self, + **kwargs + ): + """generate_security_policy_summary # noqa: E501 + + Generate security policy summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_security_policy_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_security_policy_summary_endpoint.call_with_http_info(**kwargs) + + def generate_security_template_list( + self, + **kwargs + ): + """generate_security_template_list # noqa: E501 + + Generate template list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_security_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + mode (str): Mode. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_security_template_list_endpoint.call_with_http_info(**kwargs) + + def get_device_list_by_id( + self, + policy_id, + **kwargs + ): + """get_device_list_by_id # noqa: E501 + + Get device list by Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_list_by_id(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_device_list_by_id_endpoint.call_with_http_info(**kwargs) + + def get_security_policy_device_list( + self, + **kwargs + ): + """get_security_policy_device_list # noqa: E501 + + Get device list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_security_policy_device_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_security_policy_device_list_endpoint.call_with_http_info(**kwargs) + + def get_security_template( + self, + policy_id, + **kwargs + ): + """get_security_template # noqa: E501 + + Get Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_security_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_security_template_endpoint.call_with_http_info(**kwargs) + + def get_security_templates_for_device( + self, + device_model, + **kwargs + ): + """get_security_templates_for_device # noqa: E501 + + Get templates that map a device model # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_security_templates_for_device(device_model, async_req=True) + >>> result = thread.get() + + Args: + device_model (DeviceModel): Device model + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_model'] = \ + device_model + return self.get_security_templates_for_device_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_segments_api.py b/openapi_client/api/configuration_segments_api.py new file mode 100644 index 0000000..a0667dd --- /dev/null +++ b/openapi_client/api/configuration_segments_api.py @@ -0,0 +1,684 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSegmentsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_segment_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/segment', + 'operation_id': 'create_segment', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_segment_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/segment/{id}', + 'operation_id': 'delete_segment', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_segment_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/segment/{id}', + 'operation_id': 'edit_segment', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_segment_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/segment/{id}', + 'operation_id': 'get_segment', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_segments_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/segment', + 'operation_id': 'get_segments', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_segment( + self, + **kwargs + ): + """create_segment # noqa: E501 + + Create network segment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_segment(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network segment. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_segment_endpoint.call_with_http_info(**kwargs) + + def delete_segment( + self, + id, + **kwargs + ): + """delete_segment # noqa: E501 + + Delete network segment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_segment(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Segment Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_segment_endpoint.call_with_http_info(**kwargs) + + def edit_segment( + self, + id, + **kwargs + ): + """edit_segment # noqa: E501 + + Edit network segment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_segment(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Segment Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network segment. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_segment_endpoint.call_with_http_info(**kwargs) + + def get_segment( + self, + id, + **kwargs + ): + """get_segment # noqa: E501 + + Get network segment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_segment(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Segment Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_segment_endpoint.call_with_http_info(**kwargs) + + def get_segments( + self, + **kwargs + ): + """get_segments # noqa: E501 + + Get network segments # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_segments(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_segments_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_settings_api.py b/openapi_client/api/configuration_settings_api.py new file mode 100644 index 0000000..d68b511 --- /dev/null +++ b/openapi_client/api/configuration_settings_api.py @@ -0,0 +1,1578 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSettingsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_analytics_data_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/analytics/dca', + 'operation_id': 'create_analytics_data_file', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_cert_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/certificate/{settingType}', + 'operation_id': 'edit_cert_configuration', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'setting_type', + 'body', + ], + 'required': [ + 'setting_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setting_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'setting_type': 'settingType', + }, + 'location_map': { + 'setting_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/{settingType}', + 'operation_id': 'edit_configuration', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'setting_type', + 'body', + ], + 'required': [ + 'setting_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setting_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'setting_type': 'settingType', + }, + 'location_map': { + 'setting_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_banner_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/banner', + 'operation_id': 'get_banner', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cert_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/certificate/{settingType}', + 'operation_id': 'get_cert_configuration', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'setting_type', + ], + 'required': [ + 'setting_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setting_type': + (str,), + }, + 'attribute_map': { + 'setting_type': 'settingType', + }, + 'location_map': { + 'setting_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_configuration_by_setting_type_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/{settingType}', + 'operation_id': 'get_configuration_by_setting_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'setting_type', + ], + 'required': [ + 'setting_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setting_type': + (str,), + }, + 'attribute_map': { + 'setting_type': 'settingType', + }, + 'location_map': { + 'setting_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_google_map_key_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/googleMapKey', + 'operation_id': 'get_google_map_key', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_maintenance_window_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/maintenanceWindow', + 'operation_id': 'get_maintenance_window', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_password_policy_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/passwordPolicy', + 'operation_id': 'get_password_policy', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_session_timout_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/clientSessionTimeout', + 'operation_id': 'get_session_timout', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.new_cert_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/certificate/{settingType}', + 'operation_id': 'new_cert_configuration', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'setting_type', + 'body', + ], + 'required': [ + 'setting_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setting_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'setting_type': 'settingType', + }, + 'location_map': { + 'setting_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.new_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/settings/configuration/{settingType}', + 'operation_id': 'new_configuration', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'setting_type', + 'body', + ], + 'required': [ + 'setting_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setting_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'setting_type': 'settingType', + }, + 'location_map': { + 'setting_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_analytics_data_file( + self, + **kwargs + ): + """create_analytics_data_file # noqa: E501 + + Create analytics data file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_analytics_data_file(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_analytics_data_file_endpoint.call_with_http_info(**kwargs) + + def edit_cert_configuration( + self, + setting_type, + **kwargs + ): + """edit_cert_configuration # noqa: E501 + + Update certificate configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_cert_configuration(setting_type, async_req=True) + >>> result = thread.get() + + Args: + setting_type (str): Setting type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Certificate config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['setting_type'] = \ + setting_type + return self.edit_cert_configuration_endpoint.call_with_http_info(**kwargs) + + def edit_configuration( + self, + setting_type, + **kwargs + ): + """edit_configuration # noqa: E501 + + Update configuration setting # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_configuration(setting_type, async_req=True) + >>> result = thread.get() + + Args: + setting_type (str): Setting type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Configuration setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['setting_type'] = \ + setting_type + return self.edit_configuration_endpoint.call_with_http_info(**kwargs) + + def get_banner( + self, + **kwargs + ): + """get_banner # noqa: E501 + + Retrieve banner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_banner(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_banner_endpoint.call_with_http_info(**kwargs) + + def get_cert_configuration( + self, + setting_type, + **kwargs + ): + """get_cert_configuration # noqa: E501 + + Retrieve certificate configuration value by settingType # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cert_configuration(setting_type, async_req=True) + >>> result = thread.get() + + Args: + setting_type (str): Setting type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['setting_type'] = \ + setting_type + return self.get_cert_configuration_endpoint.call_with_http_info(**kwargs) + + def get_configuration_by_setting_type( + self, + setting_type, + **kwargs + ): + """get_configuration_by_setting_type # noqa: E501 + + Retrieve configuration value by settingType # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_configuration_by_setting_type(setting_type, async_req=True) + >>> result = thread.get() + + Args: + setting_type (str): Setting type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['setting_type'] = \ + setting_type + return self.get_configuration_by_setting_type_endpoint.call_with_http_info(**kwargs) + + def get_google_map_key( + self, + **kwargs + ): + """get_google_map_key # noqa: E501 + + Retrieve Google map key # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_google_map_key(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_google_map_key_endpoint.call_with_http_info(**kwargs) + + def get_maintenance_window( + self, + **kwargs + ): + """get_maintenance_window # noqa: E501 + + Retrieve maintenance window # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_maintenance_window(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_maintenance_window_endpoint.call_with_http_info(**kwargs) + + def get_password_policy( + self, + **kwargs + ): + """get_password_policy # noqa: E501 + + Retrieve password policy from global settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_password_policy(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_password_policy_endpoint.call_with_http_info(**kwargs) + + def get_session_timout( + self, + **kwargs + ): + """get_session_timout # noqa: E501 + + Get client session timeout # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_session_timout(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_session_timout_endpoint.call_with_http_info(**kwargs) + + def new_cert_configuration( + self, + setting_type, + **kwargs + ): + """new_cert_configuration # noqa: E501 + + Add new certificate configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.new_cert_configuration(setting_type, async_req=True) + >>> result = thread.get() + + Args: + setting_type (str): Setting type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Certificate config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['setting_type'] = \ + setting_type + return self.new_cert_configuration_endpoint.call_with_http_info(**kwargs) + + def new_configuration( + self, + setting_type, + **kwargs + ): + """new_configuration # noqa: E501 + + Add new configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.new_configuration(setting_type, async_req=True) + >>> result = thread.get() + + Args: + setting_type (str): Setting type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Configuration setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['setting_type'] = \ + setting_type + return self.new_configuration_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_software_actions_api.py b/openapi_client/api/configuration_software_actions_api.py new file mode 100644 index 0000000..3cbffbe --- /dev/null +++ b/openapi_client/api/configuration_software_actions_api.py @@ -0,0 +1,2359 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSoftwareActionsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_remote_server_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/remote-server', + 'operation_id': 'add_remote_server', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_image_url_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software', + 'operation_id': 'create_image_url', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_image_url_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/{versionId}', + 'operation_id': 'delete_image_url', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_remote_server_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/remote-server/{id}', + 'operation_id': 'delete_remote_server', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_image_remote_server_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/remoteserver/{versionId}', + 'operation_id': 'edit_image_remote_server', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + 'body', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.find_software_images_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/software', + 'operation_id': 'find_software_images', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_software_images_with_filters_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/software/images', + 'operation_id': 'find_software_images_with_filters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'image_type', + 'vnf_type', + ], + 'required': [ + 'image_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'image_type': + (str,), + 'vnf_type': + (str,), + }, + 'attribute_map': { + 'image_type': 'imageType', + 'vnf_type': 'vnfType', + }, + 'location_map': { + 'image_type': 'query', + 'vnf_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_software_version_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/version', + 'operation_id': 'find_software_version', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_v_edge_software_version_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/vedge/version', + 'operation_id': 'find_v_edge_software_version', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_ztp_software_version_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/ztp/version', + 'operation_id': 'find_ztp_software_version', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_image_properties_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/imageProperties/{versionId}', + 'operation_id': 'get_image_properties', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_image_remote_server_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/remoteserver/{versionId}', + 'operation_id': 'get_image_remote_server', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_pnf_properties_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/pnfproperties/{pnfType}', + 'operation_id': 'get_pnf_properties', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'pnf_type', + ], + 'required': [ + 'pnf_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'pnf_type': + (str,), + }, + 'attribute_map': { + 'pnf_type': 'pnfType', + }, + 'location_map': { + 'pnf_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_remote_server_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/remote-server/{id}', + 'operation_id': 'get_remote_server_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_remote_server_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/remote-server', + 'operation_id': 'get_remote_server_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnf_properties_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/action/software/vnfproperties/{versionId}', + 'operation_id': 'get_vnf_properties', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_image_url_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/action/software/{versionId}', + 'operation_id': 'update_image_url', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'version_id', + 'body', + ], + 'required': [ + 'version_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'version_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'version_id': 'versionId', + }, + 'location_map': { + 'version_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_remote_server_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/action/remote-server/{id}', + 'operation_id': 'update_remote_server', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def add_remote_server( + self, + **kwargs + ): + """add_remote_server # noqa: E501 + + Add a new remote server entry. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_remote_server(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Request payload for a new remote server entry.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_remote_server_endpoint.call_with_http_info(**kwargs) + + def create_image_url( + self, + **kwargs + ): + """create_image_url # noqa: E501 + + Create software image URL # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_image_url(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Create software image request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_image_url_endpoint.call_with_http_info(**kwargs) + + def delete_image_url( + self, + version_id, + **kwargs + ): + """delete_image_url # noqa: E501 + + Delete software image URL # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_image_url(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.delete_image_url_endpoint.call_with_http_info(**kwargs) + + def delete_remote_server( + self, + id, + **kwargs + ): + """delete_remote_server # noqa: E501 + + Delete remote server for the specified ID # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_remote_server(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Remote Server ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_remote_server_endpoint.call_with_http_info(**kwargs) + + def edit_image_remote_server( + self, + version_id, + **kwargs + ): + """edit_image_remote_server # noqa: E501 + + Update Image Remote Server Details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_image_remote_server(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Image ID + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update image remote server details. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.edit_image_remote_server_endpoint.call_with_http_info(**kwargs) + + def find_software_images( + self, + **kwargs + ): + """find_software_images # noqa: E501 + + Get software images # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_software_images(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_software_images_endpoint.call_with_http_info(**kwargs) + + def find_software_images_with_filters( + self, + image_type, + **kwargs + ): + """find_software_images_with_filters # noqa: E501 + + Get software images # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_software_images_with_filters(image_type, async_req=True) + >>> result = thread.get() + + Args: + image_type (str): Image type + + Keyword Args: + vnf_type (str): VNF type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['image_type'] = \ + image_type + return self.find_software_images_with_filters_endpoint.call_with_http_info(**kwargs) + + def find_software_version( + self, + **kwargs + ): + """find_software_version # noqa: E501 + + Get software version # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_software_version(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_software_version_endpoint.call_with_http_info(**kwargs) + + def find_v_edge_software_version( + self, + **kwargs + ): + """find_v_edge_software_version # noqa: E501 + + Get vEdge software version # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_v_edge_software_version(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_v_edge_software_version_endpoint.call_with_http_info(**kwargs) + + def find_ztp_software_version( + self, + **kwargs + ): + """find_ztp_software_version # noqa: E501 + + Get ZTP software version # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_ztp_software_version(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.find_ztp_software_version_endpoint.call_with_http_info(**kwargs) + + def get_image_properties( + self, + version_id, + **kwargs + ): + """get_image_properties # noqa: E501 + + Get Image Properties # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_image_properties(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.get_image_properties_endpoint.call_with_http_info(**kwargs) + + def get_image_remote_server( + self, + version_id, + **kwargs + ): + """get_image_remote_server # noqa: E501 + + Get Image Remote Server Details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_image_remote_server(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.get_image_remote_server_endpoint.call_with_http_info(**kwargs) + + def get_pnf_properties( + self, + pnf_type, + **kwargs + ): + """get_pnf_properties # noqa: E501 + + Get PNF Properties # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pnf_properties(pnf_type, async_req=True) + >>> result = thread.get() + + Args: + pnf_type (str): PNF type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['pnf_type'] = \ + pnf_type + return self.get_pnf_properties_endpoint.call_with_http_info(**kwargs) + + def get_remote_server_by_id( + self, + id, + **kwargs + ): + """get_remote_server_by_id # noqa: E501 + + Get remote server for the specified ID # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_remote_server_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Remote Server ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_remote_server_by_id_endpoint.call_with_http_info(**kwargs) + + def get_remote_server_list( + self, + **kwargs + ): + """get_remote_server_list # noqa: E501 + + Get list of remote servers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_remote_server_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_remote_server_list_endpoint.call_with_http_info(**kwargs) + + def get_vnf_properties( + self, + version_id, + **kwargs + ): + """get_vnf_properties # noqa: E501 + + Get VNF Properties # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnf_properties(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Version + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.get_vnf_properties_endpoint.call_with_http_info(**kwargs) + + def update_image_url( + self, + version_id, + **kwargs + ): + """update_image_url # noqa: E501 + + Update software image URL # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_image_url(version_id, async_req=True) + >>> result = thread.get() + + Args: + version_id (str): Version + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Update software image request payload. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['version_id'] = \ + version_id + return self.update_image_url_endpoint.call_with_http_info(**kwargs) + + def update_remote_server( + self, + id, + **kwargs + ): + """update_remote_server # noqa: E501 + + Update remote server for the specified ID # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_remote_server(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Remote Server ID + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.update_remote_server_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_ssl_decryption_policy_definition_builder_api.py b/openapi_client/api/configuration_ssl_decryption_policy_definition_builder_api.py new file mode 100644 index 0000000..bf1c247 --- /dev/null +++ b/openapi_client/api/configuration_ssl_decryption_policy_definition_builder_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSSLDecryptionPolicyDefinitionBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption', + 'operation_id': 'create_policy_definition3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition3_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/{id}', + 'operation_id': 'delete_policy_definition3', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition3', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/{id}', + 'operation_id': 'edit_policy_definition3', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption', + 'operation_id': 'get_definitions3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/{id}', + 'operation_id': 'get_policy_definition3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/preview', + 'operation_id': 'preview_policy_definition3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/ssldecryption/bulk', + 'operation_id': 'save_policy_definition_in_bulk3', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition3( + self, + **kwargs + ): + """create_policy_definition3 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition3_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition3( + self, + id, + **kwargs + ): + """delete_policy_definition3 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition3_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition3( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition3 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition3_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition3( + self, + id, + **kwargs + ): + """edit_policy_definition3 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition3_endpoint.call_with_http_info(**kwargs) + + def get_definitions3( + self, + **kwargs + ): + """get_definitions3 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions3_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition3( + self, + id, + **kwargs + ): + """get_policy_definition3 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition3_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition3( + self, + **kwargs + ): + """preview_policy_definition3 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition3_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id3( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id3 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id3(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id3_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk3( + self, + **kwargs + ): + """save_policy_definition_in_bulk3 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk3_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_ssl_decryption_utd_profile_definition_api.py b/openapi_client/api/configuration_ssl_decryption_utd_profile_definition_api.py new file mode 100644 index 0000000..0eb4718 --- /dev/null +++ b/openapi_client/api/configuration_ssl_decryption_utd_profile_definition_api.py @@ -0,0 +1,1211 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationSSLDecryptionUTDProfileDefinitionApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_policy_definition22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile', + 'operation_id': 'create_policy_definition22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_policy_definition22_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/{id}', + 'operation_id': 'delete_policy_definition22', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_multiple_policy_definition22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/multiple/{id}', + 'operation_id': 'edit_multiple_policy_definition22', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_policy_definition22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/{id}', + 'operation_id': 'edit_policy_definition22', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_definitions22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile', + 'operation_id': 'get_definitions22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_policy_definition22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/{id}', + 'operation_id': 'get_policy_definition22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.preview_policy_definition22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/preview', + 'operation_id': 'preview_policy_definition22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_policy_definition_by_id22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/preview/{id}', + 'operation_id': 'preview_policy_definition_by_id22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_policy_definition_in_bulk22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/definition/sslutdprofile/bulk', + 'operation_id': 'save_policy_definition_in_bulk22', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_policy_definition22( + self, + **kwargs + ): + """create_policy_definition22 # noqa: E501 + + Create policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_definition22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_policy_definition22_endpoint.call_with_http_info(**kwargs) + + def delete_policy_definition22( + self, + id, + **kwargs + ): + """delete_policy_definition22 # noqa: E501 + + Delete policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_policy_definition22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_policy_definition22_endpoint.call_with_http_info(**kwargs) + + def edit_multiple_policy_definition22( + self, + id, + **kwargs + ): + """edit_multiple_policy_definition22 # noqa: E501 + + Edit multiple policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_multiple_policy_definition22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_multiple_policy_definition22_endpoint.call_with_http_info(**kwargs) + + def edit_policy_definition22( + self, + id, + **kwargs + ): + """edit_policy_definition22 # noqa: E501 + + Edit a policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_policy_definition22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.edit_policy_definition22_endpoint.call_with_http_info(**kwargs) + + def get_definitions22( + self, + **kwargs + ): + """get_definitions22 # noqa: E501 + + Get policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_definitions22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_definitions22_endpoint.call_with_http_info(**kwargs) + + def get_policy_definition22( + self, + id, + **kwargs + ): + """get_policy_definition22 # noqa: E501 + + Get a specific policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policy_definition22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_policy_definition22_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition22( + self, + **kwargs + ): + """preview_policy_definition22 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.preview_policy_definition22_endpoint.call_with_http_info(**kwargs) + + def preview_policy_definition_by_id22( + self, + id, + **kwargs + ): + """preview_policy_definition_by_id22 # noqa: E501 + + Preview policy definition # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_policy_definition_by_id22(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.preview_policy_definition_by_id22_endpoint.call_with_http_info(**kwargs) + + def save_policy_definition_in_bulk22( + self, + **kwargs + ): + """save_policy_definition_in_bulk22 # noqa: E501 + + Create/Edit policy definitions in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_policy_definition_in_bulk22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_policy_definition_in_bulk22_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_template_configuration_api.py b/openapi_client/api/configuration_template_configuration_api.py new file mode 100644 index 0000000..930b890 --- /dev/null +++ b/openapi_client/api/configuration_template_configuration_api.py @@ -0,0 +1,1379 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationTemplateConfigurationApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.generate_cli_mode_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/config/device/mode/cli', + 'operation_id': 'generate_cli_mode_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "VEDGE": "vedge", + "CONTROLLER": "controller", + "VMANAGE": "vmanage" + }, + }, + 'openapi_types': { + 'type': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generatev_manage_mode_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/config/device/mode/vmanage', + 'operation_id': 'generatev_manage_mode_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "VEDGE": "vedge", + "CONTROLLER": "controller", + "VMANAGE": "vmanage" + }, + }, + 'openapi_types': { + 'type': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_attached_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/config/attached/{deviceId}', + 'operation_id': 'get_attached_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'type', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "CFS": "CFS", + "RFS": "RFS", + "DRAFT_RFS": "DRAFT_RFS", + "DRAFT_CFS": "DRAFT_CFS" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'type': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'type': 'type', + }, + 'location_map': { + 'device_id': 'path', + 'type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_compatible_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/config/rmalist/{oldDeviceId}', + 'operation_id': 'get_compatible_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'old_device_id', + ], + 'required': [ + 'old_device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'old_device_id': + (str,), + }, + 'attribute_map': { + 'old_device_id': 'oldDeviceId', + }, + 'location_map': { + 'old_device_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_diff_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/config/diff/{deviceId}', + 'operation_id': 'get_device_diff', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_running_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/config/running/{deviceId}', + 'operation_id': 'get_running_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vpn_for_device_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/config/vpn/{deviceId}', + 'operation_id': 'get_vpn_for_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.rma_update_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/config/rmaupdate', + 'operation_id': 'rma_update', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_device_to_cli_mode_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/config/device/mode/cli', + 'operation_id': 'update_device_to_cli_mode', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_config_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/config/attach/{deviceId}', + 'operation_id': 'upload_config', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'body', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def generate_cli_mode_devices( + self, + type, + **kwargs + ): + """generate_cli_mode_devices # noqa: E501 + + Generates a JSON object that contains a list of valid devices in CLI mode # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_cli_mode_devices(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Device type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.generate_cli_mode_devices_endpoint.call_with_http_info(**kwargs) + + def generatev_manage_mode_devices( + self, + type, + **kwargs + ): + """generatev_manage_mode_devices # noqa: E501 + + Get list of devices that are allowable for vmanage modes # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generatev_manage_mode_devices(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Device type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.generatev_manage_mode_devices_endpoint.call_with_http_info(**kwargs) + + def get_attached_config( + self, + device_id, + **kwargs + ): + """get_attached_config # noqa: E501 + + Get local template attached config for given device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_attached_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Model ID + + Keyword Args: + type (str): Config type. [optional] if omitted the server will use the default value of "CFS" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_attached_config_endpoint.call_with_http_info(**kwargs) + + def get_compatible_devices( + self, + old_device_id, + **kwargs + ): + """get_compatible_devices # noqa: E501 + + Get compatible devices of model, chassis number, certificate serial number with the old device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_compatible_devices(old_device_id, async_req=True) + >>> result = thread.get() + + Args: + old_device_id (str): Device Model ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['old_device_id'] = \ + old_device_id + return self.get_compatible_devices_endpoint.call_with_http_info(**kwargs) + + def get_device_diff( + self, + device_id, + **kwargs + ): + """get_device_diff # noqa: E501 + + Generates a JSON object that contains the diff for a given device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_diff(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Model ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_diff_endpoint.call_with_http_info(**kwargs) + + def get_running_config( + self, + device_id, + **kwargs + ): + """get_running_config # noqa: E501 + + Get device running config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_running_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Model ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_running_config_endpoint.call_with_http_info(**kwargs) + + def get_vpn_for_device( + self, + device_id, + **kwargs + ): + """get_vpn_for_device # noqa: E501 + + Get list of configured VPN (excluding reserved VPN) for a device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_for_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Model ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vpn_for_device_endpoint.call_with_http_info(**kwargs) + + def rma_update( + self, + **kwargs + ): + """rma_update # noqa: E501 + + Update new device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.rma_update(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.rma_update_endpoint.call_with_http_info(**kwargs) + + def update_device_to_cli_mode( + self, + **kwargs + ): + """update_device_to_cli_mode # noqa: E501 + + Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_device_to_cli_mode(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device list. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_device_to_cli_mode_endpoint.call_with_http_info(**kwargs) + + def upload_config( + self, + device_id, + **kwargs + ): + """upload_config # noqa: E501 + + Upload device config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Model ID + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.upload_config_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_template_lock_api.py b/openapi_client/api/configuration_template_lock_api.py new file mode 100644 index 0000000..8f3309a --- /dev/null +++ b/openapi_client/api/configuration_template_lock_api.py @@ -0,0 +1,298 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationTemplateLockApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.remove_lock_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/lock/{processId}', + 'operation_id': 'remove_lock', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_id', + ], + 'required': [ + 'process_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_id': + (str,), + }, + 'attribute_map': { + 'process_id': 'processId', + }, + 'location_map': { + 'process_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.update_lease_time_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/lock/{processId}', + 'operation_id': 'update_lease_time', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_id', + ], + 'required': [ + 'process_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_id': + (str,), + }, + 'attribute_map': { + 'process_id': 'processId', + }, + 'location_map': { + 'process_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def remove_lock( + self, + process_id, + **kwargs + ): + """remove_lock # noqa: E501 + + Remove lock # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_lock(process_id, async_req=True) + >>> result = thread.get() + + Args: + process_id (str): Process Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_id'] = \ + process_id + return self.remove_lock_endpoint.call_with_http_info(**kwargs) + + def update_lease_time( + self, + process_id, + **kwargs + ): + """update_lease_time # noqa: E501 + + Update lease # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_lease_time(process_id, async_req=True) + >>> result = thread.get() + + Args: + process_id (str): Process Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_id'] = \ + process_id + return self.update_lease_time_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_template_master_api.py b/openapi_client/api/configuration_template_master_api.py new file mode 100644 index 0000000..f0f34db --- /dev/null +++ b/openapi_client/api/configuration_template_master_api.py @@ -0,0 +1,1737 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationTemplateMasterApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.change_template_resource_group1_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/device/resource-group/{resourceGroupName}/{templateId}', + 'operation_id': 'change_template_resource_group1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'resource_group_name', + ], + 'required': [ + 'template_id', + 'resource_group_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'resource_group_name': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + 'resource_group_name': 'resourceGroupName', + }, + 'location_map': { + 'template_id': 'path', + 'resource_group_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cli_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/cli', + 'operation_id': 'create_cli_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_master_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/feature', + 'operation_id': 'create_master_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_master_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/device/{templateId}', + 'operation_id': 'delete_master_template', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_master_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/{templateId}', + 'operation_id': 'edit_master_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + 'body', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_master_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device', + 'operation_id': 'generate_master_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'feature', + ], + 'required': [ + 'feature', + ], + 'nullable': [ + ], + 'enum': [ + 'feature', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('feature',): { + + "LAWFUL-INTERCEPTION": "lawful-interception", + "CLOUD-DOCK": "cloud-dock", + "NETWORK-DESIGN": "network-design", + "VMANAGE-DEFAULT": "vmanage-default", + "ALL": "all" + }, + }, + 'openapi_types': { + 'feature': + (str,), + }, + 'attribute_map': { + 'feature': 'feature', + }, + 'location_map': { + 'feature': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_template_for_migration_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/migration', + 'operation_id': 'generate_template_for_migration', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'has_aaa', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'has_aaa': + (bool,), + }, + 'attribute_map': { + 'has_aaa': 'hasAAA', + }, + 'location_map': { + 'has_aaa': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_master_template_definition_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/object/{templateId}', + 'operation_id': 'get_master_template_definition', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_out_of_sync_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/syncstatus/{templateId}', + 'operation_id': 'get_out_of_sync_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'template_id', + ], + 'required': [ + 'template_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'template_id': + (str,), + }, + 'attribute_map': { + 'template_id': 'templateId', + }, + 'location_map': { + 'template_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_out_of_sync_templates_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/device/syncstatus', + 'operation_id': 'get_out_of_sync_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.is_migration_required_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/is_migration_required', + 'operation_id': 'is_migration_required', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.migrate_templates_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/migration', + 'operation_id': 'migrate_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'prefix', + 'include_all', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + ([str],), + 'prefix': + (str,), + 'include_all': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'prefix': 'prefix', + 'include_all': 'includeAll', + }, + 'location_map': { + 'id': 'query', + 'prefix': 'query', + 'include_all': 'query', + }, + 'collection_format_map': { + 'id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.migration_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/device/migration_info', + 'operation_id': 'migration_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def change_template_resource_group1( + self, + template_id, + resource_group_name, + **kwargs + ): + """change_template_resource_group1 # noqa: E501 + + Change template resource group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.change_template_resource_group1(template_id, resource_group_name, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + resource_group_name (str): Resource group name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + kwargs['resource_group_name'] = \ + resource_group_name + return self.change_template_resource_group1_endpoint.call_with_http_info(**kwargs) + + def create_cli_template( + self, + **kwargs + ): + """create_cli_template # noqa: E501 + + Create CLI template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cli_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Create template request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_cli_template_endpoint.call_with_http_info(**kwargs) + + def create_master_template( + self, + **kwargs + ): + """create_master_template # noqa: E501 + + Create a device template from feature templates and sub templates


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_master_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Create template request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_master_template_endpoint.call_with_http_info(**kwargs) + + def delete_master_template( + self, + template_id, + **kwargs + ): + """delete_master_template # noqa: E501 + + Delete template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_master_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.delete_master_template_endpoint.call_with_http_info(**kwargs) + + def edit_master_template( + self, + template_id, + **kwargs + ): + """edit_master_template # noqa: E501 + + Edit template


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_master_template(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.edit_master_template_endpoint.call_with_http_info(**kwargs) + + def generate_master_template_list( + self, + feature, + **kwargs + ): + """generate_master_template_list # noqa: E501 + + Generate template list


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_master_template_list(feature, async_req=True) + >>> result = thread.get() + + Args: + feature (str): Feature + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['feature'] = \ + feature + return self.generate_master_template_list_endpoint.call_with_http_info(**kwargs) + + def generate_template_for_migration( + self, + **kwargs + ): + """generate_template_for_migration # noqa: E501 + + Generate a list of templates which require migration


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_template_for_migration(async_req=True) + >>> result = thread.get() + + + Keyword Args: + has_aaa (bool): Return only those uses AAA. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_template_for_migration_endpoint.call_with_http_info(**kwargs) + + def get_master_template_definition( + self, + template_id, + **kwargs + ): + """get_master_template_definition # noqa: E501 + + Generate template by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_master_template_definition(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_master_template_definition_endpoint.call_with_http_info(**kwargs) + + def get_out_of_sync_devices( + self, + template_id, + **kwargs + ): + """get_out_of_sync_devices # noqa: E501 + + Get out of sync devices


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_out_of_sync_devices(template_id, async_req=True) + >>> result = thread.get() + + Args: + template_id (str): Template Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['template_id'] = \ + template_id + return self.get_out_of_sync_devices_endpoint.call_with_http_info(**kwargs) + + def get_out_of_sync_templates( + self, + **kwargs + ): + """get_out_of_sync_templates # noqa: E501 + + Get template sync status


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_out_of_sync_templates(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_out_of_sync_templates_endpoint.call_with_http_info(**kwargs) + + def is_migration_required( + self, + **kwargs + ): + """is_migration_required # noqa: E501 + + Check if any device templates need migration


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.is_migration_required(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.is_migration_required_endpoint.call_with_http_info(**kwargs) + + def migrate_templates( + self, + id, + **kwargs + ): + """migrate_templates # noqa: E501 + + Migrate the device templates given the template Ids # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.migrate_templates(id, async_req=True) + >>> result = thread.get() + + Args: + id ([str]): Template Id + + Keyword Args: + prefix (str): Prefix. [optional] if omitted the server will use the default value of "cisco" + include_all (bool): Include all flag. [optional] if omitted the server will use the default value of True + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.migrate_templates_endpoint.call_with_http_info(**kwargs) + + def migration_info( + self, + **kwargs + ): + """migration_info # noqa: E501 + + Returns the mapping between old and migrated templates


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.migration_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.migration_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_topology_api.py b/openapi_client/api/configuration_topology_api.py new file mode 100644 index 0000000..12fa2ca --- /dev/null +++ b/openapi_client/api/configuration_topology_api.py @@ -0,0 +1,689 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_ip import DeviceIP + + +class ConfigurationTopologyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_device_topology_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/topology/device', + 'operation_id': 'create_device_topology', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([DeviceIP],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_full_topology_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/topology', + 'operation_id': 'create_full_topology', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_physical_topology_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/topology/physical', + 'operation_id': 'create_physical_topology', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([DeviceIP],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_site_topology_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/topology/device/site/{siteId}', + 'operation_id': 'get_site_topology', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'site_id', + ], + 'required': [ + 'site_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'site_id': + (str,), + }, + 'attribute_map': { + 'site_id': 'siteId', + }, + 'location_map': { + 'site_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_site_topology_monitor_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/topology/monitor/site/{siteId}', + 'operation_id': 'get_site_topology_monitor_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'site_id', + ], + 'required': [ + 'site_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'site_id': + (str,), + }, + 'attribute_map': { + 'site_id': 'siteId', + }, + 'location_map': { + 'site_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_device_topology( + self, + device_id, + **kwargs + ): + """create_device_topology # noqa: E501 + + Create device topology # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_topology(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([DeviceIP]): Device Id list + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_topology_endpoint.call_with_http_info(**kwargs) + + def create_full_topology( + self, + **kwargs + ): + """create_full_topology # noqa: E501 + + Create full topology # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_full_topology(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_full_topology_endpoint.call_with_http_info(**kwargs) + + def create_physical_topology( + self, + device_id, + **kwargs + ): + """create_physical_topology # noqa: E501 + + Create pysical topology # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_physical_topology(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([DeviceIP]): Device Id list + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_physical_topology_endpoint.call_with_http_info(**kwargs) + + def get_site_topology( + self, + site_id, + **kwargs + ): + """get_site_topology # noqa: E501 + + Get topology for a given site id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_site_topology(site_id, async_req=True) + >>> result = thread.get() + + Args: + site_id (str): Site Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['site_id'] = \ + site_id + return self.get_site_topology_endpoint.call_with_http_info(**kwargs) + + def get_site_topology_monitor_data( + self, + site_id, + **kwargs + ): + """get_site_topology_monitor_data # noqa: E501 + + Get topology monitor data for a given site id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_site_topology_monitor_data(site_id, async_req=True) + >>> result = thread.get() + + Args: + site_id (str): Site Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['site_id'] = \ + site_id + return self.get_site_topology_monitor_data_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_v_edge_template_policy_api.py b/openapi_client/api/configuration_v_edge_template_policy_api.py new file mode 100644 index 0000000..cd3e129 --- /dev/null +++ b/openapi_client/api/configuration_v_edge_template_policy_api.py @@ -0,0 +1,1078 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationVEdgeTemplatePolicyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.change_policy_resource_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/vedge/{resourceGroupName}/{policyId}', + 'operation_id': 'change_policy_resource_group', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'resource_group_name', + ], + 'required': [ + 'policy_id', + 'resource_group_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'resource_group_name': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + 'resource_group_name': 'resourceGroupName', + }, + 'location_map': { + 'policy_id': 'path', + 'resource_group_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.create_v_edge_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vedge', + 'operation_id': 'create_v_edge_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_v_edge_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/vedge/{policyId}', + 'operation_id': 'delete_v_edge_template', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_v_edge_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vedge/{policyId}', + 'operation_id': 'edit_v_edge_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_policy_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vedge', + 'operation_id': 'generate_policy_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_list_by_policy_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/vedge/devices/{policyId}', + 'operation_id': 'get_device_list_by_policy', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_edge_policy_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/vedge/devices', + 'operation_id': 'get_v_edge_policy_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_edge_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vedge/definition/{policyId}', + 'operation_id': 'get_v_edge_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def change_policy_resource_group( + self, + policy_id, + resource_group_name, + **kwargs + ): + """change_policy_resource_group # noqa: E501 + + Change policy resource group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.change_policy_resource_group(policy_id, resource_group_name, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + resource_group_name (str): Resrouce group name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + kwargs['resource_group_name'] = \ + resource_group_name + return self.change_policy_resource_group_endpoint.call_with_http_info(**kwargs) + + def create_v_edge_template( + self, + **kwargs + ): + """create_v_edge_template # noqa: E501 + + Create template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_v_edge_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_v_edge_template_endpoint.call_with_http_info(**kwargs) + + def delete_v_edge_template( + self, + policy_id, + **kwargs + ): + """delete_v_edge_template # noqa: E501 + + Delete template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_v_edge_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.delete_v_edge_template_endpoint.call_with_http_info(**kwargs) + + def edit_v_edge_template( + self, + policy_id, + **kwargs + ): + """edit_v_edge_template # noqa: E501 + + Edit template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_v_edge_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.edit_v_edge_template_endpoint.call_with_http_info(**kwargs) + + def generate_policy_template_list( + self, + **kwargs + ): + """generate_policy_template_list # noqa: E501 + + Get policy details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_policy_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_policy_template_list_endpoint.call_with_http_info(**kwargs) + + def get_device_list_by_policy( + self, + policy_id, + **kwargs + ): + """get_device_list_by_policy # noqa: E501 + + Get device list by policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_list_by_policy(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_device_list_by_policy_endpoint.call_with_http_info(**kwargs) + + def get_v_edge_policy_device_list( + self, + **kwargs + ): + """get_v_edge_policy_device_list # noqa: E501 + + Get device list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_edge_policy_device_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_v_edge_policy_device_list_endpoint.call_with_http_info(**kwargs) + + def get_v_edge_template( + self, + policy_id, + **kwargs + ): + """get_v_edge_template # noqa: E501 + + Get template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_edge_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_v_edge_template_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_v_smart_template_policy_api.py b/openapi_client/api/configuration_v_smart_template_policy_api.py new file mode 100644 index 0000000..35bf2ef --- /dev/null +++ b/openapi_client/api/configuration_v_smart_template_policy_api.py @@ -0,0 +1,1475 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ConfigurationVSmartTemplatePolicyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.activate_policy_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/activate/{policyId}', + 'operation_id': 'activate_policy', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.activate_policy_for_cloud_services_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/activate/central/{policyId}', + 'operation_id': 'activate_policy_for_cloud_services', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.check_v_smart_connectivity_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/connectivity/status', + 'operation_id': 'check_v_smart_connectivity_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_v_smart_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart', + 'operation_id': 'create_v_smart_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.de_activate_policy_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/deactivate/{policyId}', + 'operation_id': 'de_activate_policy', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_v_smart_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/{policyId}', + 'operation_id': 'delete_v_smart_template', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_template_without_lock_checks_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/central/{policyId}', + 'operation_id': 'edit_template_without_lock_checks', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_v_smart_template_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/{policyId}', + 'operation_id': 'edit_v_smart_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_v_smart_policy_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart', + 'operation_id': 'generate_v_smart_policy_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_template_by_policy_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/definition/{policyId}', + 'operation_id': 'get_template_by_policy_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.qosmos_nbar_migration_warning_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/vsmart/qosmos_nbar_migration_warning', + 'operation_id': 'qosmos_nbar_migration_warning', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def activate_policy( + self, + policy_id, + **kwargs + ): + """activate_policy # noqa: E501 + + Activate vsmart policy for a given policy id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate_policy(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.activate_policy_endpoint.call_with_http_info(**kwargs) + + def activate_policy_for_cloud_services( + self, + policy_id, + **kwargs + ): + """activate_policy_for_cloud_services # noqa: E501 + + Activate vsmart policy for a given policy id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate_policy_for_cloud_services(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.activate_policy_for_cloud_services_endpoint.call_with_http_info(**kwargs) + + def check_v_smart_connectivity_status( + self, + **kwargs + ): + """check_v_smart_connectivity_status # noqa: E501 + + Check VSmart Connectivity Status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_v_smart_connectivity_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_v_smart_connectivity_status_endpoint.call_with_http_info(**kwargs) + + def create_v_smart_template( + self, + **kwargs + ): + """create_v_smart_template # noqa: E501 + + Create template for given policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_v_smart_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_v_smart_template_endpoint.call_with_http_info(**kwargs) + + def de_activate_policy( + self, + policy_id, + **kwargs + ): + """de_activate_policy # noqa: E501 + + Deactivate vsmart policy for a given policy id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.de_activate_policy(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.de_activate_policy_endpoint.call_with_http_info(**kwargs) + + def delete_v_smart_template( + self, + policy_id, + **kwargs + ): + """delete_v_smart_template # noqa: E501 + + Delete template for a given policy id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_v_smart_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.delete_v_smart_template_endpoint.call_with_http_info(**kwargs) + + def edit_template_without_lock_checks( + self, + policy_id, + **kwargs + ): + """edit_template_without_lock_checks # noqa: E501 + + Edit template for given policy id to allow for multiple component edits # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_template_without_lock_checks(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.edit_template_without_lock_checks_endpoint.call_with_http_info(**kwargs) + + def edit_v_smart_template( + self, + policy_id, + **kwargs + ): + """edit_v_smart_template # noqa: E501 + + Edit template for given policy id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_v_smart_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Template policy. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.edit_v_smart_template_endpoint.call_with_http_info(**kwargs) + + def generate_v_smart_policy_template_list( + self, + **kwargs + ): + """generate_v_smart_policy_template_list # noqa: E501 + + Get all template vsmart policy list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_v_smart_policy_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_v_smart_policy_template_list_endpoint.call_with_http_info(**kwargs) + + def get_template_by_policy_id( + self, + policy_id, + **kwargs + ): + """get_template_by_policy_id # noqa: E501 + + Get template policy definition by policy id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_template_by_policy_id(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_template_by_policy_id_endpoint.call_with_http_info(**kwargs) + + def qosmos_nbar_migration_warning( + self, + **kwargs + ): + """qosmos_nbar_migration_warning # noqa: E501 + + Qosmos Nbar migration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.qosmos_nbar_migration_warning(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.qosmos_nbar_migration_warning_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/configuration_voice_template_policy_api.py b/openapi_client/api/configuration_voice_template_policy_api.py new file mode 100644 index 0000000..db81be2 --- /dev/null +++ b/openapi_client/api/configuration_voice_template_policy_api.py @@ -0,0 +1,1191 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_model import DeviceModel + + +class ConfigurationVoiceTemplatePolicyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_voice_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/voice', + 'operation_id': 'create_voice_template', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_voice_template_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/template/policy/voice/{policyId}', + 'operation_id': 'delete_voice_template', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_voice_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/voice/{policyId}', + 'operation_id': 'edit_voice_template', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + 'body', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_voice_policy_summary_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/voice/summary', + 'operation_id': 'generate_voice_policy_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_voice_template_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/voice', + 'operation_id': 'generate_voice_template_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_list_by_policy_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/voice/devices/{policyId}', + 'operation_id': 'get_device_list_by_policy_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_template_by_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/template/policy/voice/definition/{policyId}', + 'operation_id': 'get_template_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_voice_policy_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/voice/devices', + 'operation_id': 'get_voice_policy_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_voice_templates_for_device_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/template/policy/voice/{deviceModel}', + 'operation_id': 'get_voice_templates_for_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_model', + ], + 'required': [ + 'device_model', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_model': + (DeviceModel,), + }, + 'attribute_map': { + 'device_model': 'deviceModel', + }, + 'location_map': { + 'device_model': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_voice_template( + self, + **kwargs + ): + """create_voice_template # noqa: E501 + + Create Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_voice_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_voice_template_endpoint.call_with_http_info(**kwargs) + + def delete_voice_template( + self, + policy_id, + **kwargs + ): + """delete_voice_template # noqa: E501 + + Delete Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_voice_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.delete_voice_template_endpoint.call_with_http_info(**kwargs) + + def edit_voice_template( + self, + policy_id, + **kwargs + ): + """edit_voice_template # noqa: E501 + + Edit Template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_voice_template(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Policy template. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.edit_voice_template_endpoint.call_with_http_info(**kwargs) + + def generate_voice_policy_summary( + self, + **kwargs + ): + """generate_voice_policy_summary # noqa: E501 + + Get templates that map a device model # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_voice_policy_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_voice_policy_summary_endpoint.call_with_http_info(**kwargs) + + def generate_voice_template_list( + self, + **kwargs + ): + """generate_voice_template_list # noqa: E501 + + Generate template list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_voice_template_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_voice_template_list_endpoint.call_with_http_info(**kwargs) + + def get_device_list_by_policy_id( + self, + policy_id, + **kwargs + ): + """get_device_list_by_policy_id # noqa: E501 + + Get device list by policy Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_list_by_policy_id(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_device_list_by_policy_id_endpoint.call_with_http_info(**kwargs) + + def get_template_by_id( + self, + policy_id, + **kwargs + ): + """get_template_by_id # noqa: E501 + + Get templates by policy Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_template_by_id(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.get_template_by_id_endpoint.call_with_http_info(**kwargs) + + def get_voice_policy_device_list( + self, + **kwargs + ): + """get_voice_policy_device_list # noqa: E501 + + Get all device list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_voice_policy_device_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_voice_policy_device_list_endpoint.call_with_http_info(**kwargs) + + def get_voice_templates_for_device( + self, + device_model, + **kwargs + ): + """get_voice_templates_for_device # noqa: E501 + + Get templates that map a device model # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_voice_templates_for_device(device_model, async_req=True) + >>> result = thread.get() + + Args: + device_model (DeviceModel): Device model + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_model'] = \ + device_model + return self.get_voice_templates_for_device_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/data_collection_agent_api.py b/openapi_client/api/data_collection_agent_api.py new file mode 100644 index 0000000..d9d6696 --- /dev/null +++ b/openapi_client/api/data_collection_agent_api.py @@ -0,0 +1,2965 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class DataCollectionAgentApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_dca_analytics_data_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/settings/configuration/{type}/dca', + 'operation_id': 'create_dca_analytics_data_file', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'body', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "ANALYTICS": "analytics", + "CALLHOME": "callHome" + }, + }, + 'openapi_types': { + 'type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/analytics', + 'operation_id': 'create_stats', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_alarm_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/dca/cloudservices/alarm', + 'operation_id': 'generate_alarm', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_dca_device_state_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/data/device/state/{state_data_type}', + 'operation_id': 'generate_dca_device_state_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + 'body', + ], + 'required': [ + 'state_data_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + }, + 'location_map': { + 'state_data_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_dca_device_statistics_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/data/device/statistics/{stats_data_type}', + 'operation_id': 'generate_dca_device_statistics_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'stats_data_type', + 'body', + ], + 'required': [ + 'stats_data_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'stats_data_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'stats_data_type': 'stats_data_type', + }, + 'location_map': { + 'stats_data_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_access_token_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/cloudservices/accesstoken', + 'operation_id': 'get_access_token', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_stats_data_dca_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/analytics/all', + 'operation_id': 'get_all_stats_data_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cloud_services_configuration_dca_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/settings/configuration/cloudservices/dca', + 'operation_id': 'get_cloud_services_configuration_dca', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_crash_logs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/device/crashlog/details', + 'operation_id': 'get_crash_logs', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_crash_logs_synced_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/device/crashlog/synced', + 'operation_id': 'get_crash_logs_synced', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dca_attached_config_to_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/template/device/config/attachedconfig', + 'operation_id': 'get_dca_attached_config_to_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_dca_tenant_owners_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/dcatenantowners', + 'operation_id': 'get_dca_tenant_owners', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_devices_details_dca_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/system/device', + 'operation_id': 'get_devices_details_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_id_token_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/cloudservices/idtoken', + 'operation_id': 'get_id_token', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_db_index_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/statistics/settings/status', + 'operation_id': 'get_stats_db_index_status', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_telemetry_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/cloudservices/telemetry', + 'operation_id': 'get_telemetry_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_template_policy_definitions_dca_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/dca/template/policy/definition/approute', + 'operation_id': 'get_template_policy_definitions_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_vedge_template_list_dca_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/dca/template/policy/vedge', + 'operation_id': 'get_vedge_template_list_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_vpn_lists_dca_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/dca/template/policy/list/vpn', + 'operation_id': 'get_vpn_lists_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_vsmart_template_list_dca_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/dca/template/policy/vsmart', + 'operation_id': 'get_vsmart_template_list_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.list_all_devices_dca_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/dca/device', + 'operation_id': 'list_all_devices_dca', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.store_access_token_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/dca/cloudservices/accesstoken', + 'operation_id': 'store_access_token', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.store_id_token_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/dca/cloudservices/idtoken', + 'operation_id': 'store_id_token', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_dca_analytics_data_file( + self, + type, + **kwargs + ): + """create_dca_analytics_data_file # noqa: E501 + + Create analytics config data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dca_analytics_data_file(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Data type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.create_dca_analytics_data_file_endpoint.call_with_http_info(**kwargs) + + def create_stats( + self, + **kwargs + ): + """create_stats # noqa: E501 + + Get statistics data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_stats(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_stats_endpoint.call_with_http_info(**kwargs) + + def generate_alarm( + self, + **kwargs + ): + """generate_alarm # noqa: E501 + + Generate DCA alarms # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_alarm(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): DCA alarm message. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_alarm_endpoint.call_with_http_info(**kwargs) + + def generate_dca_device_state_data( + self, + state_data_type, + **kwargs + ): + """generate_dca_device_state_data # noqa: E501 + + Get device state data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_dca_device_state_data(state_data_type, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): Device state data + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + return self.generate_dca_device_state_data_endpoint.call_with_http_info(**kwargs) + + def generate_dca_device_statistics_data( + self, + stats_data_type, + **kwargs + ): + """generate_dca_device_statistics_data # noqa: E501 + + Get device statistics data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_dca_device_statistics_data(stats_data_type, async_req=True) + >>> result = thread.get() + + Args: + stats_data_type (str): Device statistics data + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['stats_data_type'] = \ + stats_data_type + return self.generate_dca_device_statistics_data_endpoint.call_with_http_info(**kwargs) + + def get_access_token( + self, + **kwargs + ): + """get_access_token # noqa: E501 + + Get DCA access token # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_access_token(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_access_token_endpoint.call_with_http_info(**kwargs) + + def get_all_stats_data_dca( + self, + **kwargs + ): + """get_all_stats_data_dca # noqa: E501 + + Get all statistics setting data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_stats_data_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_stats_data_dca_endpoint.call_with_http_info(**kwargs) + + def get_cloud_services_configuration_dca( + self, + **kwargs + ): + """get_cloud_services_configuration_dca # noqa: E501 + + Get DCA cloud service configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_services_configuration_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_services_configuration_dca_endpoint.call_with_http_info(**kwargs) + + def get_crash_logs( + self, + **kwargs + ): + """get_crash_logs # noqa: E501 + + Get crash log # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_crash_logs(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_crash_logs_endpoint.call_with_http_info(**kwargs) + + def get_crash_logs_synced( + self, + device_id, + **kwargs + ): + """get_crash_logs_synced # noqa: E501 + + Get device crash log # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_crash_logs_synced(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_crash_logs_synced_endpoint.call_with_http_info(**kwargs) + + def get_dca_attached_config_to_device( + self, + **kwargs + ): + """get_dca_attached_config_to_device # noqa: E501 + + Get attached config to device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dca_attached_config_to_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dca_attached_config_to_device_endpoint.call_with_http_info(**kwargs) + + def get_dca_tenant_owners( + self, + **kwargs + ): + """get_dca_tenant_owners # noqa: E501 + + Get DCA tenant owners # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dca_tenant_owners(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dca_tenant_owners_endpoint.call_with_http_info(**kwargs) + + def get_devices_details_dca( + self, + **kwargs + ): + """get_devices_details_dca # noqa: E501 + + Get device details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_details_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_details_dca_endpoint.call_with_http_info(**kwargs) + + def get_id_token( + self, + **kwargs + ): + """get_id_token # noqa: E501 + + Get DCA Id token # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_id_token(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_id_token_endpoint.call_with_http_info(**kwargs) + + def get_stats_db_index_status( + self, + **kwargs + ): + """get_stats_db_index_status # noqa: E501 + + Get statistics setting status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_db_index_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_db_index_status_endpoint.call_with_http_info(**kwargs) + + def get_telemetry_settings( + self, + **kwargs + ): + """get_telemetry_settings # noqa: E501 + + Get DCA telemetry settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_telemetry_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_telemetry_settings_endpoint.call_with_http_info(**kwargs) + + def get_template_policy_definitions_dca( + self, + **kwargs + ): + """get_template_policy_definitions_dca # noqa: E501 + + Get template policy definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_template_policy_definitions_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_template_policy_definitions_dca_endpoint.call_with_http_info(**kwargs) + + def get_vedge_template_list_dca( + self, + **kwargs + ): + """get_vedge_template_list_dca # noqa: E501 + + Get vEdge template list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vedge_template_list_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vedge_template_list_dca_endpoint.call_with_http_info(**kwargs) + + def get_vpn_lists_dca( + self, + **kwargs + ): + """get_vpn_lists_dca # noqa: E501 + + Get VPN details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_lists_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vpn_lists_dca_endpoint.call_with_http_info(**kwargs) + + def get_vsmart_template_list_dca( + self, + **kwargs + ): + """get_vsmart_template_list_dca # noqa: E501 + + Get vSmart template list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vsmart_template_list_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vsmart_template_list_dca_endpoint.call_with_http_info(**kwargs) + + def list_all_devices_dca( + self, + **kwargs + ): + """list_all_devices_dca # noqa: E501 + + Get all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_all_devices_dca(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_all_devices_dca_endpoint.call_with_http_info(**kwargs) + + def store_access_token( + self, + **kwargs + ): + """store_access_token # noqa: E501 + + Set DCA access token # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.store_access_token(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): DCA access token. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.store_access_token_endpoint.call_with_http_info(**kwargs) + + def store_id_token( + self, + **kwargs + ): + """store_id_token # noqa: E501 + + Set DCA Id token # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.store_id_token(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): DCA Id token. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.store_id_token_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/deployment_mode_api.py b/openapi_client/api/deployment_mode_api.py new file mode 100644 index 0000000..c9f762f --- /dev/null +++ b/openapi_client/api/deployment_mode_api.py @@ -0,0 +1,911 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class DeploymentModeApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.config_fedramp_mode_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/fedramp/status', + 'operation_id': 'config_fedramp_mode', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.configure_dns_sec_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/fedramp/dnssec/config', + 'operation_id': 'configure_dns_sec', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.configure_wazuh_client_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/fedramp/wazuh/config', + 'operation_id': 'configure_wazuh_client', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_dns_sec_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/fedramp/dnssec/status', + 'operation_id': 'get_dns_sec_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wazuh_agent_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/fedramp/wazuh/status', + 'operation_id': 'get_wazuh_agent_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.reques_dns_sec_actions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/fedramp/dnssec/actions', + 'operation_id': 'reques_dns_sec_actions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'action', + ], + 'required': [ + 'action', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'action': + (str,), + }, + 'attribute_map': { + 'action': 'action', + }, + 'location_map': { + 'action': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.request_wazuh_actions_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/fedramp/wazuh/actions', + 'operation_id': 'request_wazuh_actions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'action', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'action': + (str,), + }, + 'attribute_map': { + 'action': 'action', + }, + 'location_map': { + 'action': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def config_fedramp_mode( + self, + **kwargs + ): + """config_fedramp_mode # noqa: E501 + + Set network deployment mode # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.config_fedramp_mode(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network deployment mode. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.config_fedramp_mode_endpoint.call_with_http_info(**kwargs) + + def configure_dns_sec( + self, + **kwargs + ): + """configure_dns_sec # noqa: E501 + + Configure DNS-Sec # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.configure_dns_sec(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): DNS sec config request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.configure_dns_sec_endpoint.call_with_http_info(**kwargs) + + def configure_wazuh_client( + self, + **kwargs + ): + """configure_wazuh_client # noqa: E501 + + Configure Wazuh agent # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.configure_wazuh_client(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Wazhuh configuration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.configure_wazuh_client_endpoint.call_with_http_info(**kwargs) + + def get_dns_sec_status( + self, + **kwargs + ): + """get_dns_sec_status # noqa: E501 + + Get DNS-Sec status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dns_sec_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dns_sec_status_endpoint.call_with_http_info(**kwargs) + + def get_wazuh_agent_status( + self, + **kwargs + ): + """get_wazuh_agent_status # noqa: E501 + + Get Wazuh agent status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wazuh_agent_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_wazuh_agent_status_endpoint.call_with_http_info(**kwargs) + + def reques_dns_sec_actions( + self, + action, + **kwargs + ): + """reques_dns_sec_actions # noqa: E501 + + Request DNS-Sec actions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reques_dns_sec_actions(action, async_req=True) + >>> result = thread.get() + + Args: + action (str): DNS-Sec action + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['action'] = \ + action + return self.reques_dns_sec_actions_endpoint.call_with_http_info(**kwargs) + + def request_wazuh_actions( + self, + **kwargs + ): + """request_wazuh_actions # noqa: E501 + + Wazuh agent action # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.request_wazuh_actions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + action (str): Wazhuh Action. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.request_wazuh_actions_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/device_messaging_api.py b/openapi_client/api/device_messaging_api.py new file mode 100644 index 0000000..85ff0d1 --- /dev/null +++ b/openapi_client/api/device_messaging_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class DeviceMessagingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_device_vmanage_connection_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/messaging/device/vmanage', + 'operation_id': 'create_device_vmanage_connection_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_device_vmanage_connection_list( + self, + **kwargs + ): + """create_device_vmanage_connection_list # noqa: E501 + + Create device vManage connection list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_vmanage_connection_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_device_vmanage_connection_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/device_network_api.py b/openapi_client/api/device_network_api.py new file mode 100644 index 0000000..cbcdfd3 --- /dev/null +++ b/openapi_client/api/device_network_api.py @@ -0,0 +1,544 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.vpnid import VPNID + + +class DeviceNetworkApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_network_issues_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/network/issues/summary', + 'operation_id': 'get_network_issues_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_network_status_summary_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/network/status', + 'operation_id': 'get_network_status_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_reboot_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/network/issues/rebootcount', + 'operation_id': 'get_reboot_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_cached', + ], + 'required': [ + 'is_cached', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_cached': + (bool,), + }, + 'attribute_map': { + 'is_cached': 'isCached', + }, + 'location_map': { + 'is_cached': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vmanage_control_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/network/connectionssummary', + 'operation_id': 'get_vmanage_control_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_cached', + 'vpn_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_cached': + (bool,), + 'vpn_id': + ([VPNID],), + }, + 'attribute_map': { + 'is_cached': 'isCached', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'is_cached': 'query', + 'vpn_id': 'query', + }, + 'collection_format_map': { + 'vpn_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_network_issues_summary( + self, + **kwargs + ): + """get_network_issues_summary # noqa: E501 + + Retrieve network issues summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_issues_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_network_issues_summary_endpoint.call_with_http_info(**kwargs) + + def get_network_status_summary( + self, + **kwargs + ): + """get_network_status_summary # noqa: E501 + + Retrieve network status summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_status_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_network_status_summary_endpoint.call_with_http_info(**kwargs) + + def get_reboot_count( + self, + is_cached=False, + **kwargs + ): + """get_reboot_count # noqa: E501 + + Retrieve reboot count # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_reboot_count(is_cached=False, async_req=True) + >>> result = thread.get() + + Args: + is_cached (bool): Is cached flag. defaults to False, must be one of [False] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['is_cached'] = \ + is_cached + return self.get_reboot_count_endpoint.call_with_http_info(**kwargs) + + def get_vmanage_control_status( + self, + **kwargs + ): + """get_vmanage_control_status # noqa: E501 + + Retrieve vManage control status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vmanage_control_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + is_cached (bool): Is cached flag. [optional] if omitted the server will use the default value of False + vpn_id ([VPNID]): VPN Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vmanage_control_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/hsec_activate_api.py b/openapi_client/api/hsec_activate_api.py new file mode 100644 index 0000000..a61c343 --- /dev/null +++ b/openapi_client/api/hsec_activate_api.py @@ -0,0 +1,163 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class HsecActivateApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.activate_hsec_licenses_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/hsec/activate', + 'operation_id': 'activate_hsec_licenses', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def activate_hsec_licenses( + self, + **kwargs + ): + """activate_hsec_licenses # noqa: E501 + + Activate Hsec licenses on devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate_hsec_licenses(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant List. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.activate_hsec_licenses_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/hsec_api.py b/openapi_client/api/hsec_api.py new file mode 100644 index 0000000..915eb45 --- /dev/null +++ b/openapi_client/api/hsec_api.py @@ -0,0 +1,813 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class HSECApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.assign_slac_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/assignSlac', + 'operation_id': 'assign_slac', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data': + (file_type,), + }, + 'attribute_map': { + 'data': 'data', + }, + 'location_map': { + 'data': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + self.device_summmary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/devices', + 'operation_id': 'device_summmary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.device_summmary1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/devices/install', + 'operation_id': 'device_summmary1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_slac_request_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/download', + 'operation_id': 'download_slac_request_file', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.fetch_accounts1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/fetchaccounts', + 'operation_id': 'fetch_accounts1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'username', + 'pwd', + 'mode', + ], + 'required': [ + 'username', + 'pwd', + 'mode', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'username': + (str,), + 'pwd': + (str,), + 'mode': + (str,), + }, + 'attribute_map': { + 'username': 'username', + 'pwd': 'pwd', + 'mode': 'mode', + }, + 'location_map': { + 'username': 'query', + 'pwd': 'query', + 'mode': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.upload_slac_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/uploadAuth', + 'operation_id': 'upload_slac_file', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data': + (file_type,), + }, + 'attribute_map': { + 'data': 'data', + }, + 'location_map': { + 'data': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + + def assign_slac( + self, + **kwargs + ): + """assign_slac # noqa: E501 + + Assign Hsec License to devices from uploaded SLAC file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.assign_slac(async_req=True) + >>> result = thread.get() + + + Keyword Args: + data (file_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.assign_slac_endpoint.call_with_http_info(**kwargs) + + def device_summmary( + self, + **kwargs + ): + """device_summmary # noqa: E501 + + Give list of HSEC license devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.device_summmary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.device_summmary_endpoint.call_with_http_info(**kwargs) + + def device_summmary1( + self, + **kwargs + ): + """device_summmary1 # noqa: E501 + + Give list of HSEC license devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.device_summmary1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.device_summmary1_endpoint.call_with_http_info(**kwargs) + + def download_slac_request_file( + self, + **kwargs + ): + """download_slac_request_file # noqa: E501 + + Download SLAC Request file for CSSM # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_slac_request_file(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device List. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.download_slac_request_file_endpoint.call_with_http_info(**kwargs) + + def fetch_accounts1( + self, + username, + pwd, + mode, + **kwargs + ): + """fetch_accounts1 # noqa: E501 + + fetch sava accounts that support HSEC Licensing # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.fetch_accounts1(username, pwd, mode, async_req=True) + >>> result = thread.get() + + Args: + username (str): userName + pwd (str): password + mode (str): mode + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['username'] = \ + username + kwargs['pwd'] = \ + pwd + kwargs['mode'] = \ + mode + return self.fetch_accounts1_endpoint.call_with_http_info(**kwargs) + + def upload_slac_file( + self, + **kwargs + ): + """upload_slac_file # noqa: E501 + + upload SLAC File and fetch device summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_slac_file(async_req=True) + >>> result = thread.get() + + + Keyword Args: + data (file_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.upload_slac_file_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/hsec_license_api.py b/openapi_client/api/hsec_license_api.py new file mode 100644 index 0000000..9445380 --- /dev/null +++ b/openapi_client/api/hsec_license_api.py @@ -0,0 +1,165 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class HSECLicenseApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.hsecassign_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/hsec/assign', + 'operation_id': 'hsecassign', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def hsecassign( + self, + **kwargs + ): + """hsecassign # noqa: E501 + + hsec # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.hsecassign(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.hsecassign_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/locale_api.py b/openapi_client/api/locale_api.py new file mode 100644 index 0000000..9b4012b --- /dev/null +++ b/openapi_client/api/locale_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class LocaleApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_supported_locales_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/localization/supportedLocales', + 'operation_id': 'get_supported_locales', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_supported_locales( + self, + **kwargs + ): + """get_supported_locales # noqa: E501 + + Get Supported locales # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_locales(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_supported_locales_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_alarms_details_api.py b/openapi_client/api/monitoring_alarms_details_api.py new file mode 100644 index 0000000..22b6917 --- /dev/null +++ b/openapi_client/api/monitoring_alarms_details_api.py @@ -0,0 +1,4452 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringAlarmsDetailsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.clear_stale_alarm_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/alarms/clear', + 'operation_id': 'clear_stale_alarm', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'request_body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'request_body': + ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + }, + 'attribute_map': { + }, + 'location_map': { + 'request_body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.correl_anti_entropy_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/reset', + 'operation_id': 'correl_anti_entropy', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_alarm_query_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/query/input', + 'operation_id': 'create_alarm_query_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.disable_enable_alarm_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/alarms/disabled', + 'operation_id': 'disable_enable_alarm', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'event_name', + 'disable', + 'time', + 'body', + ], + 'required': [ + 'event_name', + 'disable', + 'time', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'event_name': + (str,), + 'disable': + (bool,), + 'time': + (int,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'event_name': 'eventName', + 'disable': 'disable', + 'time': 'time', + }, + 'location_map': { + 'event_name': 'query', + 'disable': 'query', + 'time': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.dump_correlation_engine_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/dump', + 'operation_id': 'dump_correlation_engine_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.enable_disable_link_state_alarm_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/alarms/link-state-alarm', + 'operation_id': 'enable_disable_link_state_alarm', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'link_name', + 'enable', + 'body', + ], + 'required': [ + 'link_name', + 'enable', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'link_name': + (str,), + 'enable': + (bool,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'link_name': 'linkName', + 'enable': 'enable', + }, + 'location_map': { + 'link_name': 'query', + 'enable': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_alarm_aggregation_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/aggregation', + 'operation_id': 'get_alarm_aggregation_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_alarm_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/uuid/{alarm_uuid}', + 'operation_id': 'get_alarm_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'alarm_uuid', + ], + 'required': [ + 'alarm_uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'alarm_uuid': + (str,), + }, + 'attribute_map': { + 'alarm_uuid': 'alarm_uuid', + }, + 'location_map': { + 'alarm_uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_alarm_severity_custom_histogram_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/severity/summary', + 'operation_id': 'get_alarm_severity_custom_histogram', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_alarm_severity_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/severitymappings', + 'operation_id': 'get_alarm_severity_mappings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_alarm_types_as_key_value_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/rulenamedisplay/keyvalue', + 'operation_id': 'get_alarm_types_as_key_value', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_alarms_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms', + 'operation_id': 'get_alarms', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_alarms_by_severity_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/severity', + 'operation_id': 'get_alarms_by_severity', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'severity_level', + 'device_id', + 'query', + ], + 'required': [ + 'severity_level', + 'device_id', + 'query', + ], + 'nullable': [ + ], + 'enum': [ + 'severity_level', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('severity_level',): { + + "MAJOR": "major", + "MINOR": "minor", + "MEDIUM": "medium", + "CRITICAL": "critical" + }, + }, + 'openapi_types': { + 'severity_level': + ([str],), + 'device_id': + ([str],), + 'query': + (str,), + }, + 'attribute_map': { + 'severity_level': 'severity-level', + 'device_id': 'deviceId', + 'query': 'query', + }, + 'location_map': { + 'severity_level': 'query', + 'device_id': 'query', + 'query': 'query', + }, + 'collection_format_map': { + 'severity_level': 'multi', + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/doccount', + 'operation_id': 'get_count1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/doccount', + 'operation_id': 'get_count_post1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_topic_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/topic', + 'operation_id': 'get_device_topic', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'ip', + ], + 'required': [ + 'ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'ip', + ] + }, + root_map={ + 'validations': { + ('ip',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ip': + (str,), + }, + 'attribute_map': { + 'ip': 'ip', + }, + 'location_map': { + 'ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_link_state_alarm_config_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/alarms/link-state-alarm', + 'operation_id': 'get_link_state_alarm_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_master_manager_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/master', + 'operation_id': 'get_master_manager_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_non_viewed_active_alarms_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/count', + 'operation_id': 'get_non_viewed_active_alarms_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_non_viewed_alarms_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/notviewed', + 'operation_id': 'get_non_viewed_alarms', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_alarm_aggregation_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/aggregation', + 'operation_id': 'get_post_alarm_aggregation_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_alarm_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/page', + 'operation_id': 'get_post_stat_bulk_alarm_raw_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [ + 'scroll_id', + 'count', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (int,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_raw_alarm_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms', + 'operation_id': 'get_raw_alarm_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_alarm_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/page', + 'operation_id': 'get_stat_bulk_alarm_raw_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [ + 'query', + 'scroll_id', + 'count', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (int,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/fields', + 'operation_id': 'get_stat_data_fields1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/query/fields', + 'operation_id': 'get_stat_query_fields1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/stats', + 'operation_id': 'get_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_disabled_alarm_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/alarms/disabled', + 'operation_id': 'list_disabled_alarm', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.mark_alarms_as_viewed_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/markviewed', + 'operation_id': 'mark_alarms_as_viewed', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'request_body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'request_body': + ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + }, + 'attribute_map': { + }, + 'location_map': { + 'request_body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.mark_all_alarms_as_viewed_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/alarms/markallasviewed', + 'operation_id': 'mark_all_alarms_as_viewed', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'type': 'type', + }, + 'location_map': { + 'type': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.restart_correlation_engine_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/restart', + 'operation_id': 'restart_correlation_engine', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.set_periodic_purge_timer_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/purgefrequency', + 'operation_id': 'set_periodic_purge_timer', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'interval', + 'active_time', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'interval': + (str,), + 'active_time': + (str,), + }, + 'attribute_map': { + 'interval': 'interval', + 'active_time': 'activeTime', + }, + 'location_map': { + 'interval': 'query', + 'active_time': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.start_tracking_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/starttracking/{testName}', + 'operation_id': 'start_tracking', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'test_name', + ], + 'required': [ + 'test_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'test_name': + (str,), + }, + 'attribute_map': { + 'test_name': 'testName', + }, + 'location_map': { + 'test_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.stop_tracking_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/alarms/stoptracking/{testName}', + 'operation_id': 'stop_tracking', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'test_name', + ], + 'required': [ + 'test_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'test_name': + (str,), + }, + 'attribute_map': { + 'test_name': 'testName', + }, + 'location_map': { + 'test_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def clear_stale_alarm( + self, + **kwargs + ): + """clear_stale_alarm # noqa: E501 + + Clears specific stale alarm # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.clear_stale_alarm(async_req=True) + >>> result = thread.get() + + + Keyword Args: + request_body ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): alarm_uuid. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.clear_stale_alarm_endpoint.call_with_http_info(**kwargs) + + def correl_anti_entropy( + self, + **kwargs + ): + """correl_anti_entropy # noqa: E501 + + Reset correlation engine data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.correl_anti_entropy(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.correl_anti_entropy_endpoint.call_with_http_info(**kwargs) + + def create_alarm_query_config( + self, + **kwargs + ): + """create_alarm_query_config # noqa: E501 + + Get query configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_alarm_query_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_alarm_query_config_endpoint.call_with_http_info(**kwargs) + + def disable_enable_alarm( + self, + event_name, + disable, + time, + **kwargs + ): + """disable_enable_alarm # noqa: E501 + + Enable/Disable a specific alarm # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disable_enable_alarm(event_name, disable, time, async_req=True) + >>> result = thread.get() + + Args: + event_name (str): Event name + disable (bool): Disable + time (int): time in hours [1, 72], -1 means infinite + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): alarm config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['event_name'] = \ + event_name + kwargs['disable'] = \ + disable + kwargs['time'] = \ + time + return self.disable_enable_alarm_endpoint.call_with_http_info(**kwargs) + + def dump_correlation_engine_data( + self, + **kwargs + ): + """dump_correlation_engine_data # noqa: E501 + + dump correlation engine server data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.dump_correlation_engine_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.dump_correlation_engine_data_endpoint.call_with_http_info(**kwargs) + + def enable_disable_link_state_alarm( + self, + link_name, + enable, + **kwargs + ): + """enable_disable_link_state_alarm # noqa: E501 + + Enable/Disable a specific link-state alarm # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_disable_link_state_alarm(link_name, enable, async_req=True) + >>> result = thread.get() + + Args: + link_name (str): Link name (bgp, ospf) + enable (bool): Enable + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): alarm config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['link_name'] = \ + link_name + kwargs['enable'] = \ + enable + return self.enable_disable_link_state_alarm_endpoint.call_with_http_info(**kwargs) + + def get_alarm_aggregation_data( + self, + **kwargs + ): + """get_alarm_aggregation_data # noqa: E501 + + Gets aggregated list of alarms along with the raw alarm data of each aggregation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarm_aggregation_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Alarm query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_alarm_aggregation_data_endpoint.call_with_http_info(**kwargs) + + def get_alarm_details( + self, + alarm_uuid="b28d5637-d966-4898-a103-7e7e8d595b50", + **kwargs + ): + """get_alarm_details # noqa: E501 + + Get alarm detail # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarm_details(alarm_uuid="b28d5637-d966-4898-a103-7e7e8d595b50", async_req=True) + >>> result = thread.get() + + Args: + alarm_uuid (str): Alarm Id. defaults to "b28d5637-d966-4898-a103-7e7e8d595b50", must be one of ["b28d5637-d966-4898-a103-7e7e8d595b50"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['alarm_uuid'] = \ + alarm_uuid + return self.get_alarm_details_endpoint.call_with_http_info(**kwargs) + + def get_alarm_severity_custom_histogram( + self, + query, + **kwargs + ): + """get_alarm_severity_custom_histogram # noqa: E501 + + Get alarm severity histogram # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarm_severity_custom_histogram(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Alarm histogram query string + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_alarm_severity_custom_histogram_endpoint.call_with_http_info(**kwargs) + + def get_alarm_severity_mappings( + self, + **kwargs + ): + """get_alarm_severity_mappings # noqa: E501 + + Gets alarm severity mappings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarm_severity_mappings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_alarm_severity_mappings_endpoint.call_with_http_info(**kwargs) + + def get_alarm_types_as_key_value( + self, + **kwargs + ): + """get_alarm_types_as_key_value # noqa: E501 + + Gets alarm type as key value pair # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarm_types_as_key_value(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_alarm_types_as_key_value_endpoint.call_with_http_info(**kwargs) + + def get_alarms( + self, + **kwargs + ): + """get_alarms # noqa: E501 + + Get alarms for last 30min if vManage query is not specified # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarms(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Alarm query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_alarms_endpoint.call_with_http_info(**kwargs) + + def get_alarms_by_severity( + self, + severity_level, + device_id, + query, + **kwargs + ): + """get_alarms_by_severity # noqa: E501 + + Get alarm by severity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_alarms_by_severity(severity_level, device_id, query, async_req=True) + >>> result = thread.get() + + Args: + severity_level ([str]): Alarm severity + device_id ([str]): Device Id + query (str): Query filter + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['severity_level'] = \ + severity_level + kwargs['device_id'] = \ + device_id + kwargs['query'] = \ + query + return self.get_alarms_by_severity_endpoint.call_with_http_info(**kwargs) + + def get_count1( + self, + query, + **kwargs + ): + """get_count1 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count1(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count1_endpoint.call_with_http_info(**kwargs) + + def get_count_post1( + self, + **kwargs + ): + """get_count_post1 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post1_endpoint.call_with_http_info(**kwargs) + + def get_device_topic( + self, + ip, + **kwargs + ): + """get_device_topic # noqa: E501 + + Get device topic state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_topic(ip, async_req=True) + >>> result = thread.get() + + Args: + ip (str): Query topic + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['ip'] = \ + ip + return self.get_device_topic_endpoint.call_with_http_info(**kwargs) + + def get_link_state_alarm_config( + self, + **kwargs + ): + """get_link_state_alarm_config # noqa: E501 + + Get configuration for link-state alarm # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_link_state_alarm_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_link_state_alarm_config_endpoint.call_with_http_info(**kwargs) + + def get_master_manager_state( + self, + **kwargs + ): + """get_master_manager_state # noqa: E501 + + Get master manager state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_master_manager_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_master_manager_state_endpoint.call_with_http_info(**kwargs) + + def get_non_viewed_active_alarms_count( + self, + **kwargs + ): + """get_non_viewed_active_alarms_count # noqa: E501 + + Get count of the alarms which are active and acknowledged by the user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_non_viewed_active_alarms_count(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_non_viewed_active_alarms_count_endpoint.call_with_http_info(**kwargs) + + def get_non_viewed_alarms( + self, + **kwargs + ): + """get_non_viewed_alarms # noqa: E501 + + Get alarms which are active and acknowledged by the user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_non_viewed_alarms(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_non_viewed_alarms_endpoint.call_with_http_info(**kwargs) + + def get_post_alarm_aggregation_data( + self, + **kwargs + ): + """get_post_alarm_aggregation_data # noqa: E501 + + Gets aggregated list of alarms along with the raw alarm data of each aggregation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_alarm_aggregation_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Input query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_alarm_aggregation_data_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_alarm_raw_data( + self, + scroll_id, + count, + **kwargs + ): + """get_post_stat_bulk_alarm_raw_data # noqa: E501 + + Get paginated alarm raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_alarm_raw_data(scroll_id, count, async_req=True) + >>> result = thread.get() + + Args: + scroll_id (str): Query offset + count (int): Query size + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Alarm query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['scroll_id'] = \ + scroll_id + kwargs['count'] = \ + count + return self.get_post_stat_bulk_alarm_raw_data_endpoint.call_with_http_info(**kwargs) + + def get_raw_alarm_data( + self, + **kwargs + ): + """get_raw_alarm_data # noqa: E501 + + Gets lists of alarms along with the raw alarm data of each. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_raw_alarm_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Alarm query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_raw_alarm_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_alarm_raw_data( + self, + query, + scroll_id, + count, + **kwargs + ): + """get_stat_bulk_alarm_raw_data # noqa: E501 + + Get paginated alarm raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_alarm_raw_data(query, scroll_id, count, async_req=True) + >>> result = thread.get() + + Args: + query (str): Alarm query string + scroll_id (str): Query offset + count (int): Query size + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + kwargs['scroll_id'] = \ + scroll_id + kwargs['count'] = \ + count + return self.get_stat_bulk_alarm_raw_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields1( + self, + **kwargs + ): + """get_stat_data_fields1 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields1_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields1( + self, + **kwargs + ): + """get_stat_query_fields1 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields1_endpoint.call_with_http_info(**kwargs) + + def get_stats( + self, + **kwargs + ): + """get_stats # noqa: E501 + + Get alarm statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_endpoint.call_with_http_info(**kwargs) + + def list_disabled_alarm( + self, + **kwargs + ): + """list_disabled_alarm # noqa: E501 + + List all disabled alarms # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_disabled_alarm(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_disabled_alarm_endpoint.call_with_http_info(**kwargs) + + def mark_alarms_as_viewed( + self, + **kwargs + ): + """mark_alarms_as_viewed # noqa: E501 + + Mark alarms as acknowledged by the user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.mark_alarms_as_viewed(async_req=True) + >>> result = thread.get() + + + Keyword Args: + request_body ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): List of alarms. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.mark_alarms_as_viewed_endpoint.call_with_http_info(**kwargs) + + def mark_all_alarms_as_viewed( + self, + **kwargs + ): + """mark_all_alarms_as_viewed # noqa: E501 + + Mark all larms as acknowledged by the user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.mark_all_alarms_as_viewed(async_req=True) + >>> result = thread.get() + + + Keyword Args: + type (str): Query filter, possible value are \"active\" \"cleared\". [optional] + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.mark_all_alarms_as_viewed_endpoint.call_with_http_info(**kwargs) + + def restart_correlation_engine( + self, + **kwargs + ): + """restart_correlation_engine # noqa: E501 + + Restart correlation engine # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.restart_correlation_engine(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.restart_correlation_engine_endpoint.call_with_http_info(**kwargs) + + def set_periodic_purge_timer( + self, + **kwargs + ): + """set_periodic_purge_timer # noqa: E501 + + Set alarm purge timer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_periodic_purge_timer(async_req=True) + >>> result = thread.get() + + + Keyword Args: + interval (str): Purge interval. [optional] + active_time (str): Purge activeTime. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.set_periodic_purge_timer_endpoint.call_with_http_info(**kwargs) + + def start_tracking( + self, + test_name, + **kwargs + ): + """start_tracking # noqa: E501 + + Start tracking events # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.start_tracking(test_name, async_req=True) + >>> result = thread.get() + + Args: + test_name (str): test name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['test_name'] = \ + test_name + return self.start_tracking_endpoint.call_with_http_info(**kwargs) + + def stop_tracking( + self, + test_name, + **kwargs + ): + """stop_tracking # noqa: E501 + + Stop tracking events # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stop_tracking(test_name, async_req=True) + >>> result = thread.get() + + Args: + test_name (str): test name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['test_name'] = \ + test_name + return self.stop_tracking_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_alarms_notification_api.py b/openapi_client/api/monitoring_alarms_notification_api.py new file mode 100644 index 0000000..0a2c228 --- /dev/null +++ b/openapi_client/api/monitoring_alarms_notification_api.py @@ -0,0 +1,558 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringAlarmsNotificationApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_notification_rule_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/notifications/rule', + 'operation_id': 'create_notification_rule', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_notification_rule_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/notifications/rules', + 'operation_id': 'delete_notification_rule', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'rule_id', + ], + 'required': [ + 'rule_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'rule_id': + (str,), + }, + 'attribute_map': { + 'rule_id': 'ruleId', + }, + 'location_map': { + 'rule_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_notification_rule_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/notifications/rules', + 'operation_id': 'get_notification_rule', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'rule_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'rule_id': + (str,), + }, + 'attribute_map': { + 'rule_id': 'ruleId', + }, + 'location_map': { + 'rule_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_notification_rule_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/notifications/rule', + 'operation_id': 'update_notification_rule', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'rule_id', + 'body', + ], + 'required': [ + 'rule_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'rule_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'rule_id': 'ruleId', + }, + 'location_map': { + 'rule_id': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_notification_rule( + self, + **kwargs + ): + """create_notification_rule # noqa: E501 + + Add notification rule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_notification_rule(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Notification rule. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_notification_rule_endpoint.call_with_http_info(**kwargs) + + def delete_notification_rule( + self, + rule_id, + **kwargs + ): + """delete_notification_rule # noqa: E501 + + Delete notification rule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_notification_rule(rule_id, async_req=True) + >>> result = thread.get() + + Args: + rule_id (str): Rule Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['rule_id'] = \ + rule_id + return self.delete_notification_rule_endpoint.call_with_http_info(**kwargs) + + def get_notification_rule( + self, + **kwargs + ): + """get_notification_rule # noqa: E501 + + Get all rules or specific notification rule by its Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_notification_rule(async_req=True) + >>> result = thread.get() + + + Keyword Args: + rule_id (str): Rule Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_notification_rule_endpoint.call_with_http_info(**kwargs) + + def update_notification_rule( + self, + rule_id, + **kwargs + ): + """update_notification_rule # noqa: E501 + + Update notification rule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_notification_rule(rule_id, async_req=True) + >>> result = thread.get() + + Args: + rule_id (str): Rule Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Notification rule. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['rule_id'] = \ + rule_id + return self.update_notification_rule_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_app_hosting_api.py b/openapi_client/api/monitoring_app_hosting_api.py new file mode 100644 index 0000000..c48b9c0 --- /dev/null +++ b/openapi_client/api/monitoring_app_hosting_api.py @@ -0,0 +1,3204 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringAppHostingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/aggregation', + 'operation_id': 'get_aggregation_data_by_query', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/aggregation', + 'operation_id': 'get_aggregation_data_by_query1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/doccount', + 'operation_id': 'get_count2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/doccount', + 'operation_id': 'get_count3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/doccount', + 'operation_id': 'get_count_post2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_count_post3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/doccount', + 'operation_id': 'get_count_post3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/page', + 'operation_id': 'get_post_stat_bulk_raw_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/page', + 'operation_id': 'get_post_stat_bulk_raw_data1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/page', + 'operation_id': 'get_stat_bulk_raw_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/page', + 'operation_id': 'get_stat_bulk_raw_data1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/fields', + 'operation_id': 'get_stat_data_fields2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/fields', + 'operation_id': 'get_stat_data_fields3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface', + 'operation_id': 'get_stat_data_raw_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting', + 'operation_id': 'get_stat_data_raw_data1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv1_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface/query/fields', + 'operation_id': 'get_stat_query_fields2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting/query/fields', + 'operation_id': 'get_stat_query_fields3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphostinginterface', + 'operation_id': 'get_stats_raw_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stats_raw_data1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/apphosting', + 'operation_id': 'get_stats_raw_data1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query( + self, + **kwargs + ): + """get_aggregation_data_by_query # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query1( + self, + **kwargs + ): + """get_aggregation_data_by_query1 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query1_endpoint.call_with_http_info(**kwargs) + + def get_count2( + self, + query, + **kwargs + ): + """get_count2 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count2(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count2_endpoint.call_with_http_info(**kwargs) + + def get_count3( + self, + query, + **kwargs + ): + """get_count3 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count3(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count3_endpoint.call_with_http_info(**kwargs) + + def get_count_post2( + self, + **kwargs + ): + """get_count_post2 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post2_endpoint.call_with_http_info(**kwargs) + + def get_count_post3( + self, + **kwargs + ): + """get_count_post3 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post3_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query1( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query1 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query1_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query( + self, + **kwargs + ): + """get_post_aggregation_data_by_query # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query1( + self, + **kwargs + ): + """get_post_aggregation_data_by_query1 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query1_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data1( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data1 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data1_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data( + self, + **kwargs + ): + """get_stat_bulk_raw_data # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data1( + self, + **kwargs + ): + """get_stat_bulk_raw_data1 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data1_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields2( + self, + **kwargs + ): + """get_stat_data_fields2 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields2_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields3( + self, + **kwargs + ): + """get_stat_data_fields3 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields3_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data( + self, + **kwargs + ): + """get_stat_data_raw_data # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data1( + self, + **kwargs + ): + """get_stat_data_raw_data1 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data1_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv1( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv1 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv1_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields2( + self, + **kwargs + ): + """get_stat_query_fields2 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields2_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields3( + self, + **kwargs + ): + """get_stat_query_fields3 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields3_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data( + self, + **kwargs + ): + """get_stats_raw_data # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data1( + self, + **kwargs + ): + """get_stats_raw_data1 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data1_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_application_aware_routing_api.py b/openapi_client/api/monitoring_application_aware_routing_api.py new file mode 100644 index 0000000..963da01 --- /dev/null +++ b/openapi_client/api/monitoring_application_aware_routing_api.py @@ -0,0 +1,2866 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringApplicationAwareRoutingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_app_route_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/fec/aggregation', + 'operation_id': 'get_aggregation_data_app_route', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_aggregation_data_by_query2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/aggregation', + 'operation_id': 'get_aggregation_data_by_query2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_approute_grid_stat_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/device/tunnel/summary', + 'operation_id': 'get_approute_grid_stat', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/doccount', + 'operation_id': 'get_count4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/doccount', + 'operation_id': 'get_count_post4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/page', + 'operation_id': 'get_post_stat_bulk_raw_data2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/page', + 'operation_id': 'get_stat_bulk_raw_data2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/fields', + 'operation_id': 'get_stat_data_fields4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute', + 'operation_id': 'get_stat_data_raw_data2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv2_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/approute/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/query/fields', + 'operation_id': 'get_stat_query_fields4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute', + 'operation_id': 'get_stats_raw_data2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_transport_health_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/transport/{type}', + 'operation_id': 'get_transport_health', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'limit', + 'query', + ], + 'required': [ + 'type', + 'limit', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'limit': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'limit': 'limit', + 'query': 'query', + }, + 'location_map': { + 'type': 'path', + 'limit': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_transport_health_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/transport/summary/{type}', + 'operation_id': 'get_transport_health_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'limit', + 'query', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'limit': + (int,), + 'query': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'limit': 'limit', + 'query': 'query', + }, + 'location_map': { + 'type': 'path', + 'limit': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tunnel_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/device/tunnels', + 'operation_id': 'get_tunnel', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tunnel_chart_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/tunnel/{type}/summary', + 'operation_id': 'get_tunnel_chart', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'query', + ], + 'required': [ + 'type', + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'query': 'query', + }, + 'location_map': { + 'type': 'path', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tunnels_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/tunnels/{type}', + 'operation_id': 'get_tunnels', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'query', + 'limit', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'query': + (str,), + 'limit': + (int,), + }, + 'attribute_map': { + 'type': 'type', + 'query': 'query', + 'limit': 'limit', + }, + 'location_map': { + 'type': 'path', + 'query': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tunnels_health_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/tunnels/health/{type}', + 'operation_id': 'get_tunnels_health', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'limit', + 'last_n_hours', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'limit': + (int,), + 'last_n_hours': + (int,), + }, + 'attribute_map': { + 'type': 'type', + 'limit': 'limit', + 'last_n_hours': 'last_n_hours', + }, + 'location_map': { + 'type': 'path', + 'limit': 'query', + 'last_n_hours': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tunnels_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/tunnels/summary/{type}', + 'operation_id': 'get_tunnels_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'query', + 'limit', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'query': + (str,), + 'limit': + (int,), + }, + 'attribute_map': { + 'type': 'type', + 'query': 'query', + 'limit': 'limit', + }, + 'location_map': { + 'type': 'path', + 'query': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_aggregation_data_app_route( + self, + **kwargs + ): + """get_aggregation_data_app_route # noqa: E501 + + Get aggregation data and fec recovery rate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_app_route(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_app_route_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query2( + self, + **kwargs + ): + """get_aggregation_data_by_query2 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query2_endpoint.call_with_http_info(**kwargs) + + def get_approute_grid_stat( + self, + **kwargs + ): + """get_approute_grid_stat # noqa: E501 + + Get statistics for top applications per tunnel in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_approute_grid_stat(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_approute_grid_stat_endpoint.call_with_http_info(**kwargs) + + def get_count4( + self, + query, + **kwargs + ): + """get_count4 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count4(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count4_endpoint.call_with_http_info(**kwargs) + + def get_count_post4( + self, + **kwargs + ): + """get_count_post4 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post4_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query2( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query2 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query2_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query2( + self, + **kwargs + ): + """get_post_aggregation_data_by_query2 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query2_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data2( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data2 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data2_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data2( + self, + **kwargs + ): + """get_stat_bulk_raw_data2 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data2_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields4( + self, + **kwargs + ): + """get_stat_data_fields4 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields4_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data2( + self, + **kwargs + ): + """get_stat_data_raw_data2 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data2_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv2( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv2 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv2_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields4( + self, + **kwargs + ): + """get_stat_query_fields4 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields4_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data2( + self, + **kwargs + ): + """get_stats_raw_data2 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data2_endpoint.call_with_http_info(**kwargs) + + def get_transport_health( + self, + type, + limit, + **kwargs + ): + """get_transport_health # noqa: E501 + + Get application-aware routing statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transport_health(type, limit, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type + limit (str): Query filter + + Keyword Args: + query (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + kwargs['limit'] = \ + limit + return self.get_transport_health_endpoint.call_with_http_info(**kwargs) + + def get_transport_health_summary( + self, + type, + **kwargs + ): + """get_transport_health_summary # noqa: E501 + + Get application-aware routing statistics summary from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transport_health_summary(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type (example:latency) + + Keyword Args: + limit (int): Query result size. [optional] if omitted the server will use the default value of 5 + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.get_transport_health_summary_endpoint.call_with_http_info(**kwargs) + + def get_tunnel( + self, + **kwargs + ): + """get_tunnel # noqa: E501 + + Get statistics for top applications per tunnel in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tunnel(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tunnel_endpoint.call_with_http_info(**kwargs) + + def get_tunnel_chart( + self, + type, + query, + **kwargs + ): + """get_tunnel_chart # noqa: E501 + + Get tunnel top statistics in as chart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tunnel_chart(type, query, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type + query (str): Query filter + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + kwargs['query'] = \ + query + return self.get_tunnel_chart_endpoint.call_with_http_info(**kwargs) + + def get_tunnels( + self, + type, + **kwargs + ): + """get_tunnels # noqa: E501 + + Get tunnel top statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tunnels(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type + + Keyword Args: + query (str): Query filter. [optional] + limit (int): Query result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.get_tunnels_endpoint.call_with_http_info(**kwargs) + + def get_tunnels_health( + self, + type, + **kwargs + ): + """get_tunnels_health # noqa: E501 + + Get tunnel health # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tunnels_health(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type (example:latency) + + Keyword Args: + limit (int): Query result size. [optional] if omitted the server will use the default value of 10 + last_n_hours (int): Time range for health average. [optional] if omitted the server will use the default value of 3 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.get_tunnels_health_endpoint.call_with_http_info(**kwargs) + + def get_tunnels_summary( + self, + type, + **kwargs + ): + """get_tunnels_summary # noqa: E501 + + Get tunnel top statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tunnels_summary(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type + + Keyword Args: + query (str): Query filter. [optional] + limit (int): Query result size. [optional] if omitted the server will use the default value of 10 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.get_tunnels_summary_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_application_aware_routing_statistics_api.py b/openapi_client/api/monitoring_application_aware_routing_statistics_api.py new file mode 100644 index 0000000..36c1917 --- /dev/null +++ b/openapi_client/api/monitoring_application_aware_routing_statistics_api.py @@ -0,0 +1,330 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringApplicationAwareRoutingStatisticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_transport_health_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/transport/{type}', + 'operation_id': 'get_transport_health', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'limit', + 'query', + ], + 'required': [ + 'type', + 'limit', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'limit': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'limit': 'limit', + 'query': 'query', + }, + 'location_map': { + 'type': 'path', + 'limit': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_transport_health_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/approute/transport/summary/{type}', + 'operation_id': 'get_transport_health_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'limit', + 'query', + ], + 'required': [ + 'type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'limit': + (int,), + 'query': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'limit': 'limit', + 'query': 'query', + }, + 'location_map': { + 'type': 'path', + 'limit': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_transport_health( + self, + type, + limit, + **kwargs + ): + """get_transport_health # noqa: E501 + + Get application-aware routing statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transport_health(type, limit, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type + limit (str): Query filter + + Keyword Args: + query (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + kwargs['limit'] = \ + limit + return self.get_transport_health_endpoint.call_with_http_info(**kwargs) + + def get_transport_health_summary( + self, + type, + **kwargs + ): + """get_transport_health_summary # noqa: E501 + + Get application-aware routing statistics summary from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_transport_health_summary(type, async_req=True) + >>> result = thread.get() + + Args: + type (str): Type (example:latency) + + Keyword Args: + limit (int): Query result size. [optional] if omitted the server will use the default value of 5 + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['type'] = \ + type + return self.get_transport_health_summary_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_art_api.py b/openapi_client/api/monitoring_art_api.py new file mode 100644 index 0000000..29fcc80 --- /dev/null +++ b/openapi_client/api/monitoring_art_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringARTApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/aggregation', + 'operation_id': 'get_aggregation_data_by_query3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/doccount', + 'operation_id': 'get_count5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/doccount', + 'operation_id': 'get_count_post5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/page', + 'operation_id': 'get_post_stat_bulk_raw_data3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/page', + 'operation_id': 'get_stat_bulk_raw_data3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/fields', + 'operation_id': 'get_stat_data_fields5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art', + 'operation_id': 'get_stat_data_raw_data3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv3_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/art/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv3', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art/query/fields', + 'operation_id': 'get_stat_query_fields5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data3_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/art', + 'operation_id': 'get_stats_raw_data3', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query3( + self, + **kwargs + ): + """get_aggregation_data_by_query3 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query3_endpoint.call_with_http_info(**kwargs) + + def get_count5( + self, + query, + **kwargs + ): + """get_count5 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count5(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count5_endpoint.call_with_http_info(**kwargs) + + def get_count_post5( + self, + **kwargs + ): + """get_count_post5 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post5_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query3( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query3 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query3_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query3( + self, + **kwargs + ): + """get_post_aggregation_data_by_query3 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query3_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data3( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data3 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data3_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data3( + self, + **kwargs + ): + """get_stat_bulk_raw_data3 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data3_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields5( + self, + **kwargs + ): + """get_stat_data_fields5 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields5_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data3( + self, + **kwargs + ): + """get_stat_data_raw_data3 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data3_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv3( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv3 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv3_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields5( + self, + **kwargs + ): + """get_stat_query_fields5 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields5_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data3( + self, + **kwargs + ): + """get_stats_raw_data3 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data3(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data3_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_bfd_api.py b/openapi_client/api/monitoring_bfd_api.py new file mode 100644 index 0000000..f874f28 --- /dev/null +++ b/openapi_client/api/monitoring_bfd_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringBFDApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/aggregation', + 'operation_id': 'get_aggregation_data_by_query4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/doccount', + 'operation_id': 'get_count6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/doccount', + 'operation_id': 'get_count_post6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/page', + 'operation_id': 'get_post_stat_bulk_raw_data4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/page', + 'operation_id': 'get_stat_bulk_raw_data4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/fields', + 'operation_id': 'get_stat_data_fields6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd', + 'operation_id': 'get_stat_data_raw_data4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv4_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/bfd/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv4', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd/query/fields', + 'operation_id': 'get_stat_query_fields6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data4_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bfd', + 'operation_id': 'get_stats_raw_data4', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query4( + self, + **kwargs + ): + """get_aggregation_data_by_query4 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query4_endpoint.call_with_http_info(**kwargs) + + def get_count6( + self, + query, + **kwargs + ): + """get_count6 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count6(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count6_endpoint.call_with_http_info(**kwargs) + + def get_count_post6( + self, + **kwargs + ): + """get_count_post6 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post6_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query4( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query4 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query4_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query4( + self, + **kwargs + ): + """get_post_aggregation_data_by_query4 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query4_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data4( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data4 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data4_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data4( + self, + **kwargs + ): + """get_stat_bulk_raw_data4 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data4_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields6( + self, + **kwargs + ): + """get_stat_data_fields6 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields6_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data4( + self, + **kwargs + ): + """get_stat_data_raw_data4 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data4_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv4( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv4 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv4_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields6( + self, + **kwargs + ): + """get_stat_query_fields6 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields6_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data4( + self, + **kwargs + ): + """get_stats_raw_data4 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data4(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data4_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_bridge_api.py b/openapi_client/api/monitoring_bridge_api.py new file mode 100644 index 0000000..95b940f --- /dev/null +++ b/openapi_client/api/monitoring_bridge_api.py @@ -0,0 +1,3204 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringBridgeApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/aggregation', + 'operation_id': 'get_aggregation_data_by_query5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/aggregation', + 'operation_id': 'get_aggregation_data_by_query6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/doccount', + 'operation_id': 'get_count7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/doccount', + 'operation_id': 'get_count8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/doccount', + 'operation_id': 'get_count_post7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_count_post8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/doccount', + 'operation_id': 'get_count_post8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/page', + 'operation_id': 'get_post_stat_bulk_raw_data5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/page', + 'operation_id': 'get_post_stat_bulk_raw_data6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/page', + 'operation_id': 'get_stat_bulk_raw_data5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/page', + 'operation_id': 'get_stat_bulk_raw_data6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/fields', + 'operation_id': 'get_stat_data_fields7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/fields', + 'operation_id': 'get_stat_data_fields8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface', + 'operation_id': 'get_stat_data_raw_data5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac', + 'operation_id': 'get_stat_data_raw_data6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv5_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv5', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv6_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface/query/fields', + 'operation_id': 'get_stat_query_fields7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac/query/fields', + 'operation_id': 'get_stat_query_fields8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data5_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgeinterface', + 'operation_id': 'get_stats_raw_data5', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stats_raw_data6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/bridgemac', + 'operation_id': 'get_stats_raw_data6', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query5( + self, + **kwargs + ): + """get_aggregation_data_by_query5 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query5_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query6( + self, + **kwargs + ): + """get_aggregation_data_by_query6 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query6_endpoint.call_with_http_info(**kwargs) + + def get_count7( + self, + query, + **kwargs + ): + """get_count7 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count7(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count7_endpoint.call_with_http_info(**kwargs) + + def get_count8( + self, + query, + **kwargs + ): + """get_count8 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count8(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count8_endpoint.call_with_http_info(**kwargs) + + def get_count_post7( + self, + **kwargs + ): + """get_count_post7 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post7_endpoint.call_with_http_info(**kwargs) + + def get_count_post8( + self, + **kwargs + ): + """get_count_post8 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post8_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query5( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query5 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query5_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query6( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query6 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query6_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query5( + self, + **kwargs + ): + """get_post_aggregation_data_by_query5 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query5_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query6( + self, + **kwargs + ): + """get_post_aggregation_data_by_query6 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query6_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data5( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data5 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data5_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data6( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data6 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data6_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data5( + self, + **kwargs + ): + """get_stat_bulk_raw_data5 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data5_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data6( + self, + **kwargs + ): + """get_stat_bulk_raw_data6 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data6_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields7( + self, + **kwargs + ): + """get_stat_data_fields7 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields7_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields8( + self, + **kwargs + ): + """get_stat_data_fields8 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields8_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data5( + self, + **kwargs + ): + """get_stat_data_raw_data5 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data5_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data6( + self, + **kwargs + ): + """get_stat_data_raw_data6 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data6_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv5( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv5 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv5_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv6( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv6 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv6_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields7( + self, + **kwargs + ): + """get_stat_query_fields7 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields7_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields8( + self, + **kwargs + ): + """get_stat_query_fields8 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields8_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data5( + self, + **kwargs + ): + """get_stats_raw_data5 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data5(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data5_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data6( + self, + **kwargs + ): + """get_stats_raw_data6 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data6(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data6_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_cellular_eiolte_api.py b/openapi_client/api/monitoring_cellular_eiolte_api.py new file mode 100644 index 0000000..94f9f0d --- /dev/null +++ b/openapi_client/api/monitoring_cellular_eiolte_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringCellularEIOLTEApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/aggregation', + 'operation_id': 'get_aggregation_data_by_query7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/doccount', + 'operation_id': 'get_count9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/doccount', + 'operation_id': 'get_count_post9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/page', + 'operation_id': 'get_post_stat_bulk_raw_data7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/page', + 'operation_id': 'get_stat_bulk_raw_data7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/fields', + 'operation_id': 'get_stat_data_fields9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte', + 'operation_id': 'get_stat_data_raw_data7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv7_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv7', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte/query/fields', + 'operation_id': 'get_stat_query_fields9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data7_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/eiolte', + 'operation_id': 'get_stats_raw_data7', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query7( + self, + **kwargs + ): + """get_aggregation_data_by_query7 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query7_endpoint.call_with_http_info(**kwargs) + + def get_count9( + self, + query, + **kwargs + ): + """get_count9 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count9(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count9_endpoint.call_with_http_info(**kwargs) + + def get_count_post9( + self, + **kwargs + ): + """get_count_post9 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post9_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query7( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query7 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query7_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query7( + self, + **kwargs + ): + """get_post_aggregation_data_by_query7 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query7_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data7( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data7 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data7_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data7( + self, + **kwargs + ): + """get_stat_bulk_raw_data7 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data7_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields9( + self, + **kwargs + ): + """get_stat_data_fields9 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields9_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data7( + self, + **kwargs + ): + """get_stat_data_raw_data7 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data7_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv7( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv7 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv7_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields9( + self, + **kwargs + ): + """get_stat_query_fields9 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields9_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data7( + self, + **kwargs + ): + """get_stats_raw_data7 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data7(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data7_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_cflowd_api.py b/openapi_client/api/monitoring_cflowd_api.py new file mode 100644 index 0000000..a722168 --- /dev/null +++ b/openapi_client/api/monitoring_cflowd_api.py @@ -0,0 +1,3720 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringCflowdApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_cflow_collector_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cflowd/flows', + 'operation_id': 'create_cflow_collector_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'src_ip', + 'dest_ip', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'src_ip': + (str,), + 'dest_ip': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'src_ip': 'src-ip', + 'dest_ip': 'dest-ip', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'src_ip': 'query', + 'dest_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cflowd_collector_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cflowd/collector', + 'operation_id': 'create_cflowd_collector_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cflowd_flows_count_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/flows-count', + 'operation_id': 'create_cflowd_flows_count_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'src_ip', + 'dest_ip', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'src_ip': + (str,), + 'dest_ip': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'src_ip': 'src-ip', + 'dest_ip': 'dest-ip', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'src_ip': 'query', + 'dest_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cflowd_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/statistics', + 'operation_id': 'create_cflowd_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cflowd_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/template', + 'operation_id': 'create_cflowd_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_flow_device_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/device/applications', + 'operation_id': 'create_flow_device_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_flows_grid_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/applications', + 'operation_id': 'create_flows_grid', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn', + 'device_id', + 'limit', + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vpn': + (str,), + 'device_id': + (str,), + 'limit': + (int,), + 'query': + (str,), + }, + 'attribute_map': { + 'vpn': 'vpn', + 'device_id': 'deviceId', + 'limit': 'limit', + 'query': 'query', + }, + 'location_map': { + 'vpn': 'query', + 'device_id': 'query', + 'limit': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_flowssummary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/applications/summary', + 'operation_id': 'create_flowssummary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'limit', + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'limit': + (int,), + 'query': + (str,), + }, + 'attribute_map': { + 'limit': 'limit', + 'query': 'query', + }, + 'location_map': { + 'limit': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/aggregation', + 'operation_id': 'get_aggregation_data_by_query8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cflowd_dpi_device_field_json_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/application/fields', + 'operation_id': 'get_cflowd_dpi_device_field_json', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_device_dash_board', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_device_dash_board': + (bool,), + }, + 'attribute_map': { + 'is_device_dash_board': 'isDeviceDashBoard', + }, + 'location_map': { + 'is_device_dash_board': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cflowd_dpi_field_json_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/device/fields', + 'operation_id': 'get_cflowd_dpi_field_json', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_device_dash_board', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_device_dash_board': + (bool,), + }, + 'attribute_map': { + 'is_device_dash_board': 'isDeviceDashBoard', + }, + 'location_map': { + 'is_device_dash_board': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/doccount', + 'operation_id': 'get_count10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/doccount', + 'operation_id': 'get_count_post10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_fn_f_cache_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/fnf/cache-stats', + 'operation_id': 'get_fn_f_cache_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_fn_f_export_client_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/fnf/export-client-stats', + 'operation_id': 'get_fn_f_export_client_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_fn_f_export_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/fnf/export-stats', + 'operation_id': 'get_fn_f_export_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_fn_f_monitor_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/fnf/monitor-stats', + 'operation_id': 'get_fn_f_monitor_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_fnf_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cflowd/fnf/flow-monitor', + 'operation_id': 'get_fnf', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/page', + 'operation_id': 'get_post_stat_bulk_raw_data8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/page', + 'operation_id': 'get_stat_bulk_raw_data8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/fields', + 'operation_id': 'get_stat_data_fields10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd', + 'operation_id': 'get_stat_data_raw_data8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv8_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv8', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd/query/fields', + 'operation_id': 'get_stat_query_fields10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data8_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cflowd', + 'operation_id': 'get_stats_raw_data8', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_cflow_collector_list( + self, + device_id, + **kwargs + ): + """create_cflow_collector_list # noqa: E501 + + Get list of cflowd flows from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cflow_collector_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + src_ip (str): Source IP. [optional] + dest_ip (str): Destination IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cflow_collector_list_endpoint.call_with_http_info(**kwargs) + + def create_cflowd_collector_list( + self, + device_id, + **kwargs + ): + """create_cflowd_collector_list # noqa: E501 + + Get cflowd collector list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cflowd_collector_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cflowd_collector_list_endpoint.call_with_http_info(**kwargs) + + def create_cflowd_flows_count_list( + self, + device_id, + **kwargs + ): + """create_cflowd_flows_count_list # noqa: E501 + + Get cflowd flow count from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cflowd_flows_count_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + src_ip (str): Source IP. [optional] + dest_ip (str): Destination IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cflowd_flows_count_list_endpoint.call_with_http_info(**kwargs) + + def create_cflowd_statistics( + self, + device_id, + **kwargs + ): + """create_cflowd_statistics # noqa: E501 + + Get cflowd statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cflowd_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cflowd_statistics_endpoint.call_with_http_info(**kwargs) + + def create_cflowd_template( + self, + device_id, + **kwargs + ): + """create_cflowd_template # noqa: E501 + + Get cflowd template from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cflowd_template(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cflowd_template_endpoint.call_with_http_info(**kwargs) + + def create_flow_device_data( + self, + **kwargs + ): + """create_flow_device_data # noqa: E501 + + Generate cflowd flows list in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_flow_device_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_flow_device_data_endpoint.call_with_http_info(**kwargs) + + def create_flows_grid( + self, + **kwargs + ): + """create_flows_grid # noqa: E501 + + Generate cflowd flows list in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_flows_grid(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vpn (str): VPN Id. [optional] + device_id (str): Device IP. [optional] + limit (int): Limit. [optional] + query (str): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_flows_grid_endpoint.call_with_http_info(**kwargs) + + def create_flowssummary( + self, + **kwargs + ): + """create_flowssummary # noqa: E501 + + Generate cflowd flows list in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_flowssummary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + limit (int): Limit. [optional] + query (str): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_flowssummary_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query8( + self, + **kwargs + ): + """get_aggregation_data_by_query8 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query8_endpoint.call_with_http_info(**kwargs) + + def get_cflowd_dpi_device_field_json( + self, + **kwargs + ): + """get_cflowd_dpi_device_field_json # noqa: E501 + + Get Cflowd DPI query field JSON # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cflowd_dpi_device_field_json(async_req=True) + >>> result = thread.get() + + + Keyword Args: + is_device_dash_board (bool): Flag whether it is device dashboard request. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cflowd_dpi_device_field_json_endpoint.call_with_http_info(**kwargs) + + def get_cflowd_dpi_field_json( + self, + **kwargs + ): + """get_cflowd_dpi_field_json # noqa: E501 + + Get CflowdvDPI query field JSON # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cflowd_dpi_field_json(async_req=True) + >>> result = thread.get() + + + Keyword Args: + is_device_dash_board (bool): Flag whether it is device dashboard request. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cflowd_dpi_field_json_endpoint.call_with_http_info(**kwargs) + + def get_count10( + self, + query, + **kwargs + ): + """get_count10 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count10(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count10_endpoint.call_with_http_info(**kwargs) + + def get_count_post10( + self, + **kwargs + ): + """get_count_post10 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post10_endpoint.call_with_http_info(**kwargs) + + def get_fn_f_cache_stats( + self, + device_id, + **kwargs + ): + """get_fn_f_cache_stats # noqa: E501 + + Get FnF cache stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fn_f_cache_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_fn_f_cache_stats_endpoint.call_with_http_info(**kwargs) + + def get_fn_f_export_client_stats( + self, + device_id, + **kwargs + ): + """get_fn_f_export_client_stats # noqa: E501 + + Get FnF export client stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fn_f_export_client_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_fn_f_export_client_stats_endpoint.call_with_http_info(**kwargs) + + def get_fn_f_export_stats( + self, + device_id, + **kwargs + ): + """get_fn_f_export_stats # noqa: E501 + + Get FnF export stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fn_f_export_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_fn_f_export_stats_endpoint.call_with_http_info(**kwargs) + + def get_fn_f_monitor_stats( + self, + device_id, + **kwargs + ): + """get_fn_f_monitor_stats # noqa: E501 + + Get FnF monitor stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fn_f_monitor_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_fn_f_monitor_stats_endpoint.call_with_http_info(**kwargs) + + def get_fnf( + self, + device_id, + **kwargs + ): + """get_fnf # noqa: E501 + + Get FnF from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fnf(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_fnf_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query8( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query8 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query8_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query8( + self, + **kwargs + ): + """get_post_aggregation_data_by_query8 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query8_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data8( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data8 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data8_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data8( + self, + **kwargs + ): + """get_stat_bulk_raw_data8 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data8_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields10( + self, + **kwargs + ): + """get_stat_data_fields10 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields10_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data8( + self, + **kwargs + ): + """get_stat_data_raw_data8 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data8_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv8( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv8 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv8_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields10( + self, + **kwargs + ): + """get_stat_query_fields10 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields10_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data8( + self, + **kwargs + ): + """get_stats_raw_data8 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data8(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data8_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_cloud_express_api.py b/openapi_client/api/monitoring_cloud_express_api.py new file mode 100644 index 0000000..301d7ad --- /dev/null +++ b/openapi_client/api/monitoring_cloud_express_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringCloudExpressApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/aggregation', + 'operation_id': 'get_aggregation_data_by_query9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/doccount', + 'operation_id': 'get_count11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/doccount', + 'operation_id': 'get_count_post11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/page', + 'operation_id': 'get_post_stat_bulk_raw_data9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/page', + 'operation_id': 'get_stat_bulk_raw_data9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/fields', + 'operation_id': 'get_stat_data_fields11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx', + 'operation_id': 'get_stat_data_raw_data9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv9_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv9', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx/query/fields', + 'operation_id': 'get_stat_query_fields11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data9_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/cloudx', + 'operation_id': 'get_stats_raw_data9', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query9( + self, + **kwargs + ): + """get_aggregation_data_by_query9 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query9_endpoint.call_with_http_info(**kwargs) + + def get_count11( + self, + query, + **kwargs + ): + """get_count11 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count11(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count11_endpoint.call_with_http_info(**kwargs) + + def get_count_post11( + self, + **kwargs + ): + """get_count_post11 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post11_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query9( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query9 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query9_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query9( + self, + **kwargs + ): + """get_post_aggregation_data_by_query9 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query9_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data9( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data9 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data9_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data9( + self, + **kwargs + ): + """get_stat_bulk_raw_data9 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data9_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields11( + self, + **kwargs + ): + """get_stat_data_fields11 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields11_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data9( + self, + **kwargs + ): + """get_stat_data_raw_data9 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data9_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv9( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv9 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv9_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields11( + self, + **kwargs + ): + """get_stat_query_fields11 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields11_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data9( + self, + **kwargs + ): + """get_stats_raw_data9 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data9(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data9_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_device_details_api.py b/openapi_client/api/monitoring_device_details_api.py new file mode 100644 index 0000000..74ac096 --- /dev/null +++ b/openapi_client/api/monitoring_device_details_api.py @@ -0,0 +1,4359 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device import Device + + +class MonitoringDeviceDetailsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_tier_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tier', + 'operation_id': 'add_tier', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'add_tier', + ], + 'required': [ + 'add_tier', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'add_tier': + (str,), + }, + 'attribute_map': { + 'add_tier': 'addTier', + }, + 'location_map': { + 'add_tier': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_tier_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tier/{tierName}', + 'operation_id': 'delete_tier', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'tier_name', + ], + 'required': [ + 'tier_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tier_name': + (str,), + }, + 'attribute_map': { + 'tier_name': 'tierName', + }, + 'location_map': { + 'tier_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.enable_sdavcon_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/enableSDAVC/{deviceIP}/{enable}', + 'operation_id': 'enable_sdavcon_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'enable', + ], + 'required': [ + 'device_ip', + 'enable', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'enable': + (bool,), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + 'enable': 'enable', + }, + 'location_map': { + 'device_ip': 'path', + 'enable': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_device_state_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/data/device/state/{state_data_type}', + 'operation_id': 'generate_device_state_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + 'start_id', + 'count', + ], + 'required': [ + 'state_data_type', + 'start_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + 'start_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + 'start_id': 'startId', + 'count': 'count', + }, + 'location_map': { + 'state_data_type': 'path', + 'start_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_device_state_data_fields_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/data/device/state/{state_data_type}/fields', + 'operation_id': 'generate_device_state_data_fields', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + ], + 'required': [ + 'state_data_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + }, + 'location_map': { + 'state_data_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_device_state_data_with_query_string_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/data/device/state/{state_data_type}/query', + 'operation_id': 'generate_device_state_data_with_query_string', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + ], + 'required': [ + 'state_data_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + }, + 'location_map': { + 'state_data_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_device_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/status', + 'operation_id': 'get_all_device_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_counters_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/counters', + 'operation_id': 'get_device_counters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_list_as_key_value_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/keyvalue', + 'operation_id': 'get_device_list_as_key_value', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_models_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/models/{uuid}', + 'operation_id': 'get_device_models', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_only_status_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/devicestatus', + 'operation_id': 'get_device_only_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_running_config_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/device/config', + 'operation_id': 'get_device_running_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([str],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'text/xml' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_running_config_html_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/device/config/html', + 'operation_id': 'get_device_running_config_html', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([str],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'text/html' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_tloc_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tloc', + 'operation_id': 'get_device_tloc_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'color', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'color': 'color', + }, + 'location_map': { + 'device_id': 'query', + 'color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_tloc_util_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tlocutil', + 'operation_id': 'get_device_tloc_util', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_tloc_util_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tlocutil/detail', + 'operation_id': 'get_device_tloc_util_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'util', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'util': + (str,), + }, + 'attribute_map': { + 'util': 'util', + }, + 'location_map': { + 'util': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_hardware_health_details_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/hardwarehealth/detail', + 'operation_id': 'get_hardware_health_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'state', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'state': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'state': 'state', + }, + 'location_map': { + 'device_id': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_hardware_health_summary_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/hardwarehealth/summary', + 'operation_id': 'get_hardware_health_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'is_cached', + ], + 'required': [ + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vpn_id': + ([str],), + 'is_cached': + (bool,), + }, + 'attribute_map': { + 'vpn_id': 'vpnId', + 'is_cached': 'isCached', + }, + 'location_map': { + 'vpn_id': 'query', + 'is_cached': 'query', + }, + 'collection_format_map': { + 'vpn_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_queues_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/stats', + 'operation_id': 'get_stats_queues', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sync_queues_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/queues', + 'operation_id': 'get_sync_queues', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tiers_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tier', + 'operation_id': 'get_tiers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_unconfigured_endpoint = _Endpoint( + settings={ + 'response_type': ([Device],), + 'auth': [], + 'endpoint_path': '/device/unconfigured', + 'operation_id': 'get_unconfigured', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_v_manage_system_ip_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vmanage', + 'operation_id': 'get_v_manage_system_ip', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vedge_inventory_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vedgeinventory/detail', + 'operation_id': 'get_vedge_inventory', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'status', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'status': + (str,), + }, + 'attribute_map': { + 'status': 'status', + }, + 'location_map': { + 'status': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vedge_inventory_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vedgeinventory/summary', + 'operation_id': 'get_vedge_inventory_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_all_device_models_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/models', + 'operation_id': 'list_all_device_models', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'list', + ], + 'required': [ + 'list', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'list': + (str,), + }, + 'attribute_map': { + 'list': 'list', + }, + 'location_map': { + 'list': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_all_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device', + 'operation_id': 'list_all_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_all_monitor_details_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/monitor', + 'operation_id': 'list_all_monitor_details_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_currently_syncing_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/sync_status', + 'operation_id': 'list_currently_syncing_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'group_id', + ], + 'required': [ + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'group_id': + (str,), + }, + 'attribute_map': { + 'group_id': 'groupId', + }, + 'location_map': { + 'group_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_reachable_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/reachable', + 'operation_id': 'list_reachable_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_unreachable_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/unreachable', + 'operation_id': 'list_unreachable_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'personality', + ], + 'required': [ + 'personality', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'personality': + (str,), + }, + 'attribute_map': { + 'personality': 'personality', + }, + 'location_map': { + 'personality': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.remove_unreachable_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/unreachable/{deviceIP}', + 'operation_id': 'remove_unreachable_device', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.set_block_sync_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/blockSync', + 'operation_id': 'set_block_sync', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'block_sync', + ], + 'required': [ + 'block_sync', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'block_sync': + (str,), + }, + 'attribute_map': { + 'block_sync': 'blockSync', + }, + 'location_map': { + 'block_sync': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.sync_all_devices_mem_db_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/syncall/memorydb', + 'operation_id': 'sync_all_devices_mem_db', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def add_tier( + self, + add_tier, + **kwargs + ): + """add_tier # noqa: E501 + + add tier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_tier(add_tier, async_req=True) + >>> result = thread.get() + + Args: + add_tier (str): addTier + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['add_tier'] = \ + add_tier + return self.add_tier_endpoint.call_with_http_info(**kwargs) + + def delete_tier( + self, + tier_name, + **kwargs + ): + """delete_tier # noqa: E501 + + deleteTier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tier(tier_name, async_req=True) + >>> result = thread.get() + + Args: + tier_name (str): deletetier + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tier_name'] = \ + tier_name + return self.delete_tier_endpoint.call_with_http_info(**kwargs) + + def enable_sdavcon_device( + self, + device_ip, + enable, + **kwargs + ): + """enable_sdavcon_device # noqa: E501 + + Enable/Disable SDAVC on device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_sdavcon_device(device_ip, enable, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + enable (bool): Enable/Disable flag + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + kwargs['enable'] = \ + enable + return self.enable_sdavcon_device_endpoint.call_with_http_info(**kwargs) + + def generate_device_state_data( + self, + state_data_type, + start_id, + **kwargs + ): + """generate_device_state_data # noqa: E501 + + Get device state data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_state_data(state_data_type, start_id, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): State data type + start_id (str): Start Id + + Keyword Args: + count (str): Count. [optional] if omitted the server will use the default value of "1000" + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + kwargs['start_id'] = \ + start_id + return self.generate_device_state_data_endpoint.call_with_http_info(**kwargs) + + def generate_device_state_data_fields( + self, + state_data_type, + **kwargs + ): + """generate_device_state_data_fields # noqa: E501 + + Get device state data fileds # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_state_data_fields(state_data_type, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): State data type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + return self.generate_device_state_data_fields_endpoint.call_with_http_info(**kwargs) + + def generate_device_state_data_with_query_string( + self, + state_data_type, + **kwargs + ): + """generate_device_state_data_with_query_string # noqa: E501 + + Get device state data fileds # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_state_data_with_query_string(state_data_type, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): State data type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + return self.generate_device_state_data_with_query_string_endpoint.call_with_http_info(**kwargs) + + def get_all_device_status( + self, + **kwargs + ): + """get_all_device_status # noqa: E501 + + Get devices status for vSmart,vBond,vEdge, and cEdge # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_device_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_device_status_endpoint.call_with_http_info(**kwargs) + + def get_device_counters( + self, + **kwargs + ): + """get_device_counters # noqa: E501 + + Get device counters # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_counters(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_counters_endpoint.call_with_http_info(**kwargs) + + def get_device_list_as_key_value( + self, + **kwargs + ): + """get_device_list_as_key_value # noqa: E501 + + Get vEdge inventory as key value (key as systemIp value as hostName) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_list_as_key_value(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_list_as_key_value_endpoint.call_with_http_info(**kwargs) + + def get_device_models( + self, + uuid, + **kwargs + ): + """get_device_models # noqa: E501 + + Get device model for the device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_models(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_device_models_endpoint.call_with_http_info(**kwargs) + + def get_device_only_status( + self, + **kwargs + ): + """get_device_only_status # noqa: E501 + + Get devices status per type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_only_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_only_status_endpoint.call_with_http_info(**kwargs) + + def get_device_running_config( + self, + device_id, + **kwargs + ): + """get_device_running_config # noqa: E501 + + Get device running configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_running_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([str]): Device Id list + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_running_config_endpoint.call_with_http_info(**kwargs) + + def get_device_running_config_html( + self, + device_id, + **kwargs + ): + """get_device_running_config_html # noqa: E501 + + Get device running configuration in HTML format # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_running_config_html(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([str]): Device Id list + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_running_config_html_endpoint.call_with_http_info(**kwargs) + + def get_device_tloc_status( + self, + **kwargs + ): + """get_device_tloc_status # noqa: E501 + + Get TLOC status list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tloc_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): Device Id. [optional] + color (str): Status color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_tloc_status_endpoint.call_with_http_info(**kwargs) + + def get_device_tloc_util( + self, + **kwargs + ): + """get_device_tloc_util # noqa: E501 + + Get TLOC list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tloc_util(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_tloc_util_endpoint.call_with_http_info(**kwargs) + + def get_device_tloc_util_details( + self, + **kwargs + ): + """get_device_tloc_util_details # noqa: E501 + + Get detailed TLOC list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tloc_util_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + util (str): Tloc util. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_tloc_util_details_endpoint.call_with_http_info(**kwargs) + + def get_hardware_health_details( + self, + **kwargs + ): + """get_hardware_health_details # noqa: E501 + + Get hardware health details for device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_hardware_health_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): Device Id. [optional] + state (str): Device state. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_hardware_health_details_endpoint.call_with_http_info(**kwargs) + + def get_hardware_health_summary( + self, + vpn_id, + **kwargs + ): + """get_hardware_health_summary # noqa: E501 + + Get hardware health summary for device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_hardware_health_summary(vpn_id, async_req=True) + >>> result = thread.get() + + Args: + vpn_id ([str]): VPN Id + + Keyword Args: + is_cached (bool): Status cached. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vpn_id'] = \ + vpn_id + return self.get_hardware_health_summary_endpoint.call_with_http_info(**kwargs) + + def get_stats_queues( + self, + **kwargs + ): + """get_stats_queues # noqa: E501 + + Get stats queue information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_queues(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_queues_endpoint.call_with_http_info(**kwargs) + + def get_sync_queues( + self, + **kwargs + ): + """get_sync_queues # noqa: E501 + + Get synchronized queue information, returns information about syncing, queued and stuck devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sync_queues(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sync_queues_endpoint.call_with_http_info(**kwargs) + + def get_tiers( + self, + **kwargs + ): + """get_tiers # noqa: E501 + + getTiers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tiers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tiers_endpoint.call_with_http_info(**kwargs) + + def get_unconfigured( + self, + **kwargs + ): + """get_unconfigured # noqa: E501 + + Get wan edge devices not configured by vManage (that is, those in CLI mode) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_unconfigured(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [Device] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_unconfigured_endpoint.call_with_http_info(**kwargs) + + def get_v_manage_system_ip( + self, + **kwargs + ): + """get_v_manage_system_ip # noqa: E501 + + Get vManage system IP # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_v_manage_system_ip(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_v_manage_system_ip_endpoint.call_with_http_info(**kwargs) + + def get_vedge_inventory( + self, + **kwargs + ): + """get_vedge_inventory # noqa: E501 + + Get detailed vEdge inventory # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vedge_inventory(async_req=True) + >>> result = thread.get() + + + Keyword Args: + status (str): Device status. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vedge_inventory_endpoint.call_with_http_info(**kwargs) + + def get_vedge_inventory_summary( + self, + **kwargs + ): + """get_vedge_inventory_summary # noqa: E501 + + Get vEdge inventory # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vedge_inventory_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vedge_inventory_summary_endpoint.call_with_http_info(**kwargs) + + def list_all_device_models( + self, + list="all", + **kwargs + ): + """list_all_device_models # noqa: E501 + + Get all device models supported by the vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_all_device_models(list="all", async_req=True) + >>> result = thread.get() + + Args: + list (str): List type of device. defaults to "all", must be one of ["all"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['list'] = \ + list + return self.list_all_device_models_endpoint.call_with_http_info(**kwargs) + + def list_all_devices( + self, + **kwargs + ): + """list_all_devices # noqa: E501 + + List all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_all_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_all_devices_endpoint.call_with_http_info(**kwargs) + + def list_all_monitor_details_devices( + self, + **kwargs + ): + """list_all_monitor_details_devices # noqa: E501 + + Get all monitoring details of the devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_all_monitor_details_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_all_monitor_details_devices_endpoint.call_with_http_info(**kwargs) + + def list_currently_syncing_devices( + self, + group_id="all", + **kwargs + ): + """list_currently_syncing_devices # noqa: E501 + + Get list of currently syncing devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_currently_syncing_devices(group_id="all", async_req=True) + >>> result = thread.get() + + Args: + group_id (str): Group Id. defaults to "all", must be one of ["all"] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['group_id'] = \ + group_id + return self.list_currently_syncing_devices_endpoint.call_with_http_info(**kwargs) + + def list_reachable_devices( + self, + **kwargs + ): + """list_reachable_devices # noqa: E501 + + Get list of reachable devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_reachable_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_reachable_devices_endpoint.call_with_http_info(**kwargs) + + def list_unreachable_devices( + self, + personality, + **kwargs + ): + """list_unreachable_devices # noqa: E501 + + Get list of unreachable devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_unreachable_devices(personality, async_req=True) + >>> result = thread.get() + + Args: + personality (str): Device personality (vedge OR vsmart OR vbond... ) + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['personality'] = \ + personality + return self.list_unreachable_devices_endpoint.call_with_http_info(**kwargs) + + def remove_unreachable_device( + self, + device_ip, + **kwargs + ): + """remove_unreachable_device # noqa: E501 + + Delete unreachable device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remove_unreachable_device(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.remove_unreachable_device_endpoint.call_with_http_info(**kwargs) + + def set_block_sync( + self, + block_sync, + **kwargs + ): + """set_block_sync # noqa: E501 + + Set collection manager block set flag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_block_sync(block_sync, async_req=True) + >>> result = thread.get() + + Args: + block_sync (str): Block sync flag + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['block_sync'] = \ + block_sync + return self.set_block_sync_endpoint.call_with_http_info(**kwargs) + + def sync_all_devices_mem_db( + self, + **kwargs + ): + """sync_all_devices_mem_db # noqa: E501 + + Synchronize memory database for all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_all_devices_mem_db(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_all_devices_mem_db_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_device_statistics_api.py b/openapi_client/api/monitoring_device_statistics_api.py new file mode 100644 index 0000000..18c1c57 --- /dev/null +++ b/openapi_client/api/monitoring_device_statistics_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringDeviceStatisticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/aggregation', + 'operation_id': 'get_aggregation_data_by_query15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/doccount', + 'operation_id': 'get_count17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/doccount', + 'operation_id': 'get_count_post17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/page', + 'operation_id': 'get_post_stat_bulk_raw_data15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/page', + 'operation_id': 'get_stat_bulk_raw_data15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/fields', + 'operation_id': 'get_stat_data_fields17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device', + 'operation_id': 'get_stat_data_raw_data14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv15_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/device/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device/query/fields', + 'operation_id': 'get_stat_query_fields17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/device', + 'operation_id': 'get_stats_raw_data15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query15( + self, + **kwargs + ): + """get_aggregation_data_by_query15 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query15_endpoint.call_with_http_info(**kwargs) + + def get_count17( + self, + query, + **kwargs + ): + """get_count17 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count17(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count17_endpoint.call_with_http_info(**kwargs) + + def get_count_post17( + self, + **kwargs + ): + """get_count_post17 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post17_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query14( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query14 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query14_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query14( + self, + **kwargs + ): + """get_post_aggregation_data_by_query14 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query14_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data15( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data15 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data15_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data15( + self, + **kwargs + ): + """get_stat_bulk_raw_data15 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data15_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields17( + self, + **kwargs + ): + """get_stat_data_fields17 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields17_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data14( + self, + **kwargs + ): + """get_stat_data_raw_data14 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data14_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv15( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv15 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv15_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields17( + self, + **kwargs + ): + """get_stat_query_fields17 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields17_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data15( + self, + **kwargs + ): + """get_stats_raw_data15 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data15_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_device_statistics_details_api.py b/openapi_client/api/monitoring_device_statistics_details_api.py new file mode 100644 index 0000000..9f3e567 --- /dev/null +++ b/openapi_client/api/monitoring_device_statistics_details_api.py @@ -0,0 +1,766 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringDeviceStatisticsDetailsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.generate_device_statistics_data_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/data/device/statistics/{state_data_type}', + 'operation_id': 'generate_device_statistics_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + 'scroll_id', + 'start_date', + 'end_date', + 'count', + 'time_zone', + ], + 'required': [ + 'state_data_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + 'scroll_id': + (str,), + 'start_date': + (str,), + 'end_date': + (str,), + 'count': + (int,), + 'time_zone': + (str,), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + 'scroll_id': 'scrollId', + 'start_date': 'startDate', + 'end_date': 'endDate', + 'count': 'count', + 'time_zone': 'timeZone', + }, + 'location_map': { + 'state_data_type': 'path', + 'scroll_id': 'query', + 'start_date': 'query', + 'end_date': 'query', + 'count': 'query', + 'time_zone': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_active_alarms_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/data/device/statistics/alarm/active', + 'operation_id': 'get_active_alarms', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'start_date', + 'end_date', + 'count', + 'time_zone', + ], + 'required': [ + 'scroll_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'start_date': + (str,), + 'end_date': + (str,), + 'count': + (int,), + 'time_zone': + (str,), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'start_date': 'startDate', + 'end_date': 'endDate', + 'count': 'count', + 'time_zone': 'timeZone', + }, + 'location_map': { + 'scroll_id': 'query', + 'start_date': 'query', + 'end_date': 'query', + 'count': 'query', + 'time_zone': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_with_state_data_type_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/data/device/statistics/{state_data_type}/doccount', + 'operation_id': 'get_count_with_state_data_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + 'start_date', + 'end_date', + 'time_zone', + ], + 'required': [ + 'state_data_type', + 'start_date', + 'end_date', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + 'start_date': + (str,), + 'end_date': + (str,), + 'time_zone': + (str,), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + 'start_date': 'startDate', + 'end_date': 'endDate', + 'time_zone': 'timeZone', + }, + 'location_map': { + 'state_data_type': 'path', + 'start_date': 'query', + 'end_date': 'query', + 'time_zone': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields_by_state_data_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/data/device/statistics/{state_data_type}/fields', + 'operation_id': 'get_stat_data_fields_by_state_data_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state_data_type', + ], + 'required': [ + 'state_data_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state_data_type': + (str,), + }, + 'attribute_map': { + 'state_data_type': 'state_data_type', + }, + 'location_map': { + 'state_data_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_statistics_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/data/device/statistics', + 'operation_id': 'get_statistics_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def generate_device_statistics_data( + self, + state_data_type, + **kwargs + ): + """generate_device_statistics_data # noqa: E501 + + Get device statistics data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_statistics_data(state_data_type, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): State data type + + Keyword Args: + scroll_id (str): Scroll Id. [optional] + start_date (str): Start date. [optional] + end_date (str): End date. [optional] + count (int): [optional] + time_zone (str): Time zone. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + return self.generate_device_statistics_data_endpoint.call_with_http_info(**kwargs) + + def get_active_alarms( + self, + scroll_id, + **kwargs + ): + """get_active_alarms # noqa: E501 + + Get active alarms # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_active_alarms(scroll_id, async_req=True) + >>> result = thread.get() + + Args: + scroll_id (str): SrollId + + Keyword Args: + start_date (str): Start date. [optional] + end_date (str): End date. [optional] + count (int): count. [optional] + time_zone (str): Time zone. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['scroll_id'] = \ + scroll_id + return self.get_active_alarms_endpoint.call_with_http_info(**kwargs) + + def get_count_with_state_data_type( + self, + state_data_type, + start_date, + end_date, + **kwargs + ): + """get_count_with_state_data_type # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_with_state_data_type(state_data_type, start_date, end_date, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): State data type(example:object) + start_date (str): Start date (example:2021-1-1T00:00:00) + end_date (str): End date (example:2021-12-1T00:00:00) + + Keyword Args: + time_zone (str): Time zone (example:UTC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + kwargs['start_date'] = \ + start_date + kwargs['end_date'] = \ + end_date + return self.get_count_with_state_data_type_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields_by_state_data_type( + self, + state_data_type, + **kwargs + ): + """get_stat_data_fields_by_state_data_type # noqa: E501 + + Get statistics fields and types # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields_by_state_data_type(state_data_type, async_req=True) + >>> result = thread.get() + + Args: + state_data_type (str): State data type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state_data_type'] = \ + state_data_type + return self.get_stat_data_fields_by_state_data_type_endpoint.call_with_http_info(**kwargs) + + def get_statistics_type( + self, + **kwargs + ): + """get_statistics_type # noqa: E501 + + Get statistics types # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_statistics_type(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_statistics_type_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_dpi_api.py b/openapi_client/api/monitoring_dpi_api.py new file mode 100644 index 0000000..92c54b2 --- /dev/null +++ b/openapi_client/api/monitoring_dpi_api.py @@ -0,0 +1,2593 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringDPIApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_dpi_device_and_app_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/device/details/applications', + 'operation_id': 'create_dpi_device_and_app_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_dpi_device_grid_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/device/applications', + 'operation_id': 'create_dpi_device_grid_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'limit', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'limit': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'limit': 'limit', + }, + 'location_map': { + 'query': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_dpi_flows_grid_list_query_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/applications', + 'operation_id': 'create_dpi_flows_grid_list_query', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'limit', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'limit': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'limit': 'limit', + }, + 'location_map': { + 'query': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_dpi_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/applications/summary', + 'operation_id': 'create_dpi_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'limit', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'limit': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'limit': 'limit', + }, + 'location_map': { + 'query': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/aggregation', + 'operation_id': 'get_aggregation_data_by_query12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_dpi_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/recovery/aggregation', + 'operation_id': 'get_aggregation_data_dpi', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_aggregation_data_for_packet_dup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/pktdup/aggregation', + 'operation_id': 'get_aggregation_data_for_packet_dup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_count14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/doccount', + 'operation_id': 'get_count14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/doccount', + 'operation_id': 'get_count_post14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/agg-app/aggregation', + 'operation_id': 'get_post_aggregation_app_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/aggregation', + 'operation_id': 'get_post_aggregation_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/page', + 'operation_id': 'get_post_stat_bulk_raw_data12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/page', + 'operation_id': 'get_stat_bulk_raw_data12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/fields', + 'operation_id': 'get_stat_data_fields14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi', + 'operation_id': 'get_stat_data_raw_data12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv12_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/dpi/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/query/fields', + 'operation_id': 'get_stat_query_fields14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi', + 'operation_id': 'get_stats_raw_data12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_unique_flow_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/dpi/device/application/flowcount', + 'operation_id': 'get_unique_flow_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'interval', + 'application', + 'window', + 'family', + ], + 'required': [ + 'device_id', + 'interval', + 'application', + 'window', + 'family', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'interval': + (str,), + 'application': + (str,), + 'window': + (str,), + 'family': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'interval': 'interval', + 'application': 'application', + 'window': 'window', + 'family': 'family', + }, + 'location_map': { + 'device_id': 'query', + 'interval': 'query', + 'application': 'query', + 'window': 'query', + 'family': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_dpi_device_and_app_details( + self, + query, + **kwargs + ): + """create_dpi_device_and_app_details # noqa: E501 + + Get detailed DPI device and app list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_device_and_app_details(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query string + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.create_dpi_device_and_app_details_endpoint.call_with_http_info(**kwargs) + + def create_dpi_device_grid_data( + self, + query, + **kwargs + ): + """create_dpi_device_grid_data # noqa: E501 + + Get detailed DPI flows list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_device_grid_data(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query string + + Keyword Args: + limit (str): Query size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.create_dpi_device_grid_data_endpoint.call_with_http_info(**kwargs) + + def create_dpi_flows_grid_list_query( + self, + query, + **kwargs + ): + """create_dpi_flows_grid_list_query # noqa: E501 + + Get detailed DPI application flows list in a grid table # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_flows_grid_list_query(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query string + + Keyword Args: + limit (str): Query size (example: 10). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.create_dpi_flows_grid_list_query_endpoint.call_with_http_info(**kwargs) + + def create_dpi_summary( + self, + query, + **kwargs + ): + """create_dpi_summary # noqa: E501 + + Get detailed DPI application flows summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_summary(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query string + + Keyword Args: + limit (str): Query size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.create_dpi_summary_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query12( + self, + **kwargs + ): + """get_aggregation_data_by_query12 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query12_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_dpi( + self, + **kwargs + ): + """get_aggregation_data_dpi # noqa: E501 + + Get aggregation data and fec recovery rate if available # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_dpi(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_dpi_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_for_packet_dup( + self, + **kwargs + ): + """get_aggregation_data_for_packet_dup # noqa: E501 + + Get time series aggregation data for packet duplication for an application over TLOCs if available # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_for_packet_dup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_for_packet_dup_endpoint.call_with_http_info(**kwargs) + + def get_count14( + self, + query, + **kwargs + ): + """get_count14 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count14(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count14_endpoint.call_with_http_info(**kwargs) + + def get_count_post14( + self, + **kwargs + ): + """get_count_post14 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post14_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data( + self, + **kwargs + ): + """get_post_aggregation_app_data # noqa: E501 + + Get raw aggregated data and display applications with the highest utilization for a device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data( + self, + **kwargs + ): + """get_post_aggregation_data # noqa: E501 + + Get raw aggregated data and display applications with the highest utilization for a device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data12( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data12 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data12_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data12( + self, + **kwargs + ): + """get_stat_bulk_raw_data12 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data12_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields14( + self, + **kwargs + ): + """get_stat_data_fields14 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields14_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data12( + self, + **kwargs + ): + """get_stat_data_raw_data12 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data12_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv12( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv12 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv12_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields14( + self, + **kwargs + ): + """get_stat_query_fields14 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields14_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data12( + self, + **kwargs + ): + """get_stats_raw_data12 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data12_endpoint.call_with_http_info(**kwargs) + + def get_unique_flow_count( + self, + device_id, + interval, + application, + window, + family, + **kwargs + ): + """get_unique_flow_count # noqa: E501 + + Get application flow count per tunnel # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_unique_flow_count(device_id, interval, application, window, family, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + interval (str): Interval + application (str): Application + window (str): Window + family (str): Family + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + kwargs['interval'] = \ + interval + kwargs['application'] = \ + application + kwargs['window'] = \ + window + kwargs['family'] = \ + family + return self.get_unique_flow_count_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_dpion_demand_troubleshooting_api.py b/openapi_client/api/monitoring_dpion_demand_troubleshooting_api.py new file mode 100644 index 0000000..cdbb6a5 --- /dev/null +++ b/openapi_client/api/monitoring_dpion_demand_troubleshooting_api.py @@ -0,0 +1,674 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringDPIOnDemandTroubleshootingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_queue_entry_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/on-demand/queue', + 'operation_id': 'create_queue_entry', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_queue_entry_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/statistics/on-demand/queue/{entryId}', + 'operation_id': 'delete_queue_entry', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'entry_id', + ], + 'required': [ + 'entry_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'entry_id': + (str,), + }, + 'attribute_map': { + 'entry_id': 'entryId', + }, + 'location_map': { + 'entry_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_queue_entries_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/on-demand/queue', + 'operation_id': 'get_queue_entries', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_queue_properties_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/on-demand/queue/properties', + 'operation_id': 'get_queue_properties', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_queue_entry_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/on-demand/queue/{entryId}', + 'operation_id': 'update_queue_entry', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'entry_id', + 'body', + ], + 'required': [ + 'entry_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'entry_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'entry_id': 'entryId', + }, + 'location_map': { + 'entry_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_queue_entry( + self, + **kwargs + ): + """create_queue_entry # noqa: E501 + + Create on-demand troubleshooting queue entry # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_queue_entry(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): On-demand queue entry. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_queue_entry_endpoint.call_with_http_info(**kwargs) + + def delete_queue_entry( + self, + entry_id, + **kwargs + ): + """delete_queue_entry # noqa: E501 + + removes on-demand queue entry # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_queue_entry(entry_id, async_req=True) + >>> result = thread.get() + + Args: + entry_id (str): Entry Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['entry_id'] = \ + entry_id + return self.delete_queue_entry_endpoint.call_with_http_info(**kwargs) + + def get_queue_entries( + self, + **kwargs + ): + """get_queue_entries # noqa: E501 + + gets current on-demand queue entries # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_queue_entries(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_queue_entries_endpoint.call_with_http_info(**kwargs) + + def get_queue_properties( + self, + **kwargs + ): + """get_queue_properties # noqa: E501 + + gets current size of on-demand queue # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_queue_properties(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_queue_properties_endpoint.call_with_http_info(**kwargs) + + def update_queue_entry( + self, + entry_id, + **kwargs + ): + """update_queue_entry # noqa: E501 + + Updates on-demand troubleshooting queue entry # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_queue_entry(entry_id, async_req=True) + >>> result = thread.get() + + Args: + entry_id (str): Entry Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): On-demand queue entry. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['entry_id'] = \ + entry_id + return self.update_queue_entry_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_endpoint_tracker_status_api.py b/openapi_client/api/monitoring_endpoint_tracker_status_api.py new file mode 100644 index 0000000..705b24b --- /dev/null +++ b/openapi_client/api/monitoring_endpoint_tracker_status_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringEndpointTrackerStatusApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/aggregation', + 'operation_id': 'get_aggregation_data_by_query18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/doccount', + 'operation_id': 'get_count20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/doccount', + 'operation_id': 'get_count_post20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/page', + 'operation_id': 'get_post_stat_bulk_raw_data18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/page', + 'operation_id': 'get_stat_bulk_raw_data18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/fields', + 'operation_id': 'get_stat_data_fields20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker', + 'operation_id': 'get_stat_data_raw_data17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv18_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker/query/fields', + 'operation_id': 'get_stat_query_fields20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/endpointTracker', + 'operation_id': 'get_stats_raw_data18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query18( + self, + **kwargs + ): + """get_aggregation_data_by_query18 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query18_endpoint.call_with_http_info(**kwargs) + + def get_count20( + self, + query, + **kwargs + ): + """get_count20 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count20(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count20_endpoint.call_with_http_info(**kwargs) + + def get_count_post20( + self, + **kwargs + ): + """get_count_post20 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post20_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query17( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query17 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query17_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query17( + self, + **kwargs + ): + """get_post_aggregation_data_by_query17 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query17_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data18( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data18 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data18_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data18( + self, + **kwargs + ): + """get_stat_bulk_raw_data18 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data18_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields20( + self, + **kwargs + ): + """get_stat_data_fields20 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields20_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data17( + self, + **kwargs + ): + """get_stat_data_raw_data17 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data17_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv18( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv18 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv18_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields20( + self, + **kwargs + ): + """get_stat_query_fields20 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields20_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data18( + self, + **kwargs + ): + """get_stats_raw_data18 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data18_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_events_api.py b/openapi_client/api/monitoring_events_api.py new file mode 100644 index 0000000..34807b9 --- /dev/null +++ b/openapi_client/api/monitoring_events_api.py @@ -0,0 +1,2651 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringEventsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_events_query_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/query/input', + 'operation_id': 'create_events_query_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.enable_events_from_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/enable/fileprocess', + 'operation_id': 'enable_events_from_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.find_events_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/severity', + 'operation_id': 'find_events', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'severity_level', + 'device_id', + 'query', + ], + 'required': [ + 'severity_level', + ], + 'nullable': [ + ], + 'enum': [ + 'severity_level', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('severity_level',): { + + "CRITICAL": "critical", + "MAJOR": "major", + "MINOR": "minor" + }, + }, + 'openapi_types': { + 'severity_level': + ([str],), + 'device_id': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'severity_level': 'severity-level', + 'device_id': 'deviceId', + 'query': 'query', + }, + 'location_map': { + 'severity_level': 'query', + 'device_id': 'query', + 'query': 'query', + }, + 'collection_format_map': { + 'severity_level': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/aggregation', + 'operation_id': 'get_aggregation_data_by_query25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_components_as_key_value_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/event/component/keyvalue', + 'operation_id': 'get_components_as_key_value', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/doccount', + 'operation_id': 'get_count27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/doccount', + 'operation_id': 'get_count_post27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_event_types_as_key_value_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/event/types/keyvalue', + 'operation_id': 'get_event_types_as_key_value', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_events_by_component_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/event/getEventsByComponent', + 'operation_id': 'get_events_by_component', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_listeners_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/listeners', + 'operation_id': 'get_listeners_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/page', + 'operation_id': 'get_post_stat_bulk_raw_data25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_severity_histogram_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/severity/summary', + 'operation_id': 'get_severity_histogram', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'query', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'query', + ] + }, + root_map={ + 'validations': { + ('query',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'query': 'query', + }, + 'location_map': { + 'device_id': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/page', + 'operation_id': 'get_stat_bulk_raw_data25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/fields', + 'operation_id': 'get_stat_data_fields27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event', + 'operation_id': 'get_stat_data_raw_data24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv25_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/event/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event/query/fields', + 'operation_id': 'get_stat_query_fields27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/event', + 'operation_id': 'get_stats_raw_data25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_events_query_config( + self, + **kwargs + ): + """create_events_query_config # noqa: E501 + + Create query configuration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_events_query_config(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_events_query_config_endpoint.call_with_http_info(**kwargs) + + def enable_events_from_file( + self, + **kwargs + ): + """enable_events_from_file # noqa: E501 + + Set enable events from file flag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_events_from_file(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.enable_events_from_file_endpoint.call_with_http_info(**kwargs) + + def find_events( + self, + severity_level, + **kwargs + ): + """find_events # noqa: E501 + + Retrieve events # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.find_events(severity_level, async_req=True) + >>> result = thread.get() + + Args: + severity_level ([str]): Severity level + + Keyword Args: + device_id (str): Device IP. [optional] + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['severity_level'] = \ + severity_level + return self.find_events_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query25( + self, + **kwargs + ): + """get_aggregation_data_by_query25 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query25_endpoint.call_with_http_info(**kwargs) + + def get_components_as_key_value( + self, + **kwargs + ): + """get_components_as_key_value # noqa: E501 + + Retrieve components as key/value pairs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_components_as_key_value(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_components_as_key_value_endpoint.call_with_http_info(**kwargs) + + def get_count27( + self, + query, + **kwargs + ): + """get_count27 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count27(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count27_endpoint.call_with_http_info(**kwargs) + + def get_count_post27( + self, + **kwargs + ): + """get_count_post27 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post27_endpoint.call_with_http_info(**kwargs) + + def get_event_types_as_key_value( + self, + **kwargs + ): + """get_event_types_as_key_value # noqa: E501 + + Retrieve event types as key/value pairs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_types_as_key_value(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_event_types_as_key_value_endpoint.call_with_http_info(**kwargs) + + def get_events_by_component( + self, + **kwargs + ): + """get_events_by_component # noqa: E501 + + Retrieve components as key/value pairs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_events_by_component(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_events_by_component_endpoint.call_with_http_info(**kwargs) + + def get_listeners_info( + self, + **kwargs + ): + """get_listeners_info # noqa: E501 + + Retrieve listener information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_listeners_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_listeners_info_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query24( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query24 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query24_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query24( + self, + **kwargs + ): + """get_post_aggregation_data_by_query24 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query24_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data25( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data25 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data25_endpoint.call_with_http_info(**kwargs) + + def get_severity_histogram( + self, + device_id, + **kwargs + ): + """get_severity_histogram # noqa: E501 + + Retrieve severity histogram # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_severity_histogram(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_severity_histogram_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data25( + self, + **kwargs + ): + """get_stat_bulk_raw_data25 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data25_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields27( + self, + **kwargs + ): + """get_stat_data_fields27 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields27_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data24( + self, + **kwargs + ): + """get_stat_data_raw_data24 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data24_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv25( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv25 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv25_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields27( + self, + **kwargs + ): + """get_stat_query_fields27 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields27_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data25( + self, + **kwargs + ): + """get_stats_raw_data25 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data25_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_flowlog_api.py b/openapi_client/api/monitoring_flowlog_api.py new file mode 100644 index 0000000..a414e8e --- /dev/null +++ b/openapi_client/api/monitoring_flowlog_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringFlowlogApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/aggregation', + 'operation_id': 'get_aggregation_data_by_query26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/doccount', + 'operation_id': 'get_count28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/doccount', + 'operation_id': 'get_count_post28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/page', + 'operation_id': 'get_post_stat_bulk_raw_data26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/page', + 'operation_id': 'get_stat_bulk_raw_data26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/fields', + 'operation_id': 'get_stat_data_fields28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog', + 'operation_id': 'get_stat_data_raw_data25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv26_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog/query/fields', + 'operation_id': 'get_stat_query_fields28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/flowlog', + 'operation_id': 'get_stats_raw_data26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query26( + self, + **kwargs + ): + """get_aggregation_data_by_query26 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query26_endpoint.call_with_http_info(**kwargs) + + def get_count28( + self, + query, + **kwargs + ): + """get_count28 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count28(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count28_endpoint.call_with_http_info(**kwargs) + + def get_count_post28( + self, + **kwargs + ): + """get_count_post28 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post28_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query25( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query25 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query25_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query26( + self, + **kwargs + ): + """get_post_aggregation_data_by_query26 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query26_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data26( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data26 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data26_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data26( + self, + **kwargs + ): + """get_stat_bulk_raw_data26 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data26_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields28( + self, + **kwargs + ): + """get_stat_data_fields28 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields28_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data25( + self, + **kwargs + ): + """get_stat_data_raw_data25 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data25_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv26( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv26 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv26_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields28( + self, + **kwargs + ): + """get_stat_query_fields28 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields28_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data26( + self, + **kwargs + ): + """get_stats_raw_data26 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data26_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_health_api.py b/openapi_client/api/monitoring_health_api.py new file mode 100644 index 0000000..77d6617 --- /dev/null +++ b/openapi_client/api/monitoring_health_api.py @@ -0,0 +1,368 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringHealthApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_devices_health_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/health/devices', + 'operation_id': 'get_devices_health', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'starting_device_id', + 'site_id', + 'group_id', + 'group_id2', + 'vpn_id', + 'reachable', + 'control_status', + 'personality', + 'health', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'starting_device_id': + (str,), + 'site_id': + (str,), + 'group_id': + (str,), + 'group_id2': + (str,), + 'vpn_id': + (str,), + 'reachable': + (bool,), + 'control_status': + (str,), + 'personality': + (str,), + 'health': + (str,), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + 'starting_device_id': 'startingDeviceId', + 'site_id': 'siteId', + 'group_id': 'group_id', + 'group_id2': 'groupId', + 'vpn_id': 'vpnId', + 'reachable': 'reachable', + 'control_status': 'controlStatus', + 'personality': 'personality', + 'health': 'health', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'starting_device_id': 'query', + 'site_id': 'query', + 'group_id': 'query', + 'group_id2': 'query', + 'vpn_id': 'query', + 'reachable': 'query', + 'control_status': 'query', + 'personality': 'query', + 'health': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_devices_health_overview_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/health/devices/overview', + 'operation_id': 'get_devices_health_overview', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'vpn_id2', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vpn_id': + (str,), + 'vpn_id2': + (str,), + }, + 'attribute_map': { + 'vpn_id': 'vpn_id', + 'vpn_id2': 'vpnId', + }, + 'location_map': { + 'vpn_id': 'query', + 'vpn_id2': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_devices_health( + self, + **kwargs + ): + """get_devices_health # noqa: E501 + + get the devices health properties # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_health(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): Page Number. [optional] + page_size (int): Page Size. [optional] + sort_by (str): Sort By Property. [optional] + sort_order (str): Sort Order. [optional] + starting_device_id (str): Optional device ID to start first page. [optional] + site_id (str): Optional site ID to filter devices. [optional] + group_id (str): Optional group ID to filter devices. [optional] + group_id2 (str): Optional group ID to filter devices. [optional] + vpn_id (str): Optional vpn ID to filter devices. [optional] + reachable (bool): [optional] + control_status (str): [optional] + personality (str): [optional] + health (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_health_endpoint.call_with_http_info(**kwargs) + + def get_devices_health_overview( + self, + **kwargs + ): + """get_devices_health_overview # noqa: E501 + + gets devices health overview # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_devices_health_overview(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vpn_id (str): Optional vpn ID to filter devices. [optional] + vpn_id2 (str): Optional vpn ID to filter devices. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_devices_health_overview_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_interface_statistics_api.py b/openapi_client/api/monitoring_interface_statistics_api.py new file mode 100644 index 0000000..b1d362b --- /dev/null +++ b/openapi_client/api/monitoring_interface_statistics_api.py @@ -0,0 +1,1873 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringInterfaceStatisticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/aggregation', + 'operation_id': 'get_aggregation_data_by_query10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bandwidth_distribution_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/ccapacity/distribution', + 'operation_id': 'get_bandwidth_distribution', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/doccount', + 'operation_id': 'get_count12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/doccount', + 'operation_id': 'get_count_post12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/page', + 'operation_id': 'get_post_stat_bulk_raw_data10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/page', + 'operation_id': 'get_stat_bulk_raw_data10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/fields', + 'operation_id': 'get_stat_data_fields12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface', + 'operation_id': 'get_stat_data_raw_data10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv10_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/interface/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv10', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/query/fields', + 'operation_id': 'get_stat_query_fields12', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_statistics_per_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface/type', + 'operation_id': 'get_statistics_per_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data10_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/interface', + 'operation_id': 'get_stats_raw_data10', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query10( + self, + **kwargs + ): + """get_aggregation_data_by_query10 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query10_endpoint.call_with_http_info(**kwargs) + + def get_bandwidth_distribution( + self, + **kwargs + ): + """get_bandwidth_distribution # noqa: E501 + + Get bandwidth distribution # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bandwidth_distribution(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_bandwidth_distribution_endpoint.call_with_http_info(**kwargs) + + def get_count12( + self, + query, + **kwargs + ): + """get_count12 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count12(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count12_endpoint.call_with_http_info(**kwargs) + + def get_count_post12( + self, + **kwargs + ): + """get_count_post12 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post12_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query10( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query10 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query10_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query10( + self, + **kwargs + ): + """get_post_aggregation_data_by_query10 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query10_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data10( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data10 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data10_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data10( + self, + **kwargs + ): + """get_stat_bulk_raw_data10 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data10_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields12( + self, + **kwargs + ): + """get_stat_data_fields12 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields12_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data10( + self, + **kwargs + ): + """get_stat_data_raw_data10 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data10_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv10( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv10 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv10_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields12( + self, + **kwargs + ): + """get_stat_query_fields12 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields12_endpoint.call_with_http_info(**kwargs) + + def get_statistics_per_interface( + self, + query, + **kwargs + ): + """get_statistics_per_interface # noqa: E501 + + Get statistics per interface # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_statistics_per_interface(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query filter + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_statistics_per_interface_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data10( + self, + **kwargs + ): + """get_stats_raw_data10 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data10(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data10_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_ips_alert_api.py b/openapi_client/api/monitoring_ips_alert_api.py new file mode 100644 index 0000000..4643d28 --- /dev/null +++ b/openapi_client/api/monitoring_ips_alert_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringIPsAlertApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/aggregation', + 'operation_id': 'get_aggregation_data_by_query21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/doccount', + 'operation_id': 'get_count23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/doccount', + 'operation_id': 'get_count_post23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query20', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/page', + 'operation_id': 'get_post_stat_bulk_raw_data21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/page', + 'operation_id': 'get_stat_bulk_raw_data21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/fields', + 'operation_id': 'get_stat_data_fields23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data20_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert', + 'operation_id': 'get_stat_data_raw_data20', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv21_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert/query/fields', + 'operation_id': 'get_stat_query_fields23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/ipsalert', + 'operation_id': 'get_stats_raw_data21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query21( + self, + **kwargs + ): + """get_aggregation_data_by_query21 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query21_endpoint.call_with_http_info(**kwargs) + + def get_count23( + self, + query, + **kwargs + ): + """get_count23 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count23(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count23_endpoint.call_with_http_info(**kwargs) + + def get_count_post23( + self, + **kwargs + ): + """get_count_post23 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post23_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query20( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query20 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query20_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query20( + self, + **kwargs + ): + """get_post_aggregation_data_by_query20 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query20_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data21( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data21 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data21_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data21( + self, + **kwargs + ): + """get_stat_bulk_raw_data21 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data21_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields23( + self, + **kwargs + ): + """get_stat_data_fields23 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields23_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data20( + self, + **kwargs + ): + """get_stat_data_raw_data20 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data20(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data20_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv21( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv21 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv21_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields23( + self, + **kwargs + ): + """get_stat_query_fields23 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields23_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data21( + self, + **kwargs + ): + """get_stats_raw_data21 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data21_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_qo_s_api.py b/openapi_client/api/monitoring_qo_s_api.py new file mode 100644 index 0000000..297f21f --- /dev/null +++ b/openapi_client/api/monitoring_qo_s_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringQoSApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/aggregation', + 'operation_id': 'get_aggregation_data_by_query13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/doccount', + 'operation_id': 'get_count15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/doccount', + 'operation_id': 'get_count_post15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query12_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query12', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/page', + 'operation_id': 'get_post_stat_bulk_raw_data13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/page', + 'operation_id': 'get_stat_bulk_raw_data13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/fields', + 'operation_id': 'get_stat_data_fields15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos', + 'operation_id': 'get_stat_data_raw_data13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv13_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/qos/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos/query/fields', + 'operation_id': 'get_stat_query_fields15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/qos', + 'operation_id': 'get_stats_raw_data13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query13( + self, + **kwargs + ): + """get_aggregation_data_by_query13 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query13_endpoint.call_with_http_info(**kwargs) + + def get_count15( + self, + query, + **kwargs + ): + """get_count15 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count15(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count15_endpoint.call_with_http_info(**kwargs) + + def get_count_post15( + self, + **kwargs + ): + """get_count_post15 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post15_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query12( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query12 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query12_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query12( + self, + **kwargs + ): + """get_post_aggregation_data_by_query12 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query12(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query12_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data13( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data13 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data13_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data13( + self, + **kwargs + ): + """get_stat_bulk_raw_data13 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data13_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields15( + self, + **kwargs + ): + """get_stat_data_fields15 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields15_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data13( + self, + **kwargs + ): + """get_stat_data_raw_data13 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data13_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv13( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv13 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv13_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields15( + self, + **kwargs + ): + """get_stat_query_fields15 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields15_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data13( + self, + **kwargs + ): + """get_stats_raw_data13 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data13_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_security_unified_logging_connection_events_api.py b/openapi_client/api/monitoring_security_unified_logging_connection_events_api.py new file mode 100644 index 0000000..05e0920 --- /dev/null +++ b/openapi_client/api/monitoring_security_unified_logging_connection_events_api.py @@ -0,0 +1,1771 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringSecurityUnifiedLoggingConnectionEventsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/aggregation', + 'operation_id': 'get_aggregation_data_by_query14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/doccount', + 'operation_id': 'get_count16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/doccount', + 'operation_id': 'get_count_post16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_filter_policy_name_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/filter/policy_name/{policyType}', + 'operation_id': 'get_filter_policy_name_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_type', + 'query', + ], + 'required': [ + 'policy_type', + 'query', + ], + 'nullable': [ + ], + 'enum': [ + 'policy_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('policy_type',): { + + "ZONEBASEDFW": "zoneBasedFW", + "INTRUSIONPREVENTION": "intrusionPrevention", + "URLFILTERING": "urlFiltering", + "ADVANCEDMALWAREPROTECTION": "advancedMalwareProtection" + }, + }, + 'openapi_types': { + 'policy_type': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'policy_type': 'policyType', + 'query': 'query', + }, + 'location_map': { + 'policy_type': 'path', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/page', + 'operation_id': 'get_post_stat_bulk_raw_data14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/page', + 'operation_id': 'get_stat_bulk_raw_data14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/fields', + 'operation_id': 'get_stat_data_fields16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv14_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv14', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections/query/fields', + 'operation_id': 'get_stat_query_fields16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data14_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections', + 'operation_id': 'get_stats_raw_data14', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_sul_stat_data_raw_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/sul/connections', + 'operation_id': 'get_sul_stat_data_raw_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_aggregation_data_by_query14( + self, + **kwargs + ): + """get_aggregation_data_by_query14 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query14_endpoint.call_with_http_info(**kwargs) + + def get_count16( + self, + query, + **kwargs + ): + """get_count16 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count16(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count16_endpoint.call_with_http_info(**kwargs) + + def get_count_post16( + self, + **kwargs + ): + """get_count_post16 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post16_endpoint.call_with_http_info(**kwargs) + + def get_filter_policy_name_list( + self, + policy_type, + query, + **kwargs + ): + """get_filter_policy_name_list # noqa: E501 + + Get filter Policy Name list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_filter_policy_name_list(policy_type, query, async_req=True) + >>> result = thread.get() + + Args: + policy_type (str): Policy type + query (str): query string + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_type'] = \ + policy_type + kwargs['query'] = \ + query + return self.get_filter_policy_name_list_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query13( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query13 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query13_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query13( + self, + **kwargs + ): + """get_post_aggregation_data_by_query13 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query13_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data14( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data14 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data14_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data14( + self, + **kwargs + ): + """get_stat_bulk_raw_data14 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data14_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields16( + self, + **kwargs + ): + """get_stat_data_fields16 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields16_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv14( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv14 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv14_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields16( + self, + **kwargs + ): + """get_stat_query_fields16 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields16_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data14( + self, + **kwargs + ): + """get_stats_raw_data14 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data14(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data14_endpoint.call_with_http_info(**kwargs) + + def get_sul_stat_data_raw_data( + self, + **kwargs + ): + """get_sul_stat_data_raw_data # noqa: E501 + + Get security connection events stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sul_stat_data_raw_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sul_stat_data_raw_data_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_server_info_api.py b/openapi_client/api/monitoring_server_info_api.py new file mode 100644 index 0000000..9e07055 --- /dev/null +++ b/openapi_client/api/monitoring_server_info_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringServerInfoApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_server_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/server/info', + 'operation_id': 'create_server_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_server_info( + self, + **kwargs + ): + """create_server_info # noqa: E501 + + Get Server info # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_server_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_server_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_stats_download_api.py b/openapi_client/api/monitoring_stats_download_api.py new file mode 100644 index 0000000..d78d815 --- /dev/null +++ b/openapi_client/api/monitoring_stats_download_api.py @@ -0,0 +1,489 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class MonitoringStatsDownloadApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.download1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}', + 'operation_id': 'download1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_type', + 'file_type', + 'queue', + 'device_ip', + 'token', + 'file_name', + ], + 'required': [ + 'process_type', + 'file_type', + 'queue', + 'device_ip', + 'token', + 'file_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_type': + (str,), + 'file_type': + (str,), + 'queue': + (str,), + 'device_ip': + (str,), + 'token': + (str,), + 'file_name': + (str,), + }, + 'attribute_map': { + 'process_type': 'processType', + 'file_type': 'fileType', + 'queue': 'queue', + 'device_ip': 'deviceIp', + 'token': 'token', + 'file_name': 'fileName', + }, + 'location_map': { + 'process_type': 'path', + 'file_type': 'path', + 'queue': 'path', + 'device_ip': 'path', + 'token': 'path', + 'file_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_list_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/statistics/download/{processType}/filelist', + 'operation_id': 'download_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_type', + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [ + 'process_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_type': + (str,), + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + 'process_type': 'processType', + }, + 'location_map': { + 'process_type': 'path', + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.fetch_list_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/statistics/download/{processType}/fetchvManageList', + 'operation_id': 'fetch_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_type', + ], + 'required': [ + 'process_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_type': + (str,), + }, + 'attribute_map': { + 'process_type': 'processType', + }, + 'location_map': { + 'process_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def download1( + self, + process_type, + file_type, + queue, + device_ip, + token, + file_name, + **kwargs + ): + """download1 # noqa: E501 + + Downloading stats file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download1(process_type, file_type, queue, device_ip, token, file_name, async_req=True) + >>> result = thread.get() + + Args: + process_type (str): Process type + file_type (str): File type + queue (str): Queue name + device_ip (str): Device IP + token (str): Token + file_name (str): File name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_type'] = \ + process_type + kwargs['file_type'] = \ + file_type + kwargs['queue'] = \ + queue + kwargs['device_ip'] = \ + device_ip + kwargs['token'] = \ + token + kwargs['file_name'] = \ + file_name + return self.download1_endpoint.call_with_http_info(**kwargs) + + def download_list( + self, + process_type, + **kwargs + ): + """download_list # noqa: E501 + + Downloading list of stats file # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_list(process_type, async_req=True) + >>> result = thread.get() + + Args: + process_type (str): Possible types are: remoteprocessing, dr + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_type'] = \ + process_type + return self.download_list_endpoint.call_with_http_info(**kwargs) + + def fetch_list( + self, + process_type, + **kwargs + ): + """fetch_list # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.fetch_list(process_type, async_req=True) + >>> result = thread.get() + + Args: + process_type (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_type'] = \ + process_type + return self.fetch_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_stats_processing_api.py b/openapi_client/api/monitoring_stats_processing_api.py new file mode 100644 index 0000000..61296b2 --- /dev/null +++ b/openapi_client/api/monitoring_stats_processing_api.py @@ -0,0 +1,1142 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringStatsProcessingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.enable_statistics_demo_mode_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/demomode', + 'operation_id': 'enable_statistics_demo_mode', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'enable', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'enable': + (bool,), + }, + 'attribute_map': { + 'enable': 'enable', + }, + 'location_map': { + 'enable': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_stats_collect_thread_report_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/statistics/collect/thread/status', + 'operation_id': 'generate_stats_collect_thread_report', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_stats_process_report_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/statistics/process/status', + 'operation_id': 'generate_stats_process_report', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_queue', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_queue': + (int,), + }, + 'attribute_map': { + 'process_queue': 'processQueue', + }, + 'location_map': { + 'process_queue': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.generate_stats_process_thread_report_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/statistics/process/thread/status', + 'operation_id': 'generate_stats_process_thread_report', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_statistic_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/statistics', + 'operation_id': 'get_statistic_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_statistics_processing_counters_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/statistics/process/counters', + 'operation_id': 'get_statistics_processing_counters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.process_statistics_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/process', + 'operation_id': 'process_statistics_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.reset_stats_collection_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/collection/reset/{processQueue}', + 'operation_id': 'reset_stats_collection', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'process_queue', + ], + 'required': [ + 'process_queue', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'process_queue': + (int,), + }, + 'attribute_map': { + 'process_queue': 'processQueue', + }, + 'location_map': { + 'process_queue': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.start_stats_collection_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/collect', + 'operation_id': 'start_stats_collection', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def enable_statistics_demo_mode( + self, + **kwargs + ): + """enable_statistics_demo_mode # noqa: E501 + + Enable statistic demo mode # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_statistics_demo_mode(async_req=True) + >>> result = thread.get() + + + Keyword Args: + enable (bool): Demo mode flag. [optional] if omitted the server will use the default value of True + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.enable_statistics_demo_mode_endpoint.call_with_http_info(**kwargs) + + def generate_stats_collect_thread_report( + self, + **kwargs + ): + """generate_stats_collect_thread_report # noqa: E501 + + Get stats collect thread report # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_stats_collect_thread_report(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_stats_collect_thread_report_endpoint.call_with_http_info(**kwargs) + + def generate_stats_process_report( + self, + **kwargs + ): + """generate_stats_process_report # noqa: E501 + + Get stats process report # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_stats_process_report(async_req=True) + >>> result = thread.get() + + + Keyword Args: + process_queue (int): Process queue. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_stats_process_report_endpoint.call_with_http_info(**kwargs) + + def generate_stats_process_thread_report( + self, + **kwargs + ): + """generate_stats_process_thread_report # noqa: E501 + + Get stats process thread report # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_stats_process_thread_report(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.generate_stats_process_thread_report_endpoint.call_with_http_info(**kwargs) + + def get_statistic_type( + self, + **kwargs + ): + """get_statistic_type # noqa: E501 + + Get statistics types # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_statistic_type(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_statistic_type_endpoint.call_with_http_info(**kwargs) + + def get_statistics_processing_counters( + self, + **kwargs + ): + """get_statistics_processing_counters # noqa: E501 + + Get statistics processing counters # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_statistics_processing_counters(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_statistics_processing_counters_endpoint.call_with_http_info(**kwargs) + + def process_statistics_data( + self, + **kwargs + ): + """process_statistics_data # noqa: E501 + + Process stats data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_statistics_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.process_statistics_data_endpoint.call_with_http_info(**kwargs) + + def reset_stats_collection( + self, + process_queue=-1, + **kwargs + ): + """reset_stats_collection # noqa: E501 + + Reset stats collect thread report # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reset_stats_collection(process_queue=-1, async_req=True) + >>> result = thread.get() + + Args: + process_queue (int): Process queue. defaults to -1, must be one of [-1] + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['process_queue'] = \ + process_queue + return self.reset_stats_collection_endpoint.call_with_http_info(**kwargs) + + def start_stats_collection( + self, + **kwargs + ): + """start_stats_collection # noqa: E501 + + Start stats collect # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.start_stats_collection(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.start_stats_collection_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_status_api.py b/openapi_client/api/monitoring_status_api.py new file mode 100644 index 0000000..945af1e --- /dev/null +++ b/openapi_client/api/monitoring_status_api.py @@ -0,0 +1,693 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringStatusApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_disabled_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/settings/disable/devicelist/{indexName}', + 'operation_id': 'get_disabled_device_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'index_name', + ], + 'required': [ + 'index_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'index_name': + (str,), + }, + 'attribute_map': { + 'index_name': 'indexName', + }, + 'location_map': { + 'index_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_enabled_index_for_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/settings/status/device', + 'operation_id': 'get_enabled_index_for_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_statistics_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/settings/status', + 'operation_id': 'get_statistics_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_statistics_device_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/settings/disable/devicelist/{indexName}', + 'operation_id': 'update_statistics_device_list', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'index_name', + 'body', + ], + 'required': [ + 'index_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'index_name': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'index_name': 'indexName', + }, + 'location_map': { + 'index_name': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_statistics_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/statistics/settings/status', + 'operation_id': 'update_statistics_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_disabled_device_list( + self, + index_name, + **kwargs + ): + """get_disabled_device_list # noqa: E501 + + Get list of disabled devices for a statistics index # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_disabled_device_list(index_name, async_req=True) + >>> result = thread.get() + + Args: + index_name (str): Index name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['index_name'] = \ + index_name + return self.get_disabled_device_list_endpoint.call_with_http_info(**kwargs) + + def get_enabled_index_for_device( + self, + device_id, + **kwargs + ): + """get_enabled_index_for_device # noqa: E501 + + Get list of enabled device for statistics index # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_enabled_index_for_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_enabled_index_for_device_endpoint.call_with_http_info(**kwargs) + + def get_statistics_settings( + self, + **kwargs + ): + """get_statistics_settings # noqa: E501 + + Get statistics settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_statistics_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_statistics_settings_endpoint.call_with_http_info(**kwargs) + + def update_statistics_device_list( + self, + index_name, + **kwargs + ): + """update_statistics_device_list # noqa: E501 + + Update list of disabled devices for a statistics index # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_statistics_device_list(index_name, async_req=True) + >>> result = thread.get() + + Args: + index_name (str): Index name + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Disabled device. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['index_name'] = \ + index_name + return self.update_statistics_device_list_endpoint.call_with_http_info(**kwargs) + + def update_statistics_settings( + self, + **kwargs + ): + """update_statistics_settings # noqa: E501 + + Update statistics settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_statistics_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats setting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_statistics_settings_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_system_status_stats_api.py b/openapi_client/api/monitoring_system_status_stats_api.py new file mode 100644 index 0000000..0db7c45 --- /dev/null +++ b/openapi_client/api/monitoring_system_status_stats_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringSystemStatusStatsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/aggregation', + 'operation_id': 'get_aggregation_data_by_query17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/doccount', + 'operation_id': 'get_count19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/doccount', + 'operation_id': 'get_count_post19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/page', + 'operation_id': 'get_post_stat_bulk_raw_data17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/page', + 'operation_id': 'get_stat_bulk_raw_data17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/fields', + 'operation_id': 'get_stat_data_fields19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats', + 'operation_id': 'get_stat_data_raw_data16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv17_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv17', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats/query/fields', + 'operation_id': 'get_stat_query_fields19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data17_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/stats', + 'operation_id': 'get_stats_raw_data17', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query17( + self, + **kwargs + ): + """get_aggregation_data_by_query17 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query17_endpoint.call_with_http_info(**kwargs) + + def get_count19( + self, + query, + **kwargs + ): + """get_count19 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count19(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count19_endpoint.call_with_http_info(**kwargs) + + def get_count_post19( + self, + **kwargs + ): + """get_count_post19 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post19_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query16( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query16 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query16_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query16( + self, + **kwargs + ): + """get_post_aggregation_data_by_query16 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query16_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data17( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data17 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data17_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data17( + self, + **kwargs + ): + """get_stat_bulk_raw_data17 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data17_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields19( + self, + **kwargs + ): + """get_stat_data_fields19 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields19_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data16( + self, + **kwargs + ): + """get_stat_data_raw_data16 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data16_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv17( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv17 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv17_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields19( + self, + **kwargs + ): + """get_stat_query_fields19 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields19_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data17( + self, + **kwargs + ): + """get_stats_raw_data17 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data17(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data17_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_umbrella_api.py b/openapi_client/api/monitoring_umbrella_api.py new file mode 100644 index 0000000..fa7c3eb --- /dev/null +++ b/openapi_client/api/monitoring_umbrella_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringUmbrellaApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/aggregation', + 'operation_id': 'get_aggregation_data_by_query24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/doccount', + 'operation_id': 'get_count26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/doccount', + 'operation_id': 'get_count_post26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/page', + 'operation_id': 'get_post_stat_bulk_raw_data24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/page', + 'operation_id': 'get_stat_bulk_raw_data24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/fields', + 'operation_id': 'get_stat_data_fields26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella', + 'operation_id': 'get_stat_data_raw_data23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv24_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella/query/fields', + 'operation_id': 'get_stat_query_fields26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/umbrella', + 'operation_id': 'get_stats_raw_data24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query24( + self, + **kwargs + ): + """get_aggregation_data_by_query24 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query24_endpoint.call_with_http_info(**kwargs) + + def get_count26( + self, + query, + **kwargs + ): + """get_count26 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count26(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count26_endpoint.call_with_http_info(**kwargs) + + def get_count_post26( + self, + **kwargs + ): + """get_count_post26 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post26_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query23( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query23 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query23_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query23( + self, + **kwargs + ): + """get_post_aggregation_data_by_query23 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query23_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data24( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data24 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data24_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data24( + self, + **kwargs + ): + """get_stat_bulk_raw_data24 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data24_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields26( + self, + **kwargs + ): + """get_stat_data_fields26 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields26_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data23( + self, + **kwargs + ): + """get_stat_data_raw_data23 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data23_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv24( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv24 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv24_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields26( + self, + **kwargs + ): + """get_stat_query_fields26 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields26_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data24( + self, + **kwargs + ): + """get_stats_raw_data24 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data24_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_umbrella_patterns_api.py b/openapi_client/api/monitoring_umbrella_patterns_api.py new file mode 100644 index 0000000..cb414a0 --- /dev/null +++ b/openapi_client/api/monitoring_umbrella_patterns_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringUmbrellaPatternsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/aggregation', + 'operation_id': 'get_aggregation_data_by_query23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/doccount', + 'operation_id': 'get_count25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/doccount', + 'operation_id': 'get_count_post25', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/page', + 'operation_id': 'get_post_stat_bulk_raw_data23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/page', + 'operation_id': 'get_stat_bulk_raw_data23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/fields', + 'operation_id': 'get_stat_data_fields25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall', + 'operation_id': 'get_stat_data_raw_data22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv23_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/fwall/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv23', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields25_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall/query/fields', + 'operation_id': 'get_stat_query_fields25', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data23_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/fwall', + 'operation_id': 'get_stats_raw_data23', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query23( + self, + **kwargs + ): + """get_aggregation_data_by_query23 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query23_endpoint.call_with_http_info(**kwargs) + + def get_count25( + self, + query, + **kwargs + ): + """get_count25 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count25(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count25_endpoint.call_with_http_info(**kwargs) + + def get_count_post25( + self, + **kwargs + ): + """get_count_post25 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post25_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query22( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query22 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query22_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query22( + self, + **kwargs + ): + """get_post_aggregation_data_by_query22 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query22_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data23( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data23 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data23_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data23( + self, + **kwargs + ): + """get_stat_bulk_raw_data23 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data23_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields25( + self, + **kwargs + ): + """get_stat_data_fields25 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields25_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data22( + self, + **kwargs + ): + """get_stat_data_raw_data22 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data22_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv23( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv23 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv23_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields25( + self, + **kwargs + ): + """get_stat_query_fields25 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields25(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields25_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data23( + self, + **kwargs + ): + """get_stats_raw_data23 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data23(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data23_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_url_filtering_api.py b/openapi_client/api/monitoring_url_filtering_api.py new file mode 100644 index 0000000..4413c24 --- /dev/null +++ b/openapi_client/api/monitoring_url_filtering_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringURLFilteringApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/aggregation', + 'operation_id': 'get_aggregation_data_by_query22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/doccount', + 'operation_id': 'get_count24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/doccount', + 'operation_id': 'get_count_post24', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/page', + 'operation_id': 'get_post_stat_bulk_raw_data22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/page', + 'operation_id': 'get_stat_bulk_raw_data22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/fields', + 'operation_id': 'get_stat_data_fields24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf', + 'operation_id': 'get_stat_data_raw_data21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv22_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/urlf/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv22', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields24_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf/query/fields', + 'operation_id': 'get_stat_query_fields24', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data22_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/urlf', + 'operation_id': 'get_stats_raw_data22', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query22( + self, + **kwargs + ): + """get_aggregation_data_by_query22 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query22_endpoint.call_with_http_info(**kwargs) + + def get_count24( + self, + query, + **kwargs + ): + """get_count24 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count24(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count24_endpoint.call_with_http_info(**kwargs) + + def get_count_post24( + self, + **kwargs + ): + """get_count_post24 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post24_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query21( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query21 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query21_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query21( + self, + **kwargs + ): + """get_post_aggregation_data_by_query21 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query21_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data22( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data22 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data22_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data22( + self, + **kwargs + ): + """get_stat_bulk_raw_data22 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data22_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields24( + self, + **kwargs + ): + """get_stat_data_fields24 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields24_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data21( + self, + **kwargs + ): + """get_stat_data_raw_data21 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data21_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv22( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv22 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv22_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields24( + self, + **kwargs + ): + """get_stat_query_fields24 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields24(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields24_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data22( + self, + **kwargs + ): + """get_stats_raw_data22 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data22(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data22_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_vnf_interface_statistics_api.py b/openapi_client/api/monitoring_vnf_interface_statistics_api.py new file mode 100644 index 0000000..939a123 --- /dev/null +++ b/openapi_client/api/monitoring_vnf_interface_statistics_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringVNFInterfaceStatisticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/aggregation', + 'operation_id': 'get_aggregation_data_by_query11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/doccount', + 'operation_id': 'get_count13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/doccount', + 'operation_id': 'get_count_post13', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/page', + 'operation_id': 'get_post_stat_bulk_raw_data11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/page', + 'operation_id': 'get_stat_bulk_raw_data11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/fields', + 'operation_id': 'get_stat_data_fields13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics', + 'operation_id': 'get_stat_data_raw_data11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv11_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv11', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields13_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics/query/fields', + 'operation_id': 'get_stat_query_fields13', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data11_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/vnfstatistics', + 'operation_id': 'get_stats_raw_data11', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query11( + self, + **kwargs + ): + """get_aggregation_data_by_query11 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query11_endpoint.call_with_http_info(**kwargs) + + def get_count13( + self, + query, + **kwargs + ): + """get_count13 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count13(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count13_endpoint.call_with_http_info(**kwargs) + + def get_count_post13( + self, + **kwargs + ): + """get_count_post13 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post13_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query11( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query11 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query11_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query11( + self, + **kwargs + ): + """get_post_aggregation_data_by_query11 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query11_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data11( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data11 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data11_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data11( + self, + **kwargs + ): + """get_stat_bulk_raw_data11 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data11_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields13( + self, + **kwargs + ): + """get_stat_data_fields13 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields13_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data11( + self, + **kwargs + ): + """get_stat_data_raw_data11 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data11_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv11( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv11 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv11_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields13( + self, + **kwargs + ): + """get_stat_query_fields13 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields13(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields13_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data11( + self, + **kwargs + ): + """get_stats_raw_data11 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data11(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data11_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/monitoring_wlan_client_info_api.py b/openapi_client/api/monitoring_wlan_client_info_api.py new file mode 100644 index 0000000..674b115 --- /dev/null +++ b/openapi_client/api/monitoring_wlan_client_info_api.py @@ -0,0 +1,1621 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MonitoringWlanClientInfoApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aggregation_data_by_query19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/aggregation', + 'operation_id': 'get_aggregation_data_by_query19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/doccount', + 'operation_id': 'get_count21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/doccount', + 'operation_id': 'get_count_post21', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/page', + 'operation_id': 'get_post_stat_bulk_raw_data19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/page', + 'operation_id': 'get_stat_bulk_raw_data19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/fields', + 'operation_id': 'get_stat_data_fields21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo', + 'operation_id': 'get_stat_data_raw_data18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv19_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv19', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields21_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo/query/fields', + 'operation_id': 'get_stat_query_fields21', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data19_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/wlanclientinfo', + 'operation_id': 'get_stats_raw_data19', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_aggregation_data_by_query19( + self, + **kwargs + ): + """get_aggregation_data_by_query19 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query19_endpoint.call_with_http_info(**kwargs) + + def get_count21( + self, + query, + **kwargs + ): + """get_count21 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count21(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count21_endpoint.call_with_http_info(**kwargs) + + def get_count_post21( + self, + **kwargs + ): + """get_count_post21 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post21_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query18( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query18 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query18_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query18( + self, + **kwargs + ): + """get_post_aggregation_data_by_query18 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query18_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data19( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data19 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data19_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data19( + self, + **kwargs + ): + """get_stat_bulk_raw_data19 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data19_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields21( + self, + **kwargs + ): + """get_stat_data_fields21 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields21_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data18( + self, + **kwargs + ): + """get_stat_data_raw_data18 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data18_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv19( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv19 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv19_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields21( + self, + **kwargs + ): + """get_stat_query_fields21 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields21(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields21_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data19( + self, + **kwargs + ): + """get_stats_raw_data19 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data19(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data19_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/msla_api.py b/openapi_client/api/msla_api.py new file mode 100644 index 0000000..c51e01d --- /dev/null +++ b/openapi_client/api/msla_api.py @@ -0,0 +1,1023 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class MSLAApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_template_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/template', + 'operation_id': 'get_all_template', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_and_device_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/monitoring/licensedDeviceCount', + 'operation_id': 'get_license_and_device_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_and_device_count1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/monitoring/licensedDistributionDetails', + 'operation_id': 'get_license_and_device_count1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_msla_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/devices', + 'operation_id': 'get_msla_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_packaging_distribution_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/monitoring/packagingDistributionDetails', + 'operation_id': 'get_packaging_distribution_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_subscriptions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/va/License', + 'operation_id': 'get_subscriptions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'virtual_account_id', + 'license_type', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'virtual_account_id': + (str,), + 'license_type': + (str,), + }, + 'attribute_map': { + 'virtual_account_id': 'virtual_account_id', + 'license_type': 'licenseType', + }, + 'location_map': { + 'virtual_account_id': 'query', + 'license_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_subscriptions1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/template/licenses', + 'operation_id': 'get_subscriptions1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.sync_licenses2_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/msla/licenses/sync', + 'operation_id': 'sync_licenses2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_all_template( + self, + **kwargs + ): + """get_all_template # noqa: E501 + + Retrieve all MSLA template # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_template(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_template_endpoint.call_with_http_info(**kwargs) + + def get_license_and_device_count( + self, + **kwargs + ): + """get_license_and_device_count # noqa: E501 + + get license and device count # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_and_device_count(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_license_and_device_count_endpoint.call_with_http_info(**kwargs) + + def get_license_and_device_count1( + self, + **kwargs + ): + """get_license_and_device_count1 # noqa: E501 + + get license and device count # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_and_device_count1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_license_and_device_count1_endpoint.call_with_http_info(**kwargs) + + def get_msla_devices( + self, + **kwargs + ): + """get_msla_devices # noqa: E501 + + Retrieve devices subscription # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_msla_devices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_msla_devices_endpoint.call_with_http_info(**kwargs) + + def get_packaging_distribution_details( + self, + **kwargs + ): + """get_packaging_distribution_details # noqa: E501 + + get packaging distribution details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_packaging_distribution_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_packaging_distribution_details_endpoint.call_with_http_info(**kwargs) + + def get_subscriptions( + self, + **kwargs + ): + """get_subscriptions # noqa: E501 + + Retrieve MSLA subscription/licenses # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_subscriptions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + virtual_account_id (str): virtual_account_id. [optional] + license_type (str): licenseType. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_subscriptions_endpoint.call_with_http_info(**kwargs) + + def get_subscriptions1( + self, + **kwargs + ): + """get_subscriptions1 # noqa: E501 + + Retrieve MSLA subscription/licenses # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_subscriptions1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_subscriptions1_endpoint.call_with_http_info(**kwargs) + + def sync_licenses2( + self, + **kwargs + ): + """sync_licenses2 # noqa: E501 + + Retrieve MSLA subscription/licenses # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_licenses2(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Sync license. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_licenses2_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/multitenant_apis_provider_api.py b/openapi_client/api/multitenant_apis_provider_api.py new file mode 100644 index 0000000..6343feb --- /dev/null +++ b/openapi_client/api/multitenant_apis_provider_api.py @@ -0,0 +1,2705 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MultitenantAPIsProviderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant', + 'operation_id': 'create_tenant', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tenant_async_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/async', + 'operation_id': 'create_tenant_async', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tenant_async_bulk_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/bulk/async', + 'operation_id': 'create_tenant_async_bulk', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tenant_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/delete', + 'operation_id': 'delete_tenant', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'body', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tenant_async_bulk_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/bulk/async', + 'operation_id': 'delete_tenant_async_bulk', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/delete', + 'operation_id': 'delete_tenant_backup', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'file_name', + ], + 'required': [ + 'file_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'file_name': + (str,), + }, + 'attribute_map': { + 'file_name': 'fileName', + }, + 'location_map': { + 'file_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_existing_backup_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/download/{path}', + 'operation_id': 'download_existing_backup_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.export_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/export', + 'operation_id': 'export_tenant_backup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.force_status_collection_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tenantstatus/force', + 'operation_id': 'force_status_collection', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_tenant_statuses_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenantstatus', + 'operation_id': 'get_all_tenant_statuses', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_tenants_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant', + 'operation_id': 'get_all_tenants', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}', + 'operation_id': 'get_tenant', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenant_hosting_capacity_onv_smarts_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/vsmart/capacity', + 'operation_id': 'get_tenant_hosting_capacity_onv_smarts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenantv_smart_mapping_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/vsmart', + 'operation_id': 'get_tenantv_smart_mapping', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.import_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/import', + 'operation_id': 'import_tenant_backup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/list', + 'operation_id': 'list_tenant_backup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.switch_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/switch', + 'operation_id': 'switch_tenant', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tenantv_smart_mt_migrate_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/vsmart-mt/migrate', + 'operation_id': 'tenantv_smart_mt_migrate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}', + 'operation_id': 'update_tenant', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'body', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_tenantv_smart_placement_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/vsmart', + 'operation_id': 'update_tenantv_smart_placement', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'body', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.v_session_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/vsessionid', + 'operation_id': 'v_session_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_tenant( + self, + **kwargs + ): + """create_tenant # noqa: E501 + + Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tenant(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tenant_endpoint.call_with_http_info(**kwargs) + + def create_tenant_async( + self, + **kwargs + ): + """create_tenant_async # noqa: E501 + + Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tenant_async(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tenant_async_endpoint.call_with_http_info(**kwargs) + + def create_tenant_async_bulk( + self, + **kwargs + ): + """create_tenant_async_bulk # noqa: E501 + + Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tenant_async_bulk(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tenant_async_bulk_endpoint.call_with_http_info(**kwargs) + + def delete_tenant( + self, + tenant_id, + **kwargs + ): + """delete_tenant # noqa: E501 + + Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.delete_tenant_endpoint.call_with_http_info(**kwargs) + + def delete_tenant_async_bulk( + self, + **kwargs + ): + """delete_tenant_async_bulk # noqa: E501 + + Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tenant_async_bulk(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_tenant_async_bulk_endpoint.call_with_http_info(**kwargs) + + def delete_tenant_backup( + self, + file_name, + **kwargs + ): + """delete_tenant_backup # noqa: E501 + + Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tenant_backup(file_name, async_req=True) + >>> result = thread.get() + + Args: + file_name (str): File name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['file_name'] = \ + file_name + return self.delete_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def download_existing_backup_file( + self, + path, + **kwargs + ): + """download_existing_backup_file # noqa: E501 + + Download a Backup File that is already stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_existing_backup_file(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): File path + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['path'] = \ + path + return self.download_existing_backup_file_endpoint.call_with_http_info(**kwargs) + + def export_tenant_backup( + self, + **kwargs + ): + """export_tenant_backup # noqa: E501 + + Trigger a backup of configuration database and store it in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.export_tenant_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.export_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def force_status_collection( + self, + **kwargs + ): + """force_status_collection # noqa: E501 + + Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.force_status_collection(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.force_status_collection_endpoint.call_with_http_info(**kwargs) + + def get_all_tenant_statuses( + self, + **kwargs + ): + """get_all_tenant_statuses # noqa: E501 + + List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_tenant_statuses(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_tenant_statuses_endpoint.call_with_http_info(**kwargs) + + def get_all_tenants( + self, + **kwargs + ): + """get_all_tenants # noqa: E501 + + Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_tenants(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): List all tenants associated with a vSmart. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_tenants_endpoint.call_with_http_info(**kwargs) + + def get_tenant( + self, + tenant_id, + **kwargs + ): + """get_tenant # noqa: E501 + + Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.get_tenant_endpoint.call_with_http_info(**kwargs) + + def get_tenant_hosting_capacity_onv_smarts( + self, + **kwargs + ): + """get_tenant_hosting_capacity_onv_smarts # noqa: E501 + + Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenant_hosting_capacity_onv_smarts(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenant_hosting_capacity_onv_smarts_endpoint.call_with_http_info(**kwargs) + + def get_tenantv_smart_mapping( + self, + **kwargs + ): + """get_tenantv_smart_mapping # noqa: E501 + + Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenantv_smart_mapping(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenantv_smart_mapping_endpoint.call_with_http_info(**kwargs) + + def import_tenant_backup( + self, + **kwargs + ): + """import_tenant_backup # noqa: E501 + + Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_tenant_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.import_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def list_tenant_backup( + self, + **kwargs + ): + """list_tenant_backup # noqa: E501 + + List all backup files of a tenant stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_tenant_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def switch_tenant( + self, + tenant_id, + **kwargs + ): + """switch_tenant # noqa: E501 + + Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.switch_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.switch_tenant_endpoint.call_with_http_info(**kwargs) + + def tenantv_smart_mt_migrate( + self, + **kwargs + ): + """tenantv_smart_mt_migrate # noqa: E501 + + Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenantv_smart_mt_migrate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.tenantv_smart_mt_migrate_endpoint.call_with_http_info(**kwargs) + + def update_tenant( + self, + tenant_id, + **kwargs + ): + """update_tenant # noqa: E501 + + Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.update_tenant_endpoint.call_with_http_info(**kwargs) + + def update_tenantv_smart_placement( + self, + tenant_id, + **kwargs + ): + """update_tenantv_smart_placement # noqa: E501 + + Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_tenantv_smart_placement(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.update_tenantv_smart_placement_endpoint.call_with_http_info(**kwargs) + + def v_session_id( + self, + tenant_id, + **kwargs + ): + """v_session_id # noqa: E501 + + Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.v_session_id(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.v_session_id_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/nwpi_api.py b/openapi_client/api/nwpi_api.py new file mode 100644 index 0000000..27147ff --- /dev/null +++ b/openapi_client/api/nwpi_api.py @@ -0,0 +1,1608 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class NWPIApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_agg_flow_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/aggFlow', + 'operation_id': 'get_agg_flow', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'trace_state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'trace_state': 'traceState', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'trace_state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_qos_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/appQosData', + 'operation_id': 'get_app_qos_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'received_timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'received_timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'received_timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'received_timestamp': 'receivedTimestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'received_timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_qos_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/appQosState', + 'operation_id': 'get_app_qos_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'trace_state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'trace_state': 'traceState', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'trace_state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_concurrent_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/concurrentData', + 'operation_id': 'get_concurrent_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_concurrent_domain_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/concurrentDomainData', + 'operation_id': 'get_concurrent_domain_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_app_hop_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventAppHopList', + 'operation_id': 'get_event_app_hop_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_app_score_bandwidth_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventAppScoreBandwidth', + 'operation_id': 'get_event_app_score_bandwidth', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + 'received_timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + 'received_timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + 'received_timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + 'received_timestamp': 'receivedTimestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + 'received_timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_flow_from_app_hop_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventFlowFromAppHop', + 'operation_id': 'get_event_flow_from_app_hop', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + 'application', + 'direction', + '_from', + 'to', + 'device_trace_id', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + 'application', + 'direction', + '_from', + 'to', + 'device_trace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + 'application': + (str,), + 'direction': + (str,), + '_from': + (str,), + 'to': + (str,), + 'device_trace_id': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + 'application': 'application', + 'direction': 'direction', + '_from': 'from', + 'to': 'to', + 'device_trace_id': 'deviceTraceId', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + 'application': 'query', + 'direction': 'query', + '_from': 'query', + 'to': 'query', + 'device_trace_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_readout_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventReadout', + 'operation_id': 'get_event_readout', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_detail_from_local_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/routingDetail', + 'operation_id': 'get_routing_detail_from_local', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'trace_state', + 'route_prefixs', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'trace_state', + 'route_prefixs', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'trace_state': + (str,), + 'route_prefixs': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'trace_state': 'traceState', + 'route_prefixs': 'routePrefixs', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'trace_state': 'query', + 'route_prefixs': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_agg_flow( + self, + trace_id, + timestamp, + trace_state, + **kwargs + ): + """get_agg_flow # noqa: E501 + + Get aggregated flow data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_agg_flow(trace_id, timestamp, trace_state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + trace_state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['trace_state'] = \ + trace_state + return self.get_agg_flow_endpoint.call_with_http_info(**kwargs) + + def get_app_qos_data( + self, + trace_id, + timestamp, + received_timestamp, + **kwargs + ): + """get_app_qos_data # noqa: E501 + + Get QoS Application data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_qos_data(trace_id, timestamp, received_timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + received_timestamp (int): received timestamp + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['received_timestamp'] = \ + received_timestamp + return self.get_app_qos_data_endpoint.call_with_http_info(**kwargs) + + def get_app_qos_state( + self, + trace_id, + timestamp, + trace_state, + **kwargs + ): + """get_app_qos_state # noqa: E501 + + Get QoS Application state to received timestamp mapping for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_qos_state(trace_id, timestamp, trace_state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + trace_state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['trace_state'] = \ + trace_state + return self.get_app_qos_state_endpoint.call_with_http_info(**kwargs) + + def get_concurrent_data( + self, + trace_id, + timestamp, + **kwargs + ): + """get_concurrent_data # noqa: E501 + + Get concurrent data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_concurrent_data(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_concurrent_data_endpoint.call_with_http_info(**kwargs) + + def get_concurrent_domain_data( + self, + trace_id, + timestamp, + **kwargs + ): + """get_concurrent_domain_data # noqa: E501 + + Get concurrent domain data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_concurrent_domain_data(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_concurrent_domain_data_endpoint.call_with_http_info(**kwargs) + + def get_event_app_hop_list( + self, + trace_id, + timestamp, + state, + **kwargs + ): + """get_event_app_hop_list # noqa: E501 + + Get Trace Application and HopList for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_app_hop_list(trace_id, timestamp, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + return self.get_event_app_hop_list_endpoint.call_with_http_info(**kwargs) + + def get_event_app_score_bandwidth( + self, + trace_id, + timestamp, + state, + received_timestamp, + **kwargs + ): + """get_event_app_score_bandwidth # noqa: E501 + + Get Trace Event Application Performance Score and Bandwidth for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_app_score_bandwidth(trace_id, timestamp, state, received_timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + received_timestamp (int): received timestamp + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + kwargs['received_timestamp'] = \ + received_timestamp + return self.get_event_app_score_bandwidth_endpoint.call_with_http_info(**kwargs) + + def get_event_flow_from_app_hop( + self, + trace_id, + timestamp, + state, + application, + direction, + _from, + to, + device_trace_id, + **kwargs + ): + """get_event_flow_from_app_hop # noqa: E501 + + Get Trace Event Flow From Application And Hop for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_flow_from_app_hop(trace_id, timestamp, state, application, direction, _from, to, device_trace_id, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + application (str): app name + direction (str): direction + _from (str): from + to (str): to + device_trace_id (int): deviceTraceId + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + kwargs['application'] = \ + application + kwargs['direction'] = \ + direction + kwargs['_from'] = \ + _from + kwargs['to'] = \ + to + kwargs['device_trace_id'] = \ + device_trace_id + return self.get_event_flow_from_app_hop_endpoint.call_with_http_info(**kwargs) + + def get_event_readout( + self, + trace_id, + timestamp, + state, + **kwargs + ): + """get_event_readout # noqa: E501 + + Get Trace Event Readout for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_readout(trace_id, timestamp, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + return self.get_event_readout_endpoint.call_with_http_info(**kwargs) + + def get_routing_detail_from_local( + self, + trace_id, + timestamp, + trace_state, + route_prefixs, + **kwargs + ): + """get_routing_detail_from_local # noqa: E501 + + Get Routing Details for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_detail_from_local(trace_id, timestamp, trace_state, route_prefixs, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + trace_state (str): trace state + route_prefixs (str): route prefixs + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['trace_state'] = \ + trace_state + kwargs['route_prefixs'] = \ + route_prefixs + return self.get_routing_detail_from_local_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/partner_aci_policy_builder_api.py b/openapi_client/api/partner_aci_policy_builder_api.py new file mode 100644 index 0000000..4ffa3e8 --- /dev/null +++ b/openapi_client/api/partner_aci_policy_builder_api.py @@ -0,0 +1,1096 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class PartnerACIPolicyBuilderApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_dscp_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/dscpmapping/{partnerId}', + 'operation_id': 'create_dscp_mappings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'body', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_dscp_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/dscpmapping/{partnerId}', + 'operation_id': 'delete_dscp_mappings', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aci_definitions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/aci/policy', + 'operation_id': 'get_aci_definitions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_data_prefix_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/prefixmapping/{partnerId}', + 'operation_id': 'get_data_prefix_mappings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_data_prefix_sequences_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/sequences', + 'operation_id': 'get_data_prefix_sequences', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dscp_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/dscpmapping/{partnerId}', + 'operation_id': 'get_dscp_mappings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_events_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/events/{partnerId}', + 'operation_id': 'get_events', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'starttime', + 'endtime', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'starttime': + (int,), + 'endtime': + (int,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + 'starttime': 'starttime', + 'endtime': 'endtime', + }, + 'location_map': { + 'partner_id': 'path', + 'starttime': 'query', + 'endtime': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.set_data_prefix_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/aci/policy/prefixmapping/{partnerId}', + 'operation_id': 'set_data_prefix_mappings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'body', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_dscp_mappings( + self, + partner_id, + **kwargs + ): + """create_dscp_mappings # noqa: E501 + + Create an ACI definition entry # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dscp_mappings(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): ACI definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.create_dscp_mappings_endpoint.call_with_http_info(**kwargs) + + def delete_dscp_mappings( + self, + partner_id, + **kwargs + ): + """delete_dscp_mappings # noqa: E501 + + Delete DSCP mapping # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_dscp_mappings(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.delete_dscp_mappings_endpoint.call_with_http_info(**kwargs) + + def get_aci_definitions( + self, + **kwargs + ): + """get_aci_definitions # noqa: E501 + + Get ACI definitions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aci_definitions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aci_definitions_endpoint.call_with_http_info(**kwargs) + + def get_data_prefix_mappings( + self, + partner_id, + **kwargs + ): + """get_data_prefix_mappings # noqa: E501 + + Get prefix mapping # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_data_prefix_mappings(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.get_data_prefix_mappings_endpoint.call_with_http_info(**kwargs) + + def get_data_prefix_sequences( + self, + **kwargs + ): + """get_data_prefix_sequences # noqa: E501 + + Get data prefix sequence # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_data_prefix_sequences(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_data_prefix_sequences_endpoint.call_with_http_info(**kwargs) + + def get_dscp_mappings( + self, + partner_id, + **kwargs + ): + """get_dscp_mappings # noqa: E501 + + Get DSCP policy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dscp_mappings(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.get_dscp_mappings_endpoint.call_with_http_info(**kwargs) + + def get_events( + self, + partner_id, + **kwargs + ): + """get_events # noqa: E501 + + Get ACI events # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_events(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + starttime (int): Start time. [optional] + endtime (int): End time. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.get_events_endpoint.call_with_http_info(**kwargs) + + def set_data_prefix_mappings( + self, + partner_id, + **kwargs + ): + """set_data_prefix_mappings # noqa: E501 + + Create data prefix mapping # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_data_prefix_mappings(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Prefix definition. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.set_data_prefix_mappings_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/partner_dnacsdaapi_api.py b/openapi_client/api/partner_dnacsdaapi_api.py new file mode 100644 index 0000000..3240085 --- /dev/null +++ b/openapi_client/api/partner_dnacsdaapi_api.py @@ -0,0 +1,842 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class PartnerDNACSDAAPIApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_sda_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/dnac/sda/config/{partnerId}', + 'operation_id': 'create_sda_config', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'body', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_sda_config_from_netconf_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/dnac/sda/netconfconfig/{partnerId}', + 'operation_id': 'create_sda_config_from_netconf', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'body', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_device_details_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/dnac/sda/device/{partnerId}/{uuid}', + 'operation_id': 'get_device_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'uuid', + ], + 'required': [ + 'partner_id', + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'uuid': + (str,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + 'uuid': 'uuid', + }, + 'location_map': { + 'partner_id': 'path', + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_overlay_vpn_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/dnac/sda/vpn', + 'operation_id': 'get_overlay_vpn_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sda_enabled_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/dnac/sda/device/{partnerId}', + 'operation_id': 'get_sda_enabled_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sites_for_partner_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/dnac/sda/site/{partnerId}', + 'operation_id': 'get_sites_for_partner', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + }, + 'location_map': { + 'partner_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_sda_config( + self, + partner_id, + **kwargs + ): + """create_sda_config # noqa: E501 + + Create SDA enabled device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sda_config(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device SDA configuration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.create_sda_config_endpoint.call_with_http_info(**kwargs) + + def create_sda_config_from_netconf( + self, + partner_id, + **kwargs + ): + """create_sda_config_from_netconf # noqa: E501 + + Create SDA enabled device from Netconf # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sda_config_from_netconf(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device SDA configuration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.create_sda_config_from_netconf_endpoint.call_with_http_info(**kwargs) + + def get_device_details( + self, + partner_id, + uuid, + **kwargs + ): + """get_device_details # noqa: E501 + + Get SDA enabled devices detail # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_details(partner_id, uuid, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + kwargs['uuid'] = \ + uuid + return self.get_device_details_endpoint.call_with_http_info(**kwargs) + + def get_overlay_vpn_list( + self, + **kwargs + ): + """get_overlay_vpn_list # noqa: E501 + + Get Overlay VPN list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_overlay_vpn_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_overlay_vpn_list_endpoint.call_with_http_info(**kwargs) + + def get_sda_enabled_devices( + self, + partner_id, + **kwargs + ): + """get_sda_enabled_devices # noqa: E501 + + Get SDA enabled devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sda_enabled_devices(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.get_sda_enabled_devices_endpoint.call_with_http_info(**kwargs) + + def get_sites_for_partner( + self, + partner_id, + **kwargs + ): + """get_sites_for_partner # noqa: E501 + + Get SDA enabled devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sites_for_partner(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.get_sites_for_partner_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/partner_registration_api.py b/openapi_client/api/partner_registration_api.py new file mode 100644 index 0000000..decfebe --- /dev/null +++ b/openapi_client/api/partner_registration_api.py @@ -0,0 +1,1713 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.event_name import EventName +from openapi_client.model.partner_type import PartnerType + + +class PartnerRegistrationApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.delete_device_mapping_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/unmap/{nmsId}', + 'operation_id': 'delete_device_mapping', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + 'body', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (str,), + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_partner_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/{nmsId}', + 'operation_id': 'delete_partner', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (PartnerType,), + 'nms_id': + (str,), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_data_change_info_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/serverlongpoll/event/poll/{partnerId}', + 'operation_id': 'get_data_change_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_id', + 'event_id', + 'event_names', + 'wait_time', + ], + 'required': [ + 'partner_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_id': + (str,), + 'event_id': + (str,), + 'event_names': + ([EventName],), + 'wait_time': + (int,), + }, + 'attribute_map': { + 'partner_id': 'partnerId', + 'event_id': 'event_id', + 'event_names': 'eventNames', + 'wait_time': 'wait_time', + }, + 'location_map': { + 'partner_id': 'path', + 'event_id': 'query', + 'event_names': 'query', + 'wait_time': 'query', + }, + 'collection_format_map': { + 'event_names': 'multi', + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_partner_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/{nmsId}', + 'operation_id': 'get_partner', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (str,), + 'nms_id': + (str,), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_partner_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/map/{nmsId}', + 'operation_id': 'get_partner_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (PartnerType,), + 'nms_id': + (str,), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_partners_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner', + 'operation_id': 'get_partners', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_partners_by_partner_type_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}', + 'operation_id': 'get_partners_by_partner_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + ], + 'required': [ + 'partner_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (str,), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + }, + 'location_map': { + 'partner_type': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vpn_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/partner/vpn', + 'operation_id': 'get_vpn_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.map_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/map/{nmsId}', + 'operation_id': 'map_devices', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + 'body', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (str,), + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.register_partner_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}', + 'operation_id': 'register_partner', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'body', + ], + 'required': [ + 'partner_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + }, + 'location_map': { + 'partner_type': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.unmap_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/map/{nmsId}', + 'operation_id': 'unmap_devices', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (PartnerType,), + 'nms_id': + (str,), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_partner_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/partner/{partnerType}/{nmsId}', + 'operation_id': 'update_partner', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'partner_type', + 'nms_id', + 'body', + ], + 'required': [ + 'partner_type', + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'partner_type': + (str,), + 'nms_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'partner_type': 'partnerType', + 'nms_id': 'nmsId', + }, + 'location_map': { + 'partner_type': 'path', + 'nms_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def delete_device_mapping( + self, + partner_type, + nms_id, + **kwargs + ): + """delete_device_mapping # noqa: E501 + + Unmap a set of devices for the partner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_device_mapping(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (str): Partner type + nms_id (str): NMS Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): List of devices. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.delete_device_mapping_endpoint.call_with_http_info(**kwargs) + + def delete_partner( + self, + partner_type, + nms_id, + **kwargs + ): + """delete_partner # noqa: E501 + + Delete NMS partner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_partner(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (PartnerType): Partner type + nms_id (str): NMS Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.delete_partner_endpoint.call_with_http_info(**kwargs) + + def get_data_change_info( + self, + partner_id, + **kwargs + ): + """get_data_change_info # noqa: E501 + + Retrieve registration change information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_data_change_info(partner_id, async_req=True) + >>> result = thread.get() + + Args: + partner_id (str): Partner Id + + Keyword Args: + event_id (str): Continuation token of ongoing event-polling session. [optional] + event_names ([EventName]): Names of type of events to filter on. [optional] + wait_time (int): Maximum polling wait time in seconds. [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_id'] = \ + partner_id + return self.get_data_change_info_endpoint.call_with_http_info(**kwargs) + + def get_partner( + self, + partner_type, + nms_id, + **kwargs + ): + """get_partner # noqa: E501 + + Get NMS partners by partner type and Id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_partner(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (str): Partner type + nms_id (str): NMS Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.get_partner_endpoint.call_with_http_info(**kwargs) + + def get_partner_devices( + self, + partner_type, + nms_id, + **kwargs + ): + """get_partner_devices # noqa: E501 + + List mapped devices for the partner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_partner_devices(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (PartnerType): Partner type + nms_id (str): NMS Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.get_partner_devices_endpoint.call_with_http_info(**kwargs) + + def get_partners( + self, + **kwargs + ): + """get_partners # noqa: E501 + + Get all NMS partners # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_partners(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_partners_endpoint.call_with_http_info(**kwargs) + + def get_partners_by_partner_type( + self, + partner_type, + **kwargs + ): + """get_partners_by_partner_type # noqa: E501 + + Get NMS partners by partner type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_partners_by_partner_type(partner_type, async_req=True) + >>> result = thread.get() + + Args: + partner_type (str): Partner type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + return self.get_partners_by_partner_type_endpoint.call_with_http_info(**kwargs) + + def get_vpn_list( + self, + **kwargs + ): + """get_vpn_list # noqa: E501 + + Get all VPNs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_vpn_list_endpoint.call_with_http_info(**kwargs) + + def map_devices( + self, + partner_type, + nms_id, + **kwargs + ): + """map_devices # noqa: E501 + + Map devices for the partner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.map_devices(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (str): Partner type + nms_id (str): NMS Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): List of devices. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.map_devices_endpoint.call_with_http_info(**kwargs) + + def register_partner( + self, + partner_type, + **kwargs + ): + """register_partner # noqa: E501 + + Register NMS partner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.register_partner(partner_type, async_req=True) + >>> result = thread.get() + + Args: + partner_type (str): Partner type + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + return self.register_partner_endpoint.call_with_http_info(**kwargs) + + def unmap_devices( + self, + partner_type, + nms_id, + **kwargs + ): + """unmap_devices # noqa: E501 + + Unmap all devices for the partner # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.unmap_devices(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (PartnerType): Partner type + nms_id (str): NMS Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.unmap_devices_endpoint.call_with_http_info(**kwargs) + + def update_partner( + self, + partner_type, + nms_id, + **kwargs + ): + """update_partner # noqa: E501 + + Update NMS partner details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_partner(partner_type, nms_id, async_req=True) + >>> result = thread.get() + + Args: + partner_type (str): Partner type + nms_id (str): NMS Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['partner_type'] = \ + partner_type + kwargs['nms_id'] = \ + nms_id + return self.update_partner_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/partner_wcm_configs_api.py b/openapi_client/api/partner_wcm_configs_api.py new file mode 100644 index 0000000..7df027c --- /dev/null +++ b/openapi_client/api/partner_wcm_configs_api.py @@ -0,0 +1,177 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class PartnerWCMConfigsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.push_netconf_configs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/partner/wcm/netconf/{nmsId}', + 'operation_id': 'push_netconf_configs', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'nms_id', + 'request_body', + ], + 'required': [ + 'nms_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'nms_id': + (str,), + 'request_body': + ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + }, + 'attribute_map': { + 'nms_id': 'nmsId', + }, + 'location_map': { + 'nms_id': 'path', + 'request_body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def push_netconf_configs( + self, + nms_id, + **kwargs + ): + """push_netconf_configs # noqa: E501 + + Push device configs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.push_netconf_configs(nms_id, async_req=True) + >>> result = thread.get() + + Args: + nms_id (str): NMS Id + + Keyword Args: + request_body ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Netconf configuration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['nms_id'] = \ + nms_id + return self.push_netconf_configs_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_aaa_api.py b/openapi_client/api/real_time_monitoring_aaa_api.py new file mode 100644 index 0000000..554608d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_aaa_api.py @@ -0,0 +1,983 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringAAAApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aa_aservers_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/aaa/servers', + 'operation_id': 'get_aa_aservers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aaa_users_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/aaa/users', + 'operation_id': 'get_aaa_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_acl_match_counter_users_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/acl/matchcounter', + 'operation_id': 'get_acl_match_counter_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_device_users_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/users/list', + 'operation_id': 'get_all_device_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_logging_from_device_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/logging', + 'operation_id': 'get_logging_from_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_unclaimed_vedges_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/unclaimed/vedges', + 'operation_id': 'get_unclaimed_vedges', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_users_from_device_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/users', + 'operation_id': 'get_users_from_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_aa_aservers( + self, + device_id, + **kwargs + ): + """get_aa_aservers # noqa: E501 + + Get AAA servers from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aa_aservers(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_aa_aservers_endpoint.call_with_http_info(**kwargs) + + def get_aaa_users( + self, + device_id, + **kwargs + ): + """get_aaa_users # noqa: E501 + + Get AAA users from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aaa_users(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_aaa_users_endpoint.call_with_http_info(**kwargs) + + def get_acl_match_counter_users( + self, + device_id, + **kwargs + ): + """get_acl_match_counter_users # noqa: E501 + + Get ACL match counters from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_acl_match_counter_users(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_acl_match_counter_users_endpoint.call_with_http_info(**kwargs) + + def get_all_device_users( + self, + device_id, + **kwargs + ): + """get_all_device_users # noqa: E501 + + Get all users from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_device_users(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_all_device_users_endpoint.call_with_http_info(**kwargs) + + def get_logging_from_device( + self, + device_id, + **kwargs + ): + """get_logging_from_device # noqa: E501 + + Get logging from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_logging_from_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_logging_from_device_endpoint.call_with_http_info(**kwargs) + + def get_unclaimed_vedges( + self, + device_id, + **kwargs + ): + """get_unclaimed_vedges # noqa: E501 + + Get unclaimed vEdges from vbond # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_unclaimed_vedges(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_unclaimed_vedges_endpoint.call_with_http_info(**kwargs) + + def get_users_from_device( + self, + device_id, + **kwargs + ): + """get_users_from_device # noqa: E501 + + Get users from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_users_from_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_users_from_device_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_app_hosting_api.py b/openapi_client/api/real_time_monitoring_app_hosting_api.py new file mode 100644 index 0000000..7e82546 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_app_hosting_api.py @@ -0,0 +1,1094 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringAppHostingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_app_hosting_attached_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/attached-devices', + 'operation_id': 'get_app_hosting_attached_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/details', + 'operation_id': 'get_app_hosting_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_guest_routes_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/guest-routes', + 'operation_id': 'get_app_hosting_guest_routes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_network_devices_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/network-interfaces', + 'operation_id': 'get_app_hosting_network_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_network_utils_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/network-utilization', + 'operation_id': 'get_app_hosting_network_utils', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_processes_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/processes', + 'operation_id': 'get_app_hosting_processes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_storage_utils_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/storage-utilization', + 'operation_id': 'get_app_hosting_storage_utils', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_hosting_utilization_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-hosting/utilization', + 'operation_id': 'get_app_hosting_utilization', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_app_hosting_attached_devices( + self, + device_id, + **kwargs + ): + """get_app_hosting_attached_devices # noqa: E501 + + Get App hosting attached device from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_attached_devices(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_attached_devices_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_details( + self, + device_id, + **kwargs + ): + """get_app_hosting_details # noqa: E501 + + Get App hosting details from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_details(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_details_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_guest_routes( + self, + device_id, + **kwargs + ): + """get_app_hosting_guest_routes # noqa: E501 + + Get App hosting guest routes from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_guest_routes(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_guest_routes_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_network_devices( + self, + device_id, + **kwargs + ): + """get_app_hosting_network_devices # noqa: E501 + + Get App hosting network interface from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_network_devices(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_network_devices_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_network_utils( + self, + device_id, + **kwargs + ): + """get_app_hosting_network_utils # noqa: E501 + + Get App hosting network utilization from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_network_utils(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_network_utils_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_processes( + self, + device_id, + **kwargs + ): + """get_app_hosting_processes # noqa: E501 + + Get App hosting processes from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_processes(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_processes_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_storage_utils( + self, + device_id, + **kwargs + ): + """get_app_hosting_storage_utils # noqa: E501 + + Get App hosting storage utilization from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_storage_utils(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_storage_utils_endpoint.call_with_http_info(**kwargs) + + def get_app_hosting_utilization( + self, + device_id, + **kwargs + ): + """get_app_hosting_utilization # noqa: E501 + + Get App hosting utilization from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_hosting_utilization(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_hosting_utilization_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_app_logs_api.py b/openapi_client/api/real_time_monitoring_app_logs_api.py new file mode 100644 index 0000000..45aeb95 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_app_logs_api.py @@ -0,0 +1,316 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringAppLogsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_app_log_flow_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app/log/flow-count', + 'operation_id': 'get_app_log_flow_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_log_flows_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app/log/flows', + 'operation_id': 'get_app_log_flows', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_app_log_flow_count( + self, + device_id, + **kwargs + ): + """get_app_log_flow_count # noqa: E501 + + Get App log flows count from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_log_flow_count(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_log_flow_count_endpoint.call_with_http_info(**kwargs) + + def get_app_log_flows( + self, + device_id, + **kwargs + ): + """get_app_log_flows # noqa: E501 + + Get App log flows from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_log_flows(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_app_log_flows_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_application_aware_route_api.py b/openapi_client/api/real_time_monitoring_application_aware_route_api.py new file mode 100644 index 0000000..d201ea5 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_application_aware_route_api.py @@ -0,0 +1,386 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringApplicationAwareRouteApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_app_route_sla_class_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-route/sla-class', + 'operation_id': 'create_app_route_sla_class_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_app_route_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/app-route/statistics', + 'operation_id': 'create_app_route_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_system_ip', + 'local_color', + 'remote_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'local_color', + 'remote_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('local_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('remote_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_system_ip': + (str,), + 'local_color': + (str,), + 'remote_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_system_ip': 'remote-system-ip', + 'local_color': 'local-color', + 'remote_color': 'remote-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_system_ip': 'query', + 'local_color': 'query', + 'remote_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_app_route_sla_class_list( + self, + device_id, + **kwargs + ): + """create_app_route_sla_class_list # noqa: E501 + + Get SLA class list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_app_route_sla_class_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_app_route_sla_class_list_endpoint.call_with_http_info(**kwargs) + + def create_app_route_statistics_list( + self, + device_id, + **kwargs + ): + """create_app_route_statistics_list # noqa: E501 + + Get application-aware routing statistics from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_app_route_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_system_ip (str): Remote system IP. [optional] + local_color (str): Local color. [optional] + remote_color (str): Remote color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_app_route_statistics_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_appqoe_api.py b/openapi_client/api/real_time_monitoring_appqoe_api.py new file mode 100644 index 0000000..0dbf15e --- /dev/null +++ b/openapi_client/api/real_time_monitoring_appqoe_api.py @@ -0,0 +1,2226 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringAppqoeApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_appqoe_active_flow_id_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/active-flow-id', + 'operation_id': 'create_appqoe_active_flow_id_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'flow_id', + 'device_id', + ], + 'required': [ + 'flow_id', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'flow_id': + (str,), + 'device_id': + (str,), + }, + 'attribute_map': { + 'flow_id': 'flow-id', + 'device_id': 'deviceId', + }, + 'location_map': { + 'flow_id': 'query', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_appqoe_flow_id_expired_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/expired-flow-id', + 'operation_id': 'create_appqoe_flow_id_expired_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'flow_id', + 'device_id', + ], + 'required': [ + 'flow_id', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'flow_id': + (str,), + 'device_id': + (str,), + }, + 'attribute_map': { + 'flow_id': 'flow-id', + 'device_id': 'deviceId', + }, + 'location_map': { + 'flow_id': 'query', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_appqoe_vpn_id_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/vpn-id', + 'operation_id': 'create_appqoe_vpn_id_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'device_id', + 'client_ip', + 'server_ip', + 'server_port', + ], + 'required': [ + 'vpn_id', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vpn_id': + (str,), + 'device_id': + (str,), + 'client_ip': + (str,), + 'server_ip': + (str,), + 'server_port': + (str,), + }, + 'attribute_map': { + 'vpn_id': 'vpn-id', + 'device_id': 'deviceId', + 'client_ip': 'client-ip', + 'server_ip': 'server-ip', + 'server_port': 'server-port', + }, + 'location_map': { + 'vpn_id': 'query', + 'device_id': 'query', + 'client_ip': 'query', + 'server_ip': 'query', + 'server_port': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_cluster_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/cluster-summary', + 'operation_id': 'get_appqoe_cluster_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_error_recent_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/error-recent', + 'operation_id': 'get_appqoe_error_recent', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_expired_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/flow-expired', + 'operation_id': 'get_appqoe_expired', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_flow_closed_error_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/flow-closed-error', + 'operation_id': 'get_appqoe_flow_closed_error', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_hput_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-hput-stats', + 'operation_id': 'get_appqoe_hput_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_nat_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-nat-stats', + 'operation_id': 'get_appqoe_nat_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_rm_resources_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-rm-resource', + 'operation_id': 'get_appqoe_rm_resources', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_rm_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-rm-stats', + 'operation_id': 'get_appqoe_rm_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_service_controllers_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/service-controllers', + 'operation_id': 'get_appqoe_service_controllers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_services_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-services-status', + 'operation_id': 'get_appqoe_services_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_sppi_pipe_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-sppi-pipe-resource', + 'operation_id': 'get_appqoe_sppi_pipe_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_sppi_queue_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/appqoe-sppi-queue-resource', + 'operation_id': 'get_appqoe_sppi_queue_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_appqoe_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/appqoe/status', + 'operation_id': 'get_appqoe_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_appqoe_active_flow_id_details( + self, + flow_id, + device_id, + **kwargs + ): + """create_appqoe_active_flow_id_details # noqa: E501 + + Get Appqoe Active flow Id details from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_appqoe_active_flow_id_details(flow_id, device_id, async_req=True) + >>> result = thread.get() + + Args: + flow_id (str): Flow Id + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['flow_id'] = \ + flow_id + kwargs['device_id'] = \ + device_id + return self.create_appqoe_active_flow_id_details_endpoint.call_with_http_info(**kwargs) + + def create_appqoe_flow_id_expired_details( + self, + flow_id, + device_id, + **kwargs + ): + """create_appqoe_flow_id_expired_details # noqa: E501 + + Get Appqoe Expired flow Id details from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_appqoe_flow_id_expired_details(flow_id, device_id, async_req=True) + >>> result = thread.get() + + Args: + flow_id (str): Flow Id + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['flow_id'] = \ + flow_id + kwargs['device_id'] = \ + device_id + return self.create_appqoe_flow_id_expired_details_endpoint.call_with_http_info(**kwargs) + + def create_appqoe_vpn_id_list( + self, + vpn_id, + device_id, + **kwargs + ): + """create_appqoe_vpn_id_list # noqa: E501 + + Get Appqoe Active vpn Id details from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_appqoe_vpn_id_list(vpn_id, device_id, async_req=True) + >>> result = thread.get() + + Args: + vpn_id (str): VPN Id + device_id (str): Device IP + + Keyword Args: + client_ip (str): Client Ip. [optional] + server_ip (str): Server Ip. [optional] + server_port (str): Server-Port. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vpn_id'] = \ + vpn_id + kwargs['device_id'] = \ + device_id + return self.create_appqoe_vpn_id_list_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_cluster_summary( + self, + device_id, + **kwargs + ): + """get_appqoe_cluster_summary # noqa: E501 + + Get Appqoe Cluster Summary from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_cluster_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_cluster_summary_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_error_recent( + self, + device_id, + **kwargs + ): + """get_appqoe_error_recent # noqa: E501 + + Get Appqoe error recent from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_error_recent(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_error_recent_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_expired( + self, + device_id, + **kwargs + ): + """get_appqoe_expired # noqa: E501 + + Get Appqoe expired from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_expired(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_expired_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_flow_closed_error( + self, + device_id, + **kwargs + ): + """get_appqoe_flow_closed_error # noqa: E501 + + Get Appqoe flow closed error from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_flow_closed_error(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_flow_closed_error_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_hput_stats( + self, + device_id, + **kwargs + ): + """get_appqoe_hput_stats # noqa: E501 + + Get Appqoe Hput Statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_hput_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_hput_stats_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_nat_stats( + self, + device_id, + **kwargs + ): + """get_appqoe_nat_stats # noqa: E501 + + Get Appqoe Nat Statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_nat_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_nat_stats_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_rm_resources( + self, + device_id, + **kwargs + ): + """get_appqoe_rm_resources # noqa: E501 + + Get Appqoe Resource Manager resources from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_rm_resources(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_rm_resources_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_rm_stats( + self, + device_id, + **kwargs + ): + """get_appqoe_rm_stats # noqa: E501 + + Get Appqoe RM Statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_rm_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_rm_stats_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_service_controllers( + self, + device_id, + **kwargs + ): + """get_appqoe_service_controllers # noqa: E501 + + Get Appqoe service controllers from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_service_controllers(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_service_controllers_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_services_status( + self, + device_id, + **kwargs + ): + """get_appqoe_services_status # noqa: E501 + + Get Appqoe Services Status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_services_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_services_status_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_sppi_pipe_stats( + self, + device_id, + **kwargs + ): + """get_appqoe_sppi_pipe_stats # noqa: E501 + + Get Appqoe Sppi Pipe Stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_sppi_pipe_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_sppi_pipe_stats_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_sppi_queue_stats( + self, + device_id, + **kwargs + ): + """get_appqoe_sppi_queue_stats # noqa: E501 + + Get Appqoe Sppi Queue Stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_sppi_queue_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_sppi_queue_stats_endpoint.call_with_http_info(**kwargs) + + def get_appqoe_status( + self, + device_id, + **kwargs + ): + """get_appqoe_status # noqa: E501 + + Get Appqoe status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_appqoe_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_appqoe_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_arp_api.py b/openapi_client/api/real_time_monitoring_arp_api.py new file mode 100644 index 0000000..facb2d0 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_arp_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringARPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_arp_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/arp', + 'operation_id': 'get_arp_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_arp_interface( + self, + device_id, + **kwargs + ): + """get_arp_interface # noqa: E501 + + Get ARP interfaces from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_arp_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_arp_interface_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_bfd_api.py b/openapi_client/api/real_time_monitoring_bfd_api.py new file mode 100644 index 0000000..3dd2c63 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_bfd_api.py @@ -0,0 +1,1928 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.vpnid import VPNID + + +class RealTimeMonitoringBFDApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_bfd_history_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/bfd/history', + 'operation_id': 'create_bfd_history_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'system_ip', + 'color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'color', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'system_ip': + (str,), + 'color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'system_ip': 'system-ip', + 'color': 'color', + }, + 'location_map': { + 'device_id': 'query', + 'system_ip': 'query', + 'color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_bfd_link_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/bfd/links', + 'operation_id': 'create_bfd_link_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state', + ], + 'required': [ + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state': + (str,), + }, + 'attribute_map': { + 'state': 'state', + }, + 'location_map': { + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_bfd_sessions_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/bfd/sessions', + 'operation_id': 'create_bfd_sessions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'system_ip', + 'color', + 'local_color', + 'region_type', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'color', + 'local_color', + 'region_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('region_type',): { + + "CORE": "core", + "ACCESS": "access" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'system_ip': + (str,), + 'color': + (str,), + 'local_color': + (str,), + 'region_type': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'system_ip': 'system-ip', + 'color': 'color', + 'local_color': 'local-color', + 'region_type': 'region-type', + }, + 'location_map': { + 'device_id': 'query', + 'system_ip': 'query', + 'color': 'query', + 'local_color': 'query', + 'region_type': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_bfd_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/summary', + 'operation_id': 'create_bfd_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_bfd_session_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/bfd/synced/sessions', + 'operation_id': 'create_synced_bfd_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'system_ip', + 'color', + 'local_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'color', + 'local_color', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'system_ip': + (str,), + 'color': + (str,), + 'local_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'system_ip': 'system-ip', + 'color': 'color', + 'local_color': 'local-color', + }, + 'location_map': { + 'device_id': 'query', + 'system_ip': 'query', + 'color': 'query', + 'local_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_tloc_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/tloc', + 'operation_id': 'create_tloc_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bfd_site_state_detail_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/sites/detail', + 'operation_id': 'get_bfd_site_state_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bfd_sites_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/sites/summary', + 'operation_id': 'get_bfd_sites_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'is_cached', + ], + 'required': [ + 'vpn_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vpn_id': + ([VPNID],), + 'is_cached': + (bool,), + }, + 'attribute_map': { + 'vpn_id': 'vpnId', + 'is_cached': 'isCached', + }, + 'location_map': { + 'vpn_id': 'query', + 'is_cached': 'query', + }, + 'collection_format_map': { + 'vpn_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_bfd_state_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/state/device', + 'operation_id': 'get_device_bfd_state_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_bfd_state_summary_tloc_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/state/device/tloc', + 'operation_id': 'get_device_bfd_state_summary_tloc', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_bfd_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/status', + 'operation_id': 'get_device_bfd_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_bfd_status_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/summary/device', + 'operation_id': 'get_device_bfd_status_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_tloc_to_intf_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bfd/state/device/tlocInterfaceMap', + 'operation_id': 'get_device_tloc_to_intf_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_bfd_history_list( + self, + device_id, + **kwargs + ): + """create_bfd_history_list # noqa: E501 + + Get BFD session history from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bfd_history_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + system_ip (str): System IP. [optional] + color (str): Remote color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bfd_history_list_endpoint.call_with_http_info(**kwargs) + + def create_bfd_link_list( + self, + state, + **kwargs + ): + """create_bfd_link_list # noqa: E501 + + Get list of BFD connections # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bfd_link_list(state, async_req=True) + >>> result = thread.get() + + Args: + state (str): Device state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state'] = \ + state + return self.create_bfd_link_list_endpoint.call_with_http_info(**kwargs) + + def create_bfd_sessions( + self, + device_id, + **kwargs + ): + """create_bfd_sessions # noqa: E501 + + Get list of BFD sessions from vManage (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bfd_sessions(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + system_ip (str): System IP. [optional] + color (str): Remote color. [optional] + local_color (str): Source color. [optional] + region_type (str): Region type. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bfd_sessions_endpoint.call_with_http_info(**kwargs) + + def create_bfd_summary( + self, + device_id, + **kwargs + ): + """create_bfd_summary # noqa: E501 + + Get BFD summary from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bfd_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bfd_summary_endpoint.call_with_http_info(**kwargs) + + def create_synced_bfd_session( + self, + device_id, + **kwargs + ): + """create_synced_bfd_session # noqa: E501 + + Get list of BFD sessions from vManage synchronously # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_bfd_session(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + system_ip (str): System IP. [optional] + color (str): Remote color. [optional] + local_color (str): Source color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_bfd_session_endpoint.call_with_http_info(**kwargs) + + def create_tloc_summary( + self, + device_id, + **kwargs + ): + """create_tloc_summary # noqa: E501 + + Get TLOC summary from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tloc_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_tloc_summary_endpoint.call_with_http_info(**kwargs) + + def get_bfd_site_state_detail( + self, + **kwargs + ): + """get_bfd_site_state_detail # noqa: E501 + + Get detailed BFD site details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bfd_site_state_detail(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_bfd_site_state_detail_endpoint.call_with_http_info(**kwargs) + + def get_bfd_sites_summary( + self, + vpn_id, + **kwargs + ): + """get_bfd_sites_summary # noqa: E501 + + Get BFD site summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bfd_sites_summary(vpn_id, async_req=True) + >>> result = thread.get() + + Args: + vpn_id ([VPNID]): Filter VPN + + Keyword Args: + is_cached (bool): Flag for caching. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vpn_id'] = \ + vpn_id + return self.get_bfd_sites_summary_endpoint.call_with_http_info(**kwargs) + + def get_device_bfd_state_summary( + self, + device_id, + **kwargs + ): + """get_device_bfd_state_summary # noqa: E501 + + Get device BFD state summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_bfd_state_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_bfd_state_summary_endpoint.call_with_http_info(**kwargs) + + def get_device_bfd_state_summary_tloc( + self, + device_id, + **kwargs + ): + """get_device_bfd_state_summary_tloc # noqa: E501 + + Get device BFD state summary with tloc color # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_bfd_state_summary_tloc(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_bfd_state_summary_tloc_endpoint.call_with_http_info(**kwargs) + + def get_device_bfd_status( + self, + **kwargs + ): + """get_device_bfd_status # noqa: E501 + + Get device BFD status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_bfd_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_bfd_status_endpoint.call_with_http_info(**kwargs) + + def get_device_bfd_status_summary( + self, + device_id, + **kwargs + ): + """get_device_bfd_status_summary # noqa: E501 + + Get device BFD status summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_bfd_status_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_bfd_status_summary_endpoint.call_with_http_info(**kwargs) + + def get_device_tloc_to_intf_list( + self, + device_id, + **kwargs + ): + """get_device_tloc_to_intf_list # noqa: E501 + + Get device tloc color to Intf Mapping Relationship # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tloc_to_intf_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_tloc_to_intf_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_bgp_api.py b/openapi_client/api/real_time_monitoring_bgp_api.py new file mode 100644 index 0000000..be1a83f --- /dev/null +++ b/openapi_client/api/real_time_monitoring_bgp_api.py @@ -0,0 +1,482 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringBGPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_bgp_neighbors_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/bgp/neighbors', + 'operation_id': 'create_bgp_neighbors_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'peer_addr', + '_as', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'peer_addr': + (str,), + '_as': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'peer_addr': 'peer-addr', + '_as': 'as', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'peer_addr': 'query', + '_as': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_bgp_routes_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/bgp/routes', + 'operation_id': 'create_bgp_routes_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'prefix', + 'nexthop', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'prefix': + (str,), + 'nexthop': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'prefix': 'prefix', + 'nexthop': 'nexthop', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'prefix': 'query', + 'nexthop': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_bgp_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bgp/summary', + 'operation_id': 'create_bgp_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_bgp_neighbors_list( + self, + device_id, + **kwargs + ): + """create_bgp_neighbors_list # noqa: E501 + + Get BGP neighbors list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bgp_neighbors_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + peer_addr (str): Peer address. [optional] + _as (str): AS number. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bgp_neighbors_list_endpoint.call_with_http_info(**kwargs) + + def create_bgp_routes_list( + self, + device_id, + **kwargs + ): + """create_bgp_routes_list # noqa: E501 + + Get BGP routes list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bgp_routes_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + prefix (str): IP prefix. [optional] + nexthop (str): Next hop. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bgp_routes_list_endpoint.call_with_http_info(**kwargs) + + def create_bgp_summary( + self, + device_id, + **kwargs + ): + """create_bgp_summary # noqa: E501 + + Get BGP summary (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bgp_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bgp_summary_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_bridge_api.py b/openapi_client/api/real_time_monitoring_bridge_api.py new file mode 100644 index 0000000..e748c32 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_bridge_api.py @@ -0,0 +1,487 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringBridgeApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_bridge_interface_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bridge/interface', + 'operation_id': 'get_bridge_interface_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bridge_interface_mac_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bridge/mac', + 'operation_id': 'get_bridge_interface_mac', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'bridge_id', + 'if_name', + 'mac_address', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'if_name', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('if_name',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'bridge_id': + (str,), + 'if_name': + (str,), + 'mac_address': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'bridge_id': 'bridge-id', + 'if_name': 'if-name', + 'mac_address': 'mac-address', + }, + 'location_map': { + 'device_id': 'query', + 'bridge_id': 'query', + 'if_name': 'query', + 'mac_address': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_bridge_interface_table_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/bridge/table', + 'operation_id': 'get_bridge_interface_table', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_bridge_interface_list( + self, + device_id, + **kwargs + ): + """get_bridge_interface_list # noqa: E501 + + Get device bridge interface list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bridge_interface_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_bridge_interface_list_endpoint.call_with_http_info(**kwargs) + + def get_bridge_interface_mac( + self, + device_id, + **kwargs + ): + """get_bridge_interface_mac # noqa: E501 + + Get device bridge interface MAC (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bridge_interface_mac(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + bridge_id (str): Bridge ID. [optional] + if_name (str): Interface name. [optional] + mac_address (str): MAC address. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_bridge_interface_mac_endpoint.call_with_http_info(**kwargs) + + def get_bridge_interface_table( + self, + device_id, + **kwargs + ): + """get_bridge_interface_table # noqa: E501 + + Get device bridge interface table (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_bridge_interface_table(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_bridge_interface_table_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cellular_aon_ipsec_interface_api.py b/openapi_client/api/real_time_monitoring_cellular_aon_ipsec_interface_api.py new file mode 100644 index 0000000..2d3a24b --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cellular_aon_ipsec_interface_api.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCellularAONIpsecInterfaceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_aon_ipsec_interface_counters_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/ipsec/interface/counters', + 'operation_id': 'get_aon_ipsec_interface_counters_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aon_ipsec_interface_sessionnfo_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/ipsec/interface/session', + 'operation_id': 'get_aon_ipsec_interface_sessionnfo', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_aon_ipsec_interface_counters_info( + self, + device_id, + **kwargs + ): + """get_aon_ipsec_interface_counters_info # noqa: E501 + + Get cellular ipsec interface info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aon_ipsec_interface_counters_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_aon_ipsec_interface_counters_info_endpoint.call_with_http_info(**kwargs) + + def get_aon_ipsec_interface_sessionnfo( + self, + device_id, + **kwargs + ): + """get_aon_ipsec_interface_sessionnfo # noqa: E501 + + Get cellular ipsec interface info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aon_ipsec_interface_sessionnfo(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_aon_ipsec_interface_sessionnfo_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cellular_api.py b/openapi_client/api/real_time_monitoring_cellular_api.py new file mode 100644 index 0000000..7ab0fa0 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cellular_api.py @@ -0,0 +1,1176 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCellularApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_cellular_connection_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/connection', + 'operation_id': 'create_cellular_connection_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_hardware_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/hardware', + 'operation_id': 'create_hardware_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_modem_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/modem', + 'operation_id': 'create_modem_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'policy_id', + ], + 'required': [ + 'policy_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'policy_id', + ] + }, + root_map={ + 'validations': { + ('policy_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'policy_id': + (str,), + }, + 'attribute_map': { + 'policy_id': 'policyId', + }, + 'location_map': { + 'policy_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_network_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/network', + 'operation_id': 'create_network_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_profile_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/profiles', + 'operation_id': 'create_profile_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_radio_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/radio', + 'operation_id': 'create_radio_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_sessions_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/sessions', + 'operation_id': 'create_sessions_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'if_name', + 'ipv4_dns_pri', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'if_name', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('if_name',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'if_name': + (str,), + 'ipv4_dns_pri': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'if_name': 'if-name', + 'ipv4_dns_pri': 'ipv4-dns-pri', + }, + 'location_map': { + 'device_id': 'query', + 'if_name': 'query', + 'ipv4_dns_pri': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cellular_status_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/cellular/status', + 'operation_id': 'get_cellular_status_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_cellular_connection_list( + self, + device_id, + **kwargs + ): + """create_cellular_connection_list # noqa: E501 + + Get cellular connection list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cellular_connection_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cellular_connection_list_endpoint.call_with_http_info(**kwargs) + + def create_hardware_list( + self, + device_id, + **kwargs + ): + """create_hardware_list # noqa: E501 + + Get cellular hardware list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_hardware_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_hardware_list_endpoint.call_with_http_info(**kwargs) + + def create_modem_list( + self, + policy_id, + **kwargs + ): + """create_modem_list # noqa: E501 + + Get cellular modem list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_modem_list(policy_id, async_req=True) + >>> result = thread.get() + + Args: + policy_id (str): Policy IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['policy_id'] = \ + policy_id + return self.create_modem_list_endpoint.call_with_http_info(**kwargs) + + def create_network_list( + self, + device_id, + **kwargs + ): + """create_network_list # noqa: E501 + + Get cellular network list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_network_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_network_list_endpoint.call_with_http_info(**kwargs) + + def create_profile_list( + self, + device_id, + **kwargs + ): + """create_profile_list # noqa: E501 + + Get cellular profile list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_profile_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_profile_list_endpoint.call_with_http_info(**kwargs) + + def create_radio_list( + self, + device_id, + **kwargs + ): + """create_radio_list # noqa: E501 + + Get cellular radio list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_radio_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_radio_list_endpoint.call_with_http_info(**kwargs) + + def create_sessions_list( + self, + device_id, + **kwargs + ): + """create_sessions_list # noqa: E501 + + Get cellular session list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_sessions_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + if_name (str): Interface name. [optional] + ipv4_dns_pri (str): DNS primary IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_sessions_list_endpoint.call_with_http_info(**kwargs) + + def get_cellular_status_list( + self, + device_id, + **kwargs + ): + """get_cellular_status_list # noqa: E501 + + Get cellular status list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cellular_status_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_cellular_status_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cellular_eiolte_connection_service_api.py b/openapi_client/api/real_time_monitoring_cellular_eiolte_connection_service_api.py new file mode 100644 index 0000000..958926d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cellular_eiolte_connection_service_api.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCellularEIOLTEConnectionServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_eiolte_connection_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/connections', + 'operation_id': 'get_eiolte_connection_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_eiolte_radio_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/radio', + 'operation_id': 'get_eiolte_radio_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_eiolte_connection_info( + self, + device_id, + **kwargs + ): + """get_eiolte_connection_info # noqa: E501 + + Get cellular connection info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_eiolte_connection_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Ip address, example:172.16.255.111 + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_eiolte_connection_info_endpoint.call_with_http_info(**kwargs) + + def get_eiolte_radio_info( + self, + device_id, + **kwargs + ): + """get_eiolte_radio_info # noqa: E501 + + Get cellular radio info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_eiolte_radio_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Ip address, example:172.16.255.111 + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_eiolte_radio_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cellular_eiolte_hardware_service_api.py b/openapi_client/api/real_time_monitoring_cellular_eiolte_hardware_service_api.py new file mode 100644 index 0000000..4fdd187 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cellular_eiolte_hardware_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCellularEIOLTEHardwareServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_eiolte_hardware_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/hardware', + 'operation_id': 'get_eiolte_hardware_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_eiolte_hardware_info( + self, + device_id, + **kwargs + ): + """get_eiolte_hardware_info # noqa: E501 + + Get cellular hardware info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_eiolte_hardware_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Ip address, example:172.16.255.111 + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_eiolte_hardware_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cellular_eiolte_network_service_api.py b/openapi_client/api/real_time_monitoring_cellular_eiolte_network_service_api.py new file mode 100644 index 0000000..56bafac --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cellular_eiolte_network_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCellularEIOLTENetworkServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_eiolte_network_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/network', + 'operation_id': 'get_eiolte_network_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_eiolte_network_info( + self, + device_id, + **kwargs + ): + """get_eiolte_network_info # noqa: E501 + + Get cellular network info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_eiolte_network_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Ip address, example:172.16.255.111 + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_eiolte_network_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cellular_eiolte_sim_service_api.py b/openapi_client/api/real_time_monitoring_cellular_eiolte_sim_service_api.py new file mode 100644 index 0000000..4886443 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cellular_eiolte_sim_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCellularEIOLTESimServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_eiolte_sim_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cellularEiolte/sim', + 'operation_id': 'get_eiolte_sim_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_eiolte_sim_info( + self, + device_id, + **kwargs + ): + """get_eiolte_sim_info # noqa: E501 + + Get cellular sim info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_eiolte_sim_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Ip address, example:172.16.255.111 + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_eiolte_sim_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cfm_api.py b/openapi_client/api/real_time_monitoring_cfm_api.py new file mode 100644 index 0000000..1bcff09 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cfm_api.py @@ -0,0 +1,654 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCFMApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_mp_database_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cfm/mp/database', + 'operation_id': 'get_mp_database', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mp_local_mep_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cfm/mp/local/mep', + 'operation_id': 'get_mp_local_mep', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'domain', + 'service', + 'mep_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'domain': + (str,), + 'service': + (str,), + 'mep_id': + (float,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'domain': 'domain', + 'service': 'service', + 'mep_id': 'mep-id', + }, + 'location_map': { + 'device_id': 'query', + 'domain': 'query', + 'service': 'query', + 'mep_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mp_local_mip_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cfm/mp/local/mip', + 'operation_id': 'get_mp_local_mip', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'level', + 'port', + 'svc_inst', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'level': + (float,), + 'port': + (str,), + 'svc_inst': + (float,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'level': 'level', + 'port': 'port', + 'svc_inst': 'svc-inst', + }, + 'location_map': { + 'device_id': 'query', + 'level': 'query', + 'port': 'query', + 'svc_inst': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_mp_remote_mep_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cfm/mp/remotemep', + 'operation_id': 'get_mp_remote_mep', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'domain', + 'service', + 'local_mep_id', + 'remote_mep_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'domain': + (str,), + 'service': + (str,), + 'local_mep_id': + (float,), + 'remote_mep_id': + (float,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'domain': 'domain', + 'service': 'service', + 'local_mep_id': 'local-mep-id', + 'remote_mep_id': 'remote-mep-id', + }, + 'location_map': { + 'device_id': 'query', + 'domain': 'query', + 'service': 'query', + 'local_mep_id': 'query', + 'remote_mep_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_mp_database( + self, + device_id, + **kwargs + ): + """get_mp_database # noqa: E501 + + Get mp database from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mp_database(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_mp_database_endpoint.call_with_http_info(**kwargs) + + def get_mp_local_mep( + self, + device_id, + **kwargs + ): + """get_mp_local_mep # noqa: E501 + + Get mp local mep from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mp_local_mep(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + domain (str): Domain Name. [optional] + service (str): Service Name. [optional] + mep_id (float): MEP ID. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_mp_local_mep_endpoint.call_with_http_info(**kwargs) + + def get_mp_local_mip( + self, + device_id, + **kwargs + ): + """get_mp_local_mip # noqa: E501 + + Get mp local mip from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mp_local_mip(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + level (float): Level. [optional] + port (str): Port. [optional] + svc_inst (float): Service Instance. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_mp_local_mip_endpoint.call_with_http_info(**kwargs) + + def get_mp_remote_mep( + self, + device_id, + **kwargs + ): + """get_mp_remote_mep # noqa: E501 + + Get mp remote mep from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_mp_remote_mep(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + domain (str): Domain Name. [optional] + service (str): Service Name. [optional] + local_mep_id (float): Local MEP ID. [optional] + remote_mep_id (float): Remote MEP ID. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_mp_remote_mep_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_cloud_express_api.py b/openapi_client/api/real_time_monitoring_cloud_express_api.py new file mode 100644 index 0000000..8d2d54c --- /dev/null +++ b/openapi_client/api/real_time_monitoring_cloud_express_api.py @@ -0,0 +1,784 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCloudExpressApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_applications_detail_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cloudx/application/detail', + 'operation_id': 'create_applications_detail_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'application', + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'vpn_id': + (str,), + 'application': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'vpn_id': 'vpn-id', + 'application': 'application', + 'query': 'query', + }, + 'location_map': { + 'vpn_id': 'query', + 'application': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_applications_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cloudx/applications', + 'operation_id': 'create_applications_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'application', + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'vpn_id': + (str,), + 'application': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'vpn_id': 'vpn-id', + 'application': 'application', + 'query': 'query', + }, + 'location_map': { + 'vpn_id': 'query', + 'application': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_gateway_exits_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cloudx/gatewayexits', + 'operation_id': 'create_gateway_exits_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'application', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'application': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'application': 'application', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'application': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_lb_applications_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cloudx/loadbalance', + 'operation_id': 'create_lb_applications_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn_id', + 'application', + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'vpn_id': + (str,), + 'application': + (str,), + 'query': + (str,), + }, + 'attribute_map': { + 'vpn_id': 'vpn-id', + 'application': 'application', + 'query': 'query', + }, + 'location_map': { + 'vpn_id': 'query', + 'application': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_local_exits_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/cloudx/localexits', + 'operation_id': 'create_local_exits_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'application', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'application': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'application': 'application', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'application': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_applications_detail_list( + self, + **kwargs + ): + """create_applications_detail_list # noqa: E501 + + Get list of cloudexpress applications from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_applications_detail_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vpn_id (str): VPN Id. [optional] + application (str): Application. [optional] + query (str): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_applications_detail_list_endpoint.call_with_http_info(**kwargs) + + def create_applications_list( + self, + **kwargs + ): + """create_applications_list # noqa: E501 + + Get list of cloudexpress applications from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_applications_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vpn_id (str): VPN Id. [optional] + application (str): Application. [optional] + query (str): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_applications_list_endpoint.call_with_http_info(**kwargs) + + def create_gateway_exits_list( + self, + device_id, + **kwargs + ): + """create_gateway_exits_list # noqa: E501 + + Get list of cloudexpress gateway exits from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_gateway_exits_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + application (str): Application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_gateway_exits_list_endpoint.call_with_http_info(**kwargs) + + def create_lb_applications_list( + self, + **kwargs + ): + """create_lb_applications_list # noqa: E501 + + Get list of cloudexpress load balance applications from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_lb_applications_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + vpn_id (str): VPN Id. [optional] + application (str): Application. [optional] + query (str): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_lb_applications_list_endpoint.call_with_http_info(**kwargs) + + def create_local_exits_list( + self, + device_id, + **kwargs + ): + """create_local_exits_list # noqa: E501 + + Get list of cloudexpress local exits from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_local_exits_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + application (str): Application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_local_exits_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_commit_list_api.py b/openapi_client/api/real_time_monitoring_commit_list_api.py new file mode 100644 index 0000000..a13d7c1 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_commit_list_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCommitListApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_device_configuration_commit_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/configuration/commit-list', + 'operation_id': 'get_device_configuration_commit_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_device_configuration_commit_list( + self, + device_id, + **kwargs + ): + """get_device_configuration_commit_list # noqa: E501 + + Get device commit list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_configuration_commit_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_configuration_commit_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_container_lifecycle_api.py b/openapi_client/api/real_time_monitoring_container_lifecycle_api.py new file mode 100644 index 0000000..954c034 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_container_lifecycle_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringContainerLifecycleApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_device_containers_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/containers/container', + 'operation_id': 'create_device_containers_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_device_containers_info( + self, + device_id, + **kwargs + ): + """create_device_containers_info # noqa: E501 + + Get device container from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_containers_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_containers_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_crash_log_api.py b/openapi_client/api/real_time_monitoring_crash_log_api.py new file mode 100644 index 0000000..90abbb5 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_crash_log_api.py @@ -0,0 +1,585 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringCrashLogApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_device_crash_logs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/crashlog/details', + 'operation_id': 'get_all_device_crash_logs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_crash_information_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/device/crashlog/log', + 'operation_id': 'get_device_crash_information', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'filename', + ], + 'required': [ + 'device_id', + 'filename', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'filename': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'filename': 'filename', + }, + 'location_map': { + 'device_id': 'query', + 'filename': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_crash_logs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/crashlog', + 'operation_id': 'get_device_crash_logs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_crash_logs_synced_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/crashlog/synced', + 'operation_id': 'get_device_crash_logs_synced', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_all_device_crash_logs( + self, + **kwargs + ): + """get_all_device_crash_logs # noqa: E501 + + Get device crash logs for all device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_device_crash_logs(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_device_crash_logs_endpoint.call_with_http_info(**kwargs) + + def get_device_crash_information( + self, + device_id, + filename, + **kwargs + ): + """get_device_crash_information # noqa: E501 + + Get device crash info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_crash_information(device_id, filename, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + filename (str): Crash file name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + kwargs['filename'] = \ + filename + return self.get_device_crash_information_endpoint.call_with_http_info(**kwargs) + + def get_device_crash_logs( + self, + device_id, + **kwargs + ): + """get_device_crash_logs # noqa: E501 + + Get device crash logs from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_crash_logs(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_crash_logs_endpoint.call_with_http_info(**kwargs) + + def get_device_crash_logs_synced( + self, + device_id, + **kwargs + ): + """get_device_crash_logs_synced # noqa: E501 + + Get device crash logs synchronously from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_crash_logs_synced(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_crash_logs_synced_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_device_api.py b/openapi_client/api/real_time_monitoring_device_api.py new file mode 100644 index 0000000..49c01b8 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_device_api.py @@ -0,0 +1,171 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_ip import DeviceIP + + +class RealTimeMonitoringDeviceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_ipv6_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipv6/nd6', + 'operation_id': 'get_ipv6_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (DeviceIP,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_ipv6_data( + self, + device_id, + **kwargs + ): + """get_ipv6_data # noqa: E501 + + Get ipv6 data from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ipv6_data(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (DeviceIP): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_ipv6_data_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_device_control_api.py b/openapi_client/api/real_time_monitoring_device_control_api.py new file mode 100644 index 0000000..0c4a9c3 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_device_control_api.py @@ -0,0 +1,2908 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDeviceControlApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_connection_history_list_real_time_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/connectionshistory', + 'operation_id': 'create_connection_history_list_real_time', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'peer_type', + 'system_ip', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'peer_type', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('peer_type',): { + + "VEDGE": "vedge", + "VSMART": "vsmart", + "VMANAGE": "vmanage", + "VBOND": "vbond" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'peer_type': + (str,), + 'system_ip': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'peer_type': 'peer-type', + 'system_ip': 'system-ip', + }, + 'location_map': { + 'device_id': 'query', + 'peer_type': 'query', + 'system_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_connections_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/summary', + 'operation_id': 'create_connections_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_link_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/links', + 'operation_id': 'create_link_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state', + ], + 'required': [ + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state': + (str,), + }, + 'attribute_map': { + 'state': 'state', + }, + 'location_map': { + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_local_properties_list_list_real_t_ime_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/localproperties', + 'operation_id': 'create_local_properties_list_list_real_t_ime', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_local_properties_synced_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/synced/localproperties', + 'operation_id': 'create_local_properties_synced_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_real_time_connection_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/connections', + 'operation_id': 'create_real_time_connection_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'peer_type', + 'system_ip', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'peer_type', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('peer_type',): { + + "VEDGE": "vedge", + "VSMART": "vsmart", + "VMANAGE": "vmanage", + "VBOND": "vbond" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'peer_type': + (str,), + 'system_ip': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'peer_type': 'peer-type', + 'system_ip': 'system-ip', + }, + 'location_map': { + 'device_id': 'query', + 'peer_type': 'query', + 'system_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_real_time_connection_list1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/connectionsinfo', + 'operation_id': 'create_real_time_connection_list1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'peer_type', + 'system_ip', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'peer_type', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('peer_type',): { + + "VEDGE": "vedge", + "VSMART": "vsmart", + "VMANAGE": "vmanage", + "VBOND": "vbond" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'peer_type': + (str,), + 'system_ip': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'peer_type': 'peer-type', + 'system_ip': 'system-ip', + }, + 'location_map': { + 'device_id': 'query', + 'peer_type': 'query', + 'system_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_connection_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/synced/connections', + 'operation_id': 'create_synced_connection_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'peer_type', + 'system_ip', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'peer_type', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('peer_type',): { + + "VEDGE": "vedge", + "VSMART": "vsmart", + "VMANAGE": "vmanage", + "VBOND": "vbond" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'peer_type': + (str,), + 'system_ip': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'peer_type': 'peer-type', + 'system_ip': 'system-ip', + }, + 'location_map': { + 'device_id': 'query', + 'peer_type': 'query', + 'system_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_valid_devices_list_real_time_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/validdevices', + 'operation_id': 'create_valid_devices_list_real_time', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_valid_v_smarts_list_real_time_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/validvsmarts', + 'operation_id': 'create_valid_v_smarts_list_real_time', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_wan_interface_list_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/waninterface', + 'operation_id': 'create_wan_interface_list_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_wan_interface_synced_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/synced/waninterface', + 'operation_id': 'create_wan_interface_synced_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_affinity_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/affinity/config', + 'operation_id': 'get_affinity_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_affinity_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/affinity/status', + 'operation_id': 'get_affinity_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_connection_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/statistics', + 'operation_id': 'get_connection_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_control_status_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/summary/device', + 'operation_id': 'get_device_control_status_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_local_device_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/status', + 'operation_id': 'get_local_device_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_port_hop_color_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/waninterface/color', + 'operation_id': 'get_port_hop_color', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_total_count_for_device_states_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/count', + 'operation_id': 'get_total_count_for_device_states', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_cached', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_cached': + (bool,), + }, + 'attribute_map': { + 'is_cached': 'isCached', + }, + 'location_map': { + 'is_cached': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_valid_v_manage_id_real_time_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/control/validvmanageid', + 'operation_id': 'get_valid_v_manage_id_real_time', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.network_summary_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/control/networksummary', + 'operation_id': 'network_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state': + (str,), + }, + 'attribute_map': { + 'state': 'state', + }, + 'location_map': { + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_connection_history_list_real_time( + self, + device_id, + **kwargs + ): + """create_connection_history_list_real_time # noqa: E501 + + Get connections history list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_connection_history_list_real_time(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + peer_type (str): Peer type. [optional] + system_ip (str): Peer system IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_connection_history_list_real_time_endpoint.call_with_http_info(**kwargs) + + def create_connections_summary( + self, + device_id, + **kwargs + ): + """create_connections_summary # noqa: E501 + + Get connections summary from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_connections_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_connections_summary_endpoint.call_with_http_info(**kwargs) + + def create_link_list( + self, + state, + **kwargs + ): + """create_link_list # noqa: E501 + + Get connections list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_link_list(state, async_req=True) + >>> result = thread.get() + + Args: + state (str): Device State + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state'] = \ + state + return self.create_link_list_endpoint.call_with_http_info(**kwargs) + + def create_local_properties_list_list_real_t_ime( + self, + device_id, + **kwargs + ): + """create_local_properties_list_list_real_t_ime # noqa: E501 + + Get local properties list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_local_properties_list_list_real_t_ime(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_local_properties_list_list_real_t_ime_endpoint.call_with_http_info(**kwargs) + + def create_local_properties_synced_list( + self, + device_id, + **kwargs + ): + """create_local_properties_synced_list # noqa: E501 + + Get local properties list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_local_properties_synced_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_local_properties_synced_list_endpoint.call_with_http_info(**kwargs) + + def create_real_time_connection_list( + self, + device_id, + **kwargs + ): + """create_real_time_connection_list # noqa: E501 + + Get connections list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_real_time_connection_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + peer_type (str): Peer type. [optional] + system_ip (str): Peer system IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_real_time_connection_list_endpoint.call_with_http_info(**kwargs) + + def create_real_time_connection_list1( + self, + device_id, + **kwargs + ): + """create_real_time_connection_list1 # noqa: E501 + + Get connections list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_real_time_connection_list1(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + peer_type (str): Peer type. [optional] + system_ip (str): Peer system IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_real_time_connection_list1_endpoint.call_with_http_info(**kwargs) + + def create_synced_connection_list( + self, + device_id, + **kwargs + ): + """create_synced_connection_list # noqa: E501 + + Get connections list from vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_connection_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + peer_type (str): Peer type. [optional] + system_ip (str): Peer system IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_connection_list_endpoint.call_with_http_info(**kwargs) + + def create_valid_devices_list_real_time( + self, + device_id, + **kwargs + ): + """create_valid_devices_list_real_time # noqa: E501 + + Get vmanage valid device list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_valid_devices_list_real_time(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_valid_devices_list_real_time_endpoint.call_with_http_info(**kwargs) + + def create_valid_v_smarts_list_real_time( + self, + device_id, + **kwargs + ): + """create_valid_v_smarts_list_real_time # noqa: E501 + + Get valid vSmart list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_valid_v_smarts_list_real_time(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_valid_v_smarts_list_real_time_endpoint.call_with_http_info(**kwargs) + + def create_wan_interface_list_list( + self, + device_id, + **kwargs + ): + """create_wan_interface_list_list # noqa: E501 + + Get WAN interface list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_interface_list_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_wan_interface_list_list_endpoint.call_with_http_info(**kwargs) + + def create_wan_interface_synced_list( + self, + device_id, + **kwargs + ): + """create_wan_interface_synced_list # noqa: E501 + + Get WAN interface list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_wan_interface_synced_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_wan_interface_synced_list_endpoint.call_with_http_info(**kwargs) + + def get_affinity_config( + self, + device_id, + **kwargs + ): + """get_affinity_config # noqa: E501 + + Get affinity config from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_affinity_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_affinity_config_endpoint.call_with_http_info(**kwargs) + + def get_affinity_status( + self, + device_id, + **kwargs + ): + """get_affinity_status # noqa: E501 + + Get affinity status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_affinity_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_affinity_status_endpoint.call_with_http_info(**kwargs) + + def get_connection_statistics( + self, + device_id, + **kwargs + ): + """get_connection_statistics # noqa: E501 + + Get connection statistics from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_connection_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_connection_statistics_endpoint.call_with_http_info(**kwargs) + + def get_device_control_status_summary( + self, + device_id, + **kwargs + ): + """get_device_control_status_summary # noqa: E501 + + Get device control status summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_control_status_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_control_status_summary_endpoint.call_with_http_info(**kwargs) + + def get_local_device_status( + self, + **kwargs + ): + """get_local_device_status # noqa: E501 + + Get local device status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_local_device_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_local_device_status_endpoint.call_with_http_info(**kwargs) + + def get_port_hop_color( + self, + device_id, + **kwargs + ): + """get_port_hop_color # noqa: E501 + + Get port hop colors # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_port_hop_color(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_port_hop_color_endpoint.call_with_http_info(**kwargs) + + def get_total_count_for_device_states( + self, + **kwargs + ): + """get_total_count_for_device_states # noqa: E501 + + Get number of vedges and vsmart device in different control states # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_total_count_for_device_states(async_req=True) + >>> result = thread.get() + + + Keyword Args: + is_cached (bool): Device State cached. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_total_count_for_device_states_endpoint.call_with_http_info(**kwargs) + + def get_valid_v_manage_id_real_time( + self, + device_id, + **kwargs + ): + """get_valid_v_manage_id_real_time # noqa: E501 + + Get valid vManage from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_valid_v_manage_id_real_time(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_valid_v_manage_id_real_time_endpoint.call_with_http_info(**kwargs) + + def network_summary( + self, + **kwargs + ): + """network_summary # noqa: E501 + + Get list of unreachable devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.network_summary(async_req=True) + >>> result = thread.get() + + + Keyword Args: + state (str): Device State. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.network_summary_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_device_feature_list_api.py b/openapi_client/api/real_time_monitoring_device_feature_list_api.py new file mode 100644 index 0000000..9727779 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_device_feature_list_api.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDeviceFeatureListApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_feature_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/featurelist', + 'operation_id': 'get_feature_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_synced_feature_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/featurelist/synced', + 'operation_id': 'get_synced_feature_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_feature_list( + self, + device_id, + **kwargs + ): + """get_feature_list # noqa: E501 + + Get feature lists from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_feature_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_feature_list_endpoint.call_with_http_info(**kwargs) + + def get_synced_feature_list( + self, + device_id, + **kwargs + ): + """get_synced_feature_list # noqa: E501 + + Get feature lists synchronously from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_synced_feature_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_synced_feature_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_device_system_stats_api.py b/openapi_client/api/real_time_monitoring_device_system_stats_api.py new file mode 100644 index 0000000..772b8ed --- /dev/null +++ b/openapi_client/api/real_time_monitoring_device_system_stats_api.py @@ -0,0 +1,1919 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDeviceSystemStatsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_device_system_cpu_stat_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/cpu', + 'operation_id': 'create_device_system_cpu_stat', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'device_id', + ], + 'required': [ + 'query', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'device_id': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'device_id': 'deviceId', + }, + 'location_map': { + 'query': 'query', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_memory_stat_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/memory', + 'operation_id': 'create_device_system_memory_stat', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'device_id', + ], + 'required': [ + 'query', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'device_id': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'device_id': 'deviceId', + }, + 'location_map': { + 'query': 'query', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/aggregation', + 'operation_id': 'get_aggregation_data_by_query16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/doccount', + 'operation_id': 'get_count18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/doccount', + 'operation_id': 'get_count_post18', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query15', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/page', + 'operation_id': 'get_post_stat_bulk_raw_data16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/page', + 'operation_id': 'get_stat_bulk_raw_data16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/fields', + 'operation_id': 'get_stat_data_fields18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data15_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system', + 'operation_id': 'get_stat_data_raw_data15', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv16_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/system/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv16', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields18_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system/query/fields', + 'operation_id': 'get_stat_query_fields18', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data16_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/system', + 'operation_id': 'get_stats_raw_data16', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_device_system_cpu_stat( + self, + query, + device_id, + **kwargs + ): + """create_device_system_cpu_stat # noqa: E501 + + Get device system CPU stats list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_cpu_stat(query, device_id, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query filter + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + kwargs['device_id'] = \ + device_id + return self.create_device_system_cpu_stat_endpoint.call_with_http_info(**kwargs) + + def create_device_system_memory_stat( + self, + query, + device_id, + **kwargs + ): + """create_device_system_memory_stat # noqa: E501 + + Get device system memory stats list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_memory_stat(query, device_id, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query filter + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + kwargs['device_id'] = \ + device_id + return self.create_device_system_memory_stat_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query16( + self, + **kwargs + ): + """get_aggregation_data_by_query16 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query16_endpoint.call_with_http_info(**kwargs) + + def get_count18( + self, + query, + **kwargs + ): + """get_count18 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count18(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count18_endpoint.call_with_http_info(**kwargs) + + def get_count_post18( + self, + **kwargs + ): + """get_count_post18 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post18_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query15( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query15 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query15_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query15( + self, + **kwargs + ): + """get_post_aggregation_data_by_query15 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query15_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data16( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data16 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data16_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data16( + self, + **kwargs + ): + """get_stat_bulk_raw_data16 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data16_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields18( + self, + **kwargs + ): + """get_stat_data_fields18 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields18_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data15( + self, + **kwargs + ): + """get_stat_data_raw_data15 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data15(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data15_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv16( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv16 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv16_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields18( + self, + **kwargs + ): + """get_stat_query_fields18 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields18(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields18_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data16( + self, + **kwargs + ): + """get_stats_raw_data16 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data16(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data16_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_dhcp_api.py b/openapi_client/api/real_time_monitoring_dhcp_api.py new file mode 100644 index 0000000..482ec50 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_dhcp_api.py @@ -0,0 +1,566 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDHCPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_dhcp_client_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dhcp/client', + 'operation_id': 'get_dhcp_client', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dhcp_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dhcp/interface', + 'operation_id': 'get_dhcp_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dhcp_server_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dhcp/server', + 'operation_id': 'get_dhcp_server', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dhcpv6_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dhcpv6/interface', + 'operation_id': 'get_dhcpv6_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_dhcp_client( + self, + device_id, + **kwargs + ): + """get_dhcp_client # noqa: E501 + + Get DHCP client from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dhcp_client(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dhcp_client_endpoint.call_with_http_info(**kwargs) + + def get_dhcp_interface( + self, + device_id, + **kwargs + ): + """get_dhcp_interface # noqa: E501 + + Get DHCP interfaces from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dhcp_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dhcp_interface_endpoint.call_with_http_info(**kwargs) + + def get_dhcp_server( + self, + device_id, + **kwargs + ): + """get_dhcp_server # noqa: E501 + + Get DHCP server from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dhcp_server(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dhcp_server_endpoint.call_with_http_info(**kwargs) + + def get_dhcpv6_interface( + self, + device_id, + **kwargs + ): + """get_dhcpv6_interface # noqa: E501 + + Get DHCPv6 interfaces from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dhcpv6_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dhcpv6_interface_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_dot1x_api.py b/openapi_client/api/real_time_monitoring_dot1x_api.py new file mode 100644 index 0000000..c969a86 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_dot1x_api.py @@ -0,0 +1,455 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDOT1xApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_dot1x_radius_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dot1x/radius', + 'operation_id': 'get_dot1x_radius', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wlandot1x_clients_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dot1x/clients', + 'operation_id': 'get_wlandot1x_clients', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wlandot1x_interfaces_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dot1x/interfaces', + 'operation_id': 'get_wlandot1x_interfaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_dot1x_radius( + self, + device_id, + **kwargs + ): + """get_dot1x_radius # noqa: E501 + + Get DOT1x Radius from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dot1x_radius(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dot1x_radius_endpoint.call_with_http_info(**kwargs) + + def get_wlandot1x_clients( + self, + device_id, + **kwargs + ): + """get_wlandot1x_clients # noqa: E501 + + Get DOT1x client from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wlandot1x_clients(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wlandot1x_clients_endpoint.call_with_http_info(**kwargs) + + def get_wlandot1x_interfaces( + self, + device_id, + **kwargs + ): + """get_wlandot1x_interfaces # noqa: E501 + + Get DOT1x interface from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wlandot1x_interfaces(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wlandot1x_interfaces_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_dpi_api.py b/openapi_client/api/real_time_monitoring_dpi_api.py new file mode 100644 index 0000000..5634073 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_dpi_api.py @@ -0,0 +1,1478 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDPIApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_dpi_collector_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/applications', + 'operation_id': 'create_dpi_collector_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'application', + 'family', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'application': + (str,), + 'family': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'application': 'application', + 'family': 'family', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'application': 'query', + 'family': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_dpi_flows_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/flows', + 'operation_id': 'create_dpi_flows_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'src_ip', + 'application', + 'family', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'src_ip': + (str,), + 'application': + (str,), + 'family': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'src_ip': 'src-ip', + 'application': 'application', + 'family': 'family', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'src_ip': 'query', + 'application': 'query', + 'family': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_dpi_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/supported-applications', + 'operation_id': 'create_dpi_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'application', + 'family', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'application': + (str,), + 'family': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'application': 'application', + 'family': 'family', + }, + 'location_map': { + 'device_id': 'query', + 'application': 'query', + 'family': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_dpi_summary_real_time_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dpi/summary', + 'operation_id': 'create_dpi_summary_real_time', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_common_application_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/common/applications', + 'operation_id': 'get_common_application_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dpi_device_details_field_json_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dpi/devicedetails/fields', + 'operation_id': 'get_dpi_device_details_field_json', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dpi_device_field_json_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dpi/application/fields', + 'operation_id': 'get_dpi_device_field_json', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'is_device_dash_board', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'is_device_dash_board': + (bool,), + }, + 'attribute_map': { + 'is_device_dash_board': 'isDeviceDashBoard', + }, + 'location_map': { + 'is_device_dash_board': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dpi_field_json_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dpi/device/fields', + 'operation_id': 'get_dpi_field_json', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_qosmos_application_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/qosmos/applications', + 'operation_id': 'get_qosmos_application_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_qosmos_static_application_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/qosmos-static/applications', + 'operation_id': 'get_qosmos_static_application_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_supported_application_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/dpi/application-mapping', + 'operation_id': 'get_supported_application_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_dpi_collector_list( + self, + device_id, + **kwargs + ): + """create_dpi_collector_list # noqa: E501 + + Get DPI applications from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_collector_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + application (str): Application. [optional] + family (str): Family. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_dpi_collector_list_endpoint.call_with_http_info(**kwargs) + + def create_dpi_flows_list( + self, + device_id, + **kwargs + ): + """create_dpi_flows_list # noqa: E501 + + Get DPI flow list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_flows_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + src_ip (str): Source IP. [optional] + application (str): Application. [optional] + family (str): Family. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_dpi_flows_list_endpoint.call_with_http_info(**kwargs) + + def create_dpi_statistics( + self, + device_id, + **kwargs + ): + """create_dpi_statistics # noqa: E501 + + Get supported applications from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + application (str): Application. [optional] + family (str): Family. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_dpi_statistics_endpoint.call_with_http_info(**kwargs) + + def create_dpi_summary_real_time( + self, + device_id, + **kwargs + ): + """create_dpi_summary_real_time # noqa: E501 + + Get DPI summary from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_dpi_summary_real_time(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_dpi_summary_real_time_endpoint.call_with_http_info(**kwargs) + + def get_common_application_list( + self, + **kwargs + ): + """get_common_application_list # noqa: E501 + + Get DPI common application list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_common_application_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_common_application_list_endpoint.call_with_http_info(**kwargs) + + def get_dpi_device_details_field_json( + self, + **kwargs + ): + """get_dpi_device_details_field_json # noqa: E501 + + Get DPI detailed field from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dpi_device_details_field_json(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dpi_device_details_field_json_endpoint.call_with_http_info(**kwargs) + + def get_dpi_device_field_json( + self, + **kwargs + ): + """get_dpi_device_field_json # noqa: E501 + + Get DPI query field from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dpi_device_field_json(async_req=True) + >>> result = thread.get() + + + Keyword Args: + is_device_dash_board (bool): Flag whether is device dashboard request. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dpi_device_field_json_endpoint.call_with_http_info(**kwargs) + + def get_dpi_field_json( + self, + **kwargs + ): + """get_dpi_field_json # noqa: E501 + + Get DPI field from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dpi_field_json(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_dpi_field_json_endpoint.call_with_http_info(**kwargs) + + def get_qosmos_application_list( + self, + **kwargs + ): + """get_qosmos_application_list # noqa: E501 + + Get DPI QoSMos application list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_qosmos_application_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_qosmos_application_list_endpoint.call_with_http_info(**kwargs) + + def get_qosmos_static_application_list( + self, + **kwargs + ): + """get_qosmos_static_application_list # noqa: E501 + + Get DPI QoSMos static application list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_qosmos_static_application_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_qosmos_static_application_list_endpoint.call_with_http_info(**kwargs) + + def get_supported_application_list( + self, + **kwargs + ): + """get_supported_application_list # noqa: E501 + + Get DPI supported application list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_supported_application_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_supported_application_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_dre_api.py b/openapi_client/api/real_time_monitoring_dre_api.py new file mode 100644 index 0000000..471bb5c --- /dev/null +++ b/openapi_client/api/real_time_monitoring_dre_api.py @@ -0,0 +1,632 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDREApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_dre_auto_bypass_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dre/auto-bypass-stats', + 'operation_id': 'get_dre_auto_bypass_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'appqoe_dre_auto_bypass_server_ip', + 'appqoe_dre_auto_bypass_port', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + 'appqoe_dre_auto_bypass_server_ip', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + ('appqoe_dre_auto_bypass_server_ip',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'appqoe_dre_auto_bypass_server_ip': + (str,), + 'appqoe_dre_auto_bypass_port': + (float,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'appqoe_dre_auto_bypass_server_ip': 'appqoe-dre-auto-bypass-server-ip', + 'appqoe_dre_auto_bypass_port': 'appqoe-dre-auto-bypass-port', + }, + 'location_map': { + 'device_id': 'query', + 'appqoe_dre_auto_bypass_server_ip': 'query', + 'appqoe_dre_auto_bypass_port': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dre_peer_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dre/peer-stats', + 'operation_id': 'get_dre_peer_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'appqoe_dre_stats_peer_system_ip', + 'appqoe_dre_stats_peer_peer_no', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + 'appqoe_dre_stats_peer_system_ip', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + ('appqoe_dre_stats_peer_system_ip',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'appqoe_dre_stats_peer_system_ip': + (str,), + 'appqoe_dre_stats_peer_peer_no': + (float,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'appqoe_dre_stats_peer_system_ip': 'appqoe-dre-stats-peer-system-ip', + 'appqoe_dre_stats_peer_peer_no': 'appqoe-dre-stats-peer-peer-no', + }, + 'location_map': { + 'device_id': 'query', + 'appqoe_dre_stats_peer_system_ip': 'query', + 'appqoe_dre_stats_peer_peer_no': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dre_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dre/dre-stats', + 'operation_id': 'get_dre_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dre_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dre/dre-status', + 'operation_id': 'get_dre_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_dre_auto_bypass_stats( + self, + device_id, + **kwargs + ): + """get_dre_auto_bypass_stats # noqa: E501 + + Get DRE auto-bypass statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dre_auto_bypass_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + appqoe_dre_auto_bypass_server_ip (str): Server IP. [optional] + appqoe_dre_auto_bypass_port (float): Port. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dre_auto_bypass_stats_endpoint.call_with_http_info(**kwargs) + + def get_dre_peer_stats( + self, + device_id, + **kwargs + ): + """get_dre_peer_stats # noqa: E501 + + Get DRE peer statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dre_peer_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + appqoe_dre_stats_peer_system_ip (str): System IP. [optional] + appqoe_dre_stats_peer_peer_no (float): Peer Number. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dre_peer_stats_endpoint.call_with_http_info(**kwargs) + + def get_dre_stats( + self, + device_id, + **kwargs + ): + """get_dre_stats # noqa: E501 + + Get DRE statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dre_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dre_stats_endpoint.call_with_http_info(**kwargs) + + def get_dre_status( + self, + device_id, + **kwargs + ): + """get_dre_status # noqa: E501 + + Get DRE status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dre_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dre_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_dual_static_route_tracker_service_api.py b/openapi_client/api/real_time_monitoring_dual_static_route_tracker_service_api.py new file mode 100644 index 0000000..52f560d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_dual_static_route_tracker_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringDualStaticRouteTrackerServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_dual_static_route_tracker_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/dualStaticRouteTracker', + 'operation_id': 'get_dual_static_route_tracker_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_dual_static_route_tracker_info( + self, + device_id, + **kwargs + ): + """get_dual_static_route_tracker_info # noqa: E501 + + Get dual static route tracker info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dual_static_route_tracker_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dual_static_route_tracker_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_eigrp_api.py b/openapi_client/api/real_time_monitoring_eigrp_api.py new file mode 100644 index 0000000..a6d7281 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_eigrp_api.py @@ -0,0 +1,455 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringEIGRPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_eigrp_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/eigrp/interface', + 'operation_id': 'create_eigrp_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_eigrp_route_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/eigrp/route', + 'operation_id': 'create_eigrp_route', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_eigrp_topology_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/eigrp/topology', + 'operation_id': 'create_eigrp_topology', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_eigrp_interface( + self, + device_id, + **kwargs + ): + """create_eigrp_interface # noqa: E501 + + Get EIGRP interface list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_eigrp_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_eigrp_interface_endpoint.call_with_http_info(**kwargs) + + def create_eigrp_route( + self, + device_id, + **kwargs + ): + """create_eigrp_route # noqa: E501 + + Get EIGRP route from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_eigrp_route(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_eigrp_route_endpoint.call_with_http_info(**kwargs) + + def create_eigrp_topology( + self, + device_id, + **kwargs + ): + """create_eigrp_topology # noqa: E501 + + Get EIGRP topology info from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_eigrp_topology(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_eigrp_topology_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_endpoint_tracker_group_service_api.py b/openapi_client/api/real_time_monitoring_endpoint_tracker_group_service_api.py new file mode 100644 index 0000000..d47dfbf --- /dev/null +++ b/openapi_client/api/real_time_monitoring_endpoint_tracker_group_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringEndpointTrackerGroupServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_endpoint_tracker_group_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/endpointTrackerGroup', + 'operation_id': 'get_endpoint_tracker_group_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_endpoint_tracker_group_info( + self, + device_id, + **kwargs + ): + """get_endpoint_tracker_group_info # noqa: E501 + + Get endpoint tracker group info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_endpoint_tracker_group_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_endpoint_tracker_group_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_endpoint_tracker_service_api.py b/openapi_client/api/real_time_monitoring_endpoint_tracker_service_api.py new file mode 100644 index 0000000..aeaac2a --- /dev/null +++ b/openapi_client/api/real_time_monitoring_endpoint_tracker_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringEndpointTrackerServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_endpoint_tracker_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/endpointTracker', + 'operation_id': 'get_endpoint_tracker_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_endpoint_tracker_info( + self, + device_id, + **kwargs + ): + """get_endpoint_tracker_info # noqa: E501 + + Get endpoint tracker info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_endpoint_tracker_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_endpoint_tracker_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_geo_fencing_api.py b/openapi_client/api/real_time_monitoring_geo_fencing_api.py new file mode 100644 index 0000000..0fcb9de --- /dev/null +++ b/openapi_client/api/real_time_monitoring_geo_fencing_api.py @@ -0,0 +1,177 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringGeoFencingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_geofence_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/geofence/status', + 'operation_id': 'get_geofence_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_geofence_status( + self, + device_id, + **kwargs + ): + """get_geofence_status # noqa: E501 + + Get Geo-fencing Status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_geofence_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_geofence_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_hardware_api.py b/openapi_client/api/real_time_monitoring_hardware_api.py new file mode 100644 index 0000000..b3e97ad --- /dev/null +++ b/openapi_client/api/real_time_monitoring_hardware_api.py @@ -0,0 +1,1409 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringHardwareApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_alarm_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/alarms', + 'operation_id': 'create_alarm_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_environment_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/environment', + 'operation_id': 'create_environment_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_error_alarm_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/errors', + 'operation_id': 'create_error_alarm_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_inventory_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/inventory', + 'operation_id': 'create_inventory_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_status_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/status/summary', + 'operation_id': 'create_status_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_alarm_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/synced/alarms', + 'operation_id': 'create_synced_alarm_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_environment_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/synced/environment', + 'operation_id': 'create_synced_environment_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_inventory_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/synced/inventory', + 'operation_id': 'create_synced_inventory_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_system_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/system', + 'operation_id': 'create_system_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_temp_threshold_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/hardware/threshold', + 'operation_id': 'create_temp_threshold_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_alarm_list( + self, + device_id, + **kwargs + ): + """create_alarm_list # noqa: E501 + + Get hardware alarm list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_alarm_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_alarm_list_endpoint.call_with_http_info(**kwargs) + + def create_environment_list( + self, + device_id, + **kwargs + ): + """create_environment_list # noqa: E501 + + Get hardware environment list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_environment_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_environment_list_endpoint.call_with_http_info(**kwargs) + + def create_error_alarm_list( + self, + **kwargs + ): + """create_error_alarm_list # noqa: E501 + + Get hardware error list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_error_alarm_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_error_alarm_list_endpoint.call_with_http_info(**kwargs) + + def create_inventory_list( + self, + device_id, + **kwargs + ): + """create_inventory_list # noqa: E501 + + Get hardware inventory list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_inventory_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_inventory_list_endpoint.call_with_http_info(**kwargs) + + def create_status_summary( + self, + device_id, + **kwargs + ): + """create_status_summary # noqa: E501 + + Get hardware status summary from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_status_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_status_summary_endpoint.call_with_http_info(**kwargs) + + def create_synced_alarm_list( + self, + device_id, + **kwargs + ): + """create_synced_alarm_list # noqa: E501 + + Get hardware alarm list synchronously from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_alarm_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_alarm_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_environment_list( + self, + device_id, + **kwargs + ): + """create_synced_environment_list # noqa: E501 + + Get hardware environment list synchronously from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_environment_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_environment_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_inventory_list( + self, + device_id, + **kwargs + ): + """create_synced_inventory_list # noqa: E501 + + Get hardware inventory list synchronously from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_inventory_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_inventory_list_endpoint.call_with_http_info(**kwargs) + + def create_system_list( + self, + device_id, + **kwargs + ): + """create_system_list # noqa: E501 + + Get hardware system data list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_system_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_system_list_endpoint.call_with_http_info(**kwargs) + + def create_temp_threshold_list( + self, + device_id, + **kwargs + ): + """create_temp_threshold_list # noqa: E501 + + Get hardware temperature list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_temp_threshold_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_temp_threshold_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_i_psec_api.py b/openapi_client/api/real_time_monitoring_i_psec_api.py new file mode 100644 index 0000000..e013d4d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_i_psec_api.py @@ -0,0 +1,2170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringIPsecApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_crypto_ipsec_identity_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipsec/identity', + 'operation_id': 'create_crypto_ipsec_identity', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + 'local_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + 'local_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + 'local_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + 'local_tloc_color': 'local-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + 'local_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cryptov1_local_sa_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipsec/ikev1', + 'operation_id': 'create_cryptov1_local_sa_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_cryptov2_local_sa_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipsec/ikev2', + 'operation_id': 'create_cryptov2_local_sa_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_i_psec_pwk_inbound_connections_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipsec/pwk/inbound', + 'operation_id': 'create_i_psec_pwk_inbound_connections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + 'local_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + 'local_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + 'local_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + 'local_tloc_color': 'local-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + 'local_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_i_psec_pwk_local_sa_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipsec/pwk/localsa', + 'operation_id': 'create_i_psec_pwk_local_sa', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + 'local_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + 'local_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + 'local_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + 'local_tloc_color': 'local-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + 'local_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_i_psec_pwk_outbound_connections_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ipsec/pwk/outbound', + 'operation_id': 'create_i_psec_pwk_outbound_connections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + 'local_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + 'local_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + 'local_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + 'local_tloc_color': 'local-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + 'local_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ike_inbound_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ipsec/ike/inbound', + 'operation_id': 'create_ike_inbound_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ike_outbound_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ipsec/ike/outbound', + 'operation_id': 'create_ike_outbound_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ike_sessions_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ipsec/ike/sessions', + 'operation_id': 'create_ike_sessions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_in_bound_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ipsec/inbound', + 'operation_id': 'create_in_bound_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + 'local_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + 'local_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + 'local_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + 'local_tloc_color': 'local-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + 'local_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_local_sa_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ipsec/localsa', + 'operation_id': 'create_local_sa_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_out_bound_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ipsec/outbound', + 'operation_id': 'create_out_bound_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_crypto_ipsec_identity( + self, + device_id, + **kwargs + ): + """create_crypto_ipsec_identity # noqa: E501 + + Get Crypto IPSEC identity entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_crypto_ipsec_identity(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + local_tloc_color (str): Local tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_crypto_ipsec_identity_endpoint.call_with_http_info(**kwargs) + + def create_cryptov1_local_sa_list( + self, + device_id, + **kwargs + ): + """create_cryptov1_local_sa_list # noqa: E501 + + Get Crypto IKEv1 SA entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cryptov1_local_sa_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cryptov1_local_sa_list_endpoint.call_with_http_info(**kwargs) + + def create_cryptov2_local_sa_list( + self, + device_id, + **kwargs + ): + """create_cryptov2_local_sa_list # noqa: E501 + + Get Crypto IKEv2 SA entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_cryptov2_local_sa_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_cryptov2_local_sa_list_endpoint.call_with_http_info(**kwargs) + + def create_i_psec_pwk_inbound_connections( + self, + device_id, + **kwargs + ): + """create_i_psec_pwk_inbound_connections # noqa: E501 + + Get IPSEC pairwise key inbound entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_i_psec_pwk_inbound_connections(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + local_tloc_color (str): Local tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_i_psec_pwk_inbound_connections_endpoint.call_with_http_info(**kwargs) + + def create_i_psec_pwk_local_sa( + self, + device_id, + **kwargs + ): + """create_i_psec_pwk_local_sa # noqa: E501 + + Get IPSEC pairwise key local SA entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_i_psec_pwk_local_sa(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + local_tloc_color (str): Local tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_i_psec_pwk_local_sa_endpoint.call_with_http_info(**kwargs) + + def create_i_psec_pwk_outbound_connections( + self, + device_id, + **kwargs + ): + """create_i_psec_pwk_outbound_connections # noqa: E501 + + Get IPSEC pairwise key outbound entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_i_psec_pwk_outbound_connections(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + local_tloc_color (str): Local tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_i_psec_pwk_outbound_connections_endpoint.call_with_http_info(**kwargs) + + def create_ike_inbound_list( + self, + device_id, + **kwargs + ): + """create_ike_inbound_list # noqa: E501 + + Get IPsec IKE inbound connection list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ike_inbound_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ike_inbound_list_endpoint.call_with_http_info(**kwargs) + + def create_ike_outbound_list( + self, + device_id, + **kwargs + ): + """create_ike_outbound_list # noqa: E501 + + Get IPsec IKE outbound connection list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ike_outbound_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ike_outbound_list_endpoint.call_with_http_info(**kwargs) + + def create_ike_sessions( + self, + device_id, + **kwargs + ): + """create_ike_sessions # noqa: E501 + + Get IPsec IKE sessions from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ike_sessions(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ike_sessions_endpoint.call_with_http_info(**kwargs) + + def create_in_bound_list( + self, + device_id, + **kwargs + ): + """create_in_bound_list # noqa: E501 + + Get IPsec inbound connection list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_in_bound_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + local_tloc_color (str): Local tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_in_bound_list_endpoint.call_with_http_info(**kwargs) + + def create_local_sa_list( + self, + device_id, + **kwargs + ): + """create_local_sa_list # noqa: E501 + + Get IPsec local SA list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_local_sa_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_local_sa_list_endpoint.call_with_http_info(**kwargs) + + def create_out_bound_list( + self, + device_id, + **kwargs + ): + """create_out_bound_list # noqa: E501 + + Get IPsec outbound connection list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_out_bound_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_out_bound_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_igmp_api.py b/openapi_client/api/real_time_monitoring_igmp_api.py new file mode 100644 index 0000000..8fa64ca --- /dev/null +++ b/openapi_client/api/real_time_monitoring_igmp_api.py @@ -0,0 +1,594 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringIGMPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_igmp_groups_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/igmp/groups', + 'operation_id': 'create_igmp_groups_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_igmp_interface_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/igmp/interface', + 'operation_id': 'create_igmp_interface_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_igmp_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/igmp/statistics', + 'operation_id': 'create_igmp_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_igmp_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/igmp/summary', + 'operation_id': 'create_igmp_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_igmp_groups_list( + self, + device_id, + **kwargs + ): + """create_igmp_groups_list # noqa: E501 + + Get IGMP neighbor list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_igmp_groups_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_igmp_groups_list_endpoint.call_with_http_info(**kwargs) + + def create_igmp_interface_list( + self, + device_id, + **kwargs + ): + """create_igmp_interface_list # noqa: E501 + + Get IGMP interface list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_igmp_interface_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_igmp_interface_list_endpoint.call_with_http_info(**kwargs) + + def create_igmp_statistics_list( + self, + device_id, + **kwargs + ): + """create_igmp_statistics_list # noqa: E501 + + Get IGMP statistics list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_igmp_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_igmp_statistics_list_endpoint.call_with_http_info(**kwargs) + + def create_igmp_summary( + self, + device_id, + **kwargs + ): + """create_igmp_summary # noqa: E501 + + Get IGMP summary from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_igmp_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_igmp_summary_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_interface_api.py b/openapi_client/api/real_time_monitoring_interface_api.py new file mode 100644 index 0000000..dac82ac --- /dev/null +++ b/openapi_client/api/real_time_monitoring_interface_api.py @@ -0,0 +1,2216 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringInterfaceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.generate_device_interface_vpn_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/vpn', + 'operation_id': 'generate_device_interface_vpn', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface', + 'operation_id': 'get_device_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_arp_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/arp_stats', + 'operation_id': 'get_device_interface_arp_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_error_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/error_stats', + 'operation_id': 'get_device_interface_error_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_ipv6_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/ipv6Stats', + 'operation_id': 'get_device_interface_ipv6_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_pkt_sizes_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/pkt_size', + 'operation_id': 'get_device_interface_pkt_sizes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_port_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/port_stats', + 'operation_id': 'get_device_interface_port_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_qos_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/qosStats', + 'operation_id': 'get_device_interface_qos_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_queue_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/queue_stats', + 'operation_id': 'get_device_interface_queue_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_interface_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/stats', + 'operation_id': 'get_device_interface_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_serial_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/serial', + 'operation_id': 'get_device_serial_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_synced_device_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/synced', + 'operation_id': 'get_synced_device_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'af_type', + 'device_id', + 'vpn_id', + 'ifname', + ], + 'required': [ + 'af_type', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'af_type', + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('af_type',): { + + "IPV4": "ipv4", + "IPV6": "ipv6" + }, + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'af_type': + (str,), + 'device_id': + (str,), + 'vpn_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'af_type': 'af-type', + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'ifname': 'ifname', + }, + 'location_map': { + 'af_type': 'query', + 'device_id': 'query', + 'vpn_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.trustsec_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/interface/trustsec', + 'operation_id': 'trustsec', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def generate_device_interface_vpn( + self, + device_id, + **kwargs + ): + """generate_device_interface_vpn # noqa: E501 + + Get device interfaces per VPN # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_device_interface_vpn(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.generate_device_interface_vpn_endpoint.call_with_http_info(**kwargs) + + def get_device_interface( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface # noqa: E501 + + Get device interfaces # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_arp_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_arp_stats # noqa: E501 + + Get interface ARP statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_arp_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_arp_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_error_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_error_stats # noqa: E501 + + Get interface error stats # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_error_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_error_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_ipv6_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_ipv6_stats # noqa: E501 + + Get interface IPv6 stats # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_ipv6_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_ipv6_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_pkt_sizes( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_pkt_sizes # noqa: E501 + + Get interface packet size # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_pkt_sizes(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_pkt_sizes_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_port_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_port_stats # noqa: E501 + + Get interface port stats # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_port_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_port_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_qos_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_qos_stats # noqa: E501 + + Get interface QOS stats # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_qos_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_qos_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_queue_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_queue_stats # noqa: E501 + + Get interface queue stats # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_queue_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_queue_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_interface_stats( + self, + af_type, + device_id, + **kwargs + ): + """get_device_interface_stats # noqa: E501 + + Get interface stats # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_interface_stats(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_interface_stats_endpoint.call_with_http_info(**kwargs) + + def get_device_serial_interface( + self, + af_type, + device_id, + **kwargs + ): + """get_device_serial_interface # noqa: E501 + + Get serial interface # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_serial_interface(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_device_serial_interface_endpoint.call_with_http_info(**kwargs) + + def get_synced_device_interface( + self, + af_type, + device_id, + **kwargs + ): + """get_synced_device_interface # noqa: E501 + + Get device interfaces synchronously # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_synced_device_interface(af_type, device_id, async_req=True) + >>> result = thread.get() + + Args: + af_type (str): AF Type + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['af_type'] = \ + af_type + kwargs['device_id'] = \ + device_id + return self.get_synced_device_interface_endpoint.call_with_http_info(**kwargs) + + def trustsec( + self, + device_id, + **kwargs + ): + """trustsec # noqa: E501 + + Get policy filter memory usage from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trustsec(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.trustsec_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ip_api.py b/openapi_client/api/real_time_monitoring_ip_api.py new file mode 100644 index 0000000..4337054 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ip_api.py @@ -0,0 +1,1732 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringIPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_fib_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/fib', + 'operation_id': 'create_fib_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'address_family', + 'prefix', + 'tloc', + 'color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + 'address_family', + 'color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + ('address_family',): { + + "IPV4": "IPv4", + "IPV6": "IPv6" + }, + ('color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'address_family': + (str,), + 'prefix': + (str,), + 'tloc': + (str,), + 'color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'address_family': 'address-family', + 'prefix': 'prefix', + 'tloc': 'tloc', + 'color': 'color', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'address_family': 'query', + 'prefix': 'query', + 'tloc': 'query', + 'color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ietf_routing_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/ipRoutes', + 'operation_id': 'create_ietf_routing_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'routing_instance_name', + 'address_family', + 'outgoing_interface', + 'source_protocol', + 'next_hop_address', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + 'routing_instance_name': + (str,), + 'address_family': + (str,), + 'outgoing_interface': + (str,), + 'source_protocol': + (str,), + 'next_hop_address': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'routing_instance_name': 'routing-instance-name', + 'address_family': 'address-family', + 'outgoing_interface': 'outgoing-interface', + 'source_protocol': 'source-protocol', + 'next_hop_address': 'next-hop-address', + }, + 'location_map': { + 'device_id': 'query', + 'routing_instance_name': 'query', + 'address_family': 'query', + 'outgoing_interface': 'query', + 'source_protocol': 'query', + 'next_hop_address': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ip_mfib_oil_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/mfiboil', + 'operation_id': 'create_ip_mfib_oil_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ip_mfib_stats_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/mfibstats', + 'operation_id': 'create_ip_mfib_stats_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ip_mfib_summary_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/mfibsummary', + 'operation_id': 'create_ip_mfib_summary_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_nat64_translation_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/nat64/translation', + 'operation_id': 'create_nat64_translation_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_nat_filter_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/nat/filter', + 'operation_id': 'create_nat_filter_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'nat_vpn_id', + 'nat_ifname', + 'private_source_address', + 'proto', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'proto', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('proto',): { + + "ICM": "icm", + "TCP": "tcp", + "UDP": "udp" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'nat_vpn_id': + (str,), + 'nat_ifname': + (str,), + 'private_source_address': + (str,), + 'proto': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'nat_vpn_id': 'nat-vpn-id', + 'nat_ifname': 'nat-ifname', + 'private_source_address': 'private-source-address', + 'proto': 'proto', + }, + 'location_map': { + 'device_id': 'query', + 'nat_vpn_id': 'query', + 'nat_ifname': 'query', + 'private_source_address': 'query', + 'proto': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_nat_interface_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/nat/interface', + 'operation_id': 'create_nat_interface_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_nat_interface_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/nat/interfacestatistics', + 'operation_id': 'create_nat_interface_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_nat_translation_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/nat/translation', + 'operation_id': 'create_nat_translation_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_route_table_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/routetable', + 'operation_id': 'create_route_table_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'address_family', + 'prefix', + 'protocol', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + 'address_family', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + ('address_family',): { + + "IPV4": "IPv4", + "IPV6": "IPv6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'address_family': + (str,), + 'prefix': + (str,), + 'protocol': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'address_family': 'address-family', + 'prefix': 'prefix', + 'protocol': 'protocol', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'address_family': 'query', + 'prefix': 'query', + 'protocol': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_fib_list( + self, + device_id, + **kwargs + ): + """create_fib_list # noqa: E501 + + Get FIB list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_fib_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + address_family (str): Address family. [optional] + prefix (str): IP prefix. [optional] + tloc (str): tloc IP. [optional] + color (str): tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_fib_list_endpoint.call_with_http_info(**kwargs) + + def create_ietf_routing_list( + self, + device_id, + **kwargs + ): + """create_ietf_routing_list # noqa: E501 + + Get ietf routing list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ietf_routing_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + routing_instance_name (str): VPN Id. [optional] + address_family (str): Address family. [optional] + outgoing_interface (str): Outgoing Interface. [optional] + source_protocol (str): Source Protocol. [optional] + next_hop_address (str): Next Hop Address. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ietf_routing_list_endpoint.call_with_http_info(**kwargs) + + def create_ip_mfib_oil_list( + self, + device_id, + **kwargs + ): + """create_ip_mfib_oil_list # noqa: E501 + + Get IP MFIB OIL list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ip_mfib_oil_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ip_mfib_oil_list_endpoint.call_with_http_info(**kwargs) + + def create_ip_mfib_stats_list( + self, + device_id, + **kwargs + ): + """create_ip_mfib_stats_list # noqa: E501 + + Get IP MFIB statistics list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ip_mfib_stats_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ip_mfib_stats_list_endpoint.call_with_http_info(**kwargs) + + def create_ip_mfib_summary_list( + self, + device_id, + **kwargs + ): + """create_ip_mfib_summary_list # noqa: E501 + + Get IP MFIB summary list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ip_mfib_summary_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ip_mfib_summary_list_endpoint.call_with_http_info(**kwargs) + + def create_nat64_translation_list( + self, + device_id, + **kwargs + ): + """create_nat64_translation_list # noqa: E501 + + Get NAT64 interface list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_nat64_translation_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_nat64_translation_list_endpoint.call_with_http_info(**kwargs) + + def create_nat_filter_list( + self, + device_id, + **kwargs + ): + """create_nat_filter_list # noqa: E501 + + Get NAT filter list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_nat_filter_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + nat_vpn_id (str): NAT VPN Id. [optional] + nat_ifname (str): NAT interface name. [optional] + private_source_address (str): Private source address. [optional] + proto (str): Protocol. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_nat_filter_list_endpoint.call_with_http_info(**kwargs) + + def create_nat_interface_list( + self, + device_id, + **kwargs + ): + """create_nat_interface_list # noqa: E501 + + Get NAT interface list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_nat_interface_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_nat_interface_list_endpoint.call_with_http_info(**kwargs) + + def create_nat_interface_statistics_list( + self, + device_id, + **kwargs + ): + """create_nat_interface_statistics_list # noqa: E501 + + Get NAT interface statistics list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_nat_interface_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_nat_interface_statistics_list_endpoint.call_with_http_info(**kwargs) + + def create_nat_translation_list( + self, + device_id, + **kwargs + ): + """create_nat_translation_list # noqa: E501 + + Get NAT translation list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_nat_translation_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_nat_translation_list_endpoint.call_with_http_info(**kwargs) + + def create_route_table_list( + self, + device_id, + **kwargs + ): + """create_route_table_list # noqa: E501 + + Get route table list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_route_table_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + address_family (str): Address family. [optional] + prefix (str): IP prefix. [optional] + protocol (str): IP protocol. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_route_table_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ipv4_fib_api.py b/openapi_client/api/real_time_monitoring_ipv4_fib_api.py new file mode 100644 index 0000000..4e9d52c --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ipv4_fib_api.py @@ -0,0 +1,233 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringIPv4FIBApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_ipv4_fib_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/v4fib', + 'operation_id': 'create_ipv4_fib_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'prefix', + 'tloc', + 'color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + 'color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + ('color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'prefix': + (str,), + 'tloc': + (str,), + 'color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'prefix': 'prefix', + 'tloc': 'tloc', + 'color': 'color', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'prefix': 'query', + 'tloc': 'query', + 'color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_ipv4_fib_list( + self, + device_id, + **kwargs + ): + """create_ipv4_fib_list # noqa: E501 + + Get IPv4 FIB list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ipv4_fib_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + prefix (str): IP prefix. [optional] + tloc (str): tloc IP. [optional] + color (str): tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ipv4_fib_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ipv6_fib_api.py b/openapi_client/api/real_time_monitoring_ipv6_fib_api.py new file mode 100644 index 0000000..bb9e151 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ipv6_fib_api.py @@ -0,0 +1,233 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringIPv6FIBApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_ipv6_fib_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ip/v6fib', + 'operation_id': 'create_ipv6_fib_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'prefix', + 'tloc', + 'color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + 'color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + ('color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'prefix': + (str,), + 'tloc': + (str,), + 'color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'prefix': 'prefix', + 'tloc': 'tloc', + 'color': 'color', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'prefix': 'query', + 'tloc': 'query', + 'color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_ipv6_fib_list( + self, + device_id, + **kwargs + ): + """create_ipv6_fib_list # noqa: E501 + + Get IPv6 FIB list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ipv6_fib_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + prefix (str): IP prefix. [optional] + tloc (str): tloc IP. [optional] + color (str): tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ipv6_fib_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ipv6_neighbours_api.py b/openapi_client/api/real_time_monitoring_ipv6_neighbours_api.py new file mode 100644 index 0000000..f2cfa69 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ipv6_neighbours_api.py @@ -0,0 +1,215 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringIPv6NeighboursApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_ipv6_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ndv6', + 'operation_id': 'get_ipv6_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn_id', + 'if_name', + 'mac', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn_id', + 'if_name', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn_id',): { + + "0": "0", + "512": "512" + }, + ('if_name',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn_id': + (str,), + 'if_name': + (str,), + 'mac': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn_id': 'vpn-id', + 'if_name': 'if-name', + 'mac': 'mac', + }, + 'location_map': { + 'device_id': 'query', + 'vpn_id': 'query', + 'if_name': 'query', + 'mac': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_ipv6_interface( + self, + device_id, + **kwargs + ): + """get_ipv6_interface # noqa: E501 + + Get IPv6 Neighbors from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ipv6_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + vpn_id (str): VPN Id. [optional] + if_name (str): Interface name. [optional] + mac (str): Mac address. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_ipv6_interface_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_license_info_api.py b/openapi_client/api/real_time_monitoring_license_info_api.py new file mode 100644 index 0000000..f86dc68 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_license_info_api.py @@ -0,0 +1,830 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringLicenseInfoApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_license_eval_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/license/evaluation', + 'operation_id': 'get_license_eval_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_pak_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/license/pak', + 'operation_id': 'get_license_pak_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_privacy_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/license/privacy', + 'operation_id': 'get_license_privacy_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_reg_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/license/registration', + 'operation_id': 'get_license_reg_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_udi_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/license/udi', + 'operation_id': 'get_license_udi_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_license_usage_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/license/usage', + 'operation_id': 'get_license_usage_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_license_eval_info( + self, + device_id, + **kwargs + ): + """get_license_eval_info # noqa: E501 + + Get license evaluation info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_eval_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_license_eval_info_endpoint.call_with_http_info(**kwargs) + + def get_license_pak_info( + self, + device_id, + **kwargs + ): + """get_license_pak_info # noqa: E501 + + Get license pak info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_pak_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_license_pak_info_endpoint.call_with_http_info(**kwargs) + + def get_license_privacy_info( + self, + device_id, + **kwargs + ): + """get_license_privacy_info # noqa: E501 + + Get license privacy info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_privacy_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_license_privacy_info_endpoint.call_with_http_info(**kwargs) + + def get_license_reg_info( + self, + device_id, + **kwargs + ): + """get_license_reg_info # noqa: E501 + + Get license registration info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_reg_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_license_reg_info_endpoint.call_with_http_info(**kwargs) + + def get_license_udi_info( + self, + device_id, + **kwargs + ): + """get_license_udi_info # noqa: E501 + + Get license UDI info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_udi_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_license_udi_info_endpoint.call_with_http_info(**kwargs) + + def get_license_usage_info( + self, + device_id, + **kwargs + ): + """get_license_usage_info # noqa: E501 + + Get license usage info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_license_usage_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_license_usage_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_multicast_api.py b/openapi_client/api/real_time_monitoring_multicast_api.py new file mode 100644 index 0000000..b2a6dc0 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_multicast_api.py @@ -0,0 +1,594 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringMulticastApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_pim_tunnel_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/multicast/tunnel', + 'operation_id': 'create_pim_tunnel_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_replicator_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/multicast/replicator', + 'operation_id': 'create_replicator_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_rpf_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/multicast/rpf', + 'operation_id': 'create_rpf_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_topology_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/multicast/topology', + 'operation_id': 'create_topology_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_pim_tunnel_list( + self, + device_id, + **kwargs + ): + """create_pim_tunnel_list # noqa: E501 + + Get PIM tunnel from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pim_tunnel_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pim_tunnel_list_endpoint.call_with_http_info(**kwargs) + + def create_replicator_list( + self, + device_id, + **kwargs + ): + """create_replicator_list # noqa: E501 + + Get replicator list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_replicator_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_replicator_list_endpoint.call_with_http_info(**kwargs) + + def create_rpf_list( + self, + device_id, + **kwargs + ): + """create_rpf_list # noqa: E501 + + Get RPF list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_rpf_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_rpf_list_endpoint.call_with_http_info(**kwargs) + + def create_topology_list( + self, + device_id, + **kwargs + ): + """create_topology_list # noqa: E501 + + Get topology list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_topology_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_topology_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_network_hub_resources_api.py b/openapi_client/api/real_time_monitoring_network_hub_resources_api.py new file mode 100644 index 0000000..ee0d231 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_network_hub_resources_api.py @@ -0,0 +1,434 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringNetworkHubResourcesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_allocation_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/resources/cpu-info/allocation', + 'operation_id': 'get_allocation_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cpu_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/resources/cpu-info/cpus', + 'operation_id': 'get_cpu_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnf_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/resources/cpu-info/vnfs', + 'operation_id': 'get_vnf_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_allocation_info( + self, + device_id, + **kwargs + ): + """get_allocation_info # noqa: E501 + + Get NetworkHub CPU allocation info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_allocation_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_allocation_info_endpoint.call_with_http_info(**kwargs) + + def get_cpu_info( + self, + device_id, + **kwargs + ): + """get_cpu_info # noqa: E501 + + Get NetworkHub CPU info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cpu_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_cpu_info_endpoint.call_with_http_info(**kwargs) + + def get_vnf_info( + self, + device_id, + **kwargs + ): + """get_vnf_info # noqa: E501 + + Get NetworkHub CPU VNF info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnf_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vnf_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_nms_api.py b/openapi_client/api/real_time_monitoring_nms_api.py new file mode 100644 index 0000000..a00fe59 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_nms_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringNMSApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_running_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/nms/running', + 'operation_id': 'get_running', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_running( + self, + device_id, + **kwargs + ): + """get_running # noqa: E501 + + Get nms running state from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_running(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_running_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ntp_api.py b/openapi_client/api/real_time_monitoring_ntp_api.py new file mode 100644 index 0000000..b193d13 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ntp_api.py @@ -0,0 +1,851 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringNTPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_associations_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ntp/associations', + 'operation_id': 'create_associations_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ntp_status_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ntp/status', + 'operation_id': 'create_ntp_status_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_peer_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ntp/peer', + 'operation_id': 'create_peer_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_te_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/virtualApplication/te', + 'operation_id': 'create_te_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_utd_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/virtualApplication/utd', + 'operation_id': 'create_utd_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_waas_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/virtualApplication/waas', + 'operation_id': 'create_waas_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_associations_list( + self, + device_id, + **kwargs + ): + """create_associations_list # noqa: E501 + + Get NTP peer associations list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_associations_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_associations_list_endpoint.call_with_http_info(**kwargs) + + def create_ntp_status_list( + self, + device_id, + **kwargs + ): + """create_ntp_status_list # noqa: E501 + + Get NTP status list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ntp_status_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ntp_status_list_endpoint.call_with_http_info(**kwargs) + + def create_peer_list( + self, + device_id, + **kwargs + ): + """create_peer_list # noqa: E501 + + Get NTP peer list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_peer_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_peer_list_endpoint.call_with_http_info(**kwargs) + + def create_te_list( + self, + device_id, + **kwargs + ): + """create_te_list # noqa: E501 + + Get ThousandEyes app list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_te_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_te_list_endpoint.call_with_http_info(**kwargs) + + def create_utd_list( + self, + device_id, + **kwargs + ): + """create_utd_list # noqa: E501 + + Get Utd apps list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_utd_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_utd_list_endpoint.call_with_http_info(**kwargs) + + def create_waas_list( + self, + device_id, + **kwargs + ): + """create_waas_list # noqa: E501 + + Get Waas apps list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_waas_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_waas_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_omp_api.py b/openapi_client/api/real_time_monitoring_omp_api.py new file mode 100644 index 0000000..c12f3be --- /dev/null +++ b/openapi_client/api/real_time_monitoring_omp_api.py @@ -0,0 +1,2270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringOMPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_advertised_routes_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/routes/advertised', + 'operation_id': 'create_advertised_routes_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_advertised_routes_list_ipv6_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/routes/advertised/ompIpv6', + 'operation_id': 'create_advertised_routes_list_ipv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_advertised_tlocs_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/tlocs/advertised', + 'operation_id': 'create_advertised_tlocs_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_cloud_x_recv_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/cloudx', + 'operation_id': 'create_omp_cloud_x_recv', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_link_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/omp/links', + 'operation_id': 'create_omp_link_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'state', + ], + 'required': [ + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'state': + (str,), + }, + 'attribute_map': { + 'state': 'state', + }, + 'location_map': { + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_mcast_auto_discover_advt_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/mcastautodiscoveradvt', + 'operation_id': 'create_omp_mcast_auto_discover_advt', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_mcast_auto_discover_recv_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/mcastautodiscoverrecv', + 'operation_id': 'create_omp_mcast_auto_discover_recv', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_mcast_routes_advt_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/mcastroutesadvt', + 'operation_id': 'create_omp_mcast_routes_advt', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_mcast_routes_recv_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/mcastroutesrecv', + 'operation_id': 'create_omp_mcast_routes_recv', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_services_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/services', + 'operation_id': 'create_omp_services', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_session_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/peers', + 'operation_id': 'create_omp_session_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_omp_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/omp/summary', + 'operation_id': 'create_omp_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_received_routes_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/routes/received', + 'operation_id': 'create_received_routes_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_received_routes_list_ipv6_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/routes/received/ompIpv6', + 'operation_id': 'create_received_routes_list_ipv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_received_tlocs_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/tlocs/received', + 'operation_id': 'create_received_tlocs_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_omp_session_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/omp/synced/peers', + 'operation_id': 'create_synced_omp_session_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_omp_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/omp/status', + 'operation_id': 'get_device_omp_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_advertised_routes_list( + self, + device_id, + **kwargs + ): + """create_advertised_routes_list # noqa: E501 + + Get OMP advertised routes list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_advertised_routes_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_advertised_routes_list_endpoint.call_with_http_info(**kwargs) + + def create_advertised_routes_list_ipv6( + self, + device_id, + **kwargs + ): + """create_advertised_routes_list_ipv6 # noqa: E501 + + Get OMP advertised routes list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_advertised_routes_list_ipv6(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_advertised_routes_list_ipv6_endpoint.call_with_http_info(**kwargs) + + def create_advertised_tlocs_list( + self, + device_id, + **kwargs + ): + """create_advertised_tlocs_list # noqa: E501 + + Get advertised TLOCs list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_advertised_tlocs_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_advertised_tlocs_list_endpoint.call_with_http_info(**kwargs) + + def create_omp_cloud_x_recv( + self, + device_id, + **kwargs + ): + """create_omp_cloud_x_recv # noqa: E501 + + Get CloudExpress routes received list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_cloud_x_recv(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_cloud_x_recv_endpoint.call_with_http_info(**kwargs) + + def create_omp_link_list( + self, + state, + **kwargs + ): + """create_omp_link_list # noqa: E501 + + Get OMP connection list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_link_list(state, async_req=True) + >>> result = thread.get() + + Args: + state (str): Connection state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['state'] = \ + state + return self.create_omp_link_list_endpoint.call_with_http_info(**kwargs) + + def create_omp_mcast_auto_discover_advt( + self, + device_id, + **kwargs + ): + """create_omp_mcast_auto_discover_advt # noqa: E501 + + Get OMP multicast autodiscover advertised list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_mcast_auto_discover_advt(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_mcast_auto_discover_advt_endpoint.call_with_http_info(**kwargs) + + def create_omp_mcast_auto_discover_recv( + self, + device_id, + **kwargs + ): + """create_omp_mcast_auto_discover_recv # noqa: E501 + + Get OMP multicast autodiscover received list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_mcast_auto_discover_recv(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_mcast_auto_discover_recv_endpoint.call_with_http_info(**kwargs) + + def create_omp_mcast_routes_advt( + self, + device_id, + **kwargs + ): + """create_omp_mcast_routes_advt # noqa: E501 + + Get OMP multicast routes advertised list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_mcast_routes_advt(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_mcast_routes_advt_endpoint.call_with_http_info(**kwargs) + + def create_omp_mcast_routes_recv( + self, + device_id, + **kwargs + ): + """create_omp_mcast_routes_recv # noqa: E501 + + Get OMP multicast routes received list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_mcast_routes_recv(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_mcast_routes_recv_endpoint.call_with_http_info(**kwargs) + + def create_omp_services( + self, + device_id, + **kwargs + ): + """create_omp_services # noqa: E501 + + Get OMP services list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_services(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_services_endpoint.call_with_http_info(**kwargs) + + def create_omp_session_list( + self, + device_id, + **kwargs + ): + """create_omp_session_list # noqa: E501 + + Get OMP session list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_session_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_session_list_endpoint.call_with_http_info(**kwargs) + + def create_omp_summary( + self, + device_id, + **kwargs + ): + """create_omp_summary # noqa: E501 + + Get OMP summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_omp_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_omp_summary_endpoint.call_with_http_info(**kwargs) + + def create_received_routes_list( + self, + device_id, + **kwargs + ): + """create_received_routes_list # noqa: E501 + + Get OMP received routes list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_received_routes_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_received_routes_list_endpoint.call_with_http_info(**kwargs) + + def create_received_routes_list_ipv6( + self, + device_id, + **kwargs + ): + """create_received_routes_list_ipv6 # noqa: E501 + + Get OMP received routes list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_received_routes_list_ipv6(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_received_routes_list_ipv6_endpoint.call_with_http_info(**kwargs) + + def create_received_tlocs_list( + self, + device_id, + **kwargs + ): + """create_received_tlocs_list # noqa: E501 + + Get received TLOCs list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_received_tlocs_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_received_tlocs_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_omp_session_list( + self, + device_id, + **kwargs + ): + """create_synced_omp_session_list # noqa: E501 + + Get OP session list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_omp_session_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_omp_session_list_endpoint.call_with_http_info(**kwargs) + + def get_device_omp_status( + self, + **kwargs + ): + """get_device_omp_status # noqa: E501 + + Get device OMP status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_omp_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_omp_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_orchestrator_api.py b/openapi_client/api/real_time_monitoring_orchestrator_api.py new file mode 100644 index 0000000..af691c2 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_orchestrator_api.py @@ -0,0 +1,1226 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringOrchestratorApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_connection_history_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/connectionshistory', + 'operation_id': 'create_connection_history_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_connection_list_from_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/connections', + 'operation_id': 'create_connection_list_from_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_connection_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/summary', + 'operation_id': 'create_connection_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_local_properties_list_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/localproperties', + 'operation_id': 'create_local_properties_list_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_reverse_proxy_mapping_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/proxymapping', + 'operation_id': 'create_reverse_proxy_mapping_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_valid_devices_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/validvedges', + 'operation_id': 'create_valid_devices_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_valid_v_smarts_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/validvsmarts', + 'operation_id': 'create_valid_v_smarts_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/statistics', + 'operation_id': 'get_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_valid_v_manage_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/orchestrator/validvmanageid', + 'operation_id': 'get_valid_v_manage_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_connection_history_list( + self, + device_id, + **kwargs + ): + """create_connection_history_list # noqa: E501 + + Get connection history list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_connection_history_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_connection_history_list_endpoint.call_with_http_info(**kwargs) + + def create_connection_list_from_device( + self, + device_id, + **kwargs + ): + """create_connection_list_from_device # noqa: E501 + + Get connection list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_connection_list_from_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_connection_list_from_device_endpoint.call_with_http_info(**kwargs) + + def create_connection_summary( + self, + device_id, + **kwargs + ): + """create_connection_summary # noqa: E501 + + Get connection summary from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_connection_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_connection_summary_endpoint.call_with_http_info(**kwargs) + + def create_local_properties_list_list( + self, + device_id, + **kwargs + ): + """create_local_properties_list_list # noqa: E501 + + Get local properties list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_local_properties_list_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_local_properties_list_list_endpoint.call_with_http_info(**kwargs) + + def create_reverse_proxy_mapping_list( + self, + device_id, + **kwargs + ): + """create_reverse_proxy_mapping_list # noqa: E501 + + Get reverse proxy mapping from vbond # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_reverse_proxy_mapping_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_reverse_proxy_mapping_list_endpoint.call_with_http_info(**kwargs) + + def create_valid_devices_list( + self, + device_id, + **kwargs + ): + """create_valid_devices_list # noqa: E501 + + Get valid device list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_valid_devices_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_valid_devices_list_endpoint.call_with_http_info(**kwargs) + + def create_valid_v_smarts_list( + self, + device_id, + **kwargs + ): + """create_valid_v_smarts_list # noqa: E501 + + Get valid vSmart list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_valid_v_smarts_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_valid_v_smarts_list_endpoint.call_with_http_info(**kwargs) + + def get_statistics( + self, + device_id, + **kwargs + ): + """get_statistics # noqa: E501 + + Get statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_statistics_endpoint.call_with_http_info(**kwargs) + + def get_valid_v_manage_id( + self, + device_id, + **kwargs + ): + """get_valid_v_manage_id # noqa: E501 + + Get valid vManage Id from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_valid_v_manage_id(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_valid_v_manage_id_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ospf_api.py b/openapi_client/api/real_time_monitoring_ospf_api.py new file mode 100644 index 0000000..9718aa6 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ospf_api.py @@ -0,0 +1,1289 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringOSPFApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_ospf_database_external_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/databaseexternal', + 'operation_id': 'create_ospf_database_external', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospf_database_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/database', + 'operation_id': 'create_ospf_database_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospf_database_summary_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/databasesummary', + 'operation_id': 'create_ospf_database_summary_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospf_interface_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/interface', + 'operation_id': 'create_ospf_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospf_neighbors_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/neighbor', + 'operation_id': 'create_ospf_neighbors', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospf_process_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/process', + 'operation_id': 'create_ospf_process', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospf_routes_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/routes', + 'operation_id': 'create_ospf_routes_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospfv3_interface_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/v3interface', + 'operation_id': 'create_ospfv3_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ospfv3_neighbors_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ospf/v3neighbor', + 'operation_id': 'create_ospfv3_neighbors', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_ospf_database_external( + self, + device_id, + **kwargs + ): + """create_ospf_database_external # noqa: E501 + + Get OSPF external database list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_database_external(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_database_external_endpoint.call_with_http_info(**kwargs) + + def create_ospf_database_list( + self, + device_id, + **kwargs + ): + """create_ospf_database_list # noqa: E501 + + Get OSPF database list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_database_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_database_list_endpoint.call_with_http_info(**kwargs) + + def create_ospf_database_summary_list( + self, + device_id, + **kwargs + ): + """create_ospf_database_summary_list # noqa: E501 + + Get OSPF database summary list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_database_summary_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_database_summary_list_endpoint.call_with_http_info(**kwargs) + + def create_ospf_interface( + self, + device_id, + **kwargs + ): + """create_ospf_interface # noqa: E501 + + Get OSPF interface list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_interface_endpoint.call_with_http_info(**kwargs) + + def create_ospf_neighbors( + self, + device_id, + **kwargs + ): + """create_ospf_neighbors # noqa: E501 + + Get OSPF neighbor list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_neighbors(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_neighbors_endpoint.call_with_http_info(**kwargs) + + def create_ospf_process( + self, + device_id, + **kwargs + ): + """create_ospf_process # noqa: E501 + + Get OSPF process list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_process(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_process_endpoint.call_with_http_info(**kwargs) + + def create_ospf_routes_list( + self, + device_id, + **kwargs + ): + """create_ospf_routes_list # noqa: E501 + + Get OSPF route list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospf_routes_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospf_routes_list_endpoint.call_with_http_info(**kwargs) + + def create_ospfv3_interface( + self, + device_id, + **kwargs + ): + """create_ospfv3_interface # noqa: E501 + + Get OSPF v3 interface list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospfv3_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospfv3_interface_endpoint.call_with_http_info(**kwargs) + + def create_ospfv3_neighbors( + self, + device_id, + **kwargs + ): + """create_ospfv3_neighbors # noqa: E501 + + Get OSPF v3 neighbor list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ospfv3_neighbors(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ospfv3_neighbors_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_pim_api.py b/openapi_client/api/real_time_monitoring_pim_api.py new file mode 100644 index 0000000..88cc6e6 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_pim_api.py @@ -0,0 +1,733 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringPIMApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_pim_interface_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/pim/interface', + 'operation_id': 'create_pim_interface_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_pim_neighbor_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/pim/neighbor', + 'operation_id': 'create_pim_neighbor_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_pim_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/pim/statistics', + 'operation_id': 'create_pim_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_pimrp_mapping_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/pim/rp-mapping', + 'operation_id': 'create_pimrp_mapping_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ppp_interface_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ppp/interface', + 'operation_id': 'create_ppp_interface_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_pim_interface_list( + self, + device_id, + **kwargs + ): + """create_pim_interface_list # noqa: E501 + + Get PIM interface list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pim_interface_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pim_interface_list_endpoint.call_with_http_info(**kwargs) + + def create_pim_neighbor_list( + self, + device_id, + **kwargs + ): + """create_pim_neighbor_list # noqa: E501 + + Get PIM neighbor list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pim_neighbor_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pim_neighbor_list_endpoint.call_with_http_info(**kwargs) + + def create_pim_statistics_list( + self, + device_id, + **kwargs + ): + """create_pim_statistics_list # noqa: E501 + + Get PIM statistics list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pim_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pim_statistics_list_endpoint.call_with_http_info(**kwargs) + + def create_pimrp_mapping_list( + self, + device_id, + **kwargs + ): + """create_pimrp_mapping_list # noqa: E501 + + Get PIM Rp-mapping list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pimrp_mapping_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pimrp_mapping_list_endpoint.call_with_http_info(**kwargs) + + def create_ppp_interface_list( + self, + device_id, + **kwargs + ): + """create_ppp_interface_list # noqa: E501 + + Get PPP interface list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ppp_interface_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ppp_interface_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_policer_api.py b/openapi_client/api/real_time_monitoring_policer_api.py new file mode 100644 index 0000000..f2863ef --- /dev/null +++ b/openapi_client/api/real_time_monitoring_policer_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringPolicerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_policed_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policer', + 'operation_id': 'get_policed_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_policed_interface( + self, + device_id, + **kwargs + ): + """get_policed_interface # noqa: E501 + + Get policed interface list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_policed_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_policed_interface_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_policy_api.py b/openapi_client/api/real_time_monitoring_policy_api.py new file mode 100644 index 0000000..8ab4a61 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_policy_api.py @@ -0,0 +1,3339 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringPolicyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_polic_data_policy_filter_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/datapolicyfilter', + 'operation_id': 'create_polic_data_policy_filter', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_polic_qos_map_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/qosmapinfo', + 'operation_id': 'create_polic_qos_map_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_polic_qos_scheduler_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/qosschedulerinfo', + 'operation_id': 'create_polic_qos_scheduler_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_associations_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/accesslistassociations', + 'operation_id': 'create_policy_access_list_associations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_associations_ipv6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/ipv6/accesslistassociations', + 'operation_id': 'create_policy_access_list_associations_ipv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_counters_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/accesslistcounters', + 'operation_id': 'create_policy_access_list_counters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_counters_ipv6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/ipv6/accesslistcounters', + 'operation_id': 'create_policy_access_list_counters_ipv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_names_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/accesslistnames', + 'operation_id': 'create_policy_access_list_names', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_names_ipv6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/ipv6/accesslistnames', + 'operation_id': 'create_policy_access_list_names_ipv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_policers_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/accesslistpolicers', + 'operation_id': 'create_policy_access_list_policers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_access_list_policers_ipv6_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/ipv6/accesslistpolicers', + 'operation_id': 'create_policy_access_list_policers_ipv6', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_app_route_policy_filter_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/approutepolicyfilter', + 'operation_id': 'create_policy_app_route_policy_filter', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_filter_memory_usage_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/filtermemoryusage', + 'operation_id': 'create_policy_filter_memory_usage', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_policy_rewrite_associations_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/rewriteassociations', + 'operation_id': 'create_policy_rewrite_associations_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_zbfw_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/zbfwstatistics', + 'operation_id': 'get_zbfw_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_zone_drop_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/zbfwdropstatistics', + 'operation_id': 'get_zone_drop_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_zone_pair_sessions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/zonepairsessions', + 'operation_id': 'get_zone_pair_sessions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_zone_pairs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/zonepairstatistics', + 'operation_id': 'get_zone_pairs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_zone_policy_filters_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/zonepolicyfilter', + 'operation_id': 'get_zone_policy_filters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.show_sdwan_policy_from_vsmart_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/vsmart', + 'operation_id': 'show_sdwan_policy_from_vsmart', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.show_vsmart_ipto_user_binding_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/iptouserbindings', + 'operation_id': 'show_vsmart_ipto_user_binding', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.show_vsmart_px_grid_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/pxgridstatus', + 'operation_id': 'show_vsmart_px_grid_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.show_vsmart_px_grid_user_sessions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/pxgridusersessions', + 'operation_id': 'show_vsmart_px_grid_user_sessions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.show_vsmart_user_usergroup_bindings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/policy/userusergroupbindings', + 'operation_id': 'show_vsmart_user_usergroup_bindings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_polic_data_policy_filter( + self, + device_id, + **kwargs + ): + """create_polic_data_policy_filter # noqa: E501 + + Get data policy filters from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_polic_data_policy_filter(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_polic_data_policy_filter_endpoint.call_with_http_info(**kwargs) + + def create_polic_qos_map_info( + self, + device_id, + **kwargs + ): + """create_polic_qos_map_info # noqa: E501 + + Get QoS map information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_polic_qos_map_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_polic_qos_map_info_endpoint.call_with_http_info(**kwargs) + + def create_polic_qos_scheduler_info( + self, + device_id, + **kwargs + ): + """create_polic_qos_scheduler_info # noqa: E501 + + Get QoS scheduler information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_polic_qos_scheduler_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_polic_qos_scheduler_info_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_associations( + self, + device_id, + **kwargs + ): + """create_policy_access_list_associations # noqa: E501 + + Get access list associations from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_associations(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_associations_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_associations_ipv6( + self, + device_id, + **kwargs + ): + """create_policy_access_list_associations_ipv6 # noqa: E501 + + Get access list associations from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_associations_ipv6(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_associations_ipv6_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_counters( + self, + device_id, + **kwargs + ): + """create_policy_access_list_counters # noqa: E501 + + Get access list counter from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_counters(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_counters_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_counters_ipv6( + self, + device_id, + **kwargs + ): + """create_policy_access_list_counters_ipv6 # noqa: E501 + + Get access list counters from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_counters_ipv6(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_counters_ipv6_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_names( + self, + device_id, + **kwargs + ): + """create_policy_access_list_names # noqa: E501 + + Get access list names from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_names(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_names_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_names_ipv6( + self, + device_id, + **kwargs + ): + """create_policy_access_list_names_ipv6 # noqa: E501 + + Get access list names from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_names_ipv6(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_names_ipv6_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_policers( + self, + device_id, + **kwargs + ): + """create_policy_access_list_policers # noqa: E501 + + Get access list policers from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_policers(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_policers_endpoint.call_with_http_info(**kwargs) + + def create_policy_access_list_policers_ipv6( + self, + device_id, + **kwargs + ): + """create_policy_access_list_policers_ipv6 # noqa: E501 + + Get access list policers from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_access_list_policers_ipv6(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_access_list_policers_ipv6_endpoint.call_with_http_info(**kwargs) + + def create_policy_app_route_policy_filter( + self, + device_id, + **kwargs + ): + """create_policy_app_route_policy_filter # noqa: E501 + + Get approute policy filter from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_app_route_policy_filter(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_app_route_policy_filter_endpoint.call_with_http_info(**kwargs) + + def create_policy_filter_memory_usage( + self, + device_id, + **kwargs + ): + """create_policy_filter_memory_usage # noqa: E501 + + Get data policy filter memory usage from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_filter_memory_usage(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_filter_memory_usage_endpoint.call_with_http_info(**kwargs) + + def create_policy_rewrite_associations_info( + self, + device_id, + **kwargs + ): + """create_policy_rewrite_associations_info # noqa: E501 + + Get rewrite associations information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_policy_rewrite_associations_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_policy_rewrite_associations_info_endpoint.call_with_http_info(**kwargs) + + def get_zbfw_statistics( + self, + device_id, + **kwargs + ): + """get_zbfw_statistics # noqa: E501 + + Get zone based firewall statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_zbfw_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_zbfw_statistics_endpoint.call_with_http_info(**kwargs) + + def get_zone_drop_statistics( + self, + device_id, + **kwargs + ): + """get_zone_drop_statistics # noqa: E501 + + Get zone drop statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_zone_drop_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_zone_drop_statistics_endpoint.call_with_http_info(**kwargs) + + def get_zone_pair_sessions( + self, + device_id, + **kwargs + ): + """get_zone_pair_sessions # noqa: E501 + + Get zone pair sessions from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_zone_pair_sessions(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_zone_pair_sessions_endpoint.call_with_http_info(**kwargs) + + def get_zone_pairs( + self, + device_id, + **kwargs + ): + """get_zone_pairs # noqa: E501 + + Get zone pair statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_zone_pairs(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_zone_pairs_endpoint.call_with_http_info(**kwargs) + + def get_zone_policy_filters( + self, + device_id, + **kwargs + ): + """get_zone_policy_filters # noqa: E501 + + Get zone policy filter from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_zone_policy_filters(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_zone_policy_filters_endpoint.call_with_http_info(**kwargs) + + def show_sdwan_policy_from_vsmart( + self, + device_id, + **kwargs + ): + """show_sdwan_policy_from_vsmart # noqa: E501 + + show Sdwan Policy From Vsmart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.show_sdwan_policy_from_vsmart(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.show_sdwan_policy_from_vsmart_endpoint.call_with_http_info(**kwargs) + + def show_vsmart_ipto_user_binding( + self, + device_id, + **kwargs + ): + """show_vsmart_ipto_user_binding # noqa: E501 + + show ip to user binding from Vsmart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.show_vsmart_ipto_user_binding(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.show_vsmart_ipto_user_binding_endpoint.call_with_http_info(**kwargs) + + def show_vsmart_px_grid_status( + self, + device_id, + **kwargs + ): + """show_vsmart_px_grid_status # noqa: E501 + + show Pxgrid status From Vsmart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.show_vsmart_px_grid_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.show_vsmart_px_grid_status_endpoint.call_with_http_info(**kwargs) + + def show_vsmart_px_grid_user_sessions( + self, + device_id, + **kwargs + ): + """show_vsmart_px_grid_user_sessions # noqa: E501 + + show Pxgrid sessions From Vsmart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.show_vsmart_px_grid_user_sessions(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.show_vsmart_px_grid_user_sessions_endpoint.call_with_http_info(**kwargs) + + def show_vsmart_user_usergroup_bindings( + self, + device_id, + **kwargs + ): + """show_vsmart_user_usergroup_bindings # noqa: E501 + + Show User-Usergroup bindings from Vsmart # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.show_vsmart_user_usergroup_bindings(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.show_vsmart_user_usergroup_bindings_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_pppo_e_api.py b/openapi_client/api/real_time_monitoring_pppo_e_api.py new file mode 100644 index 0000000..dc7d789 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_pppo_e_api.py @@ -0,0 +1,303 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_ip import DeviceIP + + +class RealTimeMonitoringPPPoEApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_pppo_e_interface_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/pppoe/session', + 'operation_id': 'create_pppo_e_interface_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (DeviceIP,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_pppo_e_neighbor_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/pppoe/statistic', + 'operation_id': 'create_pppo_e_neighbor_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (DeviceIP,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_pppo_e_interface_list( + self, + device_id, + **kwargs + ): + """create_pppo_e_interface_list # noqa: E501 + + Get PPPoE session list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pppo_e_interface_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (DeviceIP): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pppo_e_interface_list_endpoint.call_with_http_info(**kwargs) + + def create_pppo_e_neighbor_list( + self, + device_id, + **kwargs + ): + """create_pppo_e_neighbor_list # noqa: E501 + + Get PPPoE statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pppo_e_neighbor_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (DeviceIP): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_pppo_e_neighbor_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_rbac_api.py b/openapi_client/api/real_time_monitoring_rbac_api.py new file mode 100644 index 0000000..97e0b91 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_rbac_api.py @@ -0,0 +1,455 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringRBACApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_pnic_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/pnic', + 'operation_id': 'get_pnic_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_pnic_stats_from_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/pnic/synced', + 'operation_id': 'get_pnic_stats_from_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_rbac_interface_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/rbac', + 'operation_id': 'get_rbac_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_pnic_stats( + self, + device_id, + **kwargs + ): + """get_pnic_stats # noqa: E501 + + Get pnic interfaces from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pnic_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_pnic_stats_endpoint.call_with_http_info(**kwargs) + + def get_pnic_stats_from_device( + self, + device_id, + **kwargs + ): + """get_pnic_stats_from_device # noqa: E501 + + Get pnic stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pnic_stats_from_device(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_pnic_stats_from_device_endpoint.call_with_http_info(**kwargs) + + def get_rbac_interface( + self, + device_id, + **kwargs + ): + """get_rbac_interface # noqa: E501 + + Get RBAC interfaces from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_rbac_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_rbac_interface_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_reboot_history_api.py b/openapi_client/api/real_time_monitoring_reboot_history_api.py new file mode 100644 index 0000000..9f6fd4f --- /dev/null +++ b/openapi_client/api/real_time_monitoring_reboot_history_api.py @@ -0,0 +1,422 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringRebootHistoryApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_reboot_history_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/reboothistory', + 'operation_id': 'create_reboot_history_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_reboot_history_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/reboothistory/synced', + 'operation_id': 'create_synced_reboot_history_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_reboot_history_details_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/reboothistory/details', + 'operation_id': 'get_reboot_history_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_reboot_history_list( + self, + device_id, + **kwargs + ): + """create_reboot_history_list # noqa: E501 + + Get device reboot history # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_reboot_history_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_reboot_history_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_reboot_history_list( + self, + device_id, + **kwargs + ): + """create_synced_reboot_history_list # noqa: E501 + + Get device reboot history synchronously # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_reboot_history_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_reboot_history_list_endpoint.call_with_http_info(**kwargs) + + def get_reboot_history_details( + self, + **kwargs + ): + """get_reboot_history_details # noqa: E501 + + Get detailed reboot history list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_reboot_history_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_reboot_history_details_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_sdwan_statistics_api.py b/openapi_client/api/real_time_monitoring_sdwan_statistics_api.py new file mode 100644 index 0000000..e18406d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_sdwan_statistics_api.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSDWANStatisticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_sd_wan_global_drop_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sdwan-global-drop-statistics', + 'operation_id': 'get_sd_wan_global_drop_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sd_wan_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sdwan-stats', + 'operation_id': 'get_sd_wan_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_sd_wan_global_drop_statistics( + self, + device_id, + **kwargs + ): + """get_sd_wan_global_drop_statistics # noqa: E501 + + Get SD-WAN global drop statistics detail from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sd_wan_global_drop_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sd_wan_global_drop_statistics_endpoint.call_with_http_info(**kwargs) + + def get_sd_wan_stats( + self, + device_id, + **kwargs + ): + """get_sd_wan_stats # noqa: E501 + + Get SD-WAN statistics detail from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sd_wan_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sd_wan_stats_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_security_api.py b/openapi_client/api/real_time_monitoring_security_api.py new file mode 100644 index 0000000..ac7e96e --- /dev/null +++ b/openapi_client/api/real_time_monitoring_security_api.py @@ -0,0 +1,177 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSecurityApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_session_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/security/information', + 'operation_id': 'create_session_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_session_list( + self, + device_id, + **kwargs + ): + """create_session_list # noqa: E501 + + Get security information from devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_session_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_session_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_sfp_api.py b/openapi_client/api/real_time_monitoring_sfp_api.py new file mode 100644 index 0000000..4521cb1 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_sfp_api.py @@ -0,0 +1,646 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSFPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_detail_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sfp/detail', + 'operation_id': 'get_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'ifname', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'ifname': 'ifname', + }, + 'location_map': { + 'device_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_diagnostic_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sfp/diagnostic', + 'operation_id': 'get_diagnostic', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'ifname', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'ifname': 'ifname', + }, + 'location_map': { + 'device_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_diagnostic_measurement_alarm_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sfp/diagnosticMeasurementAlarm', + 'operation_id': 'get_diagnostic_measurement_alarm', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'ifname', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'ifname': 'ifname', + }, + 'location_map': { + 'device_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_diagnostic_measurement_value_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sfp/diagnosticMeasurementValue', + 'operation_id': 'get_diagnostic_measurement_value', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'ifname', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'ifname', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('ifname',): { + + "GE0/0": "ge0/0", + "GE0/1": "ge0/1", + "GE0/2": "ge0/2", + "GE0/3": "ge0/3", + "GE0/4": "ge0/4", + "GE0/5": "ge0/5", + "GE0/6": "ge0/6", + "GE0/7": "ge0/7", + "SYSTEM": "system", + "ETH0": "eth0" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'ifname': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'ifname': 'ifname', + }, + 'location_map': { + 'device_id': 'query', + 'ifname': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_detail( + self, + device_id, + **kwargs + ): + """get_detail # noqa: E501 + + Get SFP detail # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_detail(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_detail_endpoint.call_with_http_info(**kwargs) + + def get_diagnostic( + self, + device_id, + **kwargs + ): + """get_diagnostic # noqa: E501 + + Get SFP diagnostic # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_diagnostic(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_diagnostic_endpoint.call_with_http_info(**kwargs) + + def get_diagnostic_measurement_alarm( + self, + device_id, + **kwargs + ): + """get_diagnostic_measurement_alarm # noqa: E501 + + Get SFP diagnostic measurement alarm # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_diagnostic_measurement_alarm(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_diagnostic_measurement_alarm_endpoint.call_with_http_info(**kwargs) + + def get_diagnostic_measurement_value( + self, + device_id, + **kwargs + ): + """get_diagnostic_measurement_value # noqa: E501 + + Get SFP diagnostic measurement value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_diagnostic_measurement_value(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + ifname (str): IF Name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_diagnostic_measurement_value_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_show_on_demand_local_api.py b/openapi_client/api/real_time_monitoring_show_on_demand_local_api.py new file mode 100644 index 0000000..9fe30c6 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_show_on_demand_local_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringShowOnDemandLocalApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_on_demand_local_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ondemand/local', + 'operation_id': 'get_on_demand_local', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_on_demand_local( + self, + device_id, + **kwargs + ): + """get_on_demand_local # noqa: E501 + + Get on-demand local (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_on_demand_local(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_on_demand_local_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_show_on_demand_remote_api.py b/openapi_client/api/real_time_monitoring_show_on_demand_remote_api.py new file mode 100644 index 0000000..d405a6d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_show_on_demand_remote_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringShowOnDemandRemoteApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_on_demand_remote_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/ondemand/remote', + 'operation_id': 'get_on_demand_remote', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_on_demand_remote( + self, + device_id, + **kwargs + ): + """get_on_demand_remote # noqa: E501 + + Get on-demand remote (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_on_demand_remote(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_on_demand_remote_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_sig_api.py b/openapi_client/api/real_time_monitoring_sig_api.py new file mode 100644 index 0000000..db383e3 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_sig_api.py @@ -0,0 +1,680 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSIGApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_sig_tunnel_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sig/getSigTunnelList', + 'operation_id': 'get_sig_tunnel_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'page_size', + 'offset', + 'last_n_hours', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page_size': + (str,), + 'offset': + (str,), + 'last_n_hours': + (str,), + }, + 'attribute_map': { + 'page_size': 'pageSize', + 'offset': 'offset', + 'last_n_hours': 'lastNHours', + }, + 'location_map': { + 'page_size': 'query', + 'offset': 'query', + 'last_n_hours': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sig_tunnel_total_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sig/getSigTunnelTotal', + 'operation_id': 'get_sig_tunnel_total', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sig_umbrella_tunnels_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sig/umbrella/tunnels', + 'operation_id': 'get_sig_umbrella_tunnels', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sig_zscaler_tunnels_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sig/zscaler/tunnels', + 'operation_id': 'get_sig_zscaler_tunnels', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tunnel_dashboard_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sig/tunnelDashboard', + 'operation_id': 'tunnel_dashboard', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_sig_tunnel_list( + self, + **kwargs + ): + """get_sig_tunnel_list # noqa: E501 + + get Sig TunnelList # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sig_tunnel_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page_size (str): Page Size. [optional] + offset (str): Page offset. [optional] + last_n_hours (str): last n hours. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sig_tunnel_list_endpoint.call_with_http_info(**kwargs) + + def get_sig_tunnel_total( + self, + **kwargs + ): + """get_sig_tunnel_total # noqa: E501 + + get Sig Tunnel Total coount # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sig_tunnel_total(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sig_tunnel_total_endpoint.call_with_http_info(**kwargs) + + def get_sig_umbrella_tunnels( + self, + device_id, + **kwargs + ): + """get_sig_umbrella_tunnels # noqa: E501 + + Get SIG Umbrella tunnels from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sig_umbrella_tunnels(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sig_umbrella_tunnels_endpoint.call_with_http_info(**kwargs) + + def get_sig_zscaler_tunnels( + self, + device_id, + **kwargs + ): + """get_sig_zscaler_tunnels # noqa: E501 + + Get SIG Zscaler tunnels from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sig_zscaler_tunnels(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sig_zscaler_tunnels_endpoint.call_with_http_info(**kwargs) + + def tunnel_dashboard( + self, + **kwargs + ): + """tunnel_dashboard # noqa: E501 + + Get SIG Zscaler tunnels from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tunnel_dashboard(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.tunnel_dashboard_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_software_api.py b/openapi_client/api/real_time_monitoring_software_api.py new file mode 100644 index 0000000..85fb211 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_software_api.py @@ -0,0 +1,566 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSoftwareApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_smu_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/smu', + 'operation_id': 'create_smu_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_smu_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/smu/synced', + 'operation_id': 'create_synced_smu_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_software_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/software/synced', + 'operation_id': 'create_synced_software_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aaa_ucreate_software_listsers_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/software', + 'operation_id': 'get_aaa_ucreate_software_listsers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_smu_list( + self, + device_id, + **kwargs + ): + """create_smu_list # noqa: E501 + + Get software list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_smu_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_smu_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_smu_list( + self, + device_id, + **kwargs + ): + """create_synced_smu_list # noqa: E501 + + Get software list from device synchronously # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_smu_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_smu_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_software_list( + self, + device_id, + **kwargs + ): + """create_synced_software_list # noqa: E501 + + Get software list from device synchronously # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_software_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_software_list_endpoint.call_with_http_info(**kwargs) + + def get_aaa_ucreate_software_listsers( + self, + device_id, + **kwargs + ): + """get_aaa_ucreate_software_listsers # noqa: E501 + + Get software list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aaa_ucreate_software_listsers(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_aaa_ucreate_software_listsers_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_sslproxy_api.py b/openapi_client/api/real_time_monitoring_sslproxy_api.py new file mode 100644 index 0000000..c131cbc --- /dev/null +++ b/openapi_client/api/real_time_monitoring_sslproxy_api.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSslproxyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_ssl_proxy_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sslproxy/statistics', + 'operation_id': 'get_ssl_proxy_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ssl_proxy_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sslproxy/status', + 'operation_id': 'get_ssl_proxy_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_ssl_proxy_statistics( + self, + device_id, + **kwargs + ): + """get_ssl_proxy_statistics # noqa: E501 + + Get ssl proxy statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ssl_proxy_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_ssl_proxy_statistics_endpoint.call_with_http_info(**kwargs) + + def get_ssl_proxy_status( + self, + device_id, + **kwargs + ): + """get_ssl_proxy_status # noqa: E501 + + Get ssl proxy status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_ssl_proxy_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_ssl_proxy_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_static_route_tracker_service_api.py b/openapi_client/api/real_time_monitoring_static_route_tracker_service_api.py new file mode 100644 index 0000000..087e559 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_static_route_tracker_service_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringStaticRouteTrackerServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_static_route_tracker_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/staticRouteTracker', + 'operation_id': 'get_static_route_tracker_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_static_route_tracker_info( + self, + device_id, + **kwargs + ): + """get_static_route_tracker_info # noqa: E501 + + Get single static route tracker info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_static_route_tracker_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_static_route_tracker_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_system_api.py b/openapi_client/api/real_time_monitoring_system_api.py new file mode 100644 index 0000000..0f23d42 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_system_api.py @@ -0,0 +1,1255 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringSystemApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_device_info_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/system/info', + 'operation_id': 'create_device_info_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + ([str],), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + 'device_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_process_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/system/processlist', + 'operation_id': 'create_device_system_process_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_setting_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/system/settings', + 'operation_id': 'create_device_system_setting', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_setting_native_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/system/native', + 'operation_id': 'create_device_system_setting_native_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_stats_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/system/statistics', + 'operation_id': 'create_device_system_stats_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/csp/system/status', + 'operation_id': 'create_device_system_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_device_system_status_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/system/status', + 'operation_id': 'create_device_system_status_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_synced_device_system_status_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/system/synced/status', + 'operation_id': 'create_synced_device_system_status_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_system_clock_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/system/clock', + 'operation_id': 'get_device_system_clock', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_device_info_list( + self, + device_id, + **kwargs + ): + """create_device_info_list # noqa: E501 + + Get device information list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_info_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id ([str]): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_info_list_endpoint.call_with_http_info(**kwargs) + + def create_device_system_process_list( + self, + device_id, + **kwargs + ): + """create_device_system_process_list # noqa: E501 + + Get device system process list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_process_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_system_process_list_endpoint.call_with_http_info(**kwargs) + + def create_device_system_setting( + self, + device_id, + **kwargs + ): + """create_device_system_setting # noqa: E501 + + Get device system settings from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_setting(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_system_setting_endpoint.call_with_http_info(**kwargs) + + def create_device_system_setting_native_info( + self, + device_id, + **kwargs + ): + """create_device_system_setting_native_info # noqa: E501 + + Get device system native settings from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_setting_native_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_system_setting_native_info_endpoint.call_with_http_info(**kwargs) + + def create_device_system_stats_list( + self, + device_id, + **kwargs + ): + """create_device_system_stats_list # noqa: E501 + + Get device system stats list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_stats_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_system_stats_list_endpoint.call_with_http_info(**kwargs) + + def create_device_system_status( + self, + device_id, + **kwargs + ): + """create_device_system_status # noqa: E501 + + Get device system status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_system_status_endpoint.call_with_http_info(**kwargs) + + def create_device_system_status_list( + self, + device_id, + **kwargs + ): + """create_device_system_status_list # noqa: E501 + + Get device system status list (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_device_system_status_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_device_system_status_list_endpoint.call_with_http_info(**kwargs) + + def create_synced_device_system_status_list( + self, + device_id, + **kwargs + ): + """create_synced_device_system_status_list # noqa: E501 + + Get device system stats list synchronously # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_synced_device_system_status_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_synced_device_system_status_list_endpoint.call_with_http_info(**kwargs) + + def get_device_system_clock( + self, + device_id, + **kwargs + ): + """get_device_system_clock # noqa: E501 + + Get device system clock # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_system_clock(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_system_clock_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_tcp_optimization_api.py b/openapi_client/api/real_time_monitoring_tcp_optimization_api.py new file mode 100644 index 0000000..82d7465 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_tcp_optimization_api.py @@ -0,0 +1,455 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringTCPOptimizationApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_active_tcp_flows_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tcpopt/activeflows', + 'operation_id': 'get_active_tcp_flows', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_expired_tcp_flows_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tcpopt/expiredflows', + 'operation_id': 'get_expired_tcp_flows', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tcp_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tcpopt/summary', + 'operation_id': 'get_tcp_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_active_tcp_flows( + self, + device_id, + **kwargs + ): + """get_active_tcp_flows # noqa: E501 + + Get TCP optimized active flows from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_active_tcp_flows(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_active_tcp_flows_endpoint.call_with_http_info(**kwargs) + + def get_expired_tcp_flows( + self, + device_id, + **kwargs + ): + """get_expired_tcp_flows # noqa: E501 + + Get TCP optimized expired flows from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_expired_tcp_flows(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_expired_tcp_flows_endpoint.call_with_http_info(**kwargs) + + def get_tcp_summary( + self, + device_id, + **kwargs + ): + """get_tcp_summary # noqa: E501 + + Get TCP optimization summary from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tcp_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_tcp_summary_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_tcpproxy_api.py b/openapi_client/api/real_time_monitoring_tcpproxy_api.py new file mode 100644 index 0000000..6c9e9a0 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_tcpproxy_api.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringTcpproxyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_tcp_proxy_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tcpproxy/statistics', + 'operation_id': 'get_tcp_proxy_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tcp_proxy_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tcpproxy/status', + 'operation_id': 'get_tcp_proxy_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_tcp_proxy_statistics( + self, + device_id, + **kwargs + ): + """get_tcp_proxy_statistics # noqa: E501 + + Get tcp proxy statistics from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tcp_proxy_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_tcp_proxy_statistics_endpoint.call_with_http_info(**kwargs) + + def get_tcp_proxy_status( + self, + device_id, + **kwargs + ): + """get_tcp_proxy_status # noqa: E501 + + Get tcp proxy status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tcp_proxy_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_tcp_proxy_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_tools_api.py b/openapi_client/api/real_time_monitoring_tools_api.py new file mode 100644 index 0000000..b616c25 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_tools_api.py @@ -0,0 +1,767 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringToolsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_device_tools_n_slookup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/nslookup', + 'operation_id': 'get_device_tools_n_slookup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vpn', + 'dns', + 'device_id', + ], + 'required': [ + 'vpn', + 'dns', + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn', + ], + 'validation': [ + 'dns', + ] + }, + root_map={ + 'validations': { + ('dns',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('vpn',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'vpn': + (str,), + 'dns': + (str,), + 'device_id': + (str,), + }, + 'attribute_map': { + 'vpn': 'vpn', + 'dns': 'dns', + 'device_id': 'deviceId', + }, + 'location_map': { + 'vpn': 'query', + 'dns': 'query', + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_tools_netstat_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/netstat', + 'operation_id': 'get_device_tools_netstat', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn', + 'options', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn': + (str,), + 'options': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn': 'vpn', + 'options': 'options', + }, + 'location_map': { + 'device_id': 'query', + 'vpn': 'query', + 'options': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_tools_ss_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/ss', + 'operation_id': 'get_device_tools_ss', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'vpn', + 'options', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'vpn', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('vpn',): { + + "0": "0", + "512": "512" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'vpn': + (str,), + 'options': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'vpn': 'vpn', + 'options': 'options', + }, + 'location_map': { + 'device_id': 'query', + 'vpn': 'query', + 'options': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_real_timeinfo_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/realtimeinfo', + 'operation_id': 'get_real_timeinfo', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_system_netfilter_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/system-netfilter', + 'operation_id': 'get_system_netfilter', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_device_tools_n_slookup( + self, + vpn, + dns, + device_id, + **kwargs + ): + """get_device_tools_n_slookup # noqa: E501 + + Get device tool nslookup # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tools_n_slookup(vpn, dns, device_id, async_req=True) + >>> result = thread.get() + + Args: + vpn (str): VPN + dns (str): DNS + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vpn'] = \ + vpn + kwargs['dns'] = \ + dns + kwargs['device_id'] = \ + device_id + return self.get_device_tools_n_slookup_endpoint.call_with_http_info(**kwargs) + + def get_device_tools_netstat( + self, + device_id, + **kwargs + ): + """get_device_tools_netstat # noqa: E501 + + Get device tool net stat # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tools_netstat(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + vpn (str): VPN. [optional] + options (str): Options. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_tools_netstat_endpoint.call_with_http_info(**kwargs) + + def get_device_tools_ss( + self, + device_id, + **kwargs + ): + """get_device_tools_ss # noqa: E501 + + Get device tool ss # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_tools_ss(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + vpn (str): VPN. [optional] + options (str): Options. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_device_tools_ss_endpoint.call_with_http_info(**kwargs) + + def get_real_timeinfo( + self, + device_id, + **kwargs + ): + """get_real_timeinfo # noqa: E501 + + Get hardware real time info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_real_timeinfo(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_real_timeinfo_endpoint.call_with_http_info(**kwargs) + + def get_system_netfilter( + self, + device_id, + **kwargs + ): + """get_system_netfilter # noqa: E501 + + Get system netfilter info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_system_netfilter(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_system_netfilter_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_transport_api.py b/openapi_client/api/real_time_monitoring_transport_api.py new file mode 100644 index 0000000..01c7089 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_transport_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringTransportApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_transport_connection_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/transport/connection', + 'operation_id': 'create_transport_connection_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_transport_connection_list( + self, + device_id, + **kwargs + ): + """create_transport_connection_list # noqa: E501 + + Get transport connection list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_transport_connection_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_transport_connection_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_trustsec_api.py b/openapi_client/api/real_time_monitoring_trustsec_api.py new file mode 100644 index 0000000..b5fb105 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_trustsec_api.py @@ -0,0 +1,1226 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringTrustsecApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_cts_pac_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ctsPac', + 'operation_id': 'get_cts_pac', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_environment_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/environmentData', + 'operation_id': 'get_environment_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_radius_server_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/environmentData/radiusServer', + 'operation_id': 'get_radius_server', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_role_based_counters_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/roleBasedCounters', + 'operation_id': 'get_role_based_counters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_role_based_ipv6_counters_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/roleBasedIpv6Counters', + 'operation_id': 'get_role_based_ipv6_counters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_role_based_ipv6_permissions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/roleBasedIpv6Permissions', + 'operation_id': 'get_role_based_ipv6_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_role_based_permissions_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/roleBasedPermissions', + 'operation_id': 'get_role_based_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_role_based_sgt_map_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/roleBasedSgtMap', + 'operation_id': 'get_role_based_sgt_map', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sxp_connections_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/sxpConnections', + 'operation_id': 'get_sxp_connections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_cts_pac( + self, + device_id, + **kwargs + ): + """get_cts_pac # noqa: E501 + + get Cisco TrustSec PAC information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cts_pac(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_cts_pac_endpoint.call_with_http_info(**kwargs) + + def get_environment_data( + self, + device_id, + **kwargs + ): + """get_environment_data # noqa: E501 + + get Cisco TrustSec Environment Data information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_environment_data(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_environment_data_endpoint.call_with_http_info(**kwargs) + + def get_radius_server( + self, + device_id, + **kwargs + ): + """get_radius_server # noqa: E501 + + get Cisco TrustSec Environment Data Radius Server list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_radius_server(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_radius_server_endpoint.call_with_http_info(**kwargs) + + def get_role_based_counters( + self, + device_id, + **kwargs + ): + """get_role_based_counters # noqa: E501 + + get Cisco TrustSec Role Based Counters information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_role_based_counters(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_role_based_counters_endpoint.call_with_http_info(**kwargs) + + def get_role_based_ipv6_counters( + self, + device_id, + **kwargs + ): + """get_role_based_ipv6_counters # noqa: E501 + + get Cisco TrustSec Role Based Ipv6 Counters information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_role_based_ipv6_counters(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_role_based_ipv6_counters_endpoint.call_with_http_info(**kwargs) + + def get_role_based_ipv6_permissions( + self, + device_id, + **kwargs + ): + """get_role_based_ipv6_permissions # noqa: E501 + + get Cisco TrustSec Role Based ipv6 Permissions information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_role_based_ipv6_permissions(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_role_based_ipv6_permissions_endpoint.call_with_http_info(**kwargs) + + def get_role_based_permissions( + self, + device_id, + **kwargs + ): + """get_role_based_permissions # noqa: E501 + + get Cisco TrustSec Role Based Permissions information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_role_based_permissions(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_role_based_permissions_endpoint.call_with_http_info(**kwargs) + + def get_role_based_sgt_map( + self, + device_id, + **kwargs + ): + """get_role_based_sgt_map # noqa: E501 + + get Cisco TrustSec Role Based SGT Map information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_role_based_sgt_map(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_role_based_sgt_map_endpoint.call_with_http_info(**kwargs) + + def get_sxp_connections( + self, + device_id, + **kwargs + ): + """get_sxp_connections # noqa: E501 + + get Cisco TrustSec SXP Connections information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sxp_connections(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sxp_connections_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_tunnel_api.py b/openapi_client/api/real_time_monitoring_tunnel_api.py new file mode 100644 index 0000000..4c40b6f --- /dev/null +++ b/openapi_client/api/real_time_monitoring_tunnel_api.py @@ -0,0 +1,872 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringTunnelApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_bfd_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tunnel/bfd_statistics', + 'operation_id': 'create_bfd_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_fec_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tunnel/fec_statistics', + 'operation_id': 'create_fec_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_gre_keepalives_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tunnel/gre-keepalives', + 'operation_id': 'create_gre_keepalives_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_ipsec_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tunnel/ipsec_statistics', + 'operation_id': 'create_ipsec_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_packet_duplicate_statistics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tunnel/packet-duplicate', + 'operation_id': 'create_packet_duplicate_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.create_statistics_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tunnel/statistics', + 'operation_id': 'create_statistics_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_bfd_statistics_list( + self, + device_id, + **kwargs + ): + """create_bfd_statistics_list # noqa: E501 + + Get tunnel BFD statistics all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_bfd_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_bfd_statistics_list_endpoint.call_with_http_info(**kwargs) + + def create_fec_statistics( + self, + device_id, + **kwargs + ): + """create_fec_statistics # noqa: E501 + + Get tunnel fec statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_fec_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_fec_statistics_endpoint.call_with_http_info(**kwargs) + + def create_gre_keepalives_list( + self, + device_id, + **kwargs + ): + """create_gre_keepalives_list # noqa: E501 + + Get GRE keep alive information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_gre_keepalives_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_gre_keepalives_list_endpoint.call_with_http_info(**kwargs) + + def create_ipsec_statistics_list( + self, + device_id, + **kwargs + ): + """create_ipsec_statistics_list # noqa: E501 + + Get tunnel IPSec statistics all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ipsec_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ipsec_statistics_list_endpoint.call_with_http_info(**kwargs) + + def create_packet_duplicate_statistics( + self, + device_id, + **kwargs + ): + """create_packet_duplicate_statistics # noqa: E501 + + Get tunnel statistics packet duplication statistics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_packet_duplicate_statistics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_packet_duplicate_statistics_endpoint.call_with_http_info(**kwargs) + + def create_statistics_list( + self, + device_id, + **kwargs + ): + """create_statistics_list # noqa: E501 + + Get tunnel statistics all devices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_statistics_list(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_statistics_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_ucse_api.py b/openapi_client/api/real_time_monitoring_ucse_api.py new file mode 100644 index 0000000..6748238 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_ucse_api.py @@ -0,0 +1,247 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringUcseApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_ucse_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/ucse/stats', + 'operation_id': 'create_ucse_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + 'remote_tloc_address', + 'remote_tloc_color', + 'local_tloc_color', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + 'remote_tloc_color', + 'local_tloc_color', + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('remote_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + ('local_tloc_color',): { + + "DEFAULT": "default", + "MPLS": "mpls", + "METRO-ETHERNET": "metro-ethernet", + "BIZ-INTERNET": "biz-internet", + "PUBLIC-INTERNET": "public-internet", + "LTE": "lte", + "3G": "3g", + "RED": "red", + "GREEN": "green", + "BLUE": "blue", + "GOLD": "gold", + "SILVER": "silver", + "BRONZE": "bronze", + "CUSTOM1": "custom1", + "CUSTOM2": "custom2", + "CUSTOM3": "custom3", + "PRIVATE1": "private1", + "PRIVATE2": "private2", + "PRIVATE3": "private3", + "PRIVATE4": "private4", + "PRIVATE5": "private5", + "PRIVATE6": "private6" + }, + }, + 'openapi_types': { + 'device_id': + (str,), + 'remote_tloc_address': + (str,), + 'remote_tloc_color': + (str,), + 'local_tloc_color': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + 'remote_tloc_address': 'remote-tloc-address', + 'remote_tloc_color': 'remote-tloc-color', + 'local_tloc_color': 'local-tloc-color', + }, + 'location_map': { + 'device_id': 'query', + 'remote_tloc_address': 'query', + 'remote_tloc_color': 'query', + 'local_tloc_color': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_ucse_stats( + self, + device_id, + **kwargs + ): + """create_ucse_stats # noqa: E501 + + Get UCSE stats entry from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ucse_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + remote_tloc_address (str): Remote TLOC address. [optional] + remote_tloc_color (str): Remote tloc color. [optional] + local_tloc_color (str): Local tloc color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.create_ucse_stats_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_umbrella_api.py b/openapi_client/api/real_time_monitoring_umbrella_api.py new file mode 100644 index 0000000..f699b55 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_umbrella_api.py @@ -0,0 +1,698 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringUmbrellaApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_umbrella_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/umbrella/umbrella-config', + 'operation_id': 'get_umbrella_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_umbrella_dev_reg_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/umbrella/device-registration', + 'operation_id': 'get_umbrella_dev_reg', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_umbrella_dns_crypt_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/umbrella/dnscrypt', + 'operation_id': 'get_umbrella_dns_crypt', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_umbrella_dp_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/umbrella/dp-stats', + 'operation_id': 'get_umbrella_dp_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_umbrella_overview_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/umbrella/overview', + 'operation_id': 'get_umbrella_overview', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_umbrella_config( + self, + device_id, + **kwargs + ): + """get_umbrella_config # noqa: E501 + + Get Umbrella configuration from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_umbrella_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_umbrella_config_endpoint.call_with_http_info(**kwargs) + + def get_umbrella_dev_reg( + self, + device_id, + **kwargs + ): + """get_umbrella_dev_reg # noqa: E501 + + Get Umbrella device registration from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_umbrella_dev_reg(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_umbrella_dev_reg_endpoint.call_with_http_info(**kwargs) + + def get_umbrella_dns_crypt( + self, + device_id, + **kwargs + ): + """get_umbrella_dns_crypt # noqa: E501 + + Get Umbrella DNScrypt information from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_umbrella_dns_crypt(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_umbrella_dns_crypt_endpoint.call_with_http_info(**kwargs) + + def get_umbrella_dp_stats( + self, + device_id, + **kwargs + ): + """get_umbrella_dp_stats # noqa: E501 + + Get Umbrella dp-stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_umbrella_dp_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_umbrella_dp_stats_endpoint.call_with_http_info(**kwargs) + + def get_umbrella_overview( + self, + device_id, + **kwargs + ): + """get_umbrella_overview # noqa: E501 + + Get Umbrella overview from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_umbrella_overview(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_umbrella_overview_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_utd_api.py b/openapi_client/api/real_time_monitoring_utd_api.py new file mode 100644 index 0000000..e94d64e --- /dev/null +++ b/openapi_client/api/real_time_monitoring_utd_api.py @@ -0,0 +1,1838 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringUTDApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_signature_version_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/signature/version/details', + 'operation_id': 'get_signature_version_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_dataplane_config_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/dataplane-config', + 'operation_id': 'get_utd_dataplane_config', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_dataplane_global_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/dataplane-global', + 'operation_id': 'get_utd_dataplane_global', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_dataplane_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/dataplane-stats', + 'operation_id': 'get_utd_dataplane_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_dataplane_stats_summary_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/dataplane-stats-summary', + 'operation_id': 'get_utd_dataplane_stats_summary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_engine_instance_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/engine-instance-status', + 'operation_id': 'get_utd_engine_instance_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_engine_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/engine-status', + 'operation_id': 'get_utd_engine_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_file_analysis_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/file-analysis-status', + 'operation_id': 'get_utd_file_analysis_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_file_reputation_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/file-reputation-status', + 'operation_id': 'get_utd_file_reputation_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_ips_update_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/ips-update-status', + 'operation_id': 'get_utd_ips_update_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_urlf_connection_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/urlf-con-status', + 'operation_id': 'get_utd_urlf_connection_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_urlf_update_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/urlf-update-status', + 'operation_id': 'get_utd_urlf_update_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_utd_version_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/utd/version-status', + 'operation_id': 'get_utd_version_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_signature_version_info( + self, + device_id, + **kwargs + ): + """get_signature_version_info # noqa: E501 + + Get UTD Signature version information from Device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_signature_version_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_signature_version_info_endpoint.call_with_http_info(**kwargs) + + def get_utd_dataplane_config( + self, + device_id, + **kwargs + ): + """get_utd_dataplane_config # noqa: E501 + + Get data plane config from Device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_dataplane_config(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_dataplane_config_endpoint.call_with_http_info(**kwargs) + + def get_utd_dataplane_global( + self, + device_id, + **kwargs + ): + """get_utd_dataplane_global # noqa: E501 + + Get data plane global from Device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_dataplane_global(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_dataplane_global_endpoint.call_with_http_info(**kwargs) + + def get_utd_dataplane_stats( + self, + device_id, + **kwargs + ): + """get_utd_dataplane_stats # noqa: E501 + + Get data plane stats from Device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_dataplane_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_dataplane_stats_endpoint.call_with_http_info(**kwargs) + + def get_utd_dataplane_stats_summary( + self, + device_id, + **kwargs + ): + """get_utd_dataplane_stats_summary # noqa: E501 + + Get data plane stats summary # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_dataplane_stats_summary(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_dataplane_stats_summary_endpoint.call_with_http_info(**kwargs) + + def get_utd_engine_instance_status( + self, + device_id, + **kwargs + ): + """get_utd_engine_instance_status # noqa: E501 + + Get UTD engine instance status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_engine_instance_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_engine_instance_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_engine_status( + self, + device_id, + **kwargs + ): + """get_utd_engine_status # noqa: E501 + + Get UTD engine status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_engine_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_engine_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_file_analysis_status( + self, + device_id, + **kwargs + ): + """get_utd_file_analysis_status # noqa: E501 + + Get UTD file analysis status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_file_analysis_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_file_analysis_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_file_reputation_status( + self, + device_id, + **kwargs + ): + """get_utd_file_reputation_status # noqa: E501 + + Get UTD file reputation status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_file_reputation_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_file_reputation_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_ips_update_status( + self, + device_id, + **kwargs + ): + """get_utd_ips_update_status # noqa: E501 + + Get UTD IPS update status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_ips_update_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_ips_update_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_urlf_connection_status( + self, + device_id, + **kwargs + ): + """get_utd_urlf_connection_status # noqa: E501 + + Get UTD URLF Connection status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_urlf_connection_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_urlf_connection_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_urlf_update_status( + self, + device_id, + **kwargs + ): + """get_utd_urlf_update_status # noqa: E501 + + Get UTD URLF update status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_urlf_update_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_urlf_update_status_endpoint.call_with_http_info(**kwargs) + + def get_utd_version_status( + self, + device_id, + **kwargs + ): + """get_utd_version_status # noqa: E501 + + Get UTD version status from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_utd_version_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_utd_version_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_vdsl_service_api.py b/openapi_client/api/real_time_monitoring_vdsl_service_api.py new file mode 100644 index 0000000..776029e --- /dev/null +++ b/openapi_client/api/real_time_monitoring_vdsl_service_api.py @@ -0,0 +1,962 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringVDSLServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_co_line_specific_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/coLineSpecificStats', + 'operation_id': 'get_co_line_specific_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_co_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/coStats', + 'operation_id': 'get_co_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cpe_line_specific_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/cpeLineSpecificStats', + 'operation_id': 'get_cpe_line_specific_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cpe_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/cpeStats', + 'operation_id': 'get_cpe_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_line_bonding_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/lineBondingStats', + 'operation_id': 'get_line_bonding_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_line_specific_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/lineSpecificStats', + 'operation_id': 'get_line_specific_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vdsl_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vdslService/vdslInfo', + 'operation_id': 'get_vdsl_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_co_line_specific_stats( + self, + device_id, + **kwargs + ): + """get_co_line_specific_stats # noqa: E501 + + Get VDSL service line bonding stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_co_line_specific_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_co_line_specific_stats_endpoint.call_with_http_info(**kwargs) + + def get_co_stats( + self, + device_id, + **kwargs + ): + """get_co_stats # noqa: E501 + + Get CO stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_co_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_co_stats_endpoint.call_with_http_info(**kwargs) + + def get_cpe_line_specific_stats( + self, + device_id, + **kwargs + ): + """get_cpe_line_specific_stats # noqa: E501 + + Get VDSL service CPE line specific stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cpe_line_specific_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_cpe_line_specific_stats_endpoint.call_with_http_info(**kwargs) + + def get_cpe_stats( + self, + device_id, + **kwargs + ): + """get_cpe_stats # noqa: E501 + + Get CPE stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cpe_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_cpe_stats_endpoint.call_with_http_info(**kwargs) + + def get_line_bonding_stats( + self, + device_id, + **kwargs + ): + """get_line_bonding_stats # noqa: E501 + + Get VDSL service line bonding stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_line_bonding_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_line_bonding_stats_endpoint.call_with_http_info(**kwargs) + + def get_line_specific_stats( + self, + device_id, + **kwargs + ): + """get_line_specific_stats # noqa: E501 + + Get VDSL service line specific stats from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_line_specific_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_line_specific_stats_endpoint.call_with_http_info(**kwargs) + + def get_vdsl_info( + self, + device_id, + **kwargs + ): + """get_vdsl_info # noqa: E501 + + Get VDSL info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vdsl_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vdsl_info_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_vm_api.py b/openapi_client/api/real_time_monitoring_vm_api.py new file mode 100644 index 0000000..6fd89e8 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_vm_api.py @@ -0,0 +1,594 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringVMApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_cloud_dock_vm_lifecycle_nics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vm/notifications', + 'operation_id': 'get_cloud_dock_vm_lifecycle_nics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_group', + ], + 'required': [ + 'user_group', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'user_group', + ] + }, + root_map={ + 'validations': { + ('user_group',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_group': + (str,), + }, + 'attribute_map': { + 'user_group': 'userGroup', + }, + 'location_map': { + 'user_group': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vbranch_vm_lifecycle_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vm/oper/state', + 'operation_id': 'get_vbranch_vm_lifecycle', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vbranch_vm_lifecycle_nics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vm/nics', + 'operation_id': 'get_vbranch_vm_lifecycle_nics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vm_life_cycle_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vm/state', + 'operation_id': 'get_vm_life_cycle_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_cloud_dock_vm_lifecycle_nics( + self, + user_group, + **kwargs + ): + """get_cloud_dock_vm_lifecycle_nics # noqa: E501 + + Get CloudDock vm lifecycle state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_dock_vm_lifecycle_nics(user_group, async_req=True) + >>> result = thread.get() + + Args: + user_group (str): userGroup Name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_group'] = \ + user_group + return self.get_cloud_dock_vm_lifecycle_nics_endpoint.call_with_http_info(**kwargs) + + def get_vbranch_vm_lifecycle( + self, + device_id, + **kwargs + ): + """get_vbranch_vm_lifecycle # noqa: E501 + + Get vbranch vm lifecycle state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vbranch_vm_lifecycle(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vbranch_vm_lifecycle_endpoint.call_with_http_info(**kwargs) + + def get_vbranch_vm_lifecycle_nics( + self, + device_id, + **kwargs + ): + """get_vbranch_vm_lifecycle_nics # noqa: E501 + + Get vbranch vm lifecycle state (NIC) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vbranch_vm_lifecycle_nics(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vbranch_vm_lifecycle_nics_endpoint.call_with_http_info(**kwargs) + + def get_vm_life_cycle_state( + self, + device_id, + **kwargs + ): + """get_vm_life_cycle_state # noqa: E501 + + Get vm lifecycle state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vm_life_cycle_state(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vm_life_cycle_state_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_voice_api.py b/openapi_client/api/real_time_monitoring_voice_api.py new file mode 100644 index 0000000..bc1cb5d --- /dev/null +++ b/openapi_client/api/real_time_monitoring_voice_api.py @@ -0,0 +1,1358 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringVoiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_controller_t1e1_info_current15_min_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voicet1e1controllerinfo/current15minstats', + 'operation_id': 'get_controller_t1e1_info_current15_min_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_controller_t1e1_info_total_stats_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voicet1e1controllerinfo/totalstats', + 'operation_id': 'get_controller_t1e1_info_total_stats', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dsp_active_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/dspActive', + 'operation_id': 'get_dsp_active', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_dsp_farm_profiles_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/profiles', + 'operation_id': 'get_dsp_farm_profiles', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_phone_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/phoneInfo', + 'operation_id': 'get_phone_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sccp_ccm_groups_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/sccpCcmGroups', + 'operation_id': 'get_sccp_ccm_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_sccp_connections_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/sccpConnections', + 'operation_id': 'get_sccp_connections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_t1e1_isdn_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voiceisdninfo/isdnstatus', + 'operation_id': 'get_t1e1_isdn_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_voice_calls_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/voiceCalls', + 'operation_id': 'get_voice_calls', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_voip_calls_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/voice/voipCalls', + 'operation_id': 'get_voip_calls', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_controller_t1e1_info_current15_min_stats( + self, + device_id, + **kwargs + ): + """get_controller_t1e1_info_current15_min_stats # noqa: E501 + + Retrieve T1E1 controller last 15 min stats from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_controller_t1e1_info_current15_min_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_controller_t1e1_info_current15_min_stats_endpoint.call_with_http_info(**kwargs) + + def get_controller_t1e1_info_total_stats( + self, + device_id, + **kwargs + ): + """get_controller_t1e1_info_total_stats # noqa: E501 + + Retrieve T1E1 controller total stats from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_controller_t1e1_info_total_stats(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_controller_t1e1_info_total_stats_endpoint.call_with_http_info(**kwargs) + + def get_dsp_active( + self, + device_id, + **kwargs + ): + """get_dsp_active # noqa: E501 + + Get DSPFarm Active DSP info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dsp_active(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dsp_active_endpoint.call_with_http_info(**kwargs) + + def get_dsp_farm_profiles( + self, + device_id, + **kwargs + ): + """get_dsp_farm_profiles # noqa: E501 + + Get DSPFarm Profiles info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dsp_farm_profiles(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_dsp_farm_profiles_endpoint.call_with_http_info(**kwargs) + + def get_phone_info( + self, + device_id, + **kwargs + ): + """get_phone_info # noqa: E501 + + Get phone registration info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_phone_info(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_phone_info_endpoint.call_with_http_info(**kwargs) + + def get_sccp_ccm_groups( + self, + device_id, + **kwargs + ): + """get_sccp_ccm_groups # noqa: E501 + + Get DSPFarm SCCP CCM Groups info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sccp_ccm_groups(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sccp_ccm_groups_endpoint.call_with_http_info(**kwargs) + + def get_sccp_connections( + self, + device_id, + **kwargs + ): + """get_sccp_connections # noqa: E501 + + Get DSPFarm SCCP Connections info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sccp_connections(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_sccp_connections_endpoint.call_with_http_info(**kwargs) + + def get_t1e1_isdn_status( + self, + device_id, + **kwargs + ): + """get_t1e1_isdn_status # noqa: E501 + + Retrieve Voice ISDN Status from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_t1e1_isdn_status(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_t1e1_isdn_status_endpoint.call_with_http_info(**kwargs) + + def get_voice_calls( + self, + device_id, + **kwargs + ): + """get_voice_calls # noqa: E501 + + Get voice call info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_voice_calls(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_voice_calls_endpoint.call_with_http_info(**kwargs) + + def get_voip_calls( + self, + device_id, + **kwargs + ): + """get_voip_calls # noqa: E501 + + Get VOIP call info from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_voip_calls(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_voip_calls_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_vpn_api.py b/openapi_client/api/real_time_monitoring_vpn_api.py new file mode 100644 index 0000000..d00ebb7 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_vpn_api.py @@ -0,0 +1,170 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringVPNApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_vpn_instances_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/vpn', + 'operation_id': 'get_vpn_instances', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_vpn_instances( + self, + device_id, + **kwargs + ): + """get_vpn_instances # noqa: E501 + + Get VPN instance list from device (Real Time) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vpn_instances(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vpn_instances_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_vrrp_api.py b/openapi_client/api/real_time_monitoring_vrrp_api.py new file mode 100644 index 0000000..7861fad --- /dev/null +++ b/openapi_client/api/real_time_monitoring_vrrp_api.py @@ -0,0 +1,177 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringVRRPApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_vrrp_interface_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/device/vrrp', + 'operation_id': 'get_vrrp_interface', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_vrrp_interface( + self, + device_id, + **kwargs + ): + """get_vrrp_interface # noqa: E501 + + Get VRRP interface list from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vrrp_interface(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): deviceId - Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_vrrp_interface_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_wireless_api.py b/openapi_client/api/real_time_monitoring_wireless_api.py new file mode 100644 index 0000000..8dba3c0 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_wireless_api.py @@ -0,0 +1,455 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringWirelessApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_wireless_clients_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wireless/client', + 'operation_id': 'get_wireless_clients', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wireless_radios_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wireless/radio', + 'operation_id': 'get_wireless_radios', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wireless_ssid_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wireless/ssid', + 'operation_id': 'get_wireless_ssid', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_wireless_clients( + self, + device_id, + **kwargs + ): + """get_wireless_clients # noqa: E501 + + Get wireless clients from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wireless_clients(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wireless_clients_endpoint.call_with_http_info(**kwargs) + + def get_wireless_radios( + self, + device_id, + **kwargs + ): + """get_wireless_radios # noqa: E501 + + Get wireless Radios from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wireless_radios(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wireless_radios_endpoint.call_with_http_info(**kwargs) + + def get_wireless_ssid( + self, + device_id, + **kwargs + ): + """get_wireless_ssid # noqa: E501 + + Get wireless SSID from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wireless_ssid(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wireless_ssid_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/real_time_monitoring_wlan_api.py b/openapi_client/api/real_time_monitoring_wlan_api.py new file mode 100644 index 0000000..4cd77e1 --- /dev/null +++ b/openapi_client/api/real_time_monitoring_wlan_api.py @@ -0,0 +1,594 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class RealTimeMonitoringWLANApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_wlan_clients_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wlan/clients', + 'operation_id': 'get_wlan_clients', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wlan_interfaces_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wlan/interfaces', + 'operation_id': 'get_wlan_interfaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wlan_radios_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wlan/radios', + 'operation_id': 'get_wlan_radios', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_wlan_radius_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/wlan/radius', + 'operation_id': 'get_wlan_radius', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [ + 'device_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'device_id', + ] + }, + root_map={ + 'validations': { + ('device_id',): { + + 'regex': { + 'pattern': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_wlan_clients( + self, + device_id, + **kwargs + ): + """get_wlan_clients # noqa: E501 + + Get WLAN client from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wlan_clients(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wlan_clients_endpoint.call_with_http_info(**kwargs) + + def get_wlan_interfaces( + self, + device_id, + **kwargs + ): + """get_wlan_interfaces # noqa: E501 + + Get WLAN interface from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wlan_interfaces(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wlan_interfaces_endpoint.call_with_http_info(**kwargs) + + def get_wlan_radios( + self, + device_id, + **kwargs + ): + """get_wlan_radios # noqa: E501 + + Get WLAN Radios from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wlan_radios(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wlan_radios_endpoint.call_with_http_info(**kwargs) + + def get_wlan_radius( + self, + device_id, + **kwargs + ): + """get_wlan_radius # noqa: E501 + + Get WLAN RADIUS authentication from device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_wlan_radius(device_id, async_req=True) + >>> result = thread.get() + + Args: + device_id (str): Device IP + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_id'] = \ + device_id + return self.get_wlan_radius_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/resource_pool_api.py b/openapi_client/api/resource_pool_api.py new file mode 100644 index 0000000..2b128f1 --- /dev/null +++ b/openapi_client/api/resource_pool_api.py @@ -0,0 +1,447 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ResourcePoolApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_resources_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/resourcepool/resource/vpn', + 'operation_id': 'create_resources', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_resources_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/resourcepool/resource/vpn', + 'operation_id': 'delete_resources', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'tenant_vpn', + ], + 'required': [ + 'tenant_id', + 'tenant_vpn', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'tenant_vpn': + (int,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + 'tenant_vpn': 'tenantVpn', + }, + 'location_map': { + 'tenant_id': 'query', + 'tenant_vpn': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_resources_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/resourcepool/resource/vpn', + 'operation_id': 'get_resources', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'tenant_vpn', + ], + 'required': [ + 'tenant_id', + 'tenant_vpn', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'tenant_vpn': + (int,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + 'tenant_vpn': 'tenantVpn', + }, + 'location_map': { + 'tenant_id': 'query', + 'tenant_vpn': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_resources( + self, + **kwargs + ): + """create_resources # noqa: E501 + + Create Vpn resource pool and return tenant device vpn # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_resources(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): create resources from resource pool. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_resources_endpoint.call_with_http_info(**kwargs) + + def delete_resources( + self, + tenant_id, + tenant_vpn, + **kwargs + ): + """delete_resources # noqa: E501 + + Delete tenant device vpn and release the resource # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_resources(tenant_id, tenant_vpn, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + tenant_vpn (int): Tenant Vpn Number + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + kwargs['tenant_vpn'] = \ + tenant_vpn + return self.delete_resources_endpoint.call_with_http_info(**kwargs) + + def get_resources( + self, + tenant_id, + tenant_vpn, + **kwargs + ): + """get_resources # noqa: E501 + + Get tenant device vpn resource # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_resources(tenant_id, tenant_vpn, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + tenant_vpn (int): Tenant Vpn Number + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + kwargs['tenant_vpn'] = \ + tenant_vpn + return self.get_resources_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/scheduled_backup_restore_api.py b/openapi_client/api/scheduled_backup_restore_api.py new file mode 100644 index 0000000..f0f72c2 --- /dev/null +++ b/openapi_client/api/scheduled_backup_restore_api.py @@ -0,0 +1,1451 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ScheduledBackupRestoreApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.delete_schduled_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/backup/backupinfo', + 'operation_id': 'delete_schduled_backup', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'task_id', + 'backup_info_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'task_id': + (str,), + 'backup_info_id': + (str,), + }, + 'attribute_map': { + 'task_id': 'taskId', + 'backup_info_id': 'backupInfoId', + }, + 'location_map': { + 'task_id': 'query', + 'backup_info_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_schedule_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/schedule/{schedulerId}', + 'operation_id': 'delete_schedule', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'scheduler_id', + ], + 'required': [ + 'scheduler_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scheduler_id': + (str,), + }, + 'attribute_map': { + 'scheduler_id': 'schedulerId', + }, + 'location_map': { + 'scheduler_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_backup_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/backup/download/{path}', + 'operation_id': 'download_backup_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.export_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/backup/export', + 'operation_id': 'export_backup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_local_backup_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/backup/backupinfo/{localBackupInfoId}', + 'operation_id': 'get_local_backup_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'local_backup_info_id', + ], + 'required': [ + 'local_backup_info_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'local_backup_info_id': + (str,), + }, + 'attribute_map': { + 'local_backup_info_id': 'localBackupInfoId', + }, + 'location_map': { + 'local_backup_info_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_schedule_record_for_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/schedule/{schedulerId}', + 'operation_id': 'get_schedule_record_for_backup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'scheduler_id', + ], + 'required': [ + 'scheduler_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scheduler_id': + (str,), + }, + 'attribute_map': { + 'scheduler_id': 'schedulerId', + }, + 'location_map': { + 'scheduler_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.import_scheduled_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/restore/import', + 'operation_id': 'import_scheduled_backup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/backup/list', + 'operation_id': 'list_backup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'size': + (str,), + }, + 'attribute_map': { + 'size': 'size', + }, + 'location_map': { + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_schedules_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/schedule/list', + 'operation_id': 'list_schedules', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'limit', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'limit': + (int,), + }, + 'attribute_map': { + 'limit': 'limit', + }, + 'location_map': { + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.remote_import_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/restore/remoteimport', + 'operation_id': 'remote_import_backup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.schedule_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/schedule/create', + 'operation_id': 'schedule_backup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def delete_schduled_backup( + self, + **kwargs + ): + """delete_schduled_backup # noqa: E501 + + Delete all or a specific backup file stored in vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_schduled_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + task_id (str): task id. [optional] + backup_info_id (str): Local Backup Info Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_schduled_backup_endpoint.call_with_http_info(**kwargs) + + def delete_schedule( + self, + scheduler_id, + **kwargs + ): + """delete_schedule # noqa: E501 + + Delete a schedule record for backup in vManage by scheduler id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_schedule(scheduler_id, async_req=True) + >>> result = thread.get() + + Args: + scheduler_id (str): scheduler id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['scheduler_id'] = \ + scheduler_id + return self.delete_schedule_endpoint.call_with_http_info(**kwargs) + + def download_backup_file( + self, + path, + **kwargs + ): + """download_backup_file # noqa: E501 + + Download a Backup File that is already stored in vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_backup_file(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): File path + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['path'] = \ + path + return self.download_backup_file_endpoint.call_with_http_info(**kwargs) + + def export_backup( + self, + **kwargs + ): + """export_backup # noqa: E501 + + Trigger a backup of configuration database and statstics database and store it in vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.export_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): backup request information. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.export_backup_endpoint.call_with_http_info(**kwargs) + + def get_local_backup_info( + self, + local_backup_info_id, + **kwargs + ): + """get_local_backup_info # noqa: E501 + + Get a localBackupInfo record by localBackupInfoId # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_local_backup_info(local_backup_info_id, async_req=True) + >>> result = thread.get() + + Args: + local_backup_info_id (str): localBackupInfo Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['local_backup_info_id'] = \ + local_backup_info_id + return self.get_local_backup_info_endpoint.call_with_http_info(**kwargs) + + def get_schedule_record_for_backup( + self, + scheduler_id, + **kwargs + ): + """get_schedule_record_for_backup # noqa: E501 + + Get a schedule record for backup by scheduler id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_schedule_record_for_backup(scheduler_id, async_req=True) + >>> result = thread.get() + + Args: + scheduler_id (str): scheduler id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['scheduler_id'] = \ + scheduler_id + return self.get_schedule_record_for_backup_endpoint.call_with_http_info(**kwargs) + + def import_scheduled_backup( + self, + **kwargs + ): + """import_scheduled_backup # noqa: E501 + + Submit a previously backed up file and import the data and apply it to the configuraion database # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_scheduled_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.import_scheduled_backup_endpoint.call_with_http_info(**kwargs) + + def list_backup( + self, + **kwargs + ): + """list_backup # noqa: E501 + + List all backup files of a tenant stored in vManage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + size (str): size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_backup_endpoint.call_with_http_info(**kwargs) + + def list_schedules( + self, + **kwargs + ): + """list_schedules # noqa: E501 + + Get a schedule record for backup by scheduler id # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_schedules(async_req=True) + >>> result = thread.get() + + + Keyword Args: + limit (int): size. [optional] if omitted the server will use the default value of 100 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_schedules_endpoint.call_with_http_info(**kwargs) + + def remote_import_backup( + self, + **kwargs + ): + """remote_import_backup # noqa: E501 + + Remote import backup from a remote URL and import the data and apply it to the configuraion database # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.remote_import_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.remote_import_backup_endpoint.call_with_http_info(**kwargs) + + def schedule_backup( + self, + **kwargs + ): + """schedule_backup # noqa: E501 + + create backup scheduler config-db and statstics database with startDateTime and persist to config-db # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.schedule_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): schedule request information. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.schedule_backup_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/sdavc_cloud_connector_api.py b/openapi_client/api/sdavc_cloud_connector_api.py new file mode 100644 index 0000000..83f0db1 --- /dev/null +++ b/openapi_client/api/sdavc_cloud_connector_api.py @@ -0,0 +1,533 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class SDAVCCloudConnectorApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.disable_cloud_connector_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sdavc/cloudconnector', + 'operation_id': 'disable_cloud_connector', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.enable_cloud_connector_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sdavc/cloudconnector', + 'operation_id': 'enable_cloud_connector', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_cloud_connector_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sdavc/cloudconnector', + 'operation_id': 'get_cloud_connector', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_connector_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/sdavc/cloudconnector/status', + 'operation_id': 'get_cloud_connector_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def disable_cloud_connector( + self, + **kwargs + ): + """disable_cloud_connector # noqa: E501 + + Disable SD_AVC Cloud Connector # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disable_cloud_connector(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.disable_cloud_connector_endpoint.call_with_http_info(**kwargs) + + def enable_cloud_connector( + self, + **kwargs + ): + """enable_cloud_connector # noqa: E501 + + Enable SD_AVC Cloud Connector # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.enable_cloud_connector(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.enable_cloud_connector_endpoint.call_with_http_info(**kwargs) + + def get_cloud_connector( + self, + **kwargs + ): + """get_cloud_connector # noqa: E501 + + Get SD_AVC Cloud Connector Config # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_connector(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_connector_endpoint.call_with_http_info(**kwargs) + + def get_cloud_connector_status( + self, + **kwargs + ): + """get_cloud_connector_status # noqa: E501 + + Get SD_AVC Cloud Connector Status # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_connector_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_connector_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/sdavc_domain_based_app_rules_api.py b/openapi_client/api/sdavc_domain_based_app_rules_api.py new file mode 100644 index 0000000..9af65cc --- /dev/null +++ b/openapi_client/api/sdavc_domain_based_app_rules_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class SDAVCDomainBasedAppRulesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_cloud_connector_domain_app_rules_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/monitor/sdavccloudconnector/domain', + 'operation_id': 'get_cloud_connector_domain_app_rules', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_cloud_connector_domain_app_rules( + self, + **kwargs + ): + """get_cloud_connector_domain_app_rules # noqa: E501 + + Get SD_AVC App Rules based on Domain # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_connector_domain_app_rules(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_connector_domain_app_rules_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/sdavcip_address_based_app_rules_api.py b/openapi_client/api/sdavcip_address_based_app_rules_api.py new file mode 100644 index 0000000..eb70702 --- /dev/null +++ b/openapi_client/api/sdavcip_address_based_app_rules_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class SDAVCIPAddressBasedAppRulesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_cloud_connector_ip_address_app_rules_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/monitor/sdavccloudconnector/ipaddress', + 'operation_id': 'get_cloud_connector_ip_address_app_rules', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_cloud_connector_ip_address_app_rules( + self, + **kwargs + ): + """get_cloud_connector_ip_address_app_rules # noqa: E501 + + Get SD_AVC App Rules based on IP Address # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_connector_ip_address_app_rules(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_connector_ip_address_app_rules_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/smart_license_api.py b/openapi_client/api/smart_license_api.py new file mode 100644 index 0000000..0628afa --- /dev/null +++ b/openapi_client/api/smart_license_api.py @@ -0,0 +1,1089 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class SmartLicenseApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.fetch_accounts_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/fetchAccounts', + 'operation_id': 'fetch_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'mode', + 'body', + ], + 'required': [ + 'mode', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'mode': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'mode': 'mode', + }, + 'location_map': { + 'mode': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.fetch_reports_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/fetchReportsForSa', + 'operation_id': 'fetch_reports', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'sa_domain', + 'sa_id', + 'body', + ], + 'required': [ + 'sa_domain', + 'sa_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'sa_domain': + (str,), + 'sa_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'sa_domain': 'saDomain', + 'sa_id': 'saId', + }, + 'location_map': { + 'sa_domain': 'query', + 'sa_id': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.fetch_reports1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/fetchAllSa', + 'operation_id': 'fetch_reports1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/getUserSettings', + 'operation_id': 'get_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.sleauthenticate_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/authenticate', + 'operation_id': 'sleauthenticate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.sync_licenses_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/syncLicenses', + 'operation_id': 'sync_licenses', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data', + 'name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data': + (str,), + 'name': + (file_type,), + }, + 'attribute_map': { + 'data': 'data', + 'name': 'name', + }, + 'location_map': { + 'data': 'form', + 'name': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + self.sync_licenses1_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/removeSaVaSelection', + 'operation_id': 'sync_licenses1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_ack_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/smartLicensing/uploadAck', + 'operation_id': 'upload_ack', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data': + (file_type,), + }, + 'attribute_map': { + 'data': 'data', + }, + 'location_map': { + 'data': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + + def fetch_accounts( + self, + mode, + **kwargs + ): + """fetch_accounts # noqa: E501 + + fetch sava for sle # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.fetch_accounts(mode, async_req=True) + >>> result = thread.get() + + Args: + mode (str): mode + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['mode'] = \ + mode + return self.fetch_accounts_endpoint.call_with_http_info(**kwargs) + + def fetch_reports( + self, + sa_domain, + sa_id, + **kwargs + ): + """fetch_reports # noqa: E501 + + fetch reports offline for sle # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.fetch_reports(sa_domain, sa_id, async_req=True) + >>> result = thread.get() + + Args: + sa_domain (str): saDomain + sa_id (str): saId + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['sa_domain'] = \ + sa_domain + kwargs['sa_id'] = \ + sa_id + return self.fetch_reports_endpoint.call_with_http_info(**kwargs) + + def fetch_reports1( + self, + **kwargs + ): + """fetch_reports1 # noqa: E501 + + fetch reports offline for sle # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.fetch_reports1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.fetch_reports1_endpoint.call_with_http_info(**kwargs) + + def get_settings( + self, + **kwargs + ): + """get_settings # noqa: E501 + + get settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_settings_endpoint.call_with_http_info(**kwargs) + + def sleauthenticate( + self, + **kwargs + ): + """sleauthenticate # noqa: E501 + + authenticate user for sle # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sleauthenticate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sleauthenticate_endpoint.call_with_http_info(**kwargs) + + def sync_licenses( + self, + **kwargs + ): + """sync_licenses # noqa: E501 + + get all licenses for sa/va # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_licenses(async_req=True) + >>> result = thread.get() + + + Keyword Args: + data (str): [optional] + name (file_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_licenses_endpoint.call_with_http_info(**kwargs) + + def sync_licenses1( + self, + **kwargs + ): + """sync_licenses1 # noqa: E501 + + get all licenses for sa/va # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_licenses1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Partner. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_licenses1_endpoint.call_with_http_info(**kwargs) + + def upload_ack( + self, + **kwargs + ): + """upload_ack # noqa: E501 + + upload ack file for sa/va # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_ack(async_req=True) + >>> result = thread.get() + + + Keyword Args: + data (file_type): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.upload_ack_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/system_cloud_service_api.py b/openapi_client/api/system_cloud_service_api.py new file mode 100644 index 0000000..26d091c --- /dev/null +++ b/openapi_client/api/system_cloud_service_api.py @@ -0,0 +1,2475 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class SystemCloudServiceApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.add_cloud_credentials_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/credentials', + 'operation_id': 'add_cloud_credentials', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connect_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/connect', + 'operation_id': 'connect', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_webex_data_centers_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/webex/datacenter', + 'operation_id': 'delete_webex_data_centers', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.entity_ownership_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/entityownership/tree', + 'operation_id': 'entity_ownership_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_access_tokenfor_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/cloudservices/accesstoken', + 'operation_id': 'get_access_tokenfor_device', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_azure_token_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/authtoken', + 'operation_id': 'get_azure_token', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_credentials_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/credentials', + 'operation_id': 'get_cloud_credentials', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_cloud_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/cloudservices', + 'operation_id': 'get_cloud_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_code_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/devicecode', + 'operation_id': 'get_device_code', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_o365_preferred_path_from_v_analytics_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/cloudservices/m365/preferredpath', + 'operation_id': 'get_o365_preferred_path_from_v_analytics', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_otp_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/cloudservices/otp', + 'operation_id': 'get_otp', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_telemetry_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/telemetry', + 'operation_id': 'get_telemetry_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.getv_analytics_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/dca/cloudservices/vanalytics', + 'operation_id': 'getv_analytics', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.is_staging_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/staging', + 'operation_id': 'is_staging', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_entity_ownership_info_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/entityownership/list', + 'operation_id': 'list_entity_ownership_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.opt_in_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/telemetry/optin', + 'operation_id': 'opt_in', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.opt_out_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/cloudservices/telemetry/optout', + 'operation_id': 'opt_out', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.set_webex_data_centers_sync_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/webex/datacenter/syncstatus', + 'operation_id': 'set_webex_data_centers_sync_status', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_webex_data_centers_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/webex/datacenter/sync', + 'operation_id': 'update_webex_data_centers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.updatet_otp_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/dca/cloudservices/otp', + 'operation_id': 'updatet_otp', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/octet-stream' + ] + }, + api_client=api_client + ) + + def add_cloud_credentials( + self, + **kwargs + ): + """add_cloud_credentials # noqa: E501 + + Get cloud service settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_cloud_credentials(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.add_cloud_credentials_endpoint.call_with_http_info(**kwargs) + + def connect( + self, + **kwargs + ): + """connect # noqa: E501 + + Telemetry Opt In # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connect(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.connect_endpoint.call_with_http_info(**kwargs) + + def delete_webex_data_centers( + self, + **kwargs + ): + """delete_webex_data_centers # noqa: E501 + + Delete webex data center data in DB # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_webex_data_centers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_webex_data_centers_endpoint.call_with_http_info(**kwargs) + + def entity_ownership_info( + self, + **kwargs + ): + """entity_ownership_info # noqa: E501 + + Entity ownership info grouped by buckets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.entity_ownership_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.entity_ownership_info_endpoint.call_with_http_info(**kwargs) + + def get_access_tokenfor_device( + self, + **kwargs + ): + """get_access_tokenfor_device # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_access_tokenfor_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_access_tokenfor_device_endpoint.call_with_http_info(**kwargs) + + def get_azure_token( + self, + **kwargs + ): + """get_azure_token # noqa: E501 + + Get Azure token # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_azure_token(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_azure_token_endpoint.call_with_http_info(**kwargs) + + def get_cloud_credentials( + self, + **kwargs + ): + """get_cloud_credentials # noqa: E501 + + Get cloud service credentials # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_credentials(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_credentials_endpoint.call_with_http_info(**kwargs) + + def get_cloud_settings( + self, + **kwargs + ): + """get_cloud_settings # noqa: E501 + + Get cloud service settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_cloud_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_cloud_settings_endpoint.call_with_http_info(**kwargs) + + def get_device_code( + self, + **kwargs + ): + """get_device_code # noqa: E501 + + Get Azure device code # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_code(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_device_code_endpoint.call_with_http_info(**kwargs) + + def get_o365_preferred_path_from_v_analytics( + self, + **kwargs + ): + """get_o365_preferred_path_from_v_analytics # noqa: E501 + + Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_o365_preferred_path_from_v_analytics(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_o365_preferred_path_from_v_analytics_endpoint.call_with_http_info(**kwargs) + + def get_otp( + self, + **kwargs + ): + """get_otp # noqa: E501 + + Get cloud service OTP value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_otp(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_otp_endpoint.call_with_http_info(**kwargs) + + def get_telemetry_state( + self, + **kwargs + ): + """get_telemetry_state # noqa: E501 + + Get Telemetry state # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_telemetry_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_telemetry_state_endpoint.call_with_http_info(**kwargs) + + def getv_analytics( + self, + **kwargs + ): + """getv_analytics # noqa: E501 + + Get session from DCS for vAnalytics # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.getv_analytics(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.getv_analytics_endpoint.call_with_http_info(**kwargs) + + def is_staging( + self, + **kwargs + ): + """is_staging # noqa: E501 + + Check if testbed or production # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.is_staging(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.is_staging_endpoint.call_with_http_info(**kwargs) + + def list_entity_ownership_info( + self, + **kwargs + ): + """list_entity_ownership_info # noqa: E501 + + List all entity ownership info # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_entity_ownership_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_entity_ownership_info_endpoint.call_with_http_info(**kwargs) + + def opt_in( + self, + **kwargs + ): + """opt_in # noqa: E501 + + Telemetry Opt In # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opt_in(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.opt_in_endpoint.call_with_http_info(**kwargs) + + def opt_out( + self, + **kwargs + ): + """opt_out # noqa: E501 + + Telemetry Opt Out # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opt_out(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.opt_out_endpoint.call_with_http_info(**kwargs) + + def set_webex_data_centers_sync_status( + self, + **kwargs + ): + """set_webex_data_centers_sync_status # noqa: E501 + + Set webex data center sync needed to false # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_webex_data_centers_sync_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.set_webex_data_centers_sync_status_endpoint.call_with_http_info(**kwargs) + + def update_webex_data_centers( + self, + **kwargs + ): + """update_webex_data_centers # noqa: E501 + + TEMP-Update webex data center data in DB with data from Webex API # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_webex_data_centers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.update_webex_data_centers_endpoint.call_with_http_info(**kwargs) + + def updatet_otp( + self, + **kwargs + ): + """updatet_otp # noqa: E501 + + Update cloud service OTP value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.updatet_otp(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Cloud service OTP value. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.updatet_otp_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/system_cloud_service_webex_api.py b/openapi_client/api/system_cloud_service_webex_api.py new file mode 100644 index 0000000..06d40e0 --- /dev/null +++ b/openapi_client/api/system_cloud_service_webex_api.py @@ -0,0 +1,283 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class SystemCloudServiceWebexApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_webex_data_centers_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/webex/datacenter', + 'operation_id': 'get_webex_data_centers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_webex_data_centers_sync_status_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/webex/datacenter/syncstatus', + 'operation_id': 'get_webex_data_centers_sync_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_webex_data_centers( + self, + **kwargs + ): + """get_webex_data_centers # noqa: E501 + + TEMP-Insert webex data center details manually for test setup # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_webex_data_centers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_webex_data_centers_endpoint.call_with_http_info(**kwargs) + + def get_webex_data_centers_sync_status( + self, + **kwargs + ): + """get_webex_data_centers_sync_status # noqa: E501 + + Get webex data center sync status from DB # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_webex_data_centers_sync_status(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_webex_data_centers_sync_status_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/system_container_api.py b/openapi_client/api/system_container_api.py new file mode 100644 index 0000000..c8caa7e --- /dev/null +++ b/openapi_client/api/system_container_api.py @@ -0,0 +1,1105 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class SystemContainerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.activate_container_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/sdavc/task/{taskId}', + 'operation_id': 'activate_container', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'task_id', + 'body', + ], + 'required': [ + 'task_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'task_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'task_id': 'taskId', + }, + 'location_map': { + 'task_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.activate_container_on_remote_host_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/container-manager/activate/{containerName}', + 'operation_id': 'activate_container_on_remote_host', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'container_name', + 'url', + 'host_ip', + 'checksum', + ], + 'required': [ + 'container_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'container_name': + (str,), + 'url': + (str,), + 'host_ip': + (str,), + 'checksum': + (str,), + }, + 'attribute_map': { + 'container_name': 'containerName', + 'url': 'url', + 'host_ip': 'hostIp', + 'checksum': 'checksum', + }, + 'location_map': { + 'container_name': 'path', + 'url': 'query', + 'host_ip': 'query', + 'checksum': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.de_activate_container_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/container-manager/deactivate/{containerName}', + 'operation_id': 'de_activate_container', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'container_name', + 'host_ip', + ], + 'required': [ + 'container_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'container_name': + (str,), + 'host_ip': + (str,), + }, + 'attribute_map': { + 'container_name': 'containerName', + 'host_ip': 'hostIp', + }, + 'location_map': { + 'container_name': 'path', + 'host_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.does_valid_image_exist_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/container-manager/doesValidImageExist/{containerName}', + 'operation_id': 'does_valid_image_exist', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'container_name', + ], + 'required': [ + 'container_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'container_name': + (str,), + }, + 'attribute_map': { + 'container_name': 'containerName', + }, + 'location_map': { + 'container_name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_container_inspect_data_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/container-manager/inspect/{containerName}', + 'operation_id': 'get_container_inspect_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'container_name', + 'host_ip', + ], + 'required': [ + 'container_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'container_name': + (str,), + 'host_ip': + (str,), + }, + 'attribute_map': { + 'container_name': 'containerName', + 'host_ip': 'hostIp', + }, + 'location_map': { + 'container_name': 'path', + 'host_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_container_settings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/container-manager/settings/{containerName}', + 'operation_id': 'get_container_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'container_name', + 'host_ip', + ], + 'required': [ + 'container_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'container_name': + (str,), + 'host_ip': + (str,), + }, + 'attribute_map': { + 'container_name': 'containerName', + 'host_ip': 'hostIp', + }, + 'location_map': { + 'container_name': 'path', + 'host_ip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_custom_app_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/sdavc/customapps', + 'operation_id': 'get_custom_app', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.test_load_balancer_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/sdavc/test', + 'operation_id': 'test_load_balancer', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def activate_container( + self, + task_id, + **kwargs + ): + """activate_container # noqa: E501 + + Activate container # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate_container(task_id, async_req=True) + >>> result = thread.get() + + Args: + task_id (str): Task Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Container task config. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['task_id'] = \ + task_id + return self.activate_container_endpoint.call_with_http_info(**kwargs) + + def activate_container_on_remote_host( + self, + container_name, + **kwargs + ): + """activate_container_on_remote_host # noqa: E501 + + Activate container on remote host # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activate_container_on_remote_host(container_name, async_req=True) + >>> result = thread.get() + + Args: + container_name (str): Container name + + Keyword Args: + url (str): Container image URL. [optional] + host_ip (str): Container host IP. [optional] + checksum (str): Container image checksum. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['container_name'] = \ + container_name + return self.activate_container_on_remote_host_endpoint.call_with_http_info(**kwargs) + + def de_activate_container( + self, + container_name, + **kwargs + ): + """de_activate_container # noqa: E501 + + Deactivate container on remote host # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.de_activate_container(container_name, async_req=True) + >>> result = thread.get() + + Args: + container_name (str): Container name + + Keyword Args: + host_ip (str): Container host IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['container_name'] = \ + container_name + return self.de_activate_container_endpoint.call_with_http_info(**kwargs) + + def does_valid_image_exist( + self, + container_name, + **kwargs + ): + """does_valid_image_exist # noqa: E501 + + Get container image checksum # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.does_valid_image_exist(container_name, async_req=True) + >>> result = thread.get() + + Args: + container_name (str): Container name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['container_name'] = \ + container_name + return self.does_valid_image_exist_endpoint.call_with_http_info(**kwargs) + + def get_container_inspect_data( + self, + container_name, + **kwargs + ): + """get_container_inspect_data # noqa: E501 + + Get container inspect data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_container_inspect_data(container_name, async_req=True) + >>> result = thread.get() + + Args: + container_name (str): Container name + + Keyword Args: + host_ip (str): Container host IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['container_name'] = \ + container_name + return self.get_container_inspect_data_endpoint.call_with_http_info(**kwargs) + + def get_container_settings( + self, + container_name, + **kwargs + ): + """get_container_settings # noqa: E501 + + Get container settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_container_settings(container_name, async_req=True) + >>> result = thread.get() + + Args: + container_name (str): Container name + + Keyword Args: + host_ip (str): Container host IP. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['container_name'] = \ + container_name + return self.get_container_settings_endpoint.call_with_http_info(**kwargs) + + def get_custom_app( + self, + **kwargs + ): + """get_custom_app # noqa: E501 + + Displays the user-defined applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_custom_app(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_custom_app_endpoint.call_with_http_info(**kwargs) + + def test_load_balancer( + self, + **kwargs + ): + """test_load_balancer # noqa: E501 + + Test SD_AVC load balancer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_load_balancer(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.test_load_balancer_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/system_reverse_proxy_api.py b/openapi_client/api/system_reverse_proxy_api.py new file mode 100644 index 0000000..5e55d19 --- /dev/null +++ b/openapi_client/api/system_reverse_proxy_api.py @@ -0,0 +1,307 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class SystemReverseProxyApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_reverse_proxy_mappings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/system/reverseproxy/{uuid}', + 'operation_id': 'create_reverse_proxy_mappings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + 'body', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_reverse_proxy_mappings_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/system/reverseproxy/{uuid}', + 'operation_id': 'get_reverse_proxy_mappings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_reverse_proxy_mappings( + self, + uuid, + **kwargs + ): + """create_reverse_proxy_mappings # noqa: E501 + + Create reverse proxy IP/Port mappings for controller # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_reverse_proxy_mappings(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device reverse proxy mappings. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.create_reverse_proxy_mappings_endpoint.call_with_http_info(**kwargs) + + def get_reverse_proxy_mappings( + self, + uuid, + **kwargs + ): + """get_reverse_proxy_mappings # noqa: E501 + + Get reverse proxy IP/Port mappings for controller # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_reverse_proxy_mappings(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_reverse_proxy_mappings_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/tag_api.py b/openapi_client/api/tag_api.py new file mode 100644 index 0000000..1a8b667 --- /dev/null +++ b/openapi_client/api/tag_api.py @@ -0,0 +1,1313 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from openapi_client.model.tag_restful_resource import TagRestfulResource + + +class TagApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.check_for_conflicts_when_tagging_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/tag/conflictCheck', + 'operation_id': 'check_for_conflicts_when_tagging', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.check_rules_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/tag/checkRules', + 'operation_id': 'check_rules', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tag_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/tag', + 'operation_id': 'create_tag', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tag_rule_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/tag/tagRules', + 'operation_id': 'create_tag_rule', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tag_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tag/remove', + 'operation_id': 'delete_tag', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'get_o365_preferred_path_from_v_analytics_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'get_o365_preferred_path_from_v_analytics_request': + (GetO365PreferredPathFromVAnalyticsRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'get_o365_preferred_path_from_v_analytics_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tag_rule_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tag/tagRules/{tagRuleId}', + 'operation_id': 'delete_tag_rule', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'tag_rule_id', + 'config_group_id', + 'body', + ], + 'required': [ + 'tag_rule_id', + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tag_rule_id': + (str,), + 'config_group_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tag_rule_id': 'tagRuleId', + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'tag_rule_id': 'path', + 'config_group_id': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.edit_tag_rule_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tag/tagRules', + 'operation_id': 'edit_tag_rule', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_tag_endpoint = _Endpoint( + settings={ + 'response_type': ([TagRestfulResource],), + 'auth': [], + 'endpoint_path': '/tag', + 'operation_id': 'get_tag', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tag_rules_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tag/tagRules/{configGroupId}', + 'operation_id': 'get_tag_rules', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'config_group_id', + ], + 'required': [ + 'config_group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'config_group_id': + (str,), + }, + 'attribute_map': { + 'config_group_id': 'configGroupId', + }, + 'location_map': { + 'config_group_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.reindex_tag_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tag/reindex', + 'operation_id': 'reindex_tag', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def check_for_conflicts_when_tagging( + self, + **kwargs + ): + """check_for_conflicts_when_tagging # noqa: E501 + + Check for conflicts when tagging # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_for_conflicts_when_tagging(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_for_conflicts_when_tagging_endpoint.call_with_http_info(**kwargs) + + def check_rules( + self, + **kwargs + ): + """check_rules # noqa: E501 + + This API will check if a rule can be created or not # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_rules(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_rules_endpoint.call_with_http_info(**kwargs) + + def create_tag( + self, + **kwargs + ): + """create_tag # noqa: E501 + + Create a tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tag_endpoint.call_with_http_info(**kwargs) + + def create_tag_rule( + self, + **kwargs + ): + """create_tag_rule # noqa: E501 + + Create a tag rule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tag_rule(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tag_rule_endpoint.call_with_http_info(**kwargs) + + def delete_tag( + self, + **kwargs + ): + """delete_tag # noqa: E501 + + Deletes multiple tags # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + get_o365_preferred_path_from_v_analytics_request (GetO365PreferredPathFromVAnalyticsRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_tag_endpoint.call_with_http_info(**kwargs) + + def delete_tag_rule( + self, + tag_rule_id, + config_group_id, + **kwargs + ): + """delete_tag_rule # noqa: E501 + + Delete a tag rule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tag_rule(tag_rule_id, config_group_id, async_req=True) + >>> result = thread.get() + + Args: + tag_rule_id (str): tagRule Id + config_group_id (str): ConfigGroup Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tag_rule_id'] = \ + tag_rule_id + kwargs['config_group_id'] = \ + config_group_id + return self.delete_tag_rule_endpoint.call_with_http_info(**kwargs) + + def edit_tag_rule( + self, + **kwargs + ): + """edit_tag_rule # noqa: E501 + + Edit a tag rule # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_tag_rule(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.edit_tag_rule_endpoint.call_with_http_info(**kwargs) + + def get_tag( + self, + **kwargs + ): + """get_tag # noqa: E501 + + Get all tags # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [TagRestfulResource] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tag_endpoint.call_with_http_info(**kwargs) + + def get_tag_rules( + self, + config_group_id, + **kwargs + ): + """get_tag_rules # noqa: E501 + + Get tag rules # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tag_rules(config_group_id, async_req=True) + >>> result = thread.get() + + Args: + config_group_id (str): ConfigGroup Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['config_group_id'] = \ + config_group_id + return self.get_tag_rules_endpoint.call_with_http_info(**kwargs) + + def reindex_tag( + self, + **kwargs + ): + """reindex_tag # noqa: E501 + + Re-index device tags for search. Only call this API very occasionally if tag search is not returning expected results. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reindex_tag(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.reindex_tag_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/tenant_backup_restore_api.py b/openapi_client/api/tenant_backup_restore_api.py new file mode 100644 index 0000000..bdde2f6 --- /dev/null +++ b/openapi_client/api/tenant_backup_restore_api.py @@ -0,0 +1,662 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class TenantBackupRestoreApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.delete_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/delete', + 'operation_id': 'delete_tenant_backup', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'file_name', + ], + 'required': [ + 'file_name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'file_name': + (str,), + }, + 'attribute_map': { + 'file_name': 'fileName', + }, + 'location_map': { + 'file_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_existing_backup_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/download/{path}', + 'operation_id': 'download_existing_backup_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.export_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/export', + 'operation_id': 'export_tenant_backup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.import_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/import', + 'operation_id': 'import_tenant_backup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_tenant_backup_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantbackup/list', + 'operation_id': 'list_tenant_backup', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def delete_tenant_backup( + self, + file_name, + **kwargs + ): + """delete_tenant_backup # noqa: E501 + + Delete all or a specific backup file stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tenant_backup(file_name, async_req=True) + >>> result = thread.get() + + Args: + file_name (str): File name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['file_name'] = \ + file_name + return self.delete_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def download_existing_backup_file( + self, + path, + **kwargs + ): + """download_existing_backup_file # noqa: E501 + + Download a Backup File that is already stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_existing_backup_file(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): File path + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['path'] = \ + path + return self.download_existing_backup_file_endpoint.call_with_http_info(**kwargs) + + def export_tenant_backup( + self, + **kwargs + ): + """export_tenant_backup # noqa: E501 + + Trigger a backup of configuration database and store it in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.export_tenant_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.export_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def import_tenant_backup( + self, + **kwargs + ): + """import_tenant_backup # noqa: E501 + + Submit a previously backed up file and import the data and apply it to the configuraion database


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_tenant_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.import_tenant_backup_endpoint.call_with_http_info(**kwargs) + + def list_tenant_backup( + self, + **kwargs + ): + """list_tenant_backup # noqa: E501 + + List all backup files of a tenant stored in vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_tenant_backup(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_tenant_backup_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/tenant_management_api.py b/openapi_client/api/tenant_management_api.py new file mode 100644 index 0000000..b3c8173 --- /dev/null +++ b/openapi_client/api/tenant_management_api.py @@ -0,0 +1,2081 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class TenantManagementApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant', + 'operation_id': 'create_tenant', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tenant_async_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/async', + 'operation_id': 'create_tenant_async', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_tenant_async_bulk_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/bulk/async', + 'operation_id': 'create_tenant_async_bulk', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tenant_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/delete', + 'operation_id': 'delete_tenant', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'body', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_tenant_async_bulk_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/bulk/async', + 'operation_id': 'delete_tenant_async_bulk', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.force_status_collection_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tenantstatus/force', + 'operation_id': 'force_status_collection', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_tenant_statuses_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenantstatus', + 'operation_id': 'get_all_tenant_statuses', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_tenants_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant', + 'operation_id': 'get_all_tenants', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_id': + (str,), + }, + 'attribute_map': { + 'device_id': 'deviceId', + }, + 'location_map': { + 'device_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}', + 'operation_id': 'get_tenant', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenant_hosting_capacity_onv_smarts_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/vsmart/capacity', + 'operation_id': 'get_tenant_hosting_capacity_onv_smarts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_tenantv_smart_mapping_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/vsmart', + 'operation_id': 'get_tenantv_smart_mapping', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.switch_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/switch', + 'operation_id': 'switch_tenant', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tenantv_smart_mt_migrate_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/vsmart-mt/migrate', + 'operation_id': 'tenantv_smart_mt_migrate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_tenant_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}', + 'operation_id': 'update_tenant', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'body', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_tenantv_smart_placement_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/vsmart', + 'operation_id': 'update_tenantv_smart_placement', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + 'body', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.v_session_id_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenant/{tenantId}/vsessionid', + 'operation_id': 'v_session_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tenant_id', + ], + 'required': [ + 'tenant_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tenant_id': + (str,), + }, + 'attribute_map': { + 'tenant_id': 'tenantId', + }, + 'location_map': { + 'tenant_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_tenant( + self, + **kwargs + ): + """create_tenant # noqa: E501 + + Create a new tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tenant(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tenant_endpoint.call_with_http_info(**kwargs) + + def create_tenant_async( + self, + **kwargs + ): + """create_tenant_async # noqa: E501 + + Create a new tenant in Multi-Tenant vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tenant_async(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tenant_async_endpoint.call_with_http_info(**kwargs) + + def create_tenant_async_bulk( + self, + **kwargs + ): + """create_tenant_async_bulk # noqa: E501 + + Create multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_tenant_async_bulk(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_tenant_async_bulk_endpoint.call_with_http_info(**kwargs) + + def delete_tenant( + self, + tenant_id, + **kwargs + ): + """delete_tenant # noqa: E501 + + Delete a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.delete_tenant_endpoint.call_with_http_info(**kwargs) + + def delete_tenant_async_bulk( + self, + **kwargs + ): + """delete_tenant_async_bulk # noqa: E501 + + Delete multiple tenants on vManage asynchronously


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_tenant_async_bulk(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_tenant_async_bulk_endpoint.call_with_http_info(**kwargs) + + def force_status_collection( + self, + **kwargs + ): + """force_status_collection # noqa: E501 + + Force tenant status collection


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.force_status_collection(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.force_status_collection_endpoint.call_with_http_info(**kwargs) + + def get_all_tenant_statuses( + self, + **kwargs + ): + """get_all_tenant_statuses # noqa: E501 + + List all tenant status


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_tenant_statuses(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_tenant_statuses_endpoint.call_with_http_info(**kwargs) + + def get_all_tenants( + self, + **kwargs + ): + """get_all_tenants # noqa: E501 + + Lists all the tenants on the vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_tenants(async_req=True) + >>> result = thread.get() + + + Keyword Args: + device_id (str): List all tenants associated with a vSmart. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_tenants_endpoint.call_with_http_info(**kwargs) + + def get_tenant( + self, + tenant_id, + **kwargs + ): + """get_tenant # noqa: E501 + + Get a tenant by Id


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.get_tenant_endpoint.call_with_http_info(**kwargs) + + def get_tenant_hosting_capacity_onv_smarts( + self, + **kwargs + ): + """get_tenant_hosting_capacity_onv_smarts # noqa: E501 + + Lists all the vsmarts on the vManage and its tenant hosting capacity


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenant_hosting_capacity_onv_smarts(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenant_hosting_capacity_onv_smarts_endpoint.call_with_http_info(**kwargs) + + def get_tenantv_smart_mapping( + self, + **kwargs + ): + """get_tenantv_smart_mapping # noqa: E501 + + Retrieve mapping of tenants to vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_tenantv_smart_mapping(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_tenantv_smart_mapping_endpoint.call_with_http_info(**kwargs) + + def switch_tenant( + self, + tenant_id, + **kwargs + ): + """switch_tenant # noqa: E501 + + Switch to a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.switch_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.switch_tenant_endpoint.call_with_http_info(**kwargs) + + def tenantv_smart_mt_migrate( + self, + **kwargs + ): + """tenantv_smart_mt_migrate # noqa: E501 + + Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenantv_smart_mt_migrate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.tenantv_smart_mt_migrate_endpoint.call_with_http_info(**kwargs) + + def update_tenant( + self, + tenant_id, + **kwargs + ): + """update_tenant # noqa: E501 + + Update a tenant in Multi-Tenant vManage


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_tenant(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.update_tenant_endpoint.call_with_http_info(**kwargs) + + def update_tenantv_smart_placement( + self, + tenant_id, + **kwargs + ): + """update_tenantv_smart_placement # noqa: E501 + + Update placement of the Tenant from source vSmart to destination vSmart


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_tenantv_smart_placement(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Tenant model. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.update_tenantv_smart_placement_endpoint.call_with_http_info(**kwargs) + + def v_session_id( + self, + tenant_id, + **kwargs + ): + """v_session_id # noqa: E501 + + Get VSessionId for a specific tenant


Note: In a multitenant vManage system, this API is only available in the Provider view. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.v_session_id(tenant_id, async_req=True) + >>> result = thread.get() + + Args: + tenant_id (str): Tenant Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['tenant_id'] = \ + tenant_id + return self.v_session_id_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/tenant_migration_api.py b/openapi_client/api/tenant_migration_api.py new file mode 100644 index 0000000..a968039 --- /dev/null +++ b/openapi_client/api/tenant_migration_api.py @@ -0,0 +1,793 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.create_tenant_model import CreateTenantModel + + +class TenantMigrationApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.download_tenant_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantmigration/download/{path}', + 'operation_id': 'download_tenant_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.export_tenant_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantmigration/export', + 'operation_id': 'export_tenant_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'create_tenant_model', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'create_tenant_model': + (CreateTenantModel,), + }, + 'attribute_map': { + }, + 'location_map': { + 'create_tenant_model': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_migration_token_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantmigration/migrationToken', + 'operation_id': 'get_migration_token', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'migration_id', + ], + 'required': [ + 'migration_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'migration_id': + (str,), + }, + 'attribute_map': { + 'migration_id': 'migrationId', + }, + 'location_map': { + 'migration_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.import_tenant_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantmigration/import', + 'operation_id': 'import_tenant_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.migrate_network_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/tenantmigration/networkMigration', + 'operation_id': 'migrate_network', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.re_trigger_network_migration_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/tenantmigration/networkMigration', + 'operation_id': 're_trigger_network_migration', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def download_tenant_data( + self, + path, + **kwargs + ): + """download_tenant_data # noqa: E501 + + Download tenant data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_tenant_data(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): File path + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['path'] = \ + path + return self.download_tenant_data_endpoint.call_with_http_info(**kwargs) + + def export_tenant_data( + self, + **kwargs + ): + """export_tenant_data # noqa: E501 + + Export tenant data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.export_tenant_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + create_tenant_model (CreateTenantModel): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.export_tenant_data_endpoint.call_with_http_info(**kwargs) + + def get_migration_token( + self, + migration_id, + **kwargs + ): + """get_migration_token # noqa: E501 + + Get migration token # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_migration_token(migration_id, async_req=True) + >>> result = thread.get() + + Args: + migration_id (str): Migration Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['migration_id'] = \ + migration_id + return self.get_migration_token_endpoint.call_with_http_info(**kwargs) + + def import_tenant_data( + self, + **kwargs + ): + """import_tenant_data # noqa: E501 + + Import tenant data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_tenant_data(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.import_tenant_data_endpoint.call_with_http_info(**kwargs) + + def migrate_network( + self, + **kwargs + ): + """migrate_network # noqa: E501 + + Migrate network # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.migrate_network(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Network migration. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.migrate_network_endpoint.call_with_http_info(**kwargs) + + def re_trigger_network_migration( + self, + **kwargs + ): + """re_trigger_network_migration # noqa: E501 + + Re-trigger network migration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.re_trigger_network_migration(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.re_trigger_network_migration_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/tools_tac_cases_api.py b/openapi_client/api/tools_tac_cases_api.py new file mode 100644 index 0000000..18d5196 --- /dev/null +++ b/openapi_client/api/tools_tac_cases_api.py @@ -0,0 +1,656 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class ToolsTACCasesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.delete_call_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/opentaccase/scmwidget', + 'operation_id': 'delete_call', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_call_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/opentaccase/scmwidget', + 'operation_id': 'get_call', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_client_id_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/opentaccase/getClientID', + 'operation_id': 'get_client_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.oauth_access_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/opentaccase/authcode', + 'operation_id': 'oauth_access', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'code', + 'redirect', + 'is_refresh_needed', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'code': + (str,), + 'redirect': + (str,), + 'is_refresh_needed': + (bool,), + }, + 'attribute_map': { + 'code': 'code', + 'redirect': 'redirect', + 'is_refresh_needed': 'isRefreshNeeded', + }, + 'location_map': { + 'code': 'query', + 'redirect': 'query', + 'is_refresh_needed': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.post_call_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/opentaccase/scmwidget', + 'operation_id': 'post_call', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def delete_call( + self, + **kwargs + ): + """delete_call # noqa: E501 + + Proxy API for SCM Widget # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_call(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_call_endpoint.call_with_http_info(**kwargs) + + def get_call( + self, + **kwargs + ): + """get_call # noqa: E501 + + Proxy API for SCM Widget # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_call(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_call_endpoint.call_with_http_info(**kwargs) + + def get_client_id( + self, + **kwargs + ): + """get_client_id # noqa: E501 + + Gets vManage Client ID # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_client_id(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_client_id_endpoint.call_with_http_info(**kwargs) + + def oauth_access( + self, + **kwargs + ): + """oauth_access # noqa: E501 + + Gets Access Token for SSO Logjn # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.oauth_access(async_req=True) + >>> result = thread.get() + + + Keyword Args: + code (str): [optional] + redirect (str): [optional] + is_refresh_needed (bool): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.oauth_access_endpoint.call_with_http_info(**kwargs) + + def post_call( + self, + **kwargs + ): + """post_call # noqa: E501 + + Prxoy API for SCM Widget # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.post_call(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.post_call_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/troubleshooting_tools_device_connectivity_api.py b/openapi_client/api/troubleshooting_tools_device_connectivity_api.py new file mode 100644 index 0000000..abf9dd8 --- /dev/null +++ b/openapi_client/api/troubleshooting_tools_device_connectivity_api.py @@ -0,0 +1,2652 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class TroubleshootingToolsDeviceConnectivityApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.copy_admin_tech_on_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/admintech/copy', + 'operation_id': 'copy_admin_tech_on_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_admin_tech_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/admintech', + 'operation_id': 'create_admin_tech', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_admin_tech_file_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/admintech/{requestID}', + 'operation_id': 'delete_admin_tech_file', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'request_id', + ], + 'required': [ + 'request_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'request_id': + (str,), + }, + 'attribute_map': { + 'request_id': 'requestID', + }, + 'location_map': { + 'request_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_admin_tech_on_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/admintech/delete', + 'operation_id': 'delete_admin_tech_on_device', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.download_admin_tech_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/admintech/download/{filename}', + 'operation_id': 'download_admin_tech_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filename', + ], + 'required': [ + 'filename', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'filename': + (str,), + }, + 'attribute_map': { + 'filename': 'filename', + }, + 'location_map': { + 'filename': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.factory_reset_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/factoryreset', + 'operation_id': 'factory_reset', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_control_connections_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/troubleshooting/control/{uuid}', + 'operation_id': 'get_control_connections', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_configuration_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/troubleshooting/devicebringup', + 'operation_id': 'get_device_configuration', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_in_progress_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/admintechs/inprogress', + 'operation_id': 'get_in_progress_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_admin_techs_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/admintechs', + 'operation_id': 'list_admin_techs', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_admin_techs_on_device_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/device/tools/admintechlist', + 'operation_id': 'list_admin_techs_on_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.nping_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/nping/{deviceIP}', + 'operation_id': 'nping_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.ping_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/ping/{deviceIP}', + 'operation_id': 'ping_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_interface_reset_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/reset/interface/{deviceIP}', + 'operation_id': 'process_interface_reset', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_port_hop_color_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/porthopcolor/{deviceIP}', + 'operation_id': 'process_port_hop_color', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_reset_user_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/resetuser/{deviceIP}', + 'operation_id': 'process_reset_user', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.service_path_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/servicepath/{deviceIP}', + 'operation_id': 'service_path', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.traceroute_device_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/traceroute/{deviceIP}', + 'operation_id': 'traceroute_device', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tunnel_path_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/tunnelpath/{deviceIP}', + 'operation_id': 'tunnel_path', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_ip', + 'body', + ], + 'required': [ + 'device_ip', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_ip': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'device_ip': 'deviceIP', + }, + 'location_map': { + 'device_ip': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_admin_tech_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/device/tools/admintechs/upload', + 'operation_id': 'upload_admin_tech', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def copy_admin_tech_on_device( + self, + **kwargs + ): + """copy_admin_tech_on_device # noqa: E501 + + copy admin tech logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.copy_admin_tech_on_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Admin tech copy request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.copy_admin_tech_on_device_endpoint.call_with_http_info(**kwargs) + + def create_admin_tech( + self, + **kwargs + ): + """create_admin_tech # noqa: E501 + + Generate admin tech logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_admin_tech(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Admin tech generation request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_admin_tech_endpoint.call_with_http_info(**kwargs) + + def delete_admin_tech_file( + self, + request_id, + **kwargs + ): + """delete_admin_tech_file # noqa: E501 + + Delete admin tech logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_admin_tech_file(request_id, async_req=True) + >>> result = thread.get() + + Args: + request_id (str): Request Id of admin tech generation request + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['request_id'] = \ + request_id + return self.delete_admin_tech_file_endpoint.call_with_http_info(**kwargs) + + def delete_admin_tech_on_device( + self, + **kwargs + ): + """delete_admin_tech_on_device # noqa: E501 + + delete admin tech logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_admin_tech_on_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Admin tech copy request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_admin_tech_on_device_endpoint.call_with_http_info(**kwargs) + + def download_admin_tech_file( + self, + filename, + **kwargs + ): + """download_admin_tech_file # noqa: E501 + + Download admin tech logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_admin_tech_file(filename, async_req=True) + >>> result = thread.get() + + Args: + filename (str): Admin tech file + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['filename'] = \ + filename + return self.download_admin_tech_file_endpoint.call_with_http_info(**kwargs) + + def factory_reset( + self, + **kwargs + ): + """factory_reset # noqa: E501 + + Device factory reset # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.factory_reset(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device factory reset. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.factory_reset_endpoint.call_with_http_info(**kwargs) + + def get_control_connections( + self, + uuid, + **kwargs + ): + """get_control_connections # noqa: E501 + + Troubleshoot control connections # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_control_connections(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_control_connections_endpoint.call_with_http_info(**kwargs) + + def get_device_configuration( + self, + uuid, + **kwargs + ): + """get_device_configuration # noqa: E501 + + Debug device bring up # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_configuration(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_device_configuration_endpoint.call_with_http_info(**kwargs) + + def get_in_progress_count( + self, + **kwargs + ): + """get_in_progress_count # noqa: E501 + + Get device admin-tech InProgressCount # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_in_progress_count(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_in_progress_count_endpoint.call_with_http_info(**kwargs) + + def list_admin_techs( + self, + **kwargs + ): + """list_admin_techs # noqa: E501 + + Get device admin-tech information # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_admin_techs(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_admin_techs_endpoint.call_with_http_info(**kwargs) + + def list_admin_techs_on_device( + self, + **kwargs + ): + """list_admin_techs_on_device # noqa: E501 + + List admin tech logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_admin_techs_on_device(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Admin tech listing request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_admin_techs_on_device_endpoint.call_with_http_info(**kwargs) + + def nping_device( + self, + device_ip, + **kwargs + ): + """nping_device # noqa: E501 + + NPing device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.nping_device(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): NPing parameter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.nping_device_endpoint.call_with_http_info(**kwargs) + + def ping_device( + self, + device_ip, + **kwargs + ): + """ping_device # noqa: E501 + + Ping device # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.ping_device(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Ping parameter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.ping_device_endpoint.call_with_http_info(**kwargs) + + def process_interface_reset( + self, + device_ip, + **kwargs + ): + """process_interface_reset # noqa: E501 + + Reset device interface # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_interface_reset(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device interface. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.process_interface_reset_endpoint.call_with_http_info(**kwargs) + + def process_port_hop_color( + self, + device_ip, + **kwargs + ): + """process_port_hop_color # noqa: E501 + + Request port hop color # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_port_hop_color(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device port hop color. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.process_port_hop_color_endpoint.call_with_http_info(**kwargs) + + def process_reset_user( + self, + device_ip, + **kwargs + ): + """process_reset_user # noqa: E501 + + Request reset user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_reset_user(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device user reset. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.process_reset_user_endpoint.call_with_http_info(**kwargs) + + def service_path( + self, + device_ip, + **kwargs + ): + """service_path # noqa: E501 + + Service path # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.service_path(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Service path parameter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.service_path_endpoint.call_with_http_info(**kwargs) + + def traceroute_device( + self, + device_ip, + **kwargs + ): + """traceroute_device # noqa: E501 + + Traceroute # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.traceroute_device(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Traceroute parameter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.traceroute_device_endpoint.call_with_http_info(**kwargs) + + def tunnel_path( + self, + device_ip, + **kwargs + ): + """tunnel_path # noqa: E501 + + TunnelPath # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tunnel_path(device_ip, async_req=True) + >>> result = thread.get() + + Args: + device_ip (str): Device IP + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): TunnelPath parameter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_ip'] = \ + device_ip + return self.tunnel_path_endpoint.call_with_http_info(**kwargs) + + def upload_admin_tech( + self, + **kwargs + ): + """upload_admin_tech # noqa: E501 + + upload admin tech to SR # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_admin_tech(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Admin tech upload request. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.upload_admin_tech_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/troubleshooting_tools_device_group_api.py b/openapi_client/api/troubleshooting_tools_device_group_api.py new file mode 100644 index 0000000..28bd12d --- /dev/null +++ b/openapi_client/api/troubleshooting_tools_device_group_api.py @@ -0,0 +1,695 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.vpnid import VPNID + + +class TroubleshootingToolsDeviceGroupApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.list_device_group_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/group', + 'operation_id': 'list_device_group_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_device_groups_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/group/device', + 'operation_id': 'list_device_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_group_devices_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/group/devices', + 'operation_id': 'list_group_devices', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'group_id', + 'ssh', + 'vpn_id', + ], + 'required': [ + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'group_id': + (str,), + 'ssh': + (bool,), + 'vpn_id': + ([VPNID],), + }, + 'attribute_map': { + 'group_id': 'groupId', + 'ssh': 'ssh', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'group_id': 'query', + 'ssh': 'query', + 'vpn_id': 'query', + }, + 'collection_format_map': { + 'vpn_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_group_devices_for_map_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/group/map/devices', + 'operation_id': 'list_group_devices_for_map', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'group_id', + 'vpn_id', + ], + 'required': [ + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'group_id': + (str,), + 'vpn_id': + ([VPNID],), + }, + 'attribute_map': { + 'group_id': 'groupId', + 'vpn_id': 'vpnId', + }, + 'location_map': { + 'group_id': 'query', + 'vpn_id': 'query', + }, + 'collection_format_map': { + 'vpn_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_group_links_for_map_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/group/map/devices/links', + 'operation_id': 'list_group_links_for_map', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'group_id', + ], + 'required': [ + 'group_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'group_id': + (str,), + }, + 'attribute_map': { + 'group_id': 'groupId', + }, + 'location_map': { + 'group_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def list_device_group_list( + self, + **kwargs + ): + """list_device_group_list # noqa: E501 + + Retrieve device group list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_device_group_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_device_group_list_endpoint.call_with_http_info(**kwargs) + + def list_device_groups( + self, + **kwargs + ): + """list_device_groups # noqa: E501 + + Retrieve device groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_device_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_device_groups_endpoint.call_with_http_info(**kwargs) + + def list_group_devices( + self, + group_id, + **kwargs + ): + """list_group_devices # noqa: E501 + + Retrieve devices in group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_group_devices(group_id, async_req=True) + >>> result = thread.get() + + Args: + group_id (str): Group Id + + Keyword Args: + ssh (bool): SSH. [optional] if omitted the server will use the default value of False + vpn_id ([VPNID]): VPN Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['group_id'] = \ + group_id + return self.list_group_devices_endpoint.call_with_http_info(**kwargs) + + def list_group_devices_for_map( + self, + group_id, + **kwargs + ): + """list_group_devices_for_map # noqa: E501 + + Retrieve group devices for map # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_group_devices_for_map(group_id, async_req=True) + >>> result = thread.get() + + Args: + group_id (str): Group Id + + Keyword Args: + vpn_id ([VPNID]): VPN Id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['group_id'] = \ + group_id + return self.list_group_devices_for_map_endpoint.call_with_http_info(**kwargs) + + def list_group_links_for_map( + self, + group_id, + **kwargs + ): + """list_group_links_for_map # noqa: E501 + + Retrieve devices in group for map # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_group_links_for_map(group_id, async_req=True) + >>> result = thread.get() + + Args: + group_id (str): Group Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['group_id'] = \ + group_id + return self.list_group_links_for_map_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/troubleshooting_tools_diagnostics_api.py b/openapi_client/api/troubleshooting_tools_diagnostics_api.py new file mode 100644 index 0000000..e8568e1 --- /dev/null +++ b/openapi_client/api/troubleshooting_tools_diagnostics_api.py @@ -0,0 +1,12029 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from openapi_client.model.device_uuid import DeviceUuid +from openapi_client.model.uuid import Uuid + + +class TroubleshootingToolsDiagnosticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.clear_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/sessions/clear/{sessionId}', + 'operation_id': 'clear_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (str,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.disable_device_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/disable/{sessionId}', + 'operation_id': 'disable_device_log', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.disable_packet_capture_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/disable/{sessionId}', + 'operation_id': 'disable_packet_capture_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.disable_speed_test_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/disable/{sessionId}', + 'operation_id': 'disable_speed_test_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_debug_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/download/{sessionId}', + 'operation_id': 'download_debug_log', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (str,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.download_file_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/download/{sessionId}', + 'operation_id': 'download_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/octet-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.force_stop_pcap_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/forcedisbale/{sessionId}', + 'operation_id': 'force_stop_pcap_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.form_post_packet_capture_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/{deviceUUID}/{sessionId}', + 'operation_id': 'form_post_packet_capture', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_uuid', + 'session_id', + ], + 'required': [ + 'device_uuid', + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_uuid': + (str,), + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'device_uuid': 'deviceUUID', + 'session_id': 'sessionId', + }, + 'location_map': { + 'device_uuid': 'path', + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + '*/*' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_agg_flow_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/aggFlow', + 'operation_id': 'get_agg_flow', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'trace_state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'trace_state': 'traceState', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'trace_state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/aggregation', + 'operation_id': 'get_aggregation_data_by_query27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_aggregation_data_by_query28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/aggregation', + 'operation_id': 'get_aggregation_data_by_query28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_qos_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/appQosData', + 'operation_id': 'get_app_qos_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'received_timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'received_timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'received_timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'received_timestamp': 'receivedTimestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'received_timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_app_qos_state_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/appQosState', + 'operation_id': 'get_app_qos_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'trace_state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'trace_state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'trace_state': 'traceState', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'trace_state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_concurrent_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/concurrentData', + 'operation_id': 'get_concurrent_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_concurrent_domain_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/concurrentDomainData', + 'operation_id': 'get_concurrent_domain_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/doccount', + 'operation_id': 'get_count29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/doccount', + 'operation_id': 'get_count30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [ + 'query', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_count_post29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/doccount', + 'operation_id': 'get_count_post29', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_count_post30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/doccount', + 'operation_id': 'get_count_post30', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_current_timestamp_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/currentTimestamp', + 'operation_id': 'get_current_timestamp', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_db_schema_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/diagnostics/dbschema', + 'operation_id': 'get_db_schema', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_device_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/{sessionId}', + 'operation_id': 'get_device_log', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + 'log_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + 'log_id': + (int,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + 'log_id': 'logId', + }, + 'location_map': { + 'session_id': 'path', + 'log_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_domain_metric_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/domainMetric', + 'operation_id': 'get_domain_metric', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'domain', + 'first_timestamp', + 'last_timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'domain', + 'first_timestamp', + 'last_timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'domain': + (str,), + 'first_timestamp': + (int,), + 'last_timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'domain': 'domain', + 'first_timestamp': 'firstTimestamp', + 'last_timestamp': 'lastTimestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'domain': 'query', + 'first_timestamp': 'query', + 'last_timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_app_hop_list_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventAppHopList', + 'operation_id': 'get_event_app_hop_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_app_score_bandwidth_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventAppScoreBandwidth', + 'operation_id': 'get_event_app_score_bandwidth', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + 'received_timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + 'received_timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + 'received_timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + 'received_timestamp': 'receivedTimestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + 'received_timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_flow_from_app_hop_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventFlowFromAppHop', + 'operation_id': 'get_event_flow_from_app_hop', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + 'application', + 'direction', + '_from', + 'to', + 'device_trace_id', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + 'application', + 'direction', + '_from', + 'to', + 'device_trace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + 'application': + (str,), + 'direction': + (str,), + '_from': + (str,), + 'to': + (str,), + 'device_trace_id': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + 'application': 'application', + 'direction': 'direction', + '_from': 'from', + 'to': 'to', + 'device_trace_id': 'deviceTraceId', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + 'application': 'query', + 'direction': 'query', + '_from': 'query', + 'to': 'query', + 'device_trace_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_event_readout_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/eventReadout', + 'operation_id': 'get_event_readout', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_file_download_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/status/{sessionId}', + 'operation_id': 'get_file_download_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_fin_flow_time_range_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/traceFinFlowTimeRange', + 'operation_id': 'get_fin_flow_time_range', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_finalized_data_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/finalizedData', + 'operation_id': 'get_finalized_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_finalized_domain_data_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/finalizedDomainData', + 'operation_id': 'get_finalized_domain_data', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_finalized_flow_count_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/traceFinFlowCount', + 'operation_id': 'get_finalized_flow_count', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_flow_detail_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/flowDetail', + 'operation_id': 'get_flow_detail', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'flow_id', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'flow_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'flow_id': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'flow_id': 'flowId', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'flow_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_flow_metric_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/flowMetric', + 'operation_id': 'get_flow_metric', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'flow_id', + 'first_timestamp', + 'last_timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'flow_id', + 'first_timestamp', + 'last_timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'flow_id': + (int,), + 'first_timestamp': + (int,), + 'last_timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'flow_id': 'flowId', + 'first_timestamp': 'firstTimestamp', + 'last_timestamp': 'lastTimestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'flow_id': 'query', + 'first_timestamp': 'query', + 'last_timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_interface_bandwidth_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/interface/bandwidth', + 'operation_id': 'get_interface_bandwidth', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'circuit', + 'device_uuid', + ], + 'required': [ + 'circuit', + 'device_uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'circuit': + (str,), + 'device_uuid': + (DeviceUuid,), + }, + 'attribute_map': { + 'circuit': 'circuit', + 'device_uuid': 'deviceUUID', + }, + 'location_map': { + 'circuit': 'query', + 'device_uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_log_type_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/type', + 'operation_id': 'get_log_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'uuid', + ], + 'required': [ + 'uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'uuid': + (str,), + }, + 'attribute_map': { + 'uuid': 'uuid', + }, + 'location_map': { + 'uuid': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_monitor_state_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/getMonitorState', + 'operation_id': 'get_monitor_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'state', + ], + 'required': [ + 'trace_id', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_nwpi_dscp_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/nwpiDSCP', + 'operation_id': 'get_nwpi_dscp', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_nwpi_nbar_app_group_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/nwpiNbarAppGroup', + 'operation_id': 'get_nwpi_nbar_app_group', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_nwpi_protocol_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/nwpiProtocol', + 'operation_id': 'get_nwpi_protocol', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_packet_features_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/packetFeatures', + 'operation_id': 'get_packet_features', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'flow_id', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'flow_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'flow_id': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'flow_id': 'flowId', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'flow_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query26', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_app_data_by_query27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/app-agg/aggregation', + 'operation_id': 'get_post_aggregation_app_data_by_query27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_aggregation_data_by_query28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/aggregation', + 'operation_id': 'get_post_aggregation_data_by_query28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/page', + 'operation_id': 'get_post_stat_bulk_raw_data27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_post_stat_bulk_raw_data28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/page', + 'operation_id': 'get_post_stat_bulk_raw_data28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'scroll_id', + 'count', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'scroll_id': + (str,), + 'count': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'scroll_id': 'query', + 'count': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_preload_info_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/preloadinfo', + 'operation_id': 'get_preload_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_routing_detail_from_local_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/routingDetail', + 'operation_id': 'get_routing_detail_from_local', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'trace_state', + 'route_prefixs', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'trace_state', + 'route_prefixs', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'trace_state': + (str,), + 'route_prefixs': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'trace_state': 'traceState', + 'route_prefixs': 'routePrefixs', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'trace_state': 'query', + 'route_prefixs': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed', + 'operation_id': 'get_session', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_session_info_capture_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture', + 'operation_id': 'get_session_info_capture', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_session_info_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log', + 'operation_id': 'get_session_info_log', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + (str,), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_sessions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/sessions', + 'operation_id': 'get_sessions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_speed_test_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/{sessionId}', + 'operation_id': 'get_speed_test', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + 'log_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + 'log_id': + (int,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + 'log_id': 'logId', + }, + 'location_map': { + 'session_id': 'path', + 'log_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_speed_test_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/status/{sessionId}', + 'operation_id': 'get_speed_test_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/page', + 'operation_id': 'get_stat_bulk_raw_data27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_bulk_raw_data28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/page', + 'operation_id': 'get_stat_bulk_raw_data28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'scroll_id', + 'count', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'scroll_id': + (str,), + 'count': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'scroll_id': 'scrollId', + 'count': 'count', + }, + 'location_map': { + 'query': 'query', + 'scroll_id': 'query', + 'count': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/fields', + 'operation_id': 'get_stat_data_fields29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_fields30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/fields', + 'operation_id': 'get_stat_data_fields30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data26_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi', + 'operation_id': 'get_stat_data_raw_data26', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest', + 'operation_id': 'get_stat_data_raw_data27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + 'page', + 'page_size', + 'sort_by', + 'sort_order', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + }, + 'attribute_map': { + 'query': 'query', + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'query': 'query', + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv27_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv27', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_data_raw_data_as_csv28_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/csv', + 'operation_id': 'get_stat_data_raw_data_as_csv28', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'query', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'query': + (str,), + }, + 'attribute_map': { + 'query': 'query', + }, + 'location_map': { + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/csv' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields29_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/query/fields', + 'operation_id': 'get_stat_query_fields29', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stat_query_fields30_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest/query/fields', + 'operation_id': 'get_stat_query_fields30', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_stats_raw_data27_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi', + 'operation_id': 'get_stats_raw_data27', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_stats_raw_data28_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/statistics/speedtest', + 'operation_id': 'get_stats_raw_data28', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'page', + 'page_size', + 'sort_by', + 'sort_order', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page': + (int,), + 'page_size': + (int,), + 'sort_by': + (str,), + 'sort_order': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'page': 'page', + 'page_size': 'pageSize', + 'sort_by': 'sortBy', + 'sort_order': 'sortOrder', + }, + 'location_map': { + 'page': 'query', + 'page_size': 'query', + 'sort_by': 'query', + 'sort_order': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_thread_pools_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/diagnostics/threadpools', + 'operation_id': 'get_thread_pools', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_trace_flow_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/traceFlow', + 'operation_id': 'get_trace_flow', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'required': [ + 'trace_id', + 'timestamp', + 'state', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'state': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'state': 'state', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'state': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_trace_history_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/traceHistory', + 'operation_id': 'get_trace_history', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_vnic_info_by_vnf_id_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/vnicsInfo/{vnfId}', + 'operation_id': 'get_vnic_info_by_vnf_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'vnf_id', + ], + 'required': [ + 'vnf_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'vnf_id': + (str,), + }, + 'attribute_map': { + 'vnf_id': 'vnfId', + }, + 'location_map': { + 'vnf_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.monitor_override_start_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/monitor/overrideStart', + 'operation_id': 'monitor_override_start', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.monitor_start_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/monitor/start', + 'operation_id': 'monitor_start', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.monitor_stop_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/monitor/stop', + 'operation_id': 'monitor_stop', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.nwpi_post_flow_data_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/trace/record/{deviceUUID}', + 'operation_id': 'nwpi_post_flow_data', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_uuid', + 'body', + ], + 'required': [ + 'device_uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_uuid': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'device_uuid': 'deviceUUID', + }, + 'location_map': { + 'device_uuid': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.process_device_status_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/status/{deviceUUID}', + 'operation_id': 'process_device_status', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_uuid', + 'body', + ], + 'required': [ + 'device_uuid', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_uuid': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'device_uuid': 'deviceUUID', + }, + 'location_map': { + 'device_uuid': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + '*/*' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.renew_session_info_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/renew/{sessionId}', + 'operation_id': 'renew_session_info', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_speed_test_results_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/{deviceUUID}/{sessionId}', + 'operation_id': 'save_speed_test_results', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'device_uuid', + 'session_id', + 'body', + ], + 'required': [ + 'device_uuid', + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'device_uuid': + (str,), + 'session_id': + (Uuid,), + 'body': + (str,), + }, + 'attribute_map': { + 'device_uuid': 'deviceUUID', + 'session_id': 'sessionId', + }, + 'location_map': { + 'device_uuid': 'path', + 'session_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + '*/*' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.search_device_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/search/{sessionId}', + 'operation_id': 'search_device_log', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + 'body', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.start_pcap_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/start/{sessionId}', + 'operation_id': 'start_pcap_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.start_speed_test_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/start/{sessionId}', + 'operation_id': 'start_speed_test', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.stop_pcap_session_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/capture/stop/{sessionId}', + 'operation_id': 'stop_pcap_session', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.stop_speed_test_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/speed/stop/{sessionId}', + 'operation_id': 'stop_speed_test', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'session_id', + ], + 'required': [ + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'session_id': + (Uuid,), + }, + 'attribute_map': { + 'session_id': 'sessionId', + }, + 'location_map': { + 'session_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.stream_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/log/{logType}/{deviceUUID}/{sessionId}', + 'operation_id': 'stream_log', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'log_type', + 'device_uuid', + 'session_id', + 'body', + ], + 'required': [ + 'log_type', + 'device_uuid', + 'session_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'log_type': + (str,), + 'device_uuid': + (str,), + 'session_id': + (str,), + 'body': + (str,), + }, + 'attribute_map': { + 'log_type': 'logType', + 'device_uuid': 'deviceUUID', + 'session_id': 'sessionId', + }, + 'location_map': { + 'log_type': 'path', + 'device_uuid': 'path', + 'session_id': 'path', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.trace_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/trace/delete', + 'operation_id': 'trace_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (str,), + 'timestamp': + (int,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.trace_fin_flow_with_query_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/traceFinFlowWithQuery', + 'operation_id': 'trace_fin_flow_with_query', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + 'timestamp', + 'query', + ], + 'required': [ + 'trace_id', + 'timestamp', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (int,), + 'timestamp': + (int,), + 'query': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + 'timestamp': 'timestamp', + 'query': 'query', + }, + 'location_map': { + 'trace_id': 'query', + 'timestamp': 'query', + 'query': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.trace_start_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/trace/start', + 'operation_id': 'trace_start', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.trace_stop_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/stream/device/nwpi/trace/stop/{traceId}', + 'operation_id': 'trace_stop', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'trace_id', + ], + 'required': [ + 'trace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'trace_id': + (str,), + }, + 'attribute_map': { + 'trace_id': 'traceId', + }, + 'location_map': { + 'trace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def clear_session( + self, + session_id, + **kwargs + ): + """clear_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.clear_session(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (str): Session Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.clear_session_endpoint.call_with_http_info(**kwargs) + + def disable_device_log( + self, + session_id, + **kwargs + ): + """disable_device_log # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disable_device_log(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.disable_device_log_endpoint.call_with_http_info(**kwargs) + + def disable_packet_capture_session( + self, + session_id, + **kwargs + ): + """disable_packet_capture_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disable_packet_capture_session(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.disable_packet_capture_session_endpoint.call_with_http_info(**kwargs) + + def disable_speed_test_session( + self, + session_id, + **kwargs + ): + """disable_speed_test_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.disable_speed_test_session(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.disable_speed_test_session_endpoint.call_with_http_info(**kwargs) + + def download_debug_log( + self, + session_id, + **kwargs + ): + """download_debug_log # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_debug_log(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (str): Session Id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.download_debug_log_endpoint.call_with_http_info(**kwargs) + + def download_file( + self, + session_id, + **kwargs + ): + """download_file # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_file(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.download_file_endpoint.call_with_http_info(**kwargs) + + def force_stop_pcap_session( + self, + session_id, + **kwargs + ): + """force_stop_pcap_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.force_stop_pcap_session(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.force_stop_pcap_session_endpoint.call_with_http_info(**kwargs) + + def form_post_packet_capture( + self, + device_uuid, + session_id, + **kwargs + ): + """form_post_packet_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.form_post_packet_capture(device_uuid, session_id, async_req=True) + >>> result = thread.get() + + Args: + device_uuid (str): + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_uuid'] = \ + device_uuid + kwargs['session_id'] = \ + session_id + return self.form_post_packet_capture_endpoint.call_with_http_info(**kwargs) + + def get_agg_flow( + self, + trace_id, + timestamp, + trace_state, + **kwargs + ): + """get_agg_flow # noqa: E501 + + Get aggregated flow data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_agg_flow(trace_id, timestamp, trace_state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + trace_state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['trace_state'] = \ + trace_state + return self.get_agg_flow_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query27( + self, + **kwargs + ): + """get_aggregation_data_by_query27 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query27_endpoint.call_with_http_info(**kwargs) + + def get_aggregation_data_by_query28( + self, + **kwargs + ): + """get_aggregation_data_by_query28 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_aggregation_data_by_query28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_aggregation_data_by_query28_endpoint.call_with_http_info(**kwargs) + + def get_app_qos_data( + self, + trace_id, + timestamp, + received_timestamp, + **kwargs + ): + """get_app_qos_data # noqa: E501 + + Get QoS Application data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_qos_data(trace_id, timestamp, received_timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + received_timestamp (int): received timestamp + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['received_timestamp'] = \ + received_timestamp + return self.get_app_qos_data_endpoint.call_with_http_info(**kwargs) + + def get_app_qos_state( + self, + trace_id, + timestamp, + trace_state, + **kwargs + ): + """get_app_qos_state # noqa: E501 + + Get QoS Application state to received timestamp mapping for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_app_qos_state(trace_id, timestamp, trace_state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + trace_state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['trace_state'] = \ + trace_state + return self.get_app_qos_state_endpoint.call_with_http_info(**kwargs) + + def get_concurrent_data( + self, + trace_id, + timestamp, + **kwargs + ): + """get_concurrent_data # noqa: E501 + + Get concurrent data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_concurrent_data(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_concurrent_data_endpoint.call_with_http_info(**kwargs) + + def get_concurrent_domain_data( + self, + trace_id, + timestamp, + **kwargs + ): + """get_concurrent_domain_data # noqa: E501 + + Get concurrent domain data for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_concurrent_domain_data(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_concurrent_domain_data_endpoint.call_with_http_info(**kwargs) + + def get_count29( + self, + query, + **kwargs + ): + """get_count29 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count29(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count29_endpoint.call_with_http_info(**kwargs) + + def get_count30( + self, + query, + **kwargs + ): + """get_count30 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count30(query, async_req=True) + >>> result = thread.get() + + Args: + query (str): Query + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['query'] = \ + query + return self.get_count30_endpoint.call_with_http_info(**kwargs) + + def get_count_post29( + self, + **kwargs + ): + """get_count_post29 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post29_endpoint.call_with_http_info(**kwargs) + + def get_count_post30( + self, + **kwargs + ): + """get_count_post30 # noqa: E501 + + Get response count of a query # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_count_post30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Query. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_count_post30_endpoint.call_with_http_info(**kwargs) + + def get_current_timestamp( + self, + **kwargs + ): + """get_current_timestamp # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_current_timestamp(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_current_timestamp_endpoint.call_with_http_info(**kwargs) + + def get_db_schema( + self, + **kwargs + ): + """get_db_schema # noqa: E501 + + Get the current database schema # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_db_schema(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_db_schema_endpoint.call_with_http_info(**kwargs) + + def get_device_log( + self, + session_id, + **kwargs + ): + """get_device_log # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_device_log(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + log_id (int): [optional] if omitted the server will use the default value of -1 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.get_device_log_endpoint.call_with_http_info(**kwargs) + + def get_domain_metric( + self, + trace_id, + timestamp, + domain, + first_timestamp, + last_timestamp, + **kwargs + ): + """get_domain_metric # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_domain_metric(trace_id, timestamp, domain, first_timestamp, last_timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + domain (str): domain name + first_timestamp (int): first timestamp of xAxis + last_timestamp (int): last timestamp of xAxis + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['domain'] = \ + domain + kwargs['first_timestamp'] = \ + first_timestamp + kwargs['last_timestamp'] = \ + last_timestamp + return self.get_domain_metric_endpoint.call_with_http_info(**kwargs) + + def get_event_app_hop_list( + self, + trace_id, + timestamp, + state, + **kwargs + ): + """get_event_app_hop_list # noqa: E501 + + Get Trace Application and HopList for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_app_hop_list(trace_id, timestamp, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + return self.get_event_app_hop_list_endpoint.call_with_http_info(**kwargs) + + def get_event_app_score_bandwidth( + self, + trace_id, + timestamp, + state, + received_timestamp, + **kwargs + ): + """get_event_app_score_bandwidth # noqa: E501 + + Get Trace Event Application Performance Score and Bandwidth for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_app_score_bandwidth(trace_id, timestamp, state, received_timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + received_timestamp (int): received timestamp + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + kwargs['received_timestamp'] = \ + received_timestamp + return self.get_event_app_score_bandwidth_endpoint.call_with_http_info(**kwargs) + + def get_event_flow_from_app_hop( + self, + trace_id, + timestamp, + state, + application, + direction, + _from, + to, + device_trace_id, + **kwargs + ): + """get_event_flow_from_app_hop # noqa: E501 + + Get Trace Event Flow From Application And Hop for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_flow_from_app_hop(trace_id, timestamp, state, application, direction, _from, to, device_trace_id, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + application (str): app name + direction (str): direction + _from (str): from + to (str): to + device_trace_id (int): deviceTraceId + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + kwargs['application'] = \ + application + kwargs['direction'] = \ + direction + kwargs['_from'] = \ + _from + kwargs['to'] = \ + to + kwargs['device_trace_id'] = \ + device_trace_id + return self.get_event_flow_from_app_hop_endpoint.call_with_http_info(**kwargs) + + def get_event_readout( + self, + trace_id, + timestamp, + state, + **kwargs + ): + """get_event_readout # noqa: E501 + + Get Trace Event Readout for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_event_readout(trace_id, timestamp, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + return self.get_event_readout_endpoint.call_with_http_info(**kwargs) + + def get_file_download_status( + self, + session_id, + **kwargs + ): + """get_file_download_status # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_file_download_status(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.get_file_download_status_endpoint.call_with_http_info(**kwargs) + + def get_fin_flow_time_range( + self, + trace_id, + timestamp, + state, + **kwargs + ): + """get_fin_flow_time_range # noqa: E501 + + Retrieve Fin Flow time range # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fin_flow_time_range(trace_id, timestamp, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + return self.get_fin_flow_time_range_endpoint.call_with_http_info(**kwargs) + + def get_finalized_data( + self, + trace_id, + timestamp, + **kwargs + ): + """get_finalized_data # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_finalized_data(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_finalized_data_endpoint.call_with_http_info(**kwargs) + + def get_finalized_domain_data( + self, + trace_id, + timestamp, + **kwargs + ): + """get_finalized_domain_data # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_finalized_domain_data(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_finalized_domain_data_endpoint.call_with_http_info(**kwargs) + + def get_finalized_flow_count( + self, + trace_id, + timestamp, + **kwargs + ): + """get_finalized_flow_count # noqa: E501 + + Retrieve total Fin Flow counts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_finalized_flow_count(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.get_finalized_flow_count_endpoint.call_with_http_info(**kwargs) + + def get_flow_detail( + self, + trace_id, + timestamp, + flow_id, + **kwargs + ): + """get_flow_detail # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_flow_detail(trace_id, timestamp, flow_id, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + flow_id (int): flow id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['flow_id'] = \ + flow_id + return self.get_flow_detail_endpoint.call_with_http_info(**kwargs) + + def get_flow_metric( + self, + trace_id, + timestamp, + flow_id, + first_timestamp, + last_timestamp, + **kwargs + ): + """get_flow_metric # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_flow_metric(trace_id, timestamp, flow_id, first_timestamp, last_timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + flow_id (int): flow id + first_timestamp (int): first timestamp of xAxis + last_timestamp (int): last timestamp of xAxis + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['flow_id'] = \ + flow_id + kwargs['first_timestamp'] = \ + first_timestamp + kwargs['last_timestamp'] = \ + last_timestamp + return self.get_flow_metric_endpoint.call_with_http_info(**kwargs) + + def get_interface_bandwidth( + self, + circuit, + device_uuid, + **kwargs + ): + """get_interface_bandwidth # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_interface_bandwidth(circuit, device_uuid, async_req=True) + >>> result = thread.get() + + Args: + circuit (str): + device_uuid (DeviceUuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['circuit'] = \ + circuit + kwargs['device_uuid'] = \ + device_uuid + return self.get_interface_bandwidth_endpoint.call_with_http_info(**kwargs) + + def get_log_type( + self, + uuid, + **kwargs + ): + """get_log_type # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_log_type(uuid, async_req=True) + >>> result = thread.get() + + Args: + uuid (str): Device uuid + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['uuid'] = \ + uuid + return self.get_log_type_endpoint.call_with_http_info(**kwargs) + + def get_monitor_state( + self, + trace_id, + state, + **kwargs + ): + """get_monitor_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_monitor_state(trace_id, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['state'] = \ + state + return self.get_monitor_state_endpoint.call_with_http_info(**kwargs) + + def get_nwpi_dscp( + self, + **kwargs + ): + """get_nwpi_dscp # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_nwpi_dscp(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_nwpi_dscp_endpoint.call_with_http_info(**kwargs) + + def get_nwpi_nbar_app_group( + self, + **kwargs + ): + """get_nwpi_nbar_app_group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_nwpi_nbar_app_group(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_nwpi_nbar_app_group_endpoint.call_with_http_info(**kwargs) + + def get_nwpi_protocol( + self, + **kwargs + ): + """get_nwpi_protocol # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_nwpi_protocol(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_nwpi_protocol_endpoint.call_with_http_info(**kwargs) + + def get_packet_features( + self, + trace_id, + timestamp, + flow_id, + **kwargs + ): + """get_packet_features # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_packet_features(trace_id, timestamp, flow_id, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + flow_id (int): flow id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['flow_id'] = \ + flow_id + return self.get_packet_features_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query26( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query26 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query26_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_app_data_by_query27( + self, + **kwargs + ): + """get_post_aggregation_app_data_by_query27 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_app_data_by_query27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_app_data_by_query27_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query27( + self, + **kwargs + ): + """get_post_aggregation_data_by_query27 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query27_endpoint.call_with_http_info(**kwargs) + + def get_post_aggregation_data_by_query28( + self, + **kwargs + ): + """get_post_aggregation_data_by_query28 # noqa: E501 + + Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_aggregation_data_by_query28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_aggregation_data_by_query28_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data27( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data27 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data27_endpoint.call_with_http_info(**kwargs) + + def get_post_stat_bulk_raw_data28( + self, + **kwargs + ): + """get_post_stat_bulk_raw_data28 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_post_stat_bulk_raw_data28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_post_stat_bulk_raw_data28_endpoint.call_with_http_info(**kwargs) + + def get_preload_info( + self, + **kwargs + ): + """get_preload_info # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_preload_info(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_preload_info_endpoint.call_with_http_info(**kwargs) + + def get_routing_detail_from_local( + self, + trace_id, + timestamp, + trace_state, + route_prefixs, + **kwargs + ): + """get_routing_detail_from_local # noqa: E501 + + Get Routing Details for NWPI. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_routing_detail_from_local(trace_id, timestamp, trace_state, route_prefixs, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + trace_state (str): trace state + route_prefixs (str): route prefixs + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['trace_state'] = \ + trace_state + kwargs['route_prefixs'] = \ + route_prefixs + return self.get_routing_detail_from_local_endpoint.call_with_http_info(**kwargs) + + def get_session( + self, + **kwargs + ): + """get_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_session(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_session_endpoint.call_with_http_info(**kwargs) + + def get_session_info_capture( + self, + **kwargs + ): + """get_session_info_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_session_info_capture(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_session_info_capture_endpoint.call_with_http_info(**kwargs) + + def get_session_info_log( + self, + **kwargs + ): + """get_session_info_log # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_session_info_log(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_session_info_log_endpoint.call_with_http_info(**kwargs) + + def get_sessions( + self, + **kwargs + ): + """get_sessions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_sessions(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_sessions_endpoint.call_with_http_info(**kwargs) + + def get_speed_test( + self, + session_id, + **kwargs + ): + """get_speed_test # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_speed_test(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + log_id (int): [optional] if omitted the server will use the default value of 0 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.get_speed_test_endpoint.call_with_http_info(**kwargs) + + def get_speed_test_status( + self, + session_id, + **kwargs + ): + """get_speed_test_status # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_speed_test_status(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.get_speed_test_status_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data27( + self, + **kwargs + ): + """get_stat_bulk_raw_data27 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data27_endpoint.call_with_http_info(**kwargs) + + def get_stat_bulk_raw_data28( + self, + **kwargs + ): + """get_stat_bulk_raw_data28 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_bulk_raw_data28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + scroll_id (str): ES scroll Id. [optional] + count (str): Result size. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_bulk_raw_data28_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields29( + self, + **kwargs + ): + """get_stat_data_fields29 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields29_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_fields30( + self, + **kwargs + ): + """get_stat_data_fields30 # noqa: E501 + + Get fields and type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_fields30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_fields30_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data26( + self, + **kwargs + ): + """get_stat_data_raw_data26 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data26(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data26_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data27( + self, + **kwargs + ): + """get_stat_data_raw_data27 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by(emp:entry_time). [optional] + sort_order (str): sort order(emp:asc、ASC、Asc、desc、Desc、DESC). [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data27_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv27( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv27 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv27_endpoint.call_with_http_info(**kwargs) + + def get_stat_data_raw_data_as_csv28( + self, + **kwargs + ): + """get_stat_data_raw_data_as_csv28 # noqa: E501 + + Get raw data with optional query as CSV # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_data_raw_data_as_csv28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + query (str): Query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_data_raw_data_as_csv28_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields29( + self, + **kwargs + ): + """get_stat_query_fields29 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields29(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields29_endpoint.call_with_http_info(**kwargs) + + def get_stat_query_fields30( + self, + **kwargs + ): + """get_stat_query_fields30 # noqa: E501 + + Get query fields # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stat_query_fields30(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stat_query_fields30_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data27( + self, + **kwargs + ): + """get_stats_raw_data27 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data27(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data27_endpoint.call_with_http_info(**kwargs) + + def get_stats_raw_data28( + self, + **kwargs + ): + """get_stats_raw_data28 # noqa: E501 + + Get stats raw data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_stats_raw_data28(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page (int): page number. [optional] + page_size (int): page size. [optional] + sort_by (str): sort by. [optional] + sort_order (str): sort order. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Stats query string. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_stats_raw_data28_endpoint.call_with_http_info(**kwargs) + + def get_thread_pools( + self, + **kwargs + ): + """get_thread_pools # noqa: E501 + + Get information on the threadpools # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_thread_pools(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_thread_pools_endpoint.call_with_http_info(**kwargs) + + def get_trace_flow( + self, + trace_id, + timestamp, + state, + **kwargs + ): + """get_trace_flow # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_trace_flow(trace_id, timestamp, state, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + state (str): trace state + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + kwargs['state'] = \ + state + return self.get_trace_flow_endpoint.call_with_http_info(**kwargs) + + def get_trace_history( + self, + **kwargs + ): + """get_trace_history # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_trace_history(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_trace_history_endpoint.call_with_http_info(**kwargs) + + def get_vnic_info_by_vnf_id( + self, + vnf_id, + **kwargs + ): + """get_vnic_info_by_vnf_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_vnic_info_by_vnf_id(vnf_id, async_req=True) + >>> result = thread.get() + + Args: + vnf_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['vnf_id'] = \ + vnf_id + return self.get_vnic_info_by_vnf_id_endpoint.call_with_http_info(**kwargs) + + def monitor_override_start( + self, + **kwargs + ): + """monitor_override_start # noqa: E501 + + CXP Monitor Action - Override Start # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.monitor_override_start(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.monitor_override_start_endpoint.call_with_http_info(**kwargs) + + def monitor_start( + self, + **kwargs + ): + """monitor_start # noqa: E501 + + CXP Monitor Action - Start # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.monitor_start(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.monitor_start_endpoint.call_with_http_info(**kwargs) + + def monitor_stop( + self, + **kwargs + ): + """monitor_stop # noqa: E501 + + CXP Monitor Action - Stop # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.monitor_stop(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.monitor_stop_endpoint.call_with_http_info(**kwargs) + + def nwpi_post_flow_data( + self, + device_uuid, + **kwargs + ): + """nwpi_post_flow_data # noqa: E501 + + post flow data # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.nwpi_post_flow_data(device_uuid, async_req=True) + >>> result = thread.get() + + Args: + device_uuid (str): + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_uuid'] = \ + device_uuid + return self.nwpi_post_flow_data_endpoint.call_with_http_info(**kwargs) + + def process_device_status( + self, + device_uuid, + **kwargs + ): + """process_device_status # noqa: E501 + + Get device status stream # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_device_status(device_uuid, async_req=True) + >>> result = thread.get() + + Args: + device_uuid (str): Device uuid + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_uuid'] = \ + device_uuid + return self.process_device_status_endpoint.call_with_http_info(**kwargs) + + def renew_session_info( + self, + session_id, + **kwargs + ): + """renew_session_info # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.renew_session_info(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.renew_session_info_endpoint.call_with_http_info(**kwargs) + + def save_speed_test_results( + self, + device_uuid, + session_id, + **kwargs + ): + """save_speed_test_results # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_speed_test_results(device_uuid, session_id, async_req=True) + >>> result = thread.get() + + Args: + device_uuid (str): + session_id (Uuid): + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['device_uuid'] = \ + device_uuid + kwargs['session_id'] = \ + session_id + return self.save_speed_test_results_endpoint.call_with_http_info(**kwargs) + + def search_device_log( + self, + session_id, + **kwargs + ): + """search_device_log # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_device_log(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (str): Session Id + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.search_device_log_endpoint.call_with_http_info(**kwargs) + + def start_pcap_session( + self, + session_id, + **kwargs + ): + """start_pcap_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.start_pcap_session(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.start_pcap_session_endpoint.call_with_http_info(**kwargs) + + def start_speed_test( + self, + session_id, + **kwargs + ): + """start_speed_test # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.start_speed_test(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.start_speed_test_endpoint.call_with_http_info(**kwargs) + + def stop_pcap_session( + self, + session_id, + **kwargs + ): + """stop_pcap_session # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stop_pcap_session(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.stop_pcap_session_endpoint.call_with_http_info(**kwargs) + + def stop_speed_test( + self, + session_id, + **kwargs + ): + """stop_speed_test # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stop_speed_test(session_id, async_req=True) + >>> result = thread.get() + + Args: + session_id (Uuid): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['session_id'] = \ + session_id + return self.stop_speed_test_endpoint.call_with_http_info(**kwargs) + + def stream_log( + self, + log_type, + device_uuid, + session_id, + **kwargs + ): + """stream_log # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stream_log(log_type, device_uuid, session_id, async_req=True) + >>> result = thread.get() + + Args: + log_type (str): Log type + device_uuid (str): Device uuid + session_id (str): Session Id + + Keyword Args: + body (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['log_type'] = \ + log_type + kwargs['device_uuid'] = \ + device_uuid + kwargs['session_id'] = \ + session_id + return self.stream_log_endpoint.call_with_http_info(**kwargs) + + def trace_delete( + self, + trace_id, + timestamp, + **kwargs + ): + """trace_delete # noqa: E501 + + Trace Action - Delete # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trace_delete(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (str): trace id + timestamp (int): start time + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.trace_delete_endpoint.call_with_http_info(**kwargs) + + def trace_fin_flow_with_query( + self, + trace_id, + timestamp, + **kwargs + ): + """trace_fin_flow_with_query # noqa: E501 + + Retrieve Certain Fin Flows # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trace_fin_flow_with_query(trace_id, timestamp, async_req=True) + >>> result = thread.get() + + Args: + trace_id (int): trace id + timestamp (int): start time + + Keyword Args: + query (str): Query filter. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + kwargs['timestamp'] = \ + timestamp + return self.trace_fin_flow_with_query_endpoint.call_with_http_info(**kwargs) + + def trace_start( + self, + **kwargs + ): + """trace_start # noqa: E501 + + Trace Action - Start # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trace_start(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.trace_start_endpoint.call_with_http_info(**kwargs) + + def trace_stop( + self, + trace_id, + **kwargs + ): + """trace_stop # noqa: E501 + + Trace Action - Stop # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.trace_stop(trace_id, async_req=True) + >>> result = thread.get() + + Args: + trace_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['trace_id'] = \ + trace_id + return self.trace_stop_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/umbrella_api.py b/openapi_client/api/umbrella_api.py new file mode 100644 index 0000000..2afa6df --- /dev/null +++ b/openapi_client/api/umbrella_api.py @@ -0,0 +1,510 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class UmbrellaApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_keys_from_umbrella_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/umbrella/getkeys', + 'operation_id': 'get_all_keys_from_umbrella', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_management_keys_from_umbrella_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/umbrella/getkeys/management', + 'operation_id': 'get_management_keys_from_umbrella', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_network_keys_from_umbrella_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/umbrella/getkeys/networkdevices', + 'operation_id': 'get_network_keys_from_umbrella', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_reporting_keys_from_umbrella_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/umbrella/getkeys/reporting', + 'operation_id': 'get_reporting_keys_from_umbrella', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def get_all_keys_from_umbrella( + self, + **kwargs + ): + """get_all_keys_from_umbrella # noqa: E501 + + Get keys from Umbrella # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_keys_from_umbrella(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_keys_from_umbrella_endpoint.call_with_http_info(**kwargs) + + def get_management_keys_from_umbrella( + self, + **kwargs + ): + """get_management_keys_from_umbrella # noqa: E501 + + Get management keys from Umbrella # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_management_keys_from_umbrella(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_management_keys_from_umbrella_endpoint.call_with_http_info(**kwargs) + + def get_network_keys_from_umbrella( + self, + **kwargs + ): + """get_network_keys_from_umbrella # noqa: E501 + + Get network devices keys from Umbrella # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_network_keys_from_umbrella(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_network_keys_from_umbrella_endpoint.call_with_http_info(**kwargs) + + def get_reporting_keys_from_umbrella( + self, + **kwargs + ): + """get_reporting_keys_from_umbrella # noqa: E501 + + Get reporting keys from Umbrella # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_reporting_keys_from_umbrella(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_reporting_keys_from_umbrella_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/utility_configuration_db_api.py b/openapi_client/api/utility_configuration_db_api.py new file mode 100644 index 0000000..ce1bb82 --- /dev/null +++ b/openapi_client/api/utility_configuration_db_api.py @@ -0,0 +1,158 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class UtilityConfigurationDBApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_db_size_on_file_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/util/configdb/size', + 'operation_id': 'get_db_size_on_file', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_db_size_on_file( + self, + **kwargs + ): + """get_db_size_on_file # noqa: E501 + + Fetches the disk usage by configuration-db # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_db_size_on_file(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_db_size_on_file_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/utility_logging_api.py b/openapi_client/api/utility_logging_api.py new file mode 100644 index 0000000..8327555 --- /dev/null +++ b/openapi_client/api/utility_logging_api.py @@ -0,0 +1,688 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class UtilityLoggingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.debug_log_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/util/logging/debuglog', + 'operation_id': 'debug_log', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'logger_name', + 'log_message', + ], + 'required': [ + 'logger_name', + 'log_message', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'logger_name': + (str,), + 'log_message': + (str,), + }, + 'attribute_map': { + 'logger_name': 'loggerName', + 'log_message': 'logMessage', + }, + 'location_map': { + 'logger_name': 'form', + 'log_message': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/x-www-form-urlencoded' + ] + }, + api_client=api_client + ) + self.list_log_file_details_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/util/logfile/appserver', + 'operation_id': 'list_log_file_details', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_loggers_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/util/logging/loggers', + 'operation_id': 'list_loggers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_v_manage_server_log_last_n_lines_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [], + 'endpoint_path': '/util/logfile/appserver/lastnlines', + 'operation_id': 'list_v_manage_server_log_last_n_lines', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'lines', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'lines': + (int,), + }, + 'attribute_map': { + 'lines': 'lines', + }, + 'location_map': { + 'lines': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.set_log_level_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/util/logging/level', + 'operation_id': 'set_log_level', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'logger_name', + 'log_level', + ], + 'required': [ + 'logger_name', + 'log_level', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'logger_name': + (str,), + 'log_level': + (str,), + }, + 'attribute_map': { + 'logger_name': 'loggerName', + 'log_level': 'logLevel', + }, + 'location_map': { + 'logger_name': 'form', + 'log_level': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/x-www-form-urlencoded' + ] + }, + api_client=api_client + ) + + def debug_log( + self, + logger_name, + log_message, + **kwargs + ): + """debug_log # noqa: E501 + + Test whether logging works # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.debug_log(logger_name, log_message, async_req=True) + >>> result = thread.get() + + Args: + logger_name (str): + log_message (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['logger_name'] = \ + logger_name + kwargs['log_message'] = \ + log_message + return self.debug_log_endpoint.call_with_http_info(**kwargs) + + def list_log_file_details( + self, + **kwargs + ): + """list_log_file_details # noqa: E501 + + Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_log_file_details(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_log_file_details_endpoint.call_with_http_info(**kwargs) + + def list_loggers( + self, + **kwargs + ): + """list_loggers # noqa: E501 + + List loggers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_loggers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_loggers_endpoint.call_with_http_info(**kwargs) + + def list_v_manage_server_log_last_n_lines( + self, + **kwargs + ): + """list_v_manage_server_log_last_n_lines # noqa: E501 + + List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_v_manage_server_log_last_n_lines(async_req=True) + >>> result = thread.get() + + + Keyword Args: + lines (int): Number of lines. [optional] if omitted the server will use the default value of 100 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.list_v_manage_server_log_last_n_lines_endpoint.call_with_http_info(**kwargs) + + def set_log_level( + self, + logger_name, + log_level, + **kwargs + ): + """set_log_level # noqa: E501 + + Set log level for logger # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_log_level(logger_name, log_level, async_req=True) + >>> result = thread.get() + + Args: + logger_name (str): + log_level (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['logger_name'] = \ + logger_name + kwargs['log_level'] = \ + log_level + return self.set_log_level_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/utility_security_api.py b/openapi_client/api/utility_security_api.py new file mode 100644 index 0000000..84d1f95 --- /dev/null +++ b/openapi_client/api/utility_security_api.py @@ -0,0 +1,165 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class UtilitySecurityApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.check_given_ip_list_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/software/compliance/ip/origin/check', + 'operation_id': 'check_given_ip_list', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def check_given_ip_list( + self, + **kwargs + ): + """check_given_ip_list # noqa: E501 + + Block IP based on list # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.check_given_ip_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Device detail. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.check_given_ip_list_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api/workflow_management_api.py b/openapi_client/api/workflow_management_api.py new file mode 100644 index 0000000..b46f4b8 --- /dev/null +++ b/openapi_client/api/workflow_management_api.py @@ -0,0 +1,559 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class WorkflowManagementApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_workflow_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/workflow', + 'operation_id': 'create_workflow', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.delete_workflow_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/workflow', + 'operation_id': 'delete_workflow', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'query', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.get_workflows_endpoint = _Endpoint( + settings={ + 'response_type': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + 'auth': [], + 'endpoint_path': '/workflow', + 'operation_id': 'get_workflows', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'id', + 'group_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'type': + (str,), + 'id': + (str,), + 'group_id': + (str,), + }, + 'attribute_map': { + 'type': 'type', + 'id': 'id', + 'group_id': 'group-id', + }, + 'location_map': { + 'type': 'query', + 'id': 'query', + 'group_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.save_workflow_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/workflow', + 'operation_id': 'save_workflow', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'body', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'body': + ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + }, + 'attribute_map': { + }, + 'location_map': { + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def create_workflow( + self, + **kwargs + ): + """create_workflow # noqa: E501 + + Creates a workflow in the system # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_workflow(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Request to create workflow with given user context. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.create_workflow_endpoint.call_with_http_info(**kwargs) + + def delete_workflow( + self, + **kwargs + ): + """delete_workflow # noqa: E501 + + Deletes the workflow # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_workflow(async_req=True) + >>> result = thread.get() + + + Keyword Args: + id (str): Workflow id. [optional] + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Request to delete the workflow. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.delete_workflow_endpoint.call_with_http_info(**kwargs) + + def get_workflows( + self, + **kwargs + ): + """get_workflows # noqa: E501 + + List all workflows for the given tenant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_workflows(async_req=True) + >>> result = thread.get() + + + Keyword Args: + type (str): Workflow type. [optional] + id (str): Workflow id. [optional] + group_id (str): group id. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_workflows_endpoint.call_with_http_info(**kwargs) + + def save_workflow( + self, + **kwargs + ): + """save_workflow # noqa: E501 + + Saves the workflow # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.save_workflow(async_req=True) + >>> result = thread.get() + + + Keyword Args: + body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Request to save already created workflow with given user context. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.save_workflow_endpoint.call_with_http_info(**kwargs) + diff --git a/openapi_client/api_client.py b/openapi_client/api_client.py new file mode 100644 index 0000000..7b13c99 --- /dev/null +++ b/openapi_client/api_client.py @@ -0,0 +1,897 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import json +import atexit +import mimetypes +from multiprocessing.pool import ThreadPool +import io +import os +import re +import typing +from urllib.parse import quote +from urllib3.fields import RequestField + + +from openapi_client import rest +from openapi_client.configuration import Configuration +from openapi_client.exceptions import ApiTypeError, ApiValueError, ApiException +from openapi_client.model_utils import ( + ModelNormal, + ModelSimple, + ModelComposed, + check_allowed_values, + check_validations, + date, + datetime, + deserialize_file, + file_type, + model_to_dict, + none_type, + validate_and_convert_types +) + + +class ApiClient(object): + """Generic API client for OpenAPI client library builds. + + OpenAPI generic API client. This client handles the client- + server communication, and is invariant across implementations. Specifics of + the methods and models for each application are generated from the OpenAPI + templates. + + NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + :param pool_threads: The number of threads to use for async requests + to the API. More threads means more concurrent API requests. + """ + + _pool = None + + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1): + if configuration is None: + configuration = Configuration.get_default_copy() + self.configuration = configuration + self.pool_threads = pool_threads + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = 'OpenAPI-Generator/1.0.0/python' + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.close() + + def close(self): + if self._pool: + self._pool.close() + self._pool.join() + self._pool = None + if hasattr(atexit, 'unregister'): + atexit.unregister(self.close) + + @property + def pool(self): + """Create thread pool on first request + avoids instantiating unused threadpool for blocking clients. + """ + if self._pool is None: + atexit.register(self.close) + self._pool = ThreadPool(self.pool_threads) + return self._pool + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + def __call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _content_type: typing.Optional[str] = None, + _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None + ): + + config = self.configuration + + # header parameters + header_params = header_params or {} + header_params.update(self.default_headers) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict(self.parameters_to_tuples(header_params, + collection_formats)) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples(path_params, + collection_formats) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + query_params = self.parameters_to_tuples(query_params, + collection_formats) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples(post_params, + collection_formats) + post_params.extend(self.files_parameters(files)) + if header_params['Content-Type'].startswith("multipart"): + post_params = self.parameters_to_multipart(post_params, + (dict)) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # auth setting + self.update_params_for_auth(header_params, query_params, + auth_settings, resource_path, method, body, + request_auths=_request_auths) + + # request url + if _host is None: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + try: + # perform request and return response + response_data = self.request( + method, url, query_params=query_params, headers=header_params, + post_params=post_params, body=body, + _preload_content=_preload_content, + _request_timeout=_request_timeout) + except ApiException as e: + e.body = e.body.decode('utf-8') + raise e + + self.last_response = response_data + + return_data = response_data + + if not _preload_content: + return (return_data) + return return_data + + # deserialize response data + if response_type: + if response_type != (file_type,): + encoding = "utf-8" + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) + if match: + encoding = match.group(1) + response_data.data = response_data.data.decode(encoding) + + return_data = self.deserialize( + response_data, + response_type, + _check_type + ) + else: + return_data = None + + if _return_http_data_only: + return (return_data) + else: + return (return_data, response_data.status, + response_data.getheaders()) + + def parameters_to_multipart(self, params, collection_types): + """Get parameters as list of tuples, formatting as json if value is collection_types + + :param params: Parameters as list of two-tuples + :param dict collection_types: Parameter collection types + :return: Parameters as list of tuple or urllib3.fields.RequestField + """ + new_params = [] + if collection_types is None: + collection_types = (dict) + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if isinstance( + v, collection_types): # v is instance of collection_type, formatting as application/json + v = json.dumps(v, ensure_ascii=False).encode("utf-8") + field = RequestField(k, v) + field.make_multipart(content_type="application/json; charset=utf-8") + new_params.append(field) + else: + new_params.append((k, v)) + return new_params + + @classmethod + def sanitize_for_serialization(cls, obj): + """Prepares data for transmission before it is sent with the rest client + If obj is None, return None. + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + If obj is io.IOBase, return the bytes + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if isinstance(obj, (ModelNormal, ModelComposed)): + return { + key: cls.sanitize_for_serialization(val) for key, + val in model_to_dict( + obj, + serialize=True).items()} + elif isinstance(obj, io.IOBase): + return cls.get_file_data_and_close_file(obj) + elif isinstance(obj, (str, int, float, none_type, bool)): + return obj + elif isinstance(obj, (datetime, date)): + return obj.isoformat() + elif isinstance(obj, ModelSimple): + return cls.sanitize_for_serialization(obj.value) + elif isinstance(obj, (list, tuple)): + return [cls.sanitize_for_serialization(item) for item in obj] + if isinstance(obj, dict): + return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} + raise ApiValueError( + 'Unable to prepare type {} for serialization'.format( + obj.__class__.__name__)) + + def deserialize(self, response, response_type, _check_type): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param _check_type: boolean, whether to check the types of the data + received from the server + :type _check_type: bool + + :return: deserialized object. + """ + # handle file downloading + # save response body into a tmp file and return the instance + if response_type == (file_type,): + content_disposition = response.getheader("Content-Disposition") + return deserialize_file(response.data, self.configuration, + content_disposition=content_disposition) + + # fetch data from response object + try: + received_data = json.loads(response.data) + except ValueError: + received_data = response.data + + # store our data under the key of 'received_data' so users have some + # context if they are deserializing a string and the data type is wrong + deserialized_data = validate_and_convert_types( + received_data, + response_type, + ['received_data'], + True, + _check_type, + configuration=self.configuration + ) + return deserialized_data + + def call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + async_req: typing.Optional[bool] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None + ): + """Makes the HTTP request (synchronous) and returns deserialized data. + + To make an async_req request, set the async_req parameter. + + :param resource_path: Path to method endpoint. + :param method: Method to call. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param files: key -> field name, value -> a list of open file + objects for `multipart/form-data`. + :type files: dict + :param async_req bool: execute request asynchronously + :type async_req: bool, optional + :param _return_http_data_only: response data without head status code + and headers + :type _return_http_data_only: bool, optional + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :type collection_formats: dict, optional + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :type _preload_content: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _check_type: boolean describing if the data back from the server + should have its type checked. + :type _check_type: bool, optional + :param _request_auths: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auths: list, optional + :return: + If async_req parameter is True, + the request will be called asynchronously. + The method will return the request thread. + If parameter async_req is False or missing, + then the method will return the response directly. + """ + if not async_req: + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, + _preload_content, _request_timeout, _host, + _check_type, _request_auths=_request_auths) + + return self.pool.apply_async(self.__call_api, (resource_path, + method, path_params, + query_params, + header_params, body, + post_params, files, + response_type, + auth_settings, + _return_http_data_only, + collection_formats, + _preload_content, + _request_timeout, + _host, _check_type, None, _request_auths)) + + def request(self, method, url, query_params=None, headers=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + """Makes the HTTP request using RESTClient.""" + if method == "GET": + return self.rest_client.GET(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "HEAD": + return self.rest_client.HEAD(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "OPTIONS": + return self.rest_client.OPTIONS(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "POST": + return self.rest_client.POST(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PUT": + return self.rest_client.PUT(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PATCH": + return self.rest_client.PATCH(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "DELETE": + return self.rest_client.DELETE(url, + query_params=query_params, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + else: + raise ApiValueError( + "http method must be `GET`, `HEAD`, `OPTIONS`," + " `POST`, `PATCH`, `PUT` or `DELETE`." + ) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + @staticmethod + def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: + file_data = file_instance.read() + file_instance.close() + return file_data + + def files_parameters(self, + files: typing.Optional[typing.Dict[str, + typing.List[io.IOBase]]] = None): + """Builds form parameters. + + :param files: None or a dict with key=param_name and + value is a list of open file objects + :return: List of tuples of form parameters with file data + """ + if files is None: + return [] + + params = [] + for param_name, file_instances in files.items(): + if file_instances is None: + # if the file field is nullable, skip None values + continue + for file_instance in file_instances: + if file_instance is None: + # if the file field is nullable, skip None values + continue + if file_instance.closed is True: + raise ApiValueError( + "Cannot read a closed file. The passed in file_type " + "for %s must be open." % param_name + ) + filename = os.path.basename(file_instance.name) + filedata = self.get_file_data_and_close_file(file_instance) + mimetype = (mimetypes.guess_type(filename)[0] or + 'application/octet-stream') + params.append( + tuple([param_name, tuple([filename, filedata, mimetype])])) + + return params + + def select_header_accept(self, accepts): + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return + + accepts = [x.lower() for x in accepts] + + if 'application/json' in accepts: + return 'application/json' + else: + return ', '.join(accepts) + + def select_header_content_type(self, content_types, method=None, body=None): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :param method: http method (e.g. POST, PATCH). + :param body: http body to send. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return None + + content_types = [x.lower() for x in content_types] + + if (method == 'PATCH' and + 'application/json-patch+json' in content_types and + isinstance(body, list)): + return 'application/json-patch+json' + + if 'application/json' in content_types or '*/*' in content_types: + return 'application/json' + else: + return content_types[0] + + def update_params_for_auth(self, headers, queries, auth_settings, + resource_path, method, body, request_auths=None): + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :param resource_path: A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method. + :param body: A object representing the body of the HTTP request. + The object type is the return value of _encoder.default(). + :param request_auths: if set, the provided settings will + override the token in the configuration. + """ + if not auth_settings: + return + + if request_auths: + for auth_setting in request_auths: + self._apply_auth_params( + headers, queries, resource_path, method, body, auth_setting) + return + + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + self._apply_auth_params( + headers, queries, resource_path, method, body, auth_setting) + + def _apply_auth_params(self, headers, queries, resource_path, method, body, auth_setting): + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['key'] + "=" + auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] + elif auth_setting['in'] == 'query': + queries.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + +class Endpoint(object): + def __init__(self, settings=None, params_map=None, root_map=None, + headers_map=None, api_client=None, callable=None): + """Creates an endpoint + + Args: + settings (dict): see below key value pairs + 'response_type' (tuple/None): response type + 'auth' (list): a list of auth type keys + 'endpoint_path' (str): the endpoint path + 'operation_id' (str): endpoint string identifier + 'http_method' (str): POST/PUT/PATCH/GET etc + 'servers' (list): list of str servers that this endpoint is at + params_map (dict): see below key value pairs + 'all' (list): list of str endpoint parameter names + 'required' (list): list of required parameter names + 'nullable' (list): list of nullable parameter names + 'enum' (list): list of parameters with enum values + 'validation' (list): list of parameters with validations + root_map + 'validations' (dict): the dict mapping endpoint parameter tuple + paths to their validation dictionaries + 'allowed_values' (dict): the dict mapping endpoint parameter + tuple paths to their allowed_values (enum) dictionaries + 'openapi_types' (dict): param_name to openapi type + 'attribute_map' (dict): param_name to camelCase name + 'location_map' (dict): param_name to 'body', 'file', 'form', + 'header', 'path', 'query' + collection_format_map (dict): param_name to `csv` etc. + headers_map (dict): see below key value pairs + 'accept' (list): list of Accept header strings + 'content_type' (list): list of Content-Type header strings + api_client (ApiClient) api client instance + callable (function): the function which is invoked when the + Endpoint is called + """ + self.settings = settings + self.params_map = params_map + self.params_map['all'].extend([ + 'async_req', + '_host_index', + '_preload_content', + '_request_timeout', + '_return_http_data_only', + '_check_input_type', + '_check_return_type', + '_content_type', + '_spec_property_naming', + '_request_auths' + ]) + self.params_map['nullable'].extend(['_request_timeout']) + self.validations = root_map['validations'] + self.allowed_values = root_map['allowed_values'] + self.openapi_types = root_map['openapi_types'] + extra_types = { + 'async_req': (bool,), + '_host_index': (none_type, int), + '_preload_content': (bool,), + '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), + '_return_http_data_only': (bool,), + '_check_input_type': (bool,), + '_check_return_type': (bool,), + '_spec_property_naming': (bool,), + '_content_type': (none_type, str), + '_request_auths': (none_type, list) + } + self.openapi_types.update(extra_types) + self.attribute_map = root_map['attribute_map'] + self.location_map = root_map['location_map'] + self.collection_format_map = root_map['collection_format_map'] + self.headers_map = headers_map + self.api_client = api_client + self.callable = callable + + def __validate_inputs(self, kwargs): + for param in self.params_map['enum']: + if param in kwargs: + check_allowed_values( + self.allowed_values, + (param,), + kwargs[param] + ) + + for param in self.params_map['validation']: + if param in kwargs: + check_validations( + self.validations, + (param,), + kwargs[param], + configuration=self.api_client.configuration + ) + + if kwargs['_check_input_type'] is False: + return + + for key, value in kwargs.items(): + fixed_val = validate_and_convert_types( + value, + self.openapi_types[key], + [key], + kwargs['_spec_property_naming'], + kwargs['_check_input_type'], + configuration=self.api_client.configuration + ) + kwargs[key] = fixed_val + + def __gather_params(self, kwargs): + params = { + 'body': None, + 'collection_format': {}, + 'file': {}, + 'form': [], + 'header': {}, + 'path': {}, + 'query': [] + } + + for param_name, param_value in kwargs.items(): + param_location = self.location_map.get(param_name) + if param_location is None: + continue + if param_location: + if param_location == 'body': + params['body'] = param_value + continue + base_name = self.attribute_map[param_name] + if (param_location == 'form' and + self.openapi_types[param_name] == (file_type,)): + params['file'][base_name] = [param_value] + elif (param_location == 'form' and + self.openapi_types[param_name] == ([file_type],)): + # param_value is already a list + params['file'][base_name] = param_value + elif param_location in {'form', 'query'}: + param_value_full = (base_name, param_value) + params[param_location].append(param_value_full) + if param_location not in {'form', 'query'}: + params[param_location][base_name] = param_value + collection_format = self.collection_format_map.get(param_name) + if collection_format: + params['collection_format'][base_name] = collection_format + + return params + + def __call__(self, *args, **kwargs): + """ This method is invoked when endpoints are called + Example: + + api_instance = AdministrationAuditLogApi() + api_instance.generate_audit_log # this is an instance of the class Endpoint + api_instance.generate_audit_log() # this invokes api_instance.generate_audit_log.__call__() + which then invokes the callable functions stored in that endpoint at + api_instance.generate_audit_log.callable or self.callable in this class + + """ + return self.callable(self, *args, **kwargs) + + def call_with_http_info(self, **kwargs): + + try: + index = self.api_client.configuration.server_operation_index.get( + self.settings['operation_id'], self.api_client.configuration.server_index + ) if kwargs['_host_index'] is None else kwargs['_host_index'] + server_variables = self.api_client.configuration.server_operation_variables.get( + self.settings['operation_id'], self.api_client.configuration.server_variables + ) + _host = self.api_client.configuration.get_host_from_settings( + index, variables=server_variables, servers=self.settings['servers'] + ) + except IndexError: + if self.settings['servers']: + raise ApiValueError( + "Invalid host index. Must be 0 <= index < %s" % + len(self.settings['servers']) + ) + _host = None + + for key, value in kwargs.items(): + if key not in self.params_map['all']: + raise ApiTypeError( + "Got an unexpected parameter '%s'" + " to method `%s`" % + (key, self.settings['operation_id']) + ) + # only throw this nullable ApiValueError if _check_input_type + # is False, if _check_input_type==True we catch this case + # in self.__validate_inputs + if (key not in self.params_map['nullable'] and value is None + and kwargs['_check_input_type'] is False): + raise ApiValueError( + "Value may not be None for non-nullable parameter `%s`" + " when calling `%s`" % + (key, self.settings['operation_id']) + ) + + for key in self.params_map['required']: + if key not in kwargs.keys(): + raise ApiValueError( + "Missing the required parameter `%s` when calling " + "`%s`" % (key, self.settings['operation_id']) + ) + + self.__validate_inputs(kwargs) + + params = self.__gather_params(kwargs) + + accept_headers_list = self.headers_map['accept'] + if accept_headers_list: + params['header']['Accept'] = self.api_client.select_header_accept( + accept_headers_list) + + if kwargs.get('_content_type'): + params['header']['Content-Type'] = kwargs['_content_type'] + else: + content_type_headers_list = self.headers_map['content_type'] + if content_type_headers_list: + if params['body'] != "": + content_types_list = self.api_client.select_header_content_type( + content_type_headers_list, self.settings['http_method'], + params['body']) + if content_types_list: + params['header']['Content-Type'] = content_types_list + + return self.api_client.call_api( + self.settings['endpoint_path'], self.settings['http_method'], + params['path'], + params['query'], + params['header'], + body=params['body'], + post_params=params['form'], + files=params['file'], + response_type=self.settings['response_type'], + auth_settings=self.settings['auth'], + async_req=kwargs['async_req'], + _check_type=kwargs['_check_return_type'], + _return_http_data_only=kwargs['_return_http_data_only'], + _preload_content=kwargs['_preload_content'], + _request_timeout=kwargs['_request_timeout'], + _host=_host, + _request_auths=kwargs['_request_auths'], + collection_formats=params['collection_format']) diff --git a/openapi_client/apis/__init__.py b/openapi_client/apis/__init__.py new file mode 100644 index 0000000..a8158b2 --- /dev/null +++ b/openapi_client/apis/__init__.py @@ -0,0 +1,297 @@ + +# flake8: noqa + +# Import all APIs into this package. +# If you have many APIs here with many many models used in each API this may +# raise a `RecursionError`. +# In order to avoid this, import only the API that you directly need like: +# +# from openapi_client.api.administration_audit_log_api import AdministrationAuditLogApi +# +# or import this package, but before doing it, use: +# +# import sys +# sys.setrecursionlimit(n) + +# Import APIs into API package: +from openapi_client.api.administration_audit_log_api import AdministrationAuditLogApi +from openapi_client.api.administration_user_and_group_api import AdministrationUserAndGroupApi +from openapi_client.api.certificate_management_device_api import CertificateManagementDeviceApi +from openapi_client.api.certificate_management_v_manage_api import CertificateManagementVManageApi +from openapi_client.api.cluster_management_api import ClusterManagementApi +from openapi_client.api.colocation_api import ColocationApi +from openapi_client.api.colocation_service_group_api import ColocationServiceGroupApi +from openapi_client.api.configuration_advanced_inspection_profile_definition_api import ConfigurationAdvancedInspectionProfileDefinitionApi +from openapi_client.api.configuration_azure_connect_api import ConfigurationAzureConnectApi +from openapi_client.api.configuration_circuits_api import ConfigurationCircuitsApi +from openapi_client.api.configuration_cloud_express_api import ConfigurationCloudExpressApi +from openapi_client.api.configuration_cloud_on_ramp_api import ConfigurationCloudOnRampApi +from openapi_client.api.configuration_configuration_group_api import ConfigurationConfigurationGroupApi +from openapi_client.api.configuration_dashboard_status_api import ConfigurationDashboardStatusApi +from openapi_client.api.configuration_device_actions_api import ConfigurationDeviceActionsApi +from openapi_client.api.configuration_device_config_history_api import ConfigurationDeviceConfigHistoryApi +from openapi_client.api.configuration_device_connectivity_api import ConfigurationDeviceConnectivityApi +from openapi_client.api.configuration_device_firmware_update_api import ConfigurationDeviceFirmwareUpdateApi +from openapi_client.api.configuration_device_inventory_api import ConfigurationDeviceInventoryApi +from openapi_client.api.configuration_device_ssl_proxy_certificate_management_api import ConfigurationDeviceSSLProxyCertificateManagementApi +from openapi_client.api.configuration_device_software_package_api import ConfigurationDeviceSoftwarePackageApi +from openapi_client.api.configuration_device_software_update_api import ConfigurationDeviceSoftwareUpdateApi +from openapi_client.api.configuration_device_template_api import ConfigurationDeviceTemplateApi +from openapi_client.api.configuration_disaster_recovery_api import ConfigurationDisasterRecoveryApi +from openapi_client.api.configuration_downloaded_images_api import ConfigurationDownloadedImagesApi +from openapi_client.api.configuration_fqdn_list_builder_api import ConfigurationFQDNListBuilderApi +from openapi_client.api.configuration_feature_certificate_api import ConfigurationFeatureCertificateApi +from openapi_client.api.configuration_feature_profile_mobility_api import ConfigurationFeatureProfileMobilityApi +from openapi_client.api.configuration_feature_profile_sdwan_api import ConfigurationFeatureProfileSDWANApi +from openapi_client.api.configuration_general_template_api import ConfigurationGeneralTemplateApi +from openapi_client.api.configuration_identity_service_engine_api import ConfigurationIdentityServiceEngineApi +from openapi_client.api.configuration_ise_server_api import ConfigurationIseServerApi +from openapi_client.api.configuration_multi_cloud_api import ConfigurationMultiCloudApi +from openapi_client.api.configuration_multidomain_policy_api import ConfigurationMultidomainPolicyApi +from openapi_client.api.configuration_network_design_api import ConfigurationNetworkDesignApi +from openapi_client.api.configuration_network_design_templates_api import ConfigurationNetworkDesignTemplatesApi +from openapi_client.api.configuration_policy_amp_definition_builder_api import ConfigurationPolicyAMPDefinitionBuilderApi +from openapi_client.api.configuration_policy_as_path_list_builder_api import ConfigurationPolicyASPathListBuilderApi +from openapi_client.api.configuration_policy_access_list_definition_builder_api import ConfigurationPolicyAccessListDefinitionBuilderApi +from openapi_client.api.configuration_policy_app_route_definition_builder_api import ConfigurationPolicyAppRouteDefinitionBuilderApi +from openapi_client.api.configuration_policy_app_probe_class_list_builder_api import ConfigurationPolicyAppProbeClassListBuilderApi +from openapi_client.api.configuration_policy_application_list_builder_api import ConfigurationPolicyApplicationListBuilderApi +from openapi_client.api.configuration_policy_cflowd_definition_builder_api import ConfigurationPolicyCflowdDefinitionBuilderApi +from openapi_client.api.configuration_policy_cloud_application_builder_api import ConfigurationPolicyCloudApplicationBuilderApi +from openapi_client.api.configuration_policy_color_list_builder_api import ConfigurationPolicyColorListBuilderApi +from openapi_client.api.configuration_policy_community_list_builder_api import ConfigurationPolicyCommunityListBuilderApi +from openapi_client.api.configuration_policy_control_definition_builder_api import ConfigurationPolicyControlDefinitionBuilderApi +from openapi_client.api.configuration_policy_custom_application_builder_api import ConfigurationPolicyCustomApplicationBuilderApi +from openapi_client.api.configuration_policy_data_definition_builder_api import ConfigurationPolicyDataDefinitionBuilderApi +from openapi_client.api.configuration_policy_data_ipv6_prefix_list_builder_api import ConfigurationPolicyDataIPV6PrefixListBuilderApi +from openapi_client.api.configuration_policy_data_prefix_all_types_of_lists_builder_api import ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi +from openapi_client.api.configuration_policy_data_prefix_list_builder_api import ConfigurationPolicyDataPrefixListBuilderApi +from openapi_client.api.configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api import ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi +from openapi_client.api.configuration_policy_device_access_definition_builder_api import ConfigurationPolicyDeviceAccessDefinitionBuilderApi +from openapi_client.api.configuration_policy_dial_peer_definition_builder_api import ConfigurationPolicyDialPeerDefinitionBuilderApi +from openapi_client.api.configuration_policy_expanded_community_list_builder_api import ConfigurationPolicyExpandedCommunityListBuilderApi +from openapi_client.api.configuration_policy_extended_community_list_builder_api import ConfigurationPolicyExtendedCommunityListBuilderApi +from openapi_client.api.configuration_policy_fxo_port_definition_builder_api import ConfigurationPolicyFXOPortDefinitionBuilderApi +from openapi_client.api.configuration_policy_fxsdid_port_definition_builder_api import ConfigurationPolicyFXSDIDPortDefinitionBuilderApi +from openapi_client.api.configuration_policy_fxs_port_definition_builder_api import ConfigurationPolicyFXSPortDefinitionBuilderApi +from openapi_client.api.configuration_policy_fax_protocol_list_builder_api import ConfigurationPolicyFaxProtocolListBuilderApi +from openapi_client.api.configuration_policy_forwarding_class_list_builder_api import ConfigurationPolicyForwardingClassListBuilderApi +from openapi_client.api.configuration_policy_geo_location_list_builder_api import ConfigurationPolicyGeoLocationListBuilderApi +from openapi_client.api.configuration_policy_hub_and_spoke_definition_builder_api import ConfigurationPolicyHubAndSpokeDefinitionBuilderApi +from openapi_client.api.configuration_policy_ips_signature_list_builder_api import ConfigurationPolicyIPSSignatureListBuilderApi +from openapi_client.api.configuration_policy_ipv6_access_definition_builder_api import ConfigurationPolicyIPv6AccessDefinitionBuilderApi +from openapi_client.api.configuration_policy_ipv6_device_access_definition_builder_api import ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi +from openapi_client.api.configuration_policy_ipv6_prefix_list_builder_api import ConfigurationPolicyIPv6PrefixListBuilderApi +from openapi_client.api.configuration_policy_identity_list_builder_api import ConfigurationPolicyIdentityListBuilderApi +from openapi_client.api.configuration_policy_intrusion_prevention_definition_builder_api import ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi +from openapi_client.api.configuration_policy_list_builder_api import ConfigurationPolicyListBuilderApi +from openapi_client.api.configuration_policy_local_domain_definition_builder_api import ConfigurationPolicyLocalDomainDefinitionBuilderApi +from openapi_client.api.configuration_policy_local_domain_name_list_builder_api import ConfigurationPolicyLocalDomainNameListBuilderApi +from openapi_client.api.configuration_policy_media_profile_list_builder_api import ConfigurationPolicyMediaProfileListBuilderApi +from openapi_client.api.configuration_policy_mesh_definition_builder_api import ConfigurationPolicyMeshDefinitionBuilderApi +from openapi_client.api.configuration_policy_mirror_list_builder_api import ConfigurationPolicyMirrorListBuilderApi +from openapi_client.api.configuration_policy_modem_passthrough_list_builder_api import ConfigurationPolicyModemPassthroughListBuilderApi +from openapi_client.api.configuration_policy_priisdn_port_definition_builder_api import ConfigurationPolicyPRIISDNPortDefinitionBuilderApi +from openapi_client.api.configuration_policy_policer_class_list_builder_api import ConfigurationPolicyPolicerClassListBuilderApi +from openapi_client.api.configuration_policy_port_list_builder_api import ConfigurationPolicyPortListBuilderApi +from openapi_client.api.configuration_policy_prefix_list_builder_api import ConfigurationPolicyPrefixListBuilderApi +from openapi_client.api.configuration_policy_prefix_for_all_types_of_lists_builder_api import ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi +from openapi_client.api.configuration_policy_protocol_name_list_builder_api import ConfigurationPolicyProtocolNameListBuilderApi +from openapi_client.api.configuration_policy_qos_map_definition_builder_api import ConfigurationPolicyQosMapDefinitionBuilderApi +from openapi_client.api.configuration_policy_region_list_builder_api import ConfigurationPolicyRegionListBuilderApi +from openapi_client.api.configuration_policy_rewrite_rule_definition_builder_api import ConfigurationPolicyRewriteRuleDefinitionBuilderApi +from openapi_client.api.configuration_policy_sla_class_list_builder_api import ConfigurationPolicySLAClassListBuilderApi +from openapi_client.api.configuration_policy_secure_internet_gateway_data_centers_builder_api import ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi +from openapi_client.api.configuration_policy_security_assembler_api import ConfigurationPolicySecurityAssemblerApi +from openapi_client.api.configuration_policy_site_list_builder_api import ConfigurationPolicySiteListBuilderApi +from openapi_client.api.configuration_policy_supervisory_disc_list_builder_api import ConfigurationPolicySupervisoryDiscListBuilderApi +from openapi_client.api.configuration_policy_tloc_list_builder_api import ConfigurationPolicyTLOCListBuilderApi +from openapi_client.api.configuration_policy_threat_grid_api_key_list_api import ConfigurationPolicyThreatGridApiKeyListApi +from openapi_client.api.configuration_policy_translation_profile_list_builder_api import ConfigurationPolicyTranslationProfileListBuilderApi +from openapi_client.api.configuration_policy_translation_rules_list_builder_api import ConfigurationPolicyTranslationRulesListBuilderApi +from openapi_client.api.configuration_policy_trunk_group_list_builder_api import ConfigurationPolicyTrunkGroupListBuilderApi +from openapi_client.api.configuration_policy_url_black_list_builder_api import ConfigurationPolicyURLBlackListBuilderApi +from openapi_client.api.configuration_policy_url_filtering_definition_builder_api import ConfigurationPolicyURLFilteringDefinitionBuilderApi +from openapi_client.api.configuration_policy_url_white_list_builder_api import ConfigurationPolicyURLWhiteListBuilderApi +from openapi_client.api.configuration_policy_umbrella_data_list_builder_api import ConfigurationPolicyUmbrellaDataListBuilderApi +from openapi_client.api.configuration_policy_vpn_list_builder_api import ConfigurationPolicyVPNListBuilderApi +from openapi_client.api.configuration_policy_vpn_membership_group_definition_builder_api import ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi +from openapi_client.api.configuration_policy_vpn_qos_map_definition_builder_api import ConfigurationPolicyVPNQosMapDefinitionBuilderApi +from openapi_client.api.configuration_policy_voice_assembler_api import ConfigurationPolicyVoiceAssemblerApi +from openapi_client.api.configuration_policy_zone_based_firewall_definition_builder_api import ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi +from openapi_client.api.configuration_policy_zone_list_builder_api import ConfigurationPolicyZoneListBuilderApi +from openapi_client.api.configuration_policy_v_edge_assembler_api import ConfigurationPolicyVEdgeAssemblerApi +from openapi_client.api.configuration_policy_v_edge_route_definition_builder_api import ConfigurationPolicyVEdgeRouteDefinitionBuilderApi +from openapi_client.api.configuration_policy_v_smart_assembler_api import ConfigurationPolicyVSmartAssemblerApi +from openapi_client.api.configuration_pre_upgrade_check_status_api import ConfigurationPreUpgradeCheckStatusApi +from openapi_client.api.configuration_preferred_color_group_list_builder_api import ConfigurationPreferredColorGroupListBuilderApi +from openapi_client.api.configuration_quick_connect_api import ConfigurationQuickConnectApi +from openapi_client.api.configuration_rule_set_definition_api import ConfigurationRuleSetDefinitionApi +from openapi_client.api.configuration_ssl_decryption_policy_definition_builder_api import ConfigurationSSLDecryptionPolicyDefinitionBuilderApi +from openapi_client.api.configuration_ssl_decryption_utd_profile_definition_api import ConfigurationSSLDecryptionUTDProfileDefinitionApi +from openapi_client.api.configuration_secure_internet_gateway_tunnels_api import ConfigurationSecureInternetGatewayTunnelsApi +from openapi_client.api.configuration_security_group_definition_api import ConfigurationSecurityGroupDefinitionApi +from openapi_client.api.configuration_security_template_policy_api import ConfigurationSecurityTemplatePolicyApi +from openapi_client.api.configuration_segments_api import ConfigurationSegmentsApi +from openapi_client.api.configuration_settings_api import ConfigurationSettingsApi +from openapi_client.api.configuration_software_actions_api import ConfigurationSoftwareActionsApi +from openapi_client.api.configuration_template_configuration_api import ConfigurationTemplateConfigurationApi +from openapi_client.api.configuration_template_lock_api import ConfigurationTemplateLockApi +from openapi_client.api.configuration_template_master_api import ConfigurationTemplateMasterApi +from openapi_client.api.configuration_topology_api import ConfigurationTopologyApi +from openapi_client.api.configuration_voice_template_policy_api import ConfigurationVoiceTemplatePolicyApi +from openapi_client.api.configuration_v_edge_template_policy_api import ConfigurationVEdgeTemplatePolicyApi +from openapi_client.api.configuration_v_smart_template_policy_api import ConfigurationVSmartTemplatePolicyApi +from openapi_client.api.data_collection_agent_api import DataCollectionAgentApi +from openapi_client.api.deployment_mode_api import DeploymentModeApi +from openapi_client.api.device_messaging_api import DeviceMessagingApi +from openapi_client.api.device_network_api import DeviceNetworkApi +from openapi_client.api.hsec_api import HSECApi +from openapi_client.api.hsec_license_api import HSECLicenseApi +from openapi_client.api.hsec_activate_api import HsecActivateApi +from openapi_client.api.locale_api import LocaleApi +from openapi_client.api.msla_api import MSLAApi +from openapi_client.api.monitoring_art_api import MonitoringARTApi +from openapi_client.api.monitoring_alarms_details_api import MonitoringAlarmsDetailsApi +from openapi_client.api.monitoring_alarms_notification_api import MonitoringAlarmsNotificationApi +from openapi_client.api.monitoring_app_hosting_api import MonitoringAppHostingApi +from openapi_client.api.monitoring_application_aware_routing_api import MonitoringApplicationAwareRoutingApi +from openapi_client.api.monitoring_application_aware_routing_statistics_api import MonitoringApplicationAwareRoutingStatisticsApi +from openapi_client.api.monitoring_bfd_api import MonitoringBFDApi +from openapi_client.api.monitoring_bridge_api import MonitoringBridgeApi +from openapi_client.api.monitoring_cellular_eiolte_api import MonitoringCellularEIOLTEApi +from openapi_client.api.monitoring_cflowd_api import MonitoringCflowdApi +from openapi_client.api.monitoring_cloud_express_api import MonitoringCloudExpressApi +from openapi_client.api.monitoring_dpi_api import MonitoringDPIApi +from openapi_client.api.monitoring_dpion_demand_troubleshooting_api import MonitoringDPIOnDemandTroubleshootingApi +from openapi_client.api.monitoring_device_details_api import MonitoringDeviceDetailsApi +from openapi_client.api.monitoring_device_statistics_api import MonitoringDeviceStatisticsApi +from openapi_client.api.monitoring_device_statistics_details_api import MonitoringDeviceStatisticsDetailsApi +from openapi_client.api.monitoring_endpoint_tracker_status_api import MonitoringEndpointTrackerStatusApi +from openapi_client.api.monitoring_events_api import MonitoringEventsApi +from openapi_client.api.monitoring_flowlog_api import MonitoringFlowlogApi +from openapi_client.api.monitoring_health_api import MonitoringHealthApi +from openapi_client.api.monitoring_ips_alert_api import MonitoringIPsAlertApi +from openapi_client.api.monitoring_interface_statistics_api import MonitoringInterfaceStatisticsApi +from openapi_client.api.monitoring_qo_s_api import MonitoringQoSApi +from openapi_client.api.monitoring_security_unified_logging_connection_events_api import MonitoringSecurityUnifiedLoggingConnectionEventsApi +from openapi_client.api.monitoring_server_info_api import MonitoringServerInfoApi +from openapi_client.api.monitoring_stats_download_api import MonitoringStatsDownloadApi +from openapi_client.api.monitoring_stats_processing_api import MonitoringStatsProcessingApi +from openapi_client.api.monitoring_status_api import MonitoringStatusApi +from openapi_client.api.monitoring_system_status_stats_api import MonitoringSystemStatusStatsApi +from openapi_client.api.monitoring_url_filtering_api import MonitoringURLFilteringApi +from openapi_client.api.monitoring_umbrella_api import MonitoringUmbrellaApi +from openapi_client.api.monitoring_umbrella_patterns_api import MonitoringUmbrellaPatternsApi +from openapi_client.api.monitoring_vnf_interface_statistics_api import MonitoringVNFInterfaceStatisticsApi +from openapi_client.api.monitoring_wlan_client_info_api import MonitoringWlanClientInfoApi +from openapi_client.api.multitenant_apis_provider_api import MultitenantAPIsProviderApi +from openapi_client.api.nwpi_api import NWPIApi +from openapi_client.api.partner_aci_policy_builder_api import PartnerACIPolicyBuilderApi +from openapi_client.api.partner_dnacsdaapi_api import PartnerDNACSDAAPIApi +from openapi_client.api.partner_registration_api import PartnerRegistrationApi +from openapi_client.api.partner_wcm_configs_api import PartnerWCMConfigsApi +from openapi_client.api.real_time_monitoring_aaa_api import RealTimeMonitoringAAAApi +from openapi_client.api.real_time_monitoring_arp_api import RealTimeMonitoringARPApi +from openapi_client.api.real_time_monitoring_app_hosting_api import RealTimeMonitoringAppHostingApi +from openapi_client.api.real_time_monitoring_app_logs_api import RealTimeMonitoringAppLogsApi +from openapi_client.api.real_time_monitoring_application_aware_route_api import RealTimeMonitoringApplicationAwareRouteApi +from openapi_client.api.real_time_monitoring_appqoe_api import RealTimeMonitoringAppqoeApi +from openapi_client.api.real_time_monitoring_bfd_api import RealTimeMonitoringBFDApi +from openapi_client.api.real_time_monitoring_bgp_api import RealTimeMonitoringBGPApi +from openapi_client.api.real_time_monitoring_bridge_api import RealTimeMonitoringBridgeApi +from openapi_client.api.real_time_monitoring_cfm_api import RealTimeMonitoringCFMApi +from openapi_client.api.real_time_monitoring_cellular_api import RealTimeMonitoringCellularApi +from openapi_client.api.real_time_monitoring_cellular_aon_ipsec_interface_api import RealTimeMonitoringCellularAONIpsecInterfaceApi +from openapi_client.api.real_time_monitoring_cellular_eiolte_connection_service_api import RealTimeMonitoringCellularEIOLTEConnectionServiceApi +from openapi_client.api.real_time_monitoring_cellular_eiolte_hardware_service_api import RealTimeMonitoringCellularEIOLTEHardwareServiceApi +from openapi_client.api.real_time_monitoring_cellular_eiolte_network_service_api import RealTimeMonitoringCellularEIOLTENetworkServiceApi +from openapi_client.api.real_time_monitoring_cellular_eiolte_sim_service_api import RealTimeMonitoringCellularEIOLTESimServiceApi +from openapi_client.api.real_time_monitoring_cloud_express_api import RealTimeMonitoringCloudExpressApi +from openapi_client.api.real_time_monitoring_commit_list_api import RealTimeMonitoringCommitListApi +from openapi_client.api.real_time_monitoring_container_lifecycle_api import RealTimeMonitoringContainerLifecycleApi +from openapi_client.api.real_time_monitoring_crash_log_api import RealTimeMonitoringCrashLogApi +from openapi_client.api.real_time_monitoring_dhcp_api import RealTimeMonitoringDHCPApi +from openapi_client.api.real_time_monitoring_dot1x_api import RealTimeMonitoringDOT1xApi +from openapi_client.api.real_time_monitoring_dpi_api import RealTimeMonitoringDPIApi +from openapi_client.api.real_time_monitoring_dre_api import RealTimeMonitoringDREApi +from openapi_client.api.real_time_monitoring_device_api import RealTimeMonitoringDeviceApi +from openapi_client.api.real_time_monitoring_device_control_api import RealTimeMonitoringDeviceControlApi +from openapi_client.api.real_time_monitoring_device_feature_list_api import RealTimeMonitoringDeviceFeatureListApi +from openapi_client.api.real_time_monitoring_device_system_stats_api import RealTimeMonitoringDeviceSystemStatsApi +from openapi_client.api.real_time_monitoring_dual_static_route_tracker_service_api import RealTimeMonitoringDualStaticRouteTrackerServiceApi +from openapi_client.api.real_time_monitoring_eigrp_api import RealTimeMonitoringEIGRPApi +from openapi_client.api.real_time_monitoring_endpoint_tracker_group_service_api import RealTimeMonitoringEndpointTrackerGroupServiceApi +from openapi_client.api.real_time_monitoring_endpoint_tracker_service_api import RealTimeMonitoringEndpointTrackerServiceApi +from openapi_client.api.real_time_monitoring_geo_fencing_api import RealTimeMonitoringGeoFencingApi +from openapi_client.api.real_time_monitoring_hardware_api import RealTimeMonitoringHardwareApi +from openapi_client.api.real_time_monitoring_igmp_api import RealTimeMonitoringIGMPApi +from openapi_client.api.real_time_monitoring_ip_api import RealTimeMonitoringIPApi +from openapi_client.api.real_time_monitoring_i_psec_api import RealTimeMonitoringIPsecApi +from openapi_client.api.real_time_monitoring_ipv4_fib_api import RealTimeMonitoringIPv4FIBApi +from openapi_client.api.real_time_monitoring_ipv6_fib_api import RealTimeMonitoringIPv6FIBApi +from openapi_client.api.real_time_monitoring_ipv6_neighbours_api import RealTimeMonitoringIPv6NeighboursApi +from openapi_client.api.real_time_monitoring_interface_api import RealTimeMonitoringInterfaceApi +from openapi_client.api.real_time_monitoring_license_info_api import RealTimeMonitoringLicenseInfoApi +from openapi_client.api.real_time_monitoring_multicast_api import RealTimeMonitoringMulticastApi +from openapi_client.api.real_time_monitoring_nms_api import RealTimeMonitoringNMSApi +from openapi_client.api.real_time_monitoring_ntp_api import RealTimeMonitoringNTPApi +from openapi_client.api.real_time_monitoring_network_hub_resources_api import RealTimeMonitoringNetworkHubResourcesApi +from openapi_client.api.real_time_monitoring_omp_api import RealTimeMonitoringOMPApi +from openapi_client.api.real_time_monitoring_ospf_api import RealTimeMonitoringOSPFApi +from openapi_client.api.real_time_monitoring_orchestrator_api import RealTimeMonitoringOrchestratorApi +from openapi_client.api.real_time_monitoring_pim_api import RealTimeMonitoringPIMApi +from openapi_client.api.real_time_monitoring_pppo_e_api import RealTimeMonitoringPPPoEApi +from openapi_client.api.real_time_monitoring_policer_api import RealTimeMonitoringPolicerApi +from openapi_client.api.real_time_monitoring_policy_api import RealTimeMonitoringPolicyApi +from openapi_client.api.real_time_monitoring_rbac_api import RealTimeMonitoringRBACApi +from openapi_client.api.real_time_monitoring_reboot_history_api import RealTimeMonitoringRebootHistoryApi +from openapi_client.api.real_time_monitoring_sdwan_statistics_api import RealTimeMonitoringSDWANStatisticsApi +from openapi_client.api.real_time_monitoring_sfp_api import RealTimeMonitoringSFPApi +from openapi_client.api.real_time_monitoring_sig_api import RealTimeMonitoringSIGApi +from openapi_client.api.real_time_monitoring_security_api import RealTimeMonitoringSecurityApi +from openapi_client.api.real_time_monitoring_show_on_demand_local_api import RealTimeMonitoringShowOnDemandLocalApi +from openapi_client.api.real_time_monitoring_show_on_demand_remote_api import RealTimeMonitoringShowOnDemandRemoteApi +from openapi_client.api.real_time_monitoring_software_api import RealTimeMonitoringSoftwareApi +from openapi_client.api.real_time_monitoring_sslproxy_api import RealTimeMonitoringSslproxyApi +from openapi_client.api.real_time_monitoring_static_route_tracker_service_api import RealTimeMonitoringStaticRouteTrackerServiceApi +from openapi_client.api.real_time_monitoring_system_api import RealTimeMonitoringSystemApi +from openapi_client.api.real_time_monitoring_tcp_optimization_api import RealTimeMonitoringTCPOptimizationApi +from openapi_client.api.real_time_monitoring_tcpproxy_api import RealTimeMonitoringTcpproxyApi +from openapi_client.api.real_time_monitoring_tools_api import RealTimeMonitoringToolsApi +from openapi_client.api.real_time_monitoring_transport_api import RealTimeMonitoringTransportApi +from openapi_client.api.real_time_monitoring_trustsec_api import RealTimeMonitoringTrustsecApi +from openapi_client.api.real_time_monitoring_tunnel_api import RealTimeMonitoringTunnelApi +from openapi_client.api.real_time_monitoring_utd_api import RealTimeMonitoringUTDApi +from openapi_client.api.real_time_monitoring_ucse_api import RealTimeMonitoringUcseApi +from openapi_client.api.real_time_monitoring_umbrella_api import RealTimeMonitoringUmbrellaApi +from openapi_client.api.real_time_monitoring_vdsl_service_api import RealTimeMonitoringVDSLServiceApi +from openapi_client.api.real_time_monitoring_vm_api import RealTimeMonitoringVMApi +from openapi_client.api.real_time_monitoring_vpn_api import RealTimeMonitoringVPNApi +from openapi_client.api.real_time_monitoring_vrrp_api import RealTimeMonitoringVRRPApi +from openapi_client.api.real_time_monitoring_voice_api import RealTimeMonitoringVoiceApi +from openapi_client.api.real_time_monitoring_wlan_api import RealTimeMonitoringWLANApi +from openapi_client.api.real_time_monitoring_wireless_api import RealTimeMonitoringWirelessApi +from openapi_client.api.resource_pool_api import ResourcePoolApi +from openapi_client.api.sdavc_cloud_connector_api import SDAVCCloudConnectorApi +from openapi_client.api.sdavc_domain_based_app_rules_api import SDAVCDomainBasedAppRulesApi +from openapi_client.api.sdavcip_address_based_app_rules_api import SDAVCIPAddressBasedAppRulesApi +from openapi_client.api.scheduled_backup_restore_api import ScheduledBackupRestoreApi +from openapi_client.api.smart_license_api import SmartLicenseApi +from openapi_client.api.system_cloud_service_api import SystemCloudServiceApi +from openapi_client.api.system_cloud_service_webex_api import SystemCloudServiceWebexApi +from openapi_client.api.system_container_api import SystemContainerApi +from openapi_client.api.system_reverse_proxy_api import SystemReverseProxyApi +from openapi_client.api.tag_api import TagApi +from openapi_client.api.tenant_backup_restore_api import TenantBackupRestoreApi +from openapi_client.api.tenant_management_api import TenantManagementApi +from openapi_client.api.tenant_migration_api import TenantMigrationApi +from openapi_client.api.tools_tac_cases_api import ToolsTACCasesApi +from openapi_client.api.troubleshooting_tools_device_connectivity_api import TroubleshootingToolsDeviceConnectivityApi +from openapi_client.api.troubleshooting_tools_device_group_api import TroubleshootingToolsDeviceGroupApi +from openapi_client.api.troubleshooting_tools_diagnostics_api import TroubleshootingToolsDiagnosticsApi +from openapi_client.api.umbrella_api import UmbrellaApi +from openapi_client.api.utility_configuration_db_api import UtilityConfigurationDBApi +from openapi_client.api.utility_logging_api import UtilityLoggingApi +from openapi_client.api.utility_security_api import UtilitySecurityApi +from openapi_client.api.workflow_management_api import WorkflowManagementApi diff --git a/openapi_client/configuration.py b/openapi_client/configuration.py new file mode 100644 index 0000000..c46e6ec --- /dev/null +++ b/openapi_client/configuration.py @@ -0,0 +1,447 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import copy +import logging +import multiprocessing +import sys +import urllib3 + +from http import client as http_client +from openapi_client.exceptions import ApiValueError + + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +class Configuration(object): + """NOTE: This class is auto generated by OpenAPI Generator + + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param host: Base url + :param api_key: Dict to store API key(s). + Each entry in the dict specifies an API key. + The dict key is the name of the security scheme in the OAS specification. + The dict value is the API key secret. + :param api_key_prefix: Dict to store API prefix (e.g. Bearer) + The dict key is the name of the security scheme in the OAS specification. + The dict value is an API key prefix when generating the auth data. + :param username: Username for HTTP basic authentication + :param password: Password for HTTP basic authentication + :param discard_unknown_keys: Boolean value indicating whether to discard + unknown properties. A server may send a response that includes additional + properties that are not known by the client in the following scenarios: + 1. The OpenAPI document is incomplete, i.e. it does not match the server + implementation. + 2. The client was generated using an older version of the OpenAPI document + and the server has been upgraded since then. + If a schema in the OpenAPI document defines the additionalProperties attribute, + then all undeclared properties received by the server are injected into the + additional properties map. In that case, there are undeclared properties, and + nothing to discard. + :param disabled_client_side_validations (string): Comma-separated list of + JSON schema validation keywords to disable JSON schema structural validation + rules. The following keywords may be specified: multipleOf, maximum, + exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, + maxItems, minItems. + By default, the validation is performed for data generated locally by the client + and data received from the server, independent of any validation performed by + the server side. If the input data does not satisfy the JSON schema validation + rules specified in the OpenAPI document, an exception is raised. + If disabled_client_side_validations is set, structural validation is + disabled. This can be useful to troubleshoot data validation problem, such as + when the OpenAPI document validation rules do not match the actual API data + received by the server. + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum values before. + :param ssl_ca_cert: str - the path to a file of concatenated CA certificates + in PEM format + + """ + + _default = None + + def __init__(self, host=None, + api_key=None, api_key_prefix=None, + access_token=None, + username=None, password=None, + discard_unknown_keys=False, + disabled_client_side_validations="", + server_index=None, server_variables=None, + server_operation_index=None, server_operation_variables=None, + ssl_ca_cert=None, + ): + """Constructor + """ + self._base_path = "/dataservice" if host is None else host + """Default Base url + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + # Authentication Settings + self.access_token = access_token + self.api_key = {} + if api_key: + self.api_key = api_key + """dict to store API key(s) + """ + self.api_key_prefix = {} + if api_key_prefix: + self.api_key_prefix = api_key_prefix + """dict to store API prefix (e.g. Bearer) + """ + self.refresh_api_key_hook = None + """function hook to refresh API key if expired + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.discard_unknown_keys = discard_unknown_keys + self.disabled_client_side_validations = disabled_client_side_validations + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("openapi_client") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + self.debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + + self.proxy = None + """Proxy URL + """ + self.no_proxy = None + """bypass proxy for host in the no_proxy list. + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = None + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + # Options to pass down to the underlying urllib3 socket + self.socket_options = None + + def __deepcopy__(self, memo): + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name, value): + object.__setattr__(self, name, value) + if name == 'disabled_client_side_validations': + s = set(filter(None, value.split(','))) + for v in s: + if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: + raise ApiValueError( + "Invalid keyword: '{0}''".format(v)) + self._disabled_client_side_validations = s + + @classmethod + def set_default(cls, default): + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = copy.deepcopy(default) + + @classmethod + def get_default_copy(cls): + """Return new instance of configuration. + + This method returns newly created, based on default constructor, + object of Configuration class or returns a copy of default + configuration passed by the set_default method. + + :return: The configuration object. + """ + if cls._default is not None: + return copy.deepcopy(cls._default) + return Configuration() + + @property + def logger_file(self): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on http_client debug + http_client.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off http_client debug + http_client.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_api_key_with_prefix(self, identifier, alias=None): + """Gets API key (with prefix if set). + + :param identifier: The identifier of apiKey. + :param alias: The alternative identifier of apiKey. + :return: The token for api key authentication. + """ + if self.refresh_api_key_hook is not None: + self.refresh_api_key_hook(self) + key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key + + def get_basic_auth_token(self): + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self): + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + auth = {} + return auth + + def to_debug_report(self): + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: 2.0.0\n"\ + "SDK Package Version: 1.0.0".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self): + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + { + 'url': "/dataservice", + 'description': "No description provided", + } + ] + + def get_host_from_settings(self, index, variables=None, servers=None): + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self): + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value): + """Fix base path.""" + self._base_path = value + self.server_index = None diff --git a/openapi_client/exceptions.py b/openapi_client/exceptions.py new file mode 100644 index 0000000..ae0368b --- /dev/null +++ b/openapi_client/exceptions.py @@ -0,0 +1,159 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None): + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None): + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + if http_resp: + self.status = http_resp.status + self.reason = http_resp.reason + self.body = http_resp.data + self.headers = http_resp.getheaders() + else: + self.status = status + self.reason = reason + self.body = None + self.headers = None + + def __str__(self): + """Custom error messages for exception""" + error_message = "Status Code: {0}\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.body: + error_message += "HTTP response body: {0}\n".format(self.body) + + return error_message + + +class NotFoundException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(NotFoundException, self).__init__(status, reason, http_resp) + + +class UnauthorizedException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(UnauthorizedException, self).__init__(status, reason, http_resp) + + +class ForbiddenException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ForbiddenException, self).__init__(status, reason, http_resp) + + +class ServiceException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ServiceException, self).__init__(status, reason, http_resp) + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/openapi_client/model/__init__.py b/openapi_client/model/__init__.py new file mode 100644 index 0000000..b9db195 --- /dev/null +++ b/openapi_client/model/__init__.py @@ -0,0 +1,5 @@ +# we can not import model classes here because that would create a circular +# reference which would not work in python2 +# do not import all models into this module because that uses a lot of memory and stack frames +# if you need the ability to import all models from one package, import them with +# from openapi_client.models import ModelA, ModelB diff --git a/openapi_client/model/advanced_radio_setting.py b/openapi_client/model/advanced_radio_setting.py new file mode 100644 index 0000000..31e80b1 --- /dev/null +++ b/openapi_client/model/advanced_radio_setting.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.channel_power_settings import ChannelPowerSettings + from openapi_client.model.country_region_settings import CountryRegionSettings + globals()['ChannelPowerSettings'] = ChannelPowerSettings + globals()['CountryRegionSettings'] = CountryRegionSettings + + +class AdvancedRadioSetting(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'channel_power_settings': (ChannelPowerSettings,), # noqa: E501 + 'country_region_settings': (CountryRegionSettings,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'channel_power_settings': 'channelPowerSettings', # noqa: E501 + 'country_region_settings': 'countryRegionSettings', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdvancedRadioSetting - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + channel_power_settings (ChannelPowerSettings): [optional] # noqa: E501 + country_region_settings (CountryRegionSettings): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AdvancedRadioSetting - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + channel_power_settings (ChannelPowerSettings): [optional] # noqa: E501 + country_region_settings (CountryRegionSettings): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/api_re_key_device.py b/openapi_client/model/api_re_key_device.py new file mode 100644 index 0000000..88ed124 --- /dev/null +++ b/openapi_client/model/api_re_key_device.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class ApiReKeyDevice(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_id': 'deviceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiReKeyDevice - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiReKeyDevice - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/api_re_key_device_list.py b/openapi_client/model/api_re_key_device_list.py new file mode 100644 index 0000000..0853cbf --- /dev/null +++ b/openapi_client/model/api_re_key_device_list.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.api_re_key_device import ApiReKeyDevice + globals()['ApiReKeyDevice'] = ApiReKeyDevice + + +class ApiReKeyDeviceList(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'device_list': ([ApiReKeyDevice],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_list': 'deviceList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiReKeyDeviceList - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_list ([ApiReKeyDevice]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiReKeyDeviceList - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_list ([ApiReKeyDevice]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/aws_iam_credentials.py b/openapi_client/model/aws_iam_credentials.py new file mode 100644 index 0000000..7806db1 --- /dev/null +++ b/openapi_client/model/aws_iam_credentials.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class AwsIamCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'external_id': (str,), # noqa: E501 + 'role_arn': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'external_id': 'externalId', # noqa: E501 + 'role_arn': 'roleArn', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AwsIamCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + external_id (str): [optional] # noqa: E501 + role_arn (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AwsIamCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + external_id (str): [optional] # noqa: E501 + role_arn (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/aws_key_credentials.py b/openapi_client/model/aws_key_credentials.py new file mode 100644 index 0000000..2cd94c0 --- /dev/null +++ b/openapi_client/model/aws_key_credentials.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class AwsKeyCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'api_key': (str,), # noqa: E501 + 'secret_key': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'api_key': 'apiKey', # noqa: E501 + 'secret_key': 'secretKey', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AwsKeyCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + api_key (str): [optional] # noqa: E501 + secret_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AwsKeyCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + api_key (str): [optional] # noqa: E501 + secret_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/azure_credentials.py b/openapi_client/model/azure_credentials.py new file mode 100644 index 0000000..10961c8 --- /dev/null +++ b/openapi_client/model/azure_credentials.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class AzureCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'client_id': (str,), # noqa: E501 + 'cloud_tenant_id': (str,), # noqa: E501 + 'secret_key': (str,), # noqa: E501 + 'subscription_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'client_id': 'clientId', # noqa: E501 + 'cloud_tenant_id': 'cloudTenantId', # noqa: E501 + 'secret_key': 'secretKey', # noqa: E501 + 'subscription_id': 'subscriptionId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AzureCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_id (str): [optional] # noqa: E501 + cloud_tenant_id (str): [optional] # noqa: E501 + secret_key (str): [optional] # noqa: E501 + subscription_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AzureCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_id (str): [optional] # noqa: E501 + cloud_tenant_id (str): [optional] # noqa: E501 + secret_key (str): [optional] # noqa: E501 + subscription_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/banner.py b/openapi_client/model/banner.py new file mode 100644 index 0000000..ef6a1d7 --- /dev/null +++ b/openapi_client/model/banner.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Banner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'login_message': (str,), # noqa: E501 + 'motd': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'login_message': 'loginMessage', # noqa: E501 + 'motd': 'motd', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Banner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + login_message (str): [optional] # noqa: E501 + motd (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Banner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + login_message (str): [optional] # noqa: E501 + motd (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/bfd.py b/openapi_client/model/bfd.py new file mode 100644 index 0000000..3a5a36f --- /dev/null +++ b/openapi_client/model/bfd.py @@ -0,0 +1,282 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.bfd_timer_on_transport_tunnels import BfdTimerOnTransportTunnels + globals()['BfdTimerOnTransportTunnels'] = BfdTimerOnTransportTunnels + + +class Bfd(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'bfd_timer_on_transport_tunnels': (BfdTimerOnTransportTunnels,), # noqa: E501 + 'dscp_for_bfd_packets': (int,), # noqa: E501 + 'multiplier': (int,), # noqa: E501 + 'poll_interval': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'bfd_timer_on_transport_tunnels': 'bfdTimerOnTransportTunnels', # noqa: E501 + 'dscp_for_bfd_packets': 'dscpForBfdPackets', # noqa: E501 + 'multiplier': 'multiplier', # noqa: E501 + 'poll_interval': 'pollInterval', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Bfd - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bfd_timer_on_transport_tunnels (BfdTimerOnTransportTunnels): [optional] # noqa: E501 + dscp_for_bfd_packets (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + poll_interval (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Bfd - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bfd_timer_on_transport_tunnels (BfdTimerOnTransportTunnels): [optional] # noqa: E501 + dscp_for_bfd_packets (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + poll_interval (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/bfd_timer_on_transport_tunnels.py b/openapi_client/model/bfd_timer_on_transport_tunnels.py new file mode 100644 index 0000000..840b94d --- /dev/null +++ b/openapi_client/model/bfd_timer_on_transport_tunnels.py @@ -0,0 +1,288 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.biz_internet_timer import BizInternetTimer + from openapi_client.model.lte_timer import LteTimer + from openapi_client.model.mpls_timer import MplsTimer + from openapi_client.model.public_internet_timer import PublicInternetTimer + globals()['BizInternetTimer'] = BizInternetTimer + globals()['LteTimer'] = LteTimer + globals()['MplsTimer'] = MplsTimer + globals()['PublicInternetTimer'] = PublicInternetTimer + + +class BfdTimerOnTransportTunnels(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'biz_internet_timer': (BizInternetTimer,), # noqa: E501 + 'lte_timer': (LteTimer,), # noqa: E501 + 'mpls_timer': (MplsTimer,), # noqa: E501 + 'public_internet_timer': (PublicInternetTimer,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'biz_internet_timer': 'bizInternetTimer', # noqa: E501 + 'lte_timer': 'lteTimer', # noqa: E501 + 'mpls_timer': 'mplsTimer', # noqa: E501 + 'public_internet_timer': 'publicInternetTimer', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BfdTimerOnTransportTunnels - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + biz_internet_timer (BizInternetTimer): [optional] # noqa: E501 + lte_timer (LteTimer): [optional] # noqa: E501 + mpls_timer (MplsTimer): [optional] # noqa: E501 + public_internet_timer (PublicInternetTimer): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BfdTimerOnTransportTunnels - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + biz_internet_timer (BizInternetTimer): [optional] # noqa: E501 + lte_timer (LteTimer): [optional] # noqa: E501 + mpls_timer (MplsTimer): [optional] # noqa: E501 + public_internet_timer (PublicInternetTimer): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/biz_internet_timer.py b/openapi_client/model/biz_internet_timer.py new file mode 100644 index 0000000..7df9c50 --- /dev/null +++ b/openapi_client/model/biz_internet_timer.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class BizInternetTimer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'dscp': (int,), # noqa: E501 + 'hello_interval': (int,), # noqa: E501 + 'multiplier': (int,), # noqa: E501 + 'path_mtu': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dscp': 'dscp', # noqa: E501 + 'hello_interval': 'helloInterval', # noqa: E501 + 'multiplier': 'multiplier', # noqa: E501 + 'path_mtu': 'pathMtu', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BizInternetTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BizInternetTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/cellular.py b/openapi_client/model/cellular.py new file mode 100644 index 0000000..f1c3d0e --- /dev/null +++ b/openapi_client/model/cellular.py @@ -0,0 +1,396 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.cellular_all_of import CellularAllOf + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.sim_slot_config import SimSlotConfig + from openapi_client.model.variable import Variable + globals()['CellularAllOf'] = CellularAllOf + globals()['ProfileParcel'] = ProfileParcel + globals()['SimSlotConfig'] = SimSlotConfig + globals()['Variable'] = Variable + + +class Cellular(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + ('primary_slot',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('wan_config',): { + 'regex': { + 'pattern': r'(^Active$|^Standby$)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'primary_slot': (int,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'sim_slot0': (SimSlotConfig,), # noqa: E501 + 'sim_slot1': (SimSlotConfig,), # noqa: E501 + 'wan_config': (str,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'primary_slot': 'primarySlot', # noqa: E501 + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'sim_slot0': 'simSlot0', # noqa: E501 + 'sim_slot1': 'simSlot1', # noqa: E501 + 'wan_config': 'wanConfig', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Cellular - a model defined in OpenAPI + + Keyword Args: + primary_slot (int): + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + sim_slot0 (SimSlotConfig): [optional] # noqa: E501 + sim_slot1 (SimSlotConfig): [optional] # noqa: E501 + wan_config (str): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Cellular - a model defined in OpenAPI + + Keyword Args: + primary_slot (int): + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + sim_slot0 (SimSlotConfig): [optional] # noqa: E501 + sim_slot1 (SimSlotConfig): [optional] # noqa: E501 + wan_config (str): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + CellularAllOf, + ProfileParcel, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/cellular_all_of.py b/openapi_client/model/cellular_all_of.py new file mode 100644 index 0000000..aa771eb --- /dev/null +++ b/openapi_client/model/cellular_all_of.py @@ -0,0 +1,291 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.sim_slot_config import SimSlotConfig + globals()['SimSlotConfig'] = SimSlotConfig + + +class CellularAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('primary_slot',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('wan_config',): { + 'regex': { + 'pattern': r'(^Active$|^Standby$)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'sim_slot0': (SimSlotConfig,), # noqa: E501 + 'sim_slot1': (SimSlotConfig,), # noqa: E501 + 'primary_slot': (int,), # noqa: E501 + 'wan_config': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'sim_slot0': 'simSlot0', # noqa: E501 + 'sim_slot1': 'simSlot1', # noqa: E501 + 'primary_slot': 'primarySlot', # noqa: E501 + 'wan_config': 'wanConfig', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CellularAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + sim_slot0 (SimSlotConfig): [optional] # noqa: E501 + sim_slot1 (SimSlotConfig): [optional] # noqa: E501 + primary_slot (int): [optional] # noqa: E501 + wan_config (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CellularAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + sim_slot0 (SimSlotConfig): [optional] # noqa: E501 + sim_slot1 (SimSlotConfig): [optional] # noqa: E501 + primary_slot (int): [optional] # noqa: E501 + wan_config (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/cellular_profile.py b/openapi_client/model/cellular_profile.py new file mode 100644 index 0000000..d07cbb7 --- /dev/null +++ b/openapi_client/model/cellular_profile.py @@ -0,0 +1,298 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class CellularProfile(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('auth_method',): { + 'regex': { + 'pattern': r'(^none$|^pap$|^chap$|^pap_or_chap$)', # noqa: E501 + }, + }, + ('id',): { + 'inclusive_maximum': 16, + 'inclusive_minimum': 1, + }, + ('pdn_type',): { + 'regex': { + 'pattern': r'(^IPv4$|^IPv6$|^IPv4v6$)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'apn': (str,), # noqa: E501 + 'auth_method': (str,), # noqa: E501 + 'id': (int,), # noqa: E501 + 'password': (str,), # noqa: E501 + 'pdn_type': (str,), # noqa: E501 + 'user_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'apn': 'apn', # noqa: E501 + 'auth_method': 'authMethod', # noqa: E501 + 'id': 'id', # noqa: E501 + 'password': 'password', # noqa: E501 + 'pdn_type': 'pdnType', # noqa: E501 + 'user_name': 'userName', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CellularProfile - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + apn (str): [optional] # noqa: E501 + auth_method (str): [optional] # noqa: E501 + id (int): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + pdn_type (str): [optional] # noqa: E501 + user_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CellularProfile - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + apn (str): [optional] # noqa: E501 + auth_method (str): [optional] # noqa: E501 + id (int): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + pdn_type (str): [optional] # noqa: E501 + user_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/certificate_states.py b/openapi_client/model/certificate_states.py new file mode 100644 index 0000000..31d1158 --- /dev/null +++ b/openapi_client/model/certificate_states.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class CertificateStates(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'certificate_types': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'certificate_types': 'certificateTypes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CertificateStates - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + certificate_types (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CertificateStates - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + certificate_types (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/certificate_validity.py b/openapi_client/model/certificate_validity.py new file mode 100644 index 0000000..f1cd30a --- /dev/null +++ b/openapi_client/model/certificate_validity.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class CertificateValidity(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'certificate_validity': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'certificate_validity': 'certificateValidity', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CertificateValidity - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + certificate_validity (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CertificateValidity - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + certificate_validity (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/channel_power_settings.py b/openapi_client/model/channel_power_settings.py new file mode 100644 index 0000000..b05e163 --- /dev/null +++ b/openapi_client/model/channel_power_settings.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.radio_band_setting24_g import RadioBandSetting24G + from openapi_client.model.radio_band_setting5_g import RadioBandSetting5G + globals()['RadioBandSetting24G'] = RadioBandSetting24G + globals()['RadioBandSetting5G'] = RadioBandSetting5G + + +class ChannelPowerSettings(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'radio_band2_dot4_ghz': (RadioBandSetting24G,), # noqa: E501 + 'radio_band5_ghz': (RadioBandSetting5G,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'radio_band2_dot4_ghz': 'radioBand2Dot4Ghz', # noqa: E501 + 'radio_band5_ghz': 'radioBand5Ghz', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ChannelPowerSettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + radio_band2_dot4_ghz (RadioBandSetting24G): [optional] # noqa: E501 + radio_band5_ghz (RadioBandSetting5G): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ChannelPowerSettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + radio_band2_dot4_ghz (RadioBandSetting24G): [optional] # noqa: E501 + radio_band5_ghz (RadioBandSetting5G): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/config_group.py b/openapi_client/model/config_group.py new file mode 100644 index 0000000..41d2476 --- /dev/null +++ b/openapi_client/model/config_group.py @@ -0,0 +1,349 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.feature_profile import FeatureProfile + globals()['FeatureProfile'] = FeatureProfile + + +class ConfigGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('solution',): { + 'MOBILITY': "mobility", + 'SDWAN': "sdwan", + 'COMMON': "common", + }, + } + + validations = { + ('devices',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'solution': (str,), # noqa: E501 + 'state': (str,), # noqa: E501 + 'version': (int,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'devices': ([str],), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'number_of_devices': (int,), # noqa: E501 + 'number_of_devices_up_to_date': (int,), # noqa: E501 + 'profiles': ([FeatureProfile],), # noqa: E501 + 'source': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'solution': 'solution', # noqa: E501 + 'state': 'state', # noqa: E501 + 'version': 'version', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'description': 'description', # noqa: E501 + 'devices': 'devices', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'number_of_devices': 'numberOfDevices', # noqa: E501 + 'number_of_devices_up_to_date': 'numberOfDevicesUpToDate', # noqa: E501 + 'profiles': 'profiles', # noqa: E501 + 'source': 'source', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, solution, state, version, *args, **kwargs): # noqa: E501 + """ConfigGroup - a model defined in OpenAPI + + Args: + name (str): Name of the Config Group. Must be unique. + solution (str): Specify one of the device platform solution + state (str): Config Group Deployment state + version (int): Config Group Version Flag + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + description (str): Description of the Config Group.. [optional] # noqa: E501 + devices ([str]): [optional] # noqa: E501 + id (str): System generated unique identifier of the Config Group in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + number_of_devices (int): [optional] # noqa: E501 + number_of_devices_up_to_date (int): [optional] # noqa: E501 + profiles ([FeatureProfile]): List of devices UUIDs associated with this config group. [optional] # noqa: E501 + source (str): Source of config-group. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.solution = solution + self.state = state + self.version = version + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, solution, state, version, *args, **kwargs): # noqa: E501 + """ConfigGroup - a model defined in OpenAPI + + Args: + name (str): Name of the Config Group. Must be unique. + solution (str): Specify one of the device platform solution + state (str): Config Group Deployment state + version (int): Config Group Version Flag + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + description (str): Description of the Config Group.. [optional] # noqa: E501 + devices ([str]): [optional] # noqa: E501 + id (str): System generated unique identifier of the Config Group in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + number_of_devices (int): [optional] # noqa: E501 + number_of_devices_up_to_date (int): [optional] # noqa: E501 + profiles ([FeatureProfile]): List of devices UUIDs associated with this config group. [optional] # noqa: E501 + source (str): Source of config-group. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.solution = solution + self.state = state + self.version = version + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/connect_to_ntp_server.py b/openapi_client/model/connect_to_ntp_server.py new file mode 100644 index 0000000..21a0d11 --- /dev/null +++ b/openapi_client/model/connect_to_ntp_server.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class ConnectToNtpServer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'ip_address': (str,), # noqa: E501 + 'vpn': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'ip_address': 'ipAddress', # noqa: E501 + 'vpn': 'vpn', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectToNtpServer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ip_address (str): [optional] # noqa: E501 + vpn (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectToNtpServer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ip_address (str): [optional] # noqa: E501 + vpn (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/control_status.py b/openapi_client/model/control_status.py new file mode 100644 index 0000000..736b55e --- /dev/null +++ b/openapi_client/model/control_status.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class ControlStatus(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'control_down': (int,), # noqa: E501 + 'control_up': (int,), # noqa: E501 + 'partial': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'control_down': 'controlDown', # noqa: E501 + 'control_up': 'controlUp', # noqa: E501 + 'partial': 'partial', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ControlStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + control_down (int): [optional] # noqa: E501 + control_up (int): [optional] # noqa: E501 + partial (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ControlStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + control_down (int): [optional] # noqa: E501 + control_up (int): [optional] # noqa: E501 + partial (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/corporate_wifi.py b/openapi_client/model/corporate_wifi.py new file mode 100644 index 0000000..863dbe8 --- /dev/null +++ b/openapi_client/model/corporate_wifi.py @@ -0,0 +1,299 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.radius_server import RadiusServer + globals()['RadiusServer'] = RadiusServer + + +class CorporateWifi(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('security_auth_type',): { + 'regex': { + 'pattern': r'(WPA2-PSK_AES|WPA2-Enterprise)', # noqa: E501 + }, + }, + ('ssid',): { + 'max_length': 32, + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'corporate_wlan': (bool,), # noqa: E501 + 'radius_server': (RadiusServer,), # noqa: E501 + 'security_auth_type': (str,), # noqa: E501 + 'ssid': (str,), # noqa: E501 + 'visibility': (bool,), # noqa: E501 + 'wpa_psk_key': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'corporate_wlan': 'corporateWlan', # noqa: E501 + 'radius_server': 'radiusServer', # noqa: E501 + 'security_auth_type': 'securityAuthType', # noqa: E501 + 'ssid': 'ssid', # noqa: E501 + 'visibility': 'visibility', # noqa: E501 + 'wpa_psk_key': 'wpaPskKey', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CorporateWifi - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + corporate_wlan (bool): [optional] # noqa: E501 + radius_server (RadiusServer): [optional] # noqa: E501 + security_auth_type (str): [optional] # noqa: E501 + ssid (str): [optional] # noqa: E501 + visibility (bool): [optional] # noqa: E501 + wpa_psk_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CorporateWifi - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + corporate_wlan (bool): [optional] # noqa: E501 + radius_server (RadiusServer): [optional] # noqa: E501 + security_auth_type (str): [optional] # noqa: E501 + ssid (str): [optional] # noqa: E501 + visibility (bool): [optional] # noqa: E501 + wpa_psk_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/country_region_settings.py b/openapi_client/model/country_region_settings.py new file mode 100644 index 0000000..e827030 --- /dev/null +++ b/openapi_client/model/country_region_settings.py @@ -0,0 +1,273 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class CountryRegionSettings(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('regulatory_domain',): { + 'regex': { + 'pattern': r'(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'country_region': (str,), # noqa: E501 + 'regulatory_domain': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'country_region': 'countryRegion', # noqa: E501 + 'regulatory_domain': 'regulatoryDomain', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CountryRegionSettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + country_region (str): [optional] # noqa: E501 + regulatory_domain (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CountryRegionSettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + country_region (str): [optional] # noqa: E501 + regulatory_domain (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/create_device_params.py b/openapi_client/model/create_device_params.py new file mode 100644 index 0000000..fd3d28d --- /dev/null +++ b/openapi_client/model/create_device_params.py @@ -0,0 +1,288 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class CreateDeviceParams(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_ip': (str,), # noqa: E501 + 'generate_csr': (bool,), # noqa: E501 + 'password': (str,), # noqa: E501 + 'personality': (str,), # noqa: E501 + 'port': (str,), # noqa: E501 + 'protocol': (str,), # noqa: E501 + 'username': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_ip': 'deviceIP', # noqa: E501 + 'generate_csr': 'generateCSR', # noqa: E501 + 'password': 'password', # noqa: E501 + 'personality': 'personality', # noqa: E501 + 'port': 'port', # noqa: E501 + 'protocol': 'protocol', # noqa: E501 + 'username': 'username', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateDeviceParams - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_ip (str): [optional] # noqa: E501 + generate_csr (bool): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + personality (str): [optional] # noqa: E501 + port (str): [optional] # noqa: E501 + protocol (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CreateDeviceParams - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_ip (str): [optional] # noqa: E501 + generate_csr (bool): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + personality (str): [optional] # noqa: E501 + port (str): [optional] # noqa: E501 + protocol (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/create_tenant_model.py b/openapi_client/model/create_tenant_model.py new file mode 100644 index 0000000..0a3bdb6 --- /dev/null +++ b/openapi_client/model/create_tenant_model.py @@ -0,0 +1,304 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class CreateTenantModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'desc': (str,), # noqa: E501 + 'getv_bond_address': (str,), # noqa: E501 + 'getv_smarts': ([str],), # noqa: E501 + 'idp_metadata': (str,), # noqa: E501 + 'mode': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'old_idp_metadata': (str,), # noqa: E501 + 'org_name': (str,), # noqa: E501 + 'sp_metadata': (str,), # noqa: E501 + 'sub_domain': (str,), # noqa: E501 + 'wan_edge_forecast': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'desc': 'desc', # noqa: E501 + 'getv_bond_address': 'getvBondAddress', # noqa: E501 + 'getv_smarts': 'getvSmarts', # noqa: E501 + 'idp_metadata': 'idpMetadata', # noqa: E501 + 'mode': 'mode', # noqa: E501 + 'name': 'name', # noqa: E501 + 'old_idp_metadata': 'oldIdpMetadata', # noqa: E501 + 'org_name': 'orgName', # noqa: E501 + 'sp_metadata': 'spMetadata', # noqa: E501 + 'sub_domain': 'subDomain', # noqa: E501 + 'wan_edge_forecast': 'wanEdgeForecast', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateTenantModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + desc (str): [optional] # noqa: E501 + getv_bond_address (str): [optional] # noqa: E501 + getv_smarts ([str]): [optional] # noqa: E501 + idp_metadata (str): [optional] # noqa: E501 + mode (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + old_idp_metadata (str): [optional] # noqa: E501 + org_name (str): [optional] # noqa: E501 + sp_metadata (str): [optional] # noqa: E501 + sub_domain (str): [optional] # noqa: E501 + wan_edge_forecast (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CreateTenantModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + desc (str): [optional] # noqa: E501 + getv_bond_address (str): [optional] # noqa: E501 + getv_smarts ([str]): [optional] # noqa: E501 + idp_metadata (str): [optional] # noqa: E501 + mode (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + old_idp_metadata (str): [optional] # noqa: E501 + org_name (str): [optional] # noqa: E501 + sp_metadata (str): [optional] # noqa: E501 + sub_domain (str): [optional] # noqa: E501 + wan_edge_forecast (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/data_center.py b/openapi_client/model/data_center.py new file mode 100644 index 0000000..2323de8 --- /dev/null +++ b/openapi_client/model/data_center.py @@ -0,0 +1,294 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.node import Node + globals()['Node'] = Node + + +class DataCenter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'dc_personality': (str,), # noqa: E501 + 'members': ([Node],), # noqa: E501 + 'mgmt_ip_address': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'nms_personality': (str,), # noqa: E501 + 'password': (str,), # noqa: E501 + 'username': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dc_personality': 'dcPersonality', # noqa: E501 + 'members': 'members', # noqa: E501 + 'mgmt_ip_address': 'mgmtIPAddress', # noqa: E501 + 'name': 'name', # noqa: E501 + 'nms_personality': 'nmsPersonality', # noqa: E501 + 'password': 'password', # noqa: E501 + 'username': 'username', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DataCenter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dc_personality (str): [optional] # noqa: E501 + members ([Node]): [optional] # noqa: E501 + mgmt_ip_address (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + nms_personality (str): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DataCenter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dc_personality (str): [optional] # noqa: E501 + members ([Node]): [optional] # noqa: E501 + mgmt_ip_address (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + nms_personality (str): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/data_center_registration.py b/openapi_client/model/data_center_registration.py new file mode 100644 index 0000000..ba2b614 --- /dev/null +++ b/openapi_client/model/data_center_registration.py @@ -0,0 +1,300 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.data_center import DataCenter + from openapi_client.model.disaster_recovery_settings import DisasterRecoverySettings + from openapi_client.model.host import Host + from openapi_client.model.node import Node + globals()['DataCenter'] = DataCenter + globals()['DisasterRecoverySettings'] = DisasterRecoverySettings + globals()['Host'] = Host + globals()['Node'] = Node + + +class DataCenterRegistration(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'cluster_enc_key': (str,), # noqa: E501 + 'cluster_env_key': (str,), # noqa: E501 + 'data_centers': ([DataCenter],), # noqa: E501 + 'disaster_recovery_settings': (DisasterRecoverySettings,), # noqa: E501 + 'host': (Host,), # noqa: E501 + 'vbonds': ([Node],), # noqa: E501 + 'vmanage_root_ca': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'cluster_enc_key': 'clusterEncKey', # noqa: E501 + 'cluster_env_key': 'clusterEnvKey', # noqa: E501 + 'data_centers': 'dataCenters', # noqa: E501 + 'disaster_recovery_settings': 'disasterRecoverySettings', # noqa: E501 + 'host': 'host', # noqa: E501 + 'vbonds': 'vbonds', # noqa: E501 + 'vmanage_root_ca': 'vmanageRootCA', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DataCenterRegistration - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + cluster_enc_key (str): [optional] # noqa: E501 + cluster_env_key (str): [optional] # noqa: E501 + data_centers ([DataCenter]): [optional] # noqa: E501 + disaster_recovery_settings (DisasterRecoverySettings): [optional] # noqa: E501 + host (Host): [optional] # noqa: E501 + vbonds ([Node]): [optional] # noqa: E501 + vmanage_root_ca (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DataCenterRegistration - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + cluster_enc_key (str): [optional] # noqa: E501 + cluster_env_key (str): [optional] # noqa: E501 + data_centers ([DataCenter]): [optional] # noqa: E501 + disaster_recovery_settings (DisasterRecoverySettings): [optional] # noqa: E501 + host (Host): [optional] # noqa: E501 + vbonds ([Node]): [optional] # noqa: E501 + vmanage_root_ca (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/delete_tenant_bulk_model.py b/openapi_client/model/delete_tenant_bulk_model.py new file mode 100644 index 0000000..e705fa1 --- /dev/null +++ b/openapi_client/model/delete_tenant_bulk_model.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeleteTenantBulkModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'password': (str,), # noqa: E501 + 'tenant_id_list': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'password': 'password', # noqa: E501 + 'tenant_id_list': 'tenantIdList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeleteTenantBulkModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str): [optional] # noqa: E501 + tenant_id_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeleteTenantBulkModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str): [optional] # noqa: E501 + tenant_id_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/delete_tenant_model.py b/openapi_client/model/delete_tenant_model.py new file mode 100644 index 0000000..4bf6eaa --- /dev/null +++ b/openapi_client/model/delete_tenant_model.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeleteTenantModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'password': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'password': 'password', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeleteTenantModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeleteTenantModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/device.py b/openapi_client/model/device.py new file mode 100644 index 0000000..95c75c0 --- /dev/null +++ b/openapi_client/model/device.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Device(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_type': (str,), # noqa: E501 + 'system_ip': (str,), # noqa: E501 + 'uuid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_type': 'deviceType', # noqa: E501 + 'system_ip': 'systemIp', # noqa: E501 + 'uuid': 'uuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Device - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_type (str): [optional] # noqa: E501 + system_ip (str): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Device - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_type (str): [optional] # noqa: E501 + system_ip (str): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/device_health_details.py b/openapi_client/model/device_health_details.py new file mode 100644 index 0000000..414fe72 --- /dev/null +++ b/openapi_client/model/device_health_details.py @@ -0,0 +1,397 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeviceHealthDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('health',): { + 'RED': "red", + 'YELLOW': "yellow", + 'GREEN': "green", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'bfd_sessions': (int,), # noqa: E501 + 'bfd_sessions_up': (int,), # noqa: E501 + 'board_serial_number': (str,), # noqa: E501 + 'chassis_number': (str,), # noqa: E501 + 'connected_vmanages': ([str],), # noqa: E501 + 'control_connections_to_vsmat': (DeviceHealthDetails,), # noqa: E501 + 'control_connections': (int,), # noqa: E501 + 'control_connections_up': (int,), # noqa: E501 + 'cpu_load': (float,), # noqa: E501 + 'device_groups': ([str],), # noqa: E501 + 'device_model': (str,), # noqa: E501 + 'device_type': (str,), # noqa: E501 + 'expected_vsmart_connections': (int,), # noqa: E501 + 'has_geo_data': (bool,), # noqa: E501 + 'health': (str,), # noqa: E501 + 'latitude': (str,), # noqa: E501 + 'local_system_ip': (str,), # noqa: E501 + 'location': (str,), # noqa: E501 + 'longitude': (str,), # noqa: E501 + 'memory_utilization': (float,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'omp_peers': (int,), # noqa: E501 + 'omp_peers_up': (int,), # noqa: E501 + 'personality': (str,), # noqa: E501 + 'qoe': (int,), # noqa: E501 + 'reachability': (str,), # noqa: E501 + 'site_id': (str,), # noqa: E501 + 'software_version': (str,), # noqa: E501 + 'system_ip': (str,), # noqa: E501 + 'uptime_date': (int,), # noqa: E501 + 'uuid': (str,), # noqa: E501 + 'vpn_ids': ([str],), # noqa: E501 + 'vsmart_control_connections': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'bfd_sessions': 'bfd_sessions', # noqa: E501 + 'bfd_sessions_up': 'bfd_sessions_up', # noqa: E501 + 'board_serial_number': 'board_serial_number', # noqa: E501 + 'chassis_number': 'chassis_number', # noqa: E501 + 'connected_vmanages': 'connected_vmanages', # noqa: E501 + 'control_connections_to_vsmat': 'controlConnectionsToVsmat', # noqa: E501 + 'control_connections': 'control_connections', # noqa: E501 + 'control_connections_up': 'control_connections_up', # noqa: E501 + 'cpu_load': 'cpu_load', # noqa: E501 + 'device_groups': 'device_groups', # noqa: E501 + 'device_model': 'device_model', # noqa: E501 + 'device_type': 'device_type', # noqa: E501 + 'expected_vsmart_connections': 'expected_vsmart_connections', # noqa: E501 + 'has_geo_data': 'has_geo_data', # noqa: E501 + 'health': 'health', # noqa: E501 + 'latitude': 'latitude', # noqa: E501 + 'local_system_ip': 'local_system_ip', # noqa: E501 + 'location': 'location', # noqa: E501 + 'longitude': 'longitude', # noqa: E501 + 'memory_utilization': 'memory_utilization', # noqa: E501 + 'name': 'name', # noqa: E501 + 'omp_peers': 'omp_peers', # noqa: E501 + 'omp_peers_up': 'omp_peers_up', # noqa: E501 + 'personality': 'personality', # noqa: E501 + 'qoe': 'qoe', # noqa: E501 + 'reachability': 'reachability', # noqa: E501 + 'site_id': 'site_id', # noqa: E501 + 'software_version': 'software_version', # noqa: E501 + 'system_ip': 'system_ip', # noqa: E501 + 'uptime_date': 'uptime_date', # noqa: E501 + 'uuid': 'uuid', # noqa: E501 + 'vpn_ids': 'vpn_ids', # noqa: E501 + 'vsmart_control_connections': 'vsmart_control_connections', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeviceHealthDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bfd_sessions (int): [optional] # noqa: E501 + bfd_sessions_up (int): [optional] # noqa: E501 + board_serial_number (str): [optional] # noqa: E501 + chassis_number (str): [optional] # noqa: E501 + connected_vmanages ([str]): [optional] # noqa: E501 + control_connections_to_vsmat (DeviceHealthDetails): [optional] # noqa: E501 + control_connections (int): [optional] # noqa: E501 + control_connections_up (int): [optional] # noqa: E501 + cpu_load (float): [optional] # noqa: E501 + device_groups ([str]): [optional] # noqa: E501 + device_model (str): [optional] # noqa: E501 + device_type (str): [optional] # noqa: E501 + expected_vsmart_connections (int): [optional] # noqa: E501 + has_geo_data (bool): [optional] # noqa: E501 + health (str): [optional] # noqa: E501 + latitude (str): [optional] # noqa: E501 + local_system_ip (str): [optional] # noqa: E501 + location (str): [optional] # noqa: E501 + longitude (str): [optional] # noqa: E501 + memory_utilization (float): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + omp_peers (int): [optional] # noqa: E501 + omp_peers_up (int): [optional] # noqa: E501 + personality (str): [optional] # noqa: E501 + qoe (int): [optional] # noqa: E501 + reachability (str): [optional] # noqa: E501 + site_id (str): [optional] # noqa: E501 + software_version (str): [optional] # noqa: E501 + system_ip (str): [optional] # noqa: E501 + uptime_date (int): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + vpn_ids ([str]): [optional] # noqa: E501 + vsmart_control_connections (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeviceHealthDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bfd_sessions (int): [optional] # noqa: E501 + bfd_sessions_up (int): [optional] # noqa: E501 + board_serial_number (str): [optional] # noqa: E501 + chassis_number (str): [optional] # noqa: E501 + connected_vmanages ([str]): [optional] # noqa: E501 + control_connections_to_vsmat (DeviceHealthDetails): [optional] # noqa: E501 + control_connections (int): [optional] # noqa: E501 + control_connections_up (int): [optional] # noqa: E501 + cpu_load (float): [optional] # noqa: E501 + device_groups ([str]): [optional] # noqa: E501 + device_model (str): [optional] # noqa: E501 + device_type (str): [optional] # noqa: E501 + expected_vsmart_connections (int): [optional] # noqa: E501 + has_geo_data (bool): [optional] # noqa: E501 + health (str): [optional] # noqa: E501 + latitude (str): [optional] # noqa: E501 + local_system_ip (str): [optional] # noqa: E501 + location (str): [optional] # noqa: E501 + longitude (str): [optional] # noqa: E501 + memory_utilization (float): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + omp_peers (int): [optional] # noqa: E501 + omp_peers_up (int): [optional] # noqa: E501 + personality (str): [optional] # noqa: E501 + qoe (int): [optional] # noqa: E501 + reachability (str): [optional] # noqa: E501 + site_id (str): [optional] # noqa: E501 + software_version (str): [optional] # noqa: E501 + system_ip (str): [optional] # noqa: E501 + uptime_date (int): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + vpn_ids ([str]): [optional] # noqa: E501 + vsmart_control_connections (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/device_ip.py b/openapi_client/model/device_ip.py new file mode 100644 index 0000000..fa3de08 --- /dev/null +++ b/openapi_client/model/device_ip.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeviceIP(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_ip': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_ip': 'deviceIp', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeviceIP - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_ip (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeviceIP - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_ip (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/device_model.py b/openapi_client/model/device_model.py new file mode 100644 index 0000000..9a79847 --- /dev/null +++ b/openapi_client/model/device_model.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeviceModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_model': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_model': 'deviceModel', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeviceModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_model (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeviceModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_model (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/device_type.py b/openapi_client/model/device_type.py new file mode 100644 index 0000000..0b99551 --- /dev/null +++ b/openapi_client/model/device_type.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeviceType(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_type': 'deviceType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeviceType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeviceType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/device_uuid.py b/openapi_client/model/device_uuid.py new file mode 100644 index 0000000..89e31c6 --- /dev/null +++ b/openapi_client/model/device_uuid.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DeviceUuid(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'device_uuid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'device_uuid': 'deviceUuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeviceUuid - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DeviceUuid - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + device_uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/devices_health.py b/openapi_client/model/devices_health.py new file mode 100644 index 0000000..ba446c0 --- /dev/null +++ b/openapi_client/model/devices_health.py @@ -0,0 +1,278 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.device_health_details import DeviceHealthDetails + globals()['DeviceHealthDetails'] = DeviceHealthDetails + + +class DevicesHealth(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'devices': ([DeviceHealthDetails],), # noqa: E501 + 'header': ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)},), # noqa: E501 + 'total_devices': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'devices': 'devices', # noqa: E501 + 'header': 'header', # noqa: E501 + 'total_devices': 'total_devices', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DevicesHealth - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + devices ([DeviceHealthDetails]): [optional] # noqa: E501 + header ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): [optional] # noqa: E501 + total_devices (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DevicesHealth - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + devices ([DeviceHealthDetails]): [optional] # noqa: E501 + header ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): [optional] # noqa: E501 + total_devices (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/devices_health_overview.py b/openapi_client/model/devices_health_overview.py new file mode 100644 index 0000000..b3a3b30 --- /dev/null +++ b/openapi_client/model/devices_health_overview.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DevicesHealthOverview(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'fair': (int,), # noqa: E501 + 'good': (int,), # noqa: E501 + 'poor': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'fair': 'fair', # noqa: E501 + 'good': 'good', # noqa: E501 + 'poor': 'poor', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DevicesHealthOverview - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + fair (int): [optional] # noqa: E501 + good (int): [optional] # noqa: E501 + poor (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DevicesHealthOverview - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + fair (int): [optional] # noqa: E501 + good (int): [optional] # noqa: E501 + poor (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/dhcp_pool.py b/openapi_client/model/dhcp_pool.py new file mode 100644 index 0000000..3ec5205 --- /dev/null +++ b/openapi_client/model/dhcp_pool.py @@ -0,0 +1,300 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DHCPPool(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('lease_time_day',): { + 'inclusive_maximum': 365, + 'inclusive_minimum': 0, + }, + ('lease_time_hour',): { + 'inclusive_maximum': 23, + 'inclusive_minimum': 0, + }, + ('lease_time_min',): { + 'inclusive_maximum': 59, + 'inclusive_minimum': 0, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'lease_time_day': (int,), # noqa: E501 + 'lease_time_hour': (int,), # noqa: E501 + 'lease_time_min': (int,), # noqa: E501 + 'pool_network': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'lease_time_day': 'leaseTimeDay', # noqa: E501 + 'lease_time_hour': 'leaseTimeHour', # noqa: E501 + 'lease_time_min': 'leaseTimeMin', # noqa: E501 + 'pool_network': 'poolNetwork', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, lease_time_day, lease_time_hour, lease_time_min, pool_network, *args, **kwargs): # noqa: E501 + """DHCPPool - a model defined in OpenAPI + + Args: + lease_time_day (int): + lease_time_hour (int): + lease_time_min (int): + pool_network (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.lease_time_day = lease_time_day + self.lease_time_hour = lease_time_hour + self.lease_time_min = lease_time_min + self.pool_network = pool_network + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, lease_time_day, lease_time_hour, lease_time_min, pool_network, *args, **kwargs): # noqa: E501 + """DHCPPool - a model defined in OpenAPI + + Args: + lease_time_day (int): + lease_time_hour (int): + lease_time_min (int): + pool_network (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.lease_time_day = lease_time_day + self.lease_time_hour = lease_time_hour + self.lease_time_min = lease_time_min + self.pool_network = pool_network + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/disaster_recovery_settings.py b/openapi_client/model/disaster_recovery_settings.py new file mode 100644 index 0000000..48a1d8e --- /dev/null +++ b/openapi_client/model/disaster_recovery_settings.py @@ -0,0 +1,292 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DisasterRecoverySettings(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'delay_threshold': (int,), # noqa: E501 + 'dr_paused': (bool,), # noqa: E501 + 'ignored_indexes': ([str],), # noqa: E501 + 'interval': (int,), # noqa: E501 + 'interval_modified': (bool,), # noqa: E501 + 'pause_dr': (DisasterRecoverySettings,), # noqa: E501 + 'pause_replication': (bool,), # noqa: E501 + 'start_time': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'delay_threshold': 'delayThreshold', # noqa: E501 + 'dr_paused': 'drPaused', # noqa: E501 + 'ignored_indexes': 'ignoredIndexes', # noqa: E501 + 'interval': 'interval', # noqa: E501 + 'interval_modified': 'intervalModified', # noqa: E501 + 'pause_dr': 'pauseDR', # noqa: E501 + 'pause_replication': 'pauseReplication', # noqa: E501 + 'start_time': 'startTime', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DisasterRecoverySettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + delay_threshold (int): [optional] # noqa: E501 + dr_paused (bool): [optional] # noqa: E501 + ignored_indexes ([str]): [optional] # noqa: E501 + interval (int): [optional] # noqa: E501 + interval_modified (bool): [optional] # noqa: E501 + pause_dr (DisasterRecoverySettings): [optional] # noqa: E501 + pause_replication (bool): [optional] # noqa: E501 + start_time (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DisasterRecoverySettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + delay_threshold (int): [optional] # noqa: E501 + dr_paused (bool): [optional] # noqa: E501 + ignored_indexes ([str]): [optional] # noqa: E501 + interval (int): [optional] # noqa: E501 + interval_modified (bool): [optional] # noqa: E501 + pause_dr (DisasterRecoverySettings): [optional] # noqa: E501 + pause_replication (bool): [optional] # noqa: E501 + start_time (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/domain_detail.py b/openapi_client/model/domain_detail.py new file mode 100644 index 0000000..ae53bc0 --- /dev/null +++ b/openapi_client/model/domain_detail.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class DomainDetail(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('resolved_ip',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'domain': (str,), # noqa: E501 + 'resolved_ip': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'domain': 'domain', # noqa: E501 + 'resolved_ip': 'resolvedIp', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DomainDetail - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + domain (str): [optional] # noqa: E501 + resolved_ip ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DomainDetail - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + domain (str): [optional] # noqa: E501 + resolved_ip ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/entity_ownership_info.py b/openapi_client/model/entity_ownership_info.py new file mode 100644 index 0000000..936fe17 --- /dev/null +++ b/openapi_client/model/entity_ownership_info.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class EntityOwnershipInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'bucket': (str,), # noqa: E501 + 'entity_name': (str,), # noqa: E501 + 'owner': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'bucket': 'bucket', # noqa: E501 + 'entity_name': 'entityName', # noqa: E501 + 'owner': 'owner', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EntityOwnershipInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bucket (str): [optional] # noqa: E501 + entity_name (str): [optional] # noqa: E501 + owner (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EntityOwnershipInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bucket (str): [optional] # noqa: E501 + entity_name (str): [optional] # noqa: E501 + owner (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/equinix_credentials.py b/openapi_client/model/equinix_credentials.py new file mode 100644 index 0000000..1356e4d --- /dev/null +++ b/openapi_client/model/equinix_credentials.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class EquinixCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'client_id': (str,), # noqa: E501 + 'client_secret': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'client_id': 'clientId', # noqa: E501 + 'client_secret': 'clientSecret', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EquinixCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_id (str): [optional] # noqa: E501 + client_secret (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EquinixCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_id (str): [optional] # noqa: E501 + client_secret (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/equinix_location_info.py b/openapi_client/model/equinix_location_info.py new file mode 100644 index 0000000..6007191 --- /dev/null +++ b/openapi_client/model/equinix_location_info.py @@ -0,0 +1,296 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.equinix_ne_info import EquinixNEInfo + from openapi_client.model.multi_cloud_edge_billing_account_info import MultiCloudEdgeBillingAccountInfo + globals()['EquinixNEInfo'] = EquinixNEInfo + globals()['MultiCloudEdgeBillingAccountInfo'] = MultiCloudEdgeBillingAccountInfo + + +class EquinixLocationInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'eq_billing_account_info_list': ([MultiCloudEdgeBillingAccountInfo],), # noqa: E501 + 'eq_ne_info': (EquinixNEInfo,), # noqa: E501 + 'metro_code': (str,), # noqa: E501 + 'metro_name': (str,), # noqa: E501 + 'network_region': (str,), # noqa: E501 + 'site_code': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'eq_billing_account_info_list': 'eqBillingAccountInfoList', # noqa: E501 + 'eq_ne_info': 'eqNEInfo', # noqa: E501 + 'metro_code': 'metroCode', # noqa: E501 + 'metro_name': 'metroName', # noqa: E501 + 'network_region': 'networkRegion', # noqa: E501 + 'site_code': 'siteCode', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EquinixLocationInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + eq_billing_account_info_list ([MultiCloudEdgeBillingAccountInfo]): [optional] # noqa: E501 + eq_ne_info (EquinixNEInfo): [optional] # noqa: E501 + metro_code (str): [optional] # noqa: E501 + metro_name (str): [optional] # noqa: E501 + network_region (str): [optional] # noqa: E501 + site_code (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EquinixLocationInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + eq_billing_account_info_list ([MultiCloudEdgeBillingAccountInfo]): [optional] # noqa: E501 + eq_ne_info (EquinixNEInfo): [optional] # noqa: E501 + metro_code (str): [optional] # noqa: E501 + metro_name (str): [optional] # noqa: E501 + network_region (str): [optional] # noqa: E501 + site_code (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/equinix_ne_info.py b/openapi_client/model/equinix_ne_info.py new file mode 100644 index 0000000..4c105f6 --- /dev/null +++ b/openapi_client/model/equinix_ne_info.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class EquinixNEInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'image_name_list': ([str],), # noqa: E501 + 'product_size_list': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'image_name_list': 'imageNameList', # noqa: E501 + 'product_size_list': 'productSizeList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EquinixNEInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + image_name_list ([str]): [optional] # noqa: E501 + product_size_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EquinixNEInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + image_name_list ([str]): [optional] # noqa: E501 + product_size_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/equinix_partner_port.py b/openapi_client/model/equinix_partner_port.py new file mode 100644 index 0000000..3950cd4 --- /dev/null +++ b/openapi_client/model/equinix_partner_port.py @@ -0,0 +1,288 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class EquinixPartnerPort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'authorization_key': (str,), # noqa: E501 + 'company_uid': (str,), # noqa: E501 + 'connect_type': (str,), # noqa: E501 + 'product_uid': (str,), # noqa: E501 + 'speed': (str,), # noqa: E501 + 'vxc_id': (str,), # noqa: E501 + 'vxc_permitted': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'authorization_key': 'authorizationKey', # noqa: E501 + 'company_uid': 'companyUid', # noqa: E501 + 'connect_type': 'connectType', # noqa: E501 + 'product_uid': 'productUid', # noqa: E501 + 'speed': 'speed', # noqa: E501 + 'vxc_id': 'vxcId', # noqa: E501 + 'vxc_permitted': 'vxcPermitted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EquinixPartnerPort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authorization_key (str): [optional] # noqa: E501 + company_uid (str): [optional] # noqa: E501 + connect_type (str): [optional] # noqa: E501 + product_uid (str): [optional] # noqa: E501 + speed (str): [optional] # noqa: E501 + vxc_id (str): [optional] # noqa: E501 + vxc_permitted (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EquinixPartnerPort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authorization_key (str): [optional] # noqa: E501 + company_uid (str): [optional] # noqa: E501 + connect_type (str): [optional] # noqa: E501 + product_uid (str): [optional] # noqa: E501 + speed (str): [optional] # noqa: E501 + vxc_id (str): [optional] # noqa: E501 + vxc_permitted (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/ethernet.py b/openapi_client/model/ethernet.py new file mode 100644 index 0000000..7dee858 --- /dev/null +++ b/openapi_client/model/ethernet.py @@ -0,0 +1,375 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.ethernet_all_of import EthernetAllOf + from openapi_client.model.ethernet_interface import EthernetInterface + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.variable import Variable + globals()['EthernetAllOf'] = EthernetAllOf + globals()['EthernetInterface'] = EthernetInterface + globals()['ProfileParcel'] = ProfileParcel + globals()['Variable'] = Variable + + +class Ethernet(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'ethernet_interface_list': ([EthernetInterface],), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'ethernet_interface_list': 'ethernetInterfaceList', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Ethernet - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ethernet_interface_list ([EthernetInterface]): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Ethernet - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ethernet_interface_list ([EthernetInterface]): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + EthernetAllOf, + ProfileParcel, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/ethernet_all_of.py b/openapi_client/model/ethernet_all_of.py new file mode 100644 index 0000000..a883264 --- /dev/null +++ b/openapi_client/model/ethernet_all_of.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.ethernet_interface import EthernetInterface + globals()['EthernetInterface'] = EthernetInterface + + +class EthernetAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'ethernet_interface_list': ([EthernetInterface],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'ethernet_interface_list': 'ethernetInterfaceList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EthernetAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ethernet_interface_list ([EthernetInterface]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EthernetAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ethernet_interface_list ([EthernetInterface]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/ethernet_interface.py b/openapi_client/model/ethernet_interface.py new file mode 100644 index 0000000..c9c4590 --- /dev/null +++ b/openapi_client/model/ethernet_interface.py @@ -0,0 +1,316 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class EthernetInterface(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('admin_state',): { + 'regex': { + 'pattern': r'(enabled|disabled)', # noqa: E501 + }, + }, + ('ip_assignment',): { + 'regex': { + 'pattern': r'(dynamic|static)', # noqa: E501 + }, + }, + ('port_type',): { + 'regex': { + 'pattern': r'(LAN|WAN)', # noqa: E501 + }, + }, + ('wan_configuration',): { + 'regex': { + 'pattern': r'(Active)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'admin_state': (str,), # noqa: E501 + 'corporate_lan': (bool,), # noqa: E501 + 'interface_name': (str,), # noqa: E501 + 'ip_assignment': (str,), # noqa: E501 + 'port_type': (str,), # noqa: E501 + 'static_ip_address': (str,), # noqa: E501 + 'static_ip_address_subnet_mask': (str,), # noqa: E501 + 'static_route_ip': (str,), # noqa: E501 + 'wan_configuration': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'admin_state': 'adminState', # noqa: E501 + 'corporate_lan': 'corporateLan', # noqa: E501 + 'interface_name': 'interfaceName', # noqa: E501 + 'ip_assignment': 'ipAssignment', # noqa: E501 + 'port_type': 'portType', # noqa: E501 + 'static_ip_address': 'staticIpAddress', # noqa: E501 + 'static_ip_address_subnet_mask': 'staticIpAddressSubnetMask', # noqa: E501 + 'static_route_ip': 'staticRouteIp', # noqa: E501 + 'wan_configuration': 'wanConfiguration', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EthernetInterface - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + admin_state (str): [optional] # noqa: E501 + corporate_lan (bool): [optional] # noqa: E501 + interface_name (str): [optional] # noqa: E501 + ip_assignment (str): [optional] # noqa: E501 + port_type (str): [optional] # noqa: E501 + static_ip_address (str): [optional] # noqa: E501 + static_ip_address_subnet_mask (str): [optional] # noqa: E501 + static_route_ip (str): [optional] # noqa: E501 + wan_configuration (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EthernetInterface - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + admin_state (str): [optional] # noqa: E501 + corporate_lan (bool): [optional] # noqa: E501 + interface_name (str): [optional] # noqa: E501 + ip_assignment (str): [optional] # noqa: E501 + port_type (str): [optional] # noqa: E501 + static_ip_address (str): [optional] # noqa: E501 + static_ip_address_subnet_mask (str): [optional] # noqa: E501 + static_route_ip (str): [optional] # noqa: E501 + wan_configuration (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/event_name.py b/openapi_client/model/event_name.py new file mode 100644 index 0000000..51f546a --- /dev/null +++ b/openapi_client/model/event_name.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class EventName(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'event_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'event_name': 'eventName', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EventName - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + event_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EventName - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + event_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/feature_profile.py b/openapi_client/model/feature_profile.py new file mode 100644 index 0000000..9ea9576 --- /dev/null +++ b/openapi_client/model/feature_profile.py @@ -0,0 +1,310 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class FeatureProfile(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'solution': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'solution': 'solution', # noqa: E501 + 'type': 'type', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'description': 'description', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, solution, type, *args, **kwargs): # noqa: E501 + """FeatureProfile - a model defined in OpenAPI + + Args: + name (str): Name of the feature Profile. Must be unique. + solution (str): Solution of the feature Profile. + type (str): Type of the feature Profile. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + description (str): Description of the feature Profile.. [optional] # noqa: E501 + id (str): System generated unique identifier of the feature profile in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.solution = solution + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, solution, type, *args, **kwargs): # noqa: E501 + """FeatureProfile - a model defined in OpenAPI + + Args: + name (str): Name of the feature Profile. Must be unique. + solution (str): Solution of the feature Profile. + type (str): Type of the feature Profile. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + description (str): Description of the feature Profile.. [optional] # noqa: E501 + id (str): System generated unique identifier of the feature profile in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.solution = solution + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/gcp_credentials.py b/openapi_client/model/gcp_credentials.py new file mode 100644 index 0000000..0a97e8f --- /dev/null +++ b/openapi_client/model/gcp_credentials.py @@ -0,0 +1,292 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class GcpCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'client_email': (str,), # noqa: E501 + 'client_id': (str,), # noqa: E501 + 'cloud_tenant_id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'private_key_data': (str,), # noqa: E501 + 'private_key': (str,), # noqa: E501 + 'private_key_id': (str,), # noqa: E501 + 'project_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'client_email': 'client_email', # noqa: E501 + 'client_id': 'client_id', # noqa: E501 + 'cloud_tenant_id': 'cloudTenantId', # noqa: E501 + 'name': 'name', # noqa: E501 + 'private_key_data': 'privateKeyData', # noqa: E501 + 'private_key': 'private_key', # noqa: E501 + 'private_key_id': 'private_key_id', # noqa: E501 + 'project_id': 'project_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GcpCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_email (str): [optional] # noqa: E501 + client_id (str): [optional] # noqa: E501 + cloud_tenant_id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + private_key_data (str): [optional] # noqa: E501 + private_key (str): [optional] # noqa: E501 + private_key_id (str): [optional] # noqa: E501 + project_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GcpCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_email (str): [optional] # noqa: E501 + client_id (str): [optional] # noqa: E501 + cloud_tenant_id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + private_key_data (str): [optional] # noqa: E501 + private_key (str): [optional] # noqa: E501 + private_key_id (str): [optional] # noqa: E501 + project_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/get_o365_preferred_path_from_v_analytics_request.py b/openapi_client/model/get_o365_preferred_path_from_v_analytics_request.py new file mode 100644 index 0000000..b9c48da --- /dev/null +++ b/openapi_client/model/get_o365_preferred_path_from_v_analytics_request.py @@ -0,0 +1,283 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.get_o365_preferred_path_from_v_analytics_request_value import GetO365PreferredPathFromVAnalyticsRequestValue + globals()['GetO365PreferredPathFromVAnalyticsRequestValue'] = GetO365PreferredPathFromVAnalyticsRequestValue + + +class GetO365PreferredPathFromVAnalyticsRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value_type',): { + 'ARRAY': "ARRAY", + 'OBJECT': "OBJECT", + 'STRING': "STRING", + 'NUMBER': "NUMBER", + 'TRUE': "TRUE", + 'FALSE': "FALSE", + 'NULL': "NULL", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (GetO365PreferredPathFromVAnalyticsRequestValue,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'value_type': (str,), # noqa: E501 + 'empty': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'value_type': 'valueType', # noqa: E501 + 'empty': 'empty', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GetO365PreferredPathFromVAnalyticsRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + value_type (str): [optional] # noqa: E501 + empty (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GetO365PreferredPathFromVAnalyticsRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + value_type (str): [optional] # noqa: E501 + empty (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/get_o365_preferred_path_from_v_analytics_request_value.py b/openapi_client/model/get_o365_preferred_path_from_v_analytics_request_value.py new file mode 100644 index 0000000..47369f3 --- /dev/null +++ b/openapi_client/model/get_o365_preferred_path_from_v_analytics_request_value.py @@ -0,0 +1,273 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class GetO365PreferredPathFromVAnalyticsRequestValue(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value_type',): { + 'ARRAY': "ARRAY", + 'OBJECT': "OBJECT", + 'STRING': "STRING", + 'NUMBER': "NUMBER", + 'TRUE': "TRUE", + 'FALSE': "FALSE", + 'NULL': "NULL", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'value_type': 'valueType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GetO365PreferredPathFromVAnalyticsRequestValue - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + value_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GetO365PreferredPathFromVAnalyticsRequestValue - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + value_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/global_settings.py b/openapi_client/model/global_settings.py new file mode 100644 index 0000000..81d891c --- /dev/null +++ b/openapi_client/model/global_settings.py @@ -0,0 +1,425 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.banner import Banner + from openapi_client.model.bfd import Bfd + from openapi_client.model.connect_to_ntp_server import ConnectToNtpServer + from openapi_client.model.global_settings_all_of import GlobalSettingsAllOf + from openapi_client.model.ip_sec_security import IpSecSecurity + from openapi_client.model.logging_system_messages import LoggingSystemMessages + from openapi_client.model.login_access_to_router import LoginAccessToRouter + from openapi_client.model.omp import OMP + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.systems import Systems + from openapi_client.model.variable import Variable + globals()['Banner'] = Banner + globals()['Bfd'] = Bfd + globals()['ConnectToNtpServer'] = ConnectToNtpServer + globals()['GlobalSettingsAllOf'] = GlobalSettingsAllOf + globals()['IpSecSecurity'] = IpSecSecurity + globals()['LoggingSystemMessages'] = LoggingSystemMessages + globals()['LoginAccessToRouter'] = LoginAccessToRouter + globals()['OMP'] = OMP + globals()['ProfileParcel'] = ProfileParcel + globals()['Systems'] = Systems + globals()['Variable'] = Variable + + +class GlobalSettings(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'basic_name': (str,), # noqa: E501 + 'basic_description': (str,), # noqa: E501 + 'ntp_server': ([ConnectToNtpServer],), # noqa: E501 + 'systems': (Systems,), # noqa: E501 + 'banner': (Banner,), # noqa: E501 + 'login_access_to_router': (LoginAccessToRouter,), # noqa: E501 + 'bfd': (Bfd,), # noqa: E501 + 'omp': (OMP,), # noqa: E501 + 'ip_sec_security': (IpSecSecurity,), # noqa: E501 + 'logging_system_messages': (LoggingSystemMessages,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'basic_name': 'basicName', # noqa: E501 + 'basic_description': 'basicDescription', # noqa: E501 + 'ntp_server': 'ntpServer', # noqa: E501 + 'systems': 'systems', # noqa: E501 + 'banner': 'banner', # noqa: E501 + 'login_access_to_router': 'loginAccessToRouter', # noqa: E501 + 'bfd': 'bfd', # noqa: E501 + 'omp': 'omp', # noqa: E501 + 'ip_sec_security': 'ipSecSecurity', # noqa: E501 + 'logging_system_messages': 'loggingSystemMessages', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GlobalSettings - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + basic_name (str): [optional] # noqa: E501 + basic_description (str): [optional] # noqa: E501 + ntp_server ([ConnectToNtpServer]): [optional] # noqa: E501 + systems (Systems): [optional] # noqa: E501 + banner (Banner): [optional] # noqa: E501 + login_access_to_router (LoginAccessToRouter): [optional] # noqa: E501 + bfd (Bfd): [optional] # noqa: E501 + omp (OMP): [optional] # noqa: E501 + ip_sec_security (IpSecSecurity): [optional] # noqa: E501 + logging_system_messages (LoggingSystemMessages): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GlobalSettings - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + basic_name (str): [optional] # noqa: E501 + basic_description (str): [optional] # noqa: E501 + ntp_server ([ConnectToNtpServer]): [optional] # noqa: E501 + systems (Systems): [optional] # noqa: E501 + banner (Banner): [optional] # noqa: E501 + login_access_to_router (LoginAccessToRouter): [optional] # noqa: E501 + bfd (Bfd): [optional] # noqa: E501 + omp (OMP): [optional] # noqa: E501 + ip_sec_security (IpSecSecurity): [optional] # noqa: E501 + logging_system_messages (LoggingSystemMessages): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + GlobalSettingsAllOf, + ProfileParcel, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/global_settings_all_of.py b/openapi_client/model/global_settings_all_of.py new file mode 100644 index 0000000..704101a --- /dev/null +++ b/openapi_client/model/global_settings_all_of.py @@ -0,0 +1,320 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.banner import Banner + from openapi_client.model.bfd import Bfd + from openapi_client.model.connect_to_ntp_server import ConnectToNtpServer + from openapi_client.model.ip_sec_security import IpSecSecurity + from openapi_client.model.logging_system_messages import LoggingSystemMessages + from openapi_client.model.login_access_to_router import LoginAccessToRouter + from openapi_client.model.omp import OMP + from openapi_client.model.systems import Systems + globals()['Banner'] = Banner + globals()['Bfd'] = Bfd + globals()['ConnectToNtpServer'] = ConnectToNtpServer + globals()['IpSecSecurity'] = IpSecSecurity + globals()['LoggingSystemMessages'] = LoggingSystemMessages + globals()['LoginAccessToRouter'] = LoginAccessToRouter + globals()['OMP'] = OMP + globals()['Systems'] = Systems + + +class GlobalSettingsAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'basic_name': (str,), # noqa: E501 + 'basic_description': (str,), # noqa: E501 + 'ntp_server': ([ConnectToNtpServer],), # noqa: E501 + 'systems': (Systems,), # noqa: E501 + 'banner': (Banner,), # noqa: E501 + 'login_access_to_router': (LoginAccessToRouter,), # noqa: E501 + 'bfd': (Bfd,), # noqa: E501 + 'omp': (OMP,), # noqa: E501 + 'ip_sec_security': (IpSecSecurity,), # noqa: E501 + 'logging_system_messages': (LoggingSystemMessages,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'basic_name': 'basicName', # noqa: E501 + 'basic_description': 'basicDescription', # noqa: E501 + 'ntp_server': 'ntpServer', # noqa: E501 + 'systems': 'systems', # noqa: E501 + 'banner': 'banner', # noqa: E501 + 'login_access_to_router': 'loginAccessToRouter', # noqa: E501 + 'bfd': 'bfd', # noqa: E501 + 'omp': 'omp', # noqa: E501 + 'ip_sec_security': 'ipSecSecurity', # noqa: E501 + 'logging_system_messages': 'loggingSystemMessages', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GlobalSettingsAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + basic_name (str): [optional] # noqa: E501 + basic_description (str): [optional] # noqa: E501 + ntp_server ([ConnectToNtpServer]): [optional] # noqa: E501 + systems (Systems): [optional] # noqa: E501 + banner (Banner): [optional] # noqa: E501 + login_access_to_router (LoginAccessToRouter): [optional] # noqa: E501 + bfd (Bfd): [optional] # noqa: E501 + omp (OMP): [optional] # noqa: E501 + ip_sec_security (IpSecSecurity): [optional] # noqa: E501 + logging_system_messages (LoggingSystemMessages): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GlobalSettingsAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + basic_name (str): [optional] # noqa: E501 + basic_description (str): [optional] # noqa: E501 + ntp_server ([ConnectToNtpServer]): [optional] # noqa: E501 + systems (Systems): [optional] # noqa: E501 + banner (Banner): [optional] # noqa: E501 + login_access_to_router (LoginAccessToRouter): [optional] # noqa: E501 + bfd (Bfd): [optional] # noqa: E501 + omp (OMP): [optional] # noqa: E501 + ip_sec_security (IpSecSecurity): [optional] # noqa: E501 + logging_system_messages (LoggingSystemMessages): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/group_id.py b/openapi_client/model/group_id.py new file mode 100644 index 0000000..df1dfe6 --- /dev/null +++ b/openapi_client/model/group_id.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class GroupId(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'group_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'group_id': 'groupId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GroupId - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + group_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GroupId - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + group_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/guest_wifi.py b/openapi_client/model/guest_wifi.py new file mode 100644 index 0000000..9e4afef --- /dev/null +++ b/openapi_client/model/guest_wifi.py @@ -0,0 +1,285 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class GuestWifi(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('security_auth_type',): { + 'regex': { + 'pattern': r'(OPEN|WPA2-PSK_AES)', # noqa: E501 + }, + }, + ('ssid',): { + 'max_length': 32, + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'security_auth_type': (str,), # noqa: E501 + 'ssid': (str,), # noqa: E501 + 'visibility': (bool,), # noqa: E501 + 'wpa_psk_key': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'security_auth_type': 'securityAuthType', # noqa: E501 + 'ssid': 'ssid', # noqa: E501 + 'visibility': 'visibility', # noqa: E501 + 'wpa_psk_key': 'wpaPskKey', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GuestWifi - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + security_auth_type (str): [optional] # noqa: E501 + ssid (str): [optional] # noqa: E501 + visibility (bool): [optional] # noqa: E501 + wpa_psk_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GuestWifi - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + security_auth_type (str): [optional] # noqa: E501 + ssid (str): [optional] # noqa: E501 + visibility (bool): [optional] # noqa: E501 + wpa_psk_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/header.py b/openapi_client/model/header.py new file mode 100644 index 0000000..4ef2134 --- /dev/null +++ b/openapi_client/model/header.py @@ -0,0 +1,278 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.header_element import HeaderElement + globals()['HeaderElement'] = HeaderElement + + +class Header(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'elements': ([HeaderElement],), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'elements': 'elements', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Header - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + elements ([HeaderElement]): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Header - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + elements ([HeaderElement]): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/header_element.py b/openapi_client/model/header_element.py new file mode 100644 index 0000000..6dbcb42 --- /dev/null +++ b/openapi_client/model/header_element.py @@ -0,0 +1,282 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.name_value_pair import NameValuePair + globals()['NameValuePair'] = NameValuePair + + +class HeaderElement(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'parameter_count': (int,), # noqa: E501 + 'parameters': ([NameValuePair],), # noqa: E501 + 'value': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'parameter_count': 'parameterCount', # noqa: E501 + 'parameters': 'parameters', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """HeaderElement - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + parameter_count (int): [optional] # noqa: E501 + parameters ([NameValuePair]): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """HeaderElement - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + parameter_count (int): [optional] # noqa: E501 + parameters ([NameValuePair]): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/host.py b/openapi_client/model/host.py new file mode 100644 index 0000000..dbca2b2 --- /dev/null +++ b/openapi_client/model/host.py @@ -0,0 +1,284 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Host(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'data_center_name': (str,), # noqa: E501 + 'dc_personality': (str,), # noqa: E501 + 'ifname': (str,), # noqa: E501 + 'ip': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'serialno': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_center_name': 'dataCenterName', # noqa: E501 + 'dc_personality': 'dcPersonality', # noqa: E501 + 'ifname': 'ifname', # noqa: E501 + 'ip': 'ip', # noqa: E501 + 'name': 'name', # noqa: E501 + 'serialno': 'serialno', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Host - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data_center_name (str): [optional] # noqa: E501 + dc_personality (str): [optional] # noqa: E501 + ifname (str): [optional] # noqa: E501 + ip (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + serialno (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Host - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data_center_name (str): [optional] # noqa: E501 + dc_personality (str): [optional] # noqa: E501 + ifname (str): [optional] # noqa: E501 + ip (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + serialno (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/ike_phase.py b/openapi_client/model/ike_phase.py new file mode 100644 index 0000000..b0f556a --- /dev/null +++ b/openapi_client/model/ike_phase.py @@ -0,0 +1,300 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class IkePhase(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('cipher_suite',): { + 'regex': { + 'pattern': r'(aes128-cbc-sha1|aes256-cbc-sha1|aes128-cbc-sha2|aes256-cbc-sha2)', # noqa: E501 + }, + }, + ('diffe_hellman_group',): { + 'regex': { + 'pattern': r'(14|15|16|19|20|21)', # noqa: E501 + }, + }, + ('ike_version',): { + 'inclusive_maximum': 2, + 'inclusive_minimum': 1, + }, + ('rekey_timer',): { + 'inclusive_maximum': 1209600, + 'inclusive_minimum': 300, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'cipher_suite': (str,), # noqa: E501 + 'diffe_hellman_group': (str,), # noqa: E501 + 'ike_version': (int,), # noqa: E501 + 'rekey_timer': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'cipher_suite': 'cipherSuite', # noqa: E501 + 'diffe_hellman_group': 'diffeHellmanGroup', # noqa: E501 + 'ike_version': 'ikeVersion', # noqa: E501 + 'rekey_timer': 'rekeyTimer', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, cipher_suite, *args, **kwargs): # noqa: E501 + """IkePhase - a model defined in OpenAPI + + Args: + cipher_suite (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + diffe_hellman_group (str): [optional] # noqa: E501 + ike_version (int): [optional] # noqa: E501 + rekey_timer (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.cipher_suite = cipher_suite + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, cipher_suite, *args, **kwargs): # noqa: E501 + """IkePhase - a model defined in OpenAPI + + Args: + cipher_suite (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + diffe_hellman_group (str): [optional] # noqa: E501 + ike_version (int): [optional] # noqa: E501 + rekey_timer (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.cipher_suite = cipher_suite + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/ip_sec_policy.py b/openapi_client/model/ip_sec_policy.py new file mode 100644 index 0000000..f01f536 --- /dev/null +++ b/openapi_client/model/ip_sec_policy.py @@ -0,0 +1,291 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.ike_phase import IkePhase + globals()['IkePhase'] = IkePhase + + +class IpSecPolicy(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('ike_phase2_cipher_suite',): { + 'regex': { + 'pattern': r'(aes128-sha1|aes256-cbc-sha1|aes256-gcm|null-sha|aes256-cbc-sha256|aes256-cbc-sha384|aes256-cbc-sha512)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'ike_phase1': (IkePhase,), # noqa: E501 + 'ike_phase2_cipher_suite': (str,), # noqa: E501 + 'preset': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'ike_phase1': 'ikePhase1', # noqa: E501 + 'ike_phase2_cipher_suite': 'ikePhase2CipherSuite', # noqa: E501 + 'preset': 'preset', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, ike_phase1, ike_phase2_cipher_suite, *args, **kwargs): # noqa: E501 + """IpSecPolicy - a model defined in OpenAPI + + Args: + ike_phase1 (IkePhase): + ike_phase2_cipher_suite (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + preset (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.ike_phase1 = ike_phase1 + self.ike_phase2_cipher_suite = ike_phase2_cipher_suite + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, ike_phase1, ike_phase2_cipher_suite, *args, **kwargs): # noqa: E501 + """IpSecPolicy - a model defined in OpenAPI + + Args: + ike_phase1 (IkePhase): + ike_phase2_cipher_suite (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + preset (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.ike_phase1 = ike_phase1 + self.ike_phase2_cipher_suite = ike_phase2_cipher_suite + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/ip_sec_security.py b/openapi_client/model/ip_sec_security.py new file mode 100644 index 0000000..27aaf17 --- /dev/null +++ b/openapi_client/model/ip_sec_security.py @@ -0,0 +1,281 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class IpSecSecurity(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('authentication_type',): { + 'regex': { + 'pattern': r'(ah-sha1-hmac|sha1-hmac)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'authentication_type': (str,), # noqa: E501 + 'ip_sec_pairwise_keying': (str,), # noqa: E501 + 'rekey_time': (int,), # noqa: E501 + 'replay_window': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'authentication_type': 'authenticationType', # noqa: E501 + 'ip_sec_pairwise_keying': 'ipSecPairwiseKeying', # noqa: E501 + 'rekey_time': 'rekeyTime', # noqa: E501 + 'replay_window': 'replayWindow', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """IpSecSecurity - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authentication_type (str): [optional] # noqa: E501 + ip_sec_pairwise_keying (str): [optional] # noqa: E501 + rekey_time (int): [optional] # noqa: E501 + replay_window (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """IpSecSecurity - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authentication_type (str): [optional] # noqa: E501 + ip_sec_pairwise_keying (str): [optional] # noqa: E501 + rekey_time (int): [optional] # noqa: E501 + replay_window (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/logging_system_messages.py b/openapi_client/model/logging_system_messages.py new file mode 100644 index 0000000..7a7cfc8 --- /dev/null +++ b/openapi_client/model/logging_system_messages.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class LoggingSystemMessages(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'max_file_size': (int,), # noqa: E501 + 'priority': (str,), # noqa: E501 + 'rotations': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'max_file_size': 'maxFileSize', # noqa: E501 + 'priority': 'priority', # noqa: E501 + 'rotations': 'rotations', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LoggingSystemMessages - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + max_file_size (int): [optional] # noqa: E501 + priority (str): [optional] # noqa: E501 + rotations (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LoggingSystemMessages - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + max_file_size (int): [optional] # noqa: E501 + priority (str): [optional] # noqa: E501 + rotations (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/login_access_to_router.py b/openapi_client/model/login_access_to_router.py new file mode 100644 index 0000000..f08e97e --- /dev/null +++ b/openapi_client/model/login_access_to_router.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class LoginAccessToRouter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'authentication_order': (str,), # noqa: E501 + 'local_password': (str,), # noqa: E501 + 'local_user': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'authentication_order': 'authenticationOrder', # noqa: E501 + 'local_password': 'localPassword', # noqa: E501 + 'local_user': 'localUser', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LoginAccessToRouter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authentication_order (str): [optional] # noqa: E501 + local_password (str): [optional] # noqa: E501 + local_user (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LoginAccessToRouter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authentication_order (str): [optional] # noqa: E501 + local_password (str): [optional] # noqa: E501 + local_user (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/lte_timer.py b/openapi_client/model/lte_timer.py new file mode 100644 index 0000000..16b6cf6 --- /dev/null +++ b/openapi_client/model/lte_timer.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class LteTimer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'dscp': (int,), # noqa: E501 + 'hello_interval': (int,), # noqa: E501 + 'multiplier': (int,), # noqa: E501 + 'path_mtu': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dscp': 'dscp', # noqa: E501 + 'hello_interval': 'helloInterval', # noqa: E501 + 'multiplier': 'multiplier', # noqa: E501 + 'path_mtu': 'pathMtu', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LteTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LteTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/megaport_credentials.py b/openapi_client/model/megaport_credentials.py new file mode 100644 index 0000000..9e2bfda --- /dev/null +++ b/openapi_client/model/megaport_credentials.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class MegaportCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'password': (str,), # noqa: E501 + 'username': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'password': 'password', # noqa: E501 + 'username': 'username', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MegaportCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MegaportCredentials - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/megaport_location_info.py b/openapi_client/model/megaport_location_info.py new file mode 100644 index 0000000..cbd1c5b --- /dev/null +++ b/openapi_client/model/megaport_location_info.py @@ -0,0 +1,302 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.megaport_mve_info import MegaportMVEInfo + globals()['MegaportMVEInfo'] = MegaportMVEInfo + + +class MegaportLocationInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'address': (str,), # noqa: E501 + 'country': (str,), # noqa: E501 + 'live_date': (str,), # noqa: E501 + 'market': (str,), # noqa: E501 + 'metro_name': (str,), # noqa: E501 + 'mp_mve_info': (MegaportMVEInfo,), # noqa: E501 + 'network_region': (str,), # noqa: E501 + 'site_code': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'address': 'address', # noqa: E501 + 'country': 'country', # noqa: E501 + 'live_date': 'liveDate', # noqa: E501 + 'market': 'market', # noqa: E501 + 'metro_name': 'metroName', # noqa: E501 + 'mp_mve_info': 'mpMVEInfo', # noqa: E501 + 'network_region': 'networkRegion', # noqa: E501 + 'site_code': 'siteCode', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MegaportLocationInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + address (str): [optional] # noqa: E501 + country (str): [optional] # noqa: E501 + live_date (str): [optional] # noqa: E501 + market (str): [optional] # noqa: E501 + metro_name (str): [optional] # noqa: E501 + mp_mve_info (MegaportMVEInfo): [optional] # noqa: E501 + network_region (str): [optional] # noqa: E501 + site_code (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MegaportLocationInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + address (str): [optional] # noqa: E501 + country (str): [optional] # noqa: E501 + live_date (str): [optional] # noqa: E501 + market (str): [optional] # noqa: E501 + metro_name (str): [optional] # noqa: E501 + mp_mve_info (MegaportMVEInfo): [optional] # noqa: E501 + network_region (str): [optional] # noqa: E501 + site_code (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/megaport_mve_info.py b/openapi_client/model/megaport_mve_info.py new file mode 100644 index 0000000..09ebb59 --- /dev/null +++ b/openapi_client/model/megaport_mve_info.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class MegaportMVEInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'image_name_list': ([str],), # noqa: E501 + 'product_size_list': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'image_name_list': 'imageNameList', # noqa: E501 + 'product_size_list': 'productSizeList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MegaportMVEInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + image_name_list ([str]): [optional] # noqa: E501 + product_size_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MegaportMVEInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + image_name_list ([str]): [optional] # noqa: E501 + product_size_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/megaport_partner_port.py b/openapi_client/model/megaport_partner_port.py new file mode 100644 index 0000000..d7f2b30 --- /dev/null +++ b/openapi_client/model/megaport_partner_port.py @@ -0,0 +1,288 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class MegaportPartnerPort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'authorization_key': (str,), # noqa: E501 + 'company_uid': (str,), # noqa: E501 + 'connect_type': (str,), # noqa: E501 + 'product_uid': (str,), # noqa: E501 + 'speed': (str,), # noqa: E501 + 'vxc_id': (str,), # noqa: E501 + 'vxc_permitted': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'authorization_key': 'authorizationKey', # noqa: E501 + 'company_uid': 'companyUid', # noqa: E501 + 'connect_type': 'connectType', # noqa: E501 + 'product_uid': 'productUid', # noqa: E501 + 'speed': 'speed', # noqa: E501 + 'vxc_id': 'vxcId', # noqa: E501 + 'vxc_permitted': 'vxcPermitted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MegaportPartnerPort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authorization_key (str): [optional] # noqa: E501 + company_uid (str): [optional] # noqa: E501 + connect_type (str): [optional] # noqa: E501 + product_uid (str): [optional] # noqa: E501 + speed (str): [optional] # noqa: E501 + vxc_id (str): [optional] # noqa: E501 + vxc_permitted (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MegaportPartnerPort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + authorization_key (str): [optional] # noqa: E501 + company_uid (str): [optional] # noqa: E501 + connect_type (str): [optional] # noqa: E501 + product_uid (str): [optional] # noqa: E501 + speed (str): [optional] # noqa: E501 + vxc_id (str): [optional] # noqa: E501 + vxc_permitted (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/mpls_timer.py b/openapi_client/model/mpls_timer.py new file mode 100644 index 0000000..37aa3dc --- /dev/null +++ b/openapi_client/model/mpls_timer.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class MplsTimer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'dscp': (int,), # noqa: E501 + 'hello_interval': (int,), # noqa: E501 + 'multiplier': (int,), # noqa: E501 + 'path_mtu': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dscp': 'dscp', # noqa: E501 + 'hello_interval': 'helloInterval', # noqa: E501 + 'multiplier': 'multiplier', # noqa: E501 + 'path_mtu': 'pathMtu', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MplsTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MplsTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/multi_cloud_account_info.py b/openapi_client/model/multi_cloud_account_info.py new file mode 100644 index 0000000..dd9bd24 --- /dev/null +++ b/openapi_client/model/multi_cloud_account_info.py @@ -0,0 +1,356 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.aws_iam_credentials import AwsIamCredentials + from openapi_client.model.aws_key_credentials import AwsKeyCredentials + from openapi_client.model.azure_credentials import AzureCredentials + from openapi_client.model.gcp_credentials import GcpCredentials + globals()['AwsIamCredentials'] = AwsIamCredentials + globals()['AwsKeyCredentials'] = AwsKeyCredentials + globals()['AzureCredentials'] = AzureCredentials + globals()['GcpCredentials'] = GcpCredentials + + +class MultiCloudAccountInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'account_credentials': (str,), # noqa: E501 + 'account_id': (str,), # noqa: E501 + 'account_name': (str,), # noqa: E501 + 'aws_cloud_gateway_with_tvpc_enabled': (bool,), # noqa: E501 + 'aws_iam_credentials': (AwsIamCredentials,), # noqa: E501 + 'aws_key_credentials': (AwsKeyCredentials,), # noqa: E501 + 'az_o365_enabled': (bool,), # noqa: E501 + 'azure_credentials': (AzureCredentials,), # noqa: E501 + 'client_email': (str,), # noqa: E501 + 'cloud_gateway_enabled': (bool,), # noqa: E501 + 'cloud_type': (str,), # noqa: E501 + 'cred_type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'gcp_billing_id': (str,), # noqa: E501 + 'gcp_credentials': (GcpCredentials,), # noqa: E501 + 'host_vpc_enabled': (bool,), # noqa: E501 + 'org_name': (str,), # noqa: E501 + 'private_key_id': (str,), # noqa: E501 + 'region_list': ([str],), # noqa: E501 + 'service_discovery_enabled': (bool,), # noqa: E501 + 'vnet_enabled': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'account_credentials': 'accountCredentials', # noqa: E501 + 'account_id': 'accountId', # noqa: E501 + 'account_name': 'accountName', # noqa: E501 + 'aws_cloud_gateway_with_tvpc_enabled': 'awsCloudGatewayWithTvpcEnabled', # noqa: E501 + 'aws_iam_credentials': 'awsIamCredentials', # noqa: E501 + 'aws_key_credentials': 'awsKeyCredentials', # noqa: E501 + 'az_o365_enabled': 'azO365Enabled', # noqa: E501 + 'azure_credentials': 'azureCredentials', # noqa: E501 + 'client_email': 'clientEmail', # noqa: E501 + 'cloud_gateway_enabled': 'cloudGatewayEnabled', # noqa: E501 + 'cloud_type': 'cloudType', # noqa: E501 + 'cred_type': 'credType', # noqa: E501 + 'description': 'description', # noqa: E501 + 'gcp_billing_id': 'gcpBillingId', # noqa: E501 + 'gcp_credentials': 'gcpCredentials', # noqa: E501 + 'host_vpc_enabled': 'hostVpcEnabled', # noqa: E501 + 'org_name': 'orgName', # noqa: E501 + 'private_key_id': 'privateKeyId', # noqa: E501 + 'region_list': 'regionList', # noqa: E501 + 'service_discovery_enabled': 'serviceDiscoveryEnabled', # noqa: E501 + 'vnet_enabled': 'vnetEnabled', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MultiCloudAccountInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account_credentials (str): [optional] # noqa: E501 + account_id (str): [optional] # noqa: E501 + account_name (str): [optional] # noqa: E501 + aws_cloud_gateway_with_tvpc_enabled (bool): [optional] # noqa: E501 + aws_iam_credentials (AwsIamCredentials): [optional] # noqa: E501 + aws_key_credentials (AwsKeyCredentials): [optional] # noqa: E501 + az_o365_enabled (bool): [optional] # noqa: E501 + azure_credentials (AzureCredentials): [optional] # noqa: E501 + client_email (str): [optional] # noqa: E501 + cloud_gateway_enabled (bool): [optional] # noqa: E501 + cloud_type (str): [optional] # noqa: E501 + cred_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + gcp_billing_id (str): [optional] # noqa: E501 + gcp_credentials (GcpCredentials): [optional] # noqa: E501 + host_vpc_enabled (bool): [optional] # noqa: E501 + org_name (str): [optional] # noqa: E501 + private_key_id (str): [optional] # noqa: E501 + region_list ([str]): [optional] # noqa: E501 + service_discovery_enabled (bool): [optional] # noqa: E501 + vnet_enabled (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MultiCloudAccountInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account_credentials (str): [optional] # noqa: E501 + account_id (str): [optional] # noqa: E501 + account_name (str): [optional] # noqa: E501 + aws_cloud_gateway_with_tvpc_enabled (bool): [optional] # noqa: E501 + aws_iam_credentials (AwsIamCredentials): [optional] # noqa: E501 + aws_key_credentials (AwsKeyCredentials): [optional] # noqa: E501 + az_o365_enabled (bool): [optional] # noqa: E501 + azure_credentials (AzureCredentials): [optional] # noqa: E501 + client_email (str): [optional] # noqa: E501 + cloud_gateway_enabled (bool): [optional] # noqa: E501 + cloud_type (str): [optional] # noqa: E501 + cred_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + gcp_billing_id (str): [optional] # noqa: E501 + gcp_credentials (GcpCredentials): [optional] # noqa: E501 + host_vpc_enabled (bool): [optional] # noqa: E501 + org_name (str): [optional] # noqa: E501 + private_key_id (str): [optional] # noqa: E501 + region_list ([str]): [optional] # noqa: E501 + service_discovery_enabled (bool): [optional] # noqa: E501 + vnet_enabled (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/multi_cloud_edge_account_info.py b/openapi_client/model/multi_cloud_edge_account_info.py new file mode 100644 index 0000000..97dcca8 --- /dev/null +++ b/openapi_client/model/multi_cloud_edge_account_info.py @@ -0,0 +1,326 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.equinix_credentials import EquinixCredentials + from openapi_client.model.megaport_credentials import MegaportCredentials + from openapi_client.model.multi_cloud_edge_billing_account_info import MultiCloudEdgeBillingAccountInfo + from openapi_client.model.multi_cloud_edge_location_info import MultiCloudEdgeLocationInfo + from openapi_client.model.multi_cloud_edge_partner_port import MultiCloudEdgePartnerPort + globals()['EquinixCredentials'] = EquinixCredentials + globals()['MegaportCredentials'] = MegaportCredentials + globals()['MultiCloudEdgeBillingAccountInfo'] = MultiCloudEdgeBillingAccountInfo + globals()['MultiCloudEdgeLocationInfo'] = MultiCloudEdgeLocationInfo + globals()['MultiCloudEdgePartnerPort'] = MultiCloudEdgePartnerPort + + +class MultiCloudEdgeAccountInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'account_credentials': (str,), # noqa: E501 + 'cred_type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'edge_account_id': (str,), # noqa: E501 + 'edge_account_name': (str,), # noqa: E501 + 'edge_billing_account_info': (MultiCloudEdgeBillingAccountInfo,), # noqa: E501 + 'edge_location_info_list': ([MultiCloudEdgeLocationInfo],), # noqa: E501 + 'edge_partner_ports_list': ([MultiCloudEdgePartnerPort],), # noqa: E501 + 'edge_type': (str,), # noqa: E501 + 'equinix_credentials': (EquinixCredentials,), # noqa: E501 + 'megaport_credentials': (MegaportCredentials,), # noqa: E501 + 'org_name': (str,), # noqa: E501 + 'region_list': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'account_credentials': 'accountCredentials', # noqa: E501 + 'cred_type': 'credType', # noqa: E501 + 'description': 'description', # noqa: E501 + 'edge_account_id': 'edgeAccountId', # noqa: E501 + 'edge_account_name': 'edgeAccountName', # noqa: E501 + 'edge_billing_account_info': 'edgeBillingAccountInfo', # noqa: E501 + 'edge_location_info_list': 'edgeLocationInfoList', # noqa: E501 + 'edge_partner_ports_list': 'edgePartnerPortsList', # noqa: E501 + 'edge_type': 'edgeType', # noqa: E501 + 'equinix_credentials': 'equinixCredentials', # noqa: E501 + 'megaport_credentials': 'megaportCredentials', # noqa: E501 + 'org_name': 'orgName', # noqa: E501 + 'region_list': 'regionList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MultiCloudEdgeAccountInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account_credentials (str): [optional] # noqa: E501 + cred_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + edge_account_id (str): [optional] # noqa: E501 + edge_account_name (str): [optional] # noqa: E501 + edge_billing_account_info (MultiCloudEdgeBillingAccountInfo): [optional] # noqa: E501 + edge_location_info_list ([MultiCloudEdgeLocationInfo]): [optional] # noqa: E501 + edge_partner_ports_list ([MultiCloudEdgePartnerPort]): [optional] # noqa: E501 + edge_type (str): [optional] # noqa: E501 + equinix_credentials (EquinixCredentials): [optional] # noqa: E501 + megaport_credentials (MegaportCredentials): [optional] # noqa: E501 + org_name (str): [optional] # noqa: E501 + region_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MultiCloudEdgeAccountInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account_credentials (str): [optional] # noqa: E501 + cred_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + edge_account_id (str): [optional] # noqa: E501 + edge_account_name (str): [optional] # noqa: E501 + edge_billing_account_info (MultiCloudEdgeBillingAccountInfo): [optional] # noqa: E501 + edge_location_info_list ([MultiCloudEdgeLocationInfo]): [optional] # noqa: E501 + edge_partner_ports_list ([MultiCloudEdgePartnerPort]): [optional] # noqa: E501 + edge_type (str): [optional] # noqa: E501 + equinix_credentials (EquinixCredentials): [optional] # noqa: E501 + megaport_credentials (MegaportCredentials): [optional] # noqa: E501 + org_name (str): [optional] # noqa: E501 + region_list ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/multi_cloud_edge_billing_account_info.py b/openapi_client/model/multi_cloud_edge_billing_account_info.py new file mode 100644 index 0000000..dec6d99 --- /dev/null +++ b/openapi_client/model/multi_cloud_edge_billing_account_info.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class MultiCloudEdgeBillingAccountInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'edge_billing_account_id': (str,), # noqa: E501 + 'edge_billing_account_name': (str,), # noqa: E501 + 'edge_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'edge_billing_account_id': 'edgeBillingAccountId', # noqa: E501 + 'edge_billing_account_name': 'edgeBillingAccountName', # noqa: E501 + 'edge_type': 'edgeType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MultiCloudEdgeBillingAccountInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + edge_billing_account_id (str): [optional] # noqa: E501 + edge_billing_account_name (str): [optional] # noqa: E501 + edge_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MultiCloudEdgeBillingAccountInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + edge_billing_account_id (str): [optional] # noqa: E501 + edge_billing_account_name (str): [optional] # noqa: E501 + edge_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/multi_cloud_edge_location_info.py b/openapi_client/model/multi_cloud_edge_location_info.py new file mode 100644 index 0000000..a9b6271 --- /dev/null +++ b/openapi_client/model/multi_cloud_edge_location_info.py @@ -0,0 +1,288 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.equinix_location_info import EquinixLocationInfo + from openapi_client.model.megaport_location_info import MegaportLocationInfo + globals()['EquinixLocationInfo'] = EquinixLocationInfo + globals()['MegaportLocationInfo'] = MegaportLocationInfo + + +class MultiCloudEdgeLocationInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'edge_type': (str,), # noqa: E501 + 'eq_location_info': (EquinixLocationInfo,), # noqa: E501 + 'location_id': (str,), # noqa: E501 + 'location_name': (str,), # noqa: E501 + 'mp_location_info': (MegaportLocationInfo,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'edge_type': 'edgeType', # noqa: E501 + 'eq_location_info': 'eqLocationInfo', # noqa: E501 + 'location_id': 'locationId', # noqa: E501 + 'location_name': 'locationName', # noqa: E501 + 'mp_location_info': 'mpLocationInfo', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MultiCloudEdgeLocationInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + edge_type (str): [optional] # noqa: E501 + eq_location_info (EquinixLocationInfo): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + location_name (str): [optional] # noqa: E501 + mp_location_info (MegaportLocationInfo): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MultiCloudEdgeLocationInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + edge_type (str): [optional] # noqa: E501 + eq_location_info (EquinixLocationInfo): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + location_name (str): [optional] # noqa: E501 + mp_location_info (MegaportLocationInfo): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/multi_cloud_edge_partner_port.py b/openapi_client/model/multi_cloud_edge_partner_port.py new file mode 100644 index 0000000..fa4d69e --- /dev/null +++ b/openapi_client/model/multi_cloud_edge_partner_port.py @@ -0,0 +1,292 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.equinix_partner_port import EquinixPartnerPort + from openapi_client.model.megaport_partner_port import MegaportPartnerPort + globals()['EquinixPartnerPort'] = EquinixPartnerPort + globals()['MegaportPartnerPort'] = MegaportPartnerPort + + +class MultiCloudEdgePartnerPort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'cloud_type': (str,), # noqa: E501 + 'edge_type': (str,), # noqa: E501 + 'eq_partner_port': (EquinixPartnerPort,), # noqa: E501 + 'location_id': (str,), # noqa: E501 + 'mp_partner_port': (MegaportPartnerPort,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'cloud_type': 'cloudType', # noqa: E501 + 'edge_type': 'edgeType', # noqa: E501 + 'eq_partner_port': 'eqPartnerPort', # noqa: E501 + 'location_id': 'locationId', # noqa: E501 + 'mp_partner_port': 'mpPartnerPort', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MultiCloudEdgePartnerPort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + cloud_type (str): [optional] # noqa: E501 + edge_type (str): [optional] # noqa: E501 + eq_partner_port (EquinixPartnerPort): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + mp_partner_port (MegaportPartnerPort): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MultiCloudEdgePartnerPort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + cloud_type (str): [optional] # noqa: E501 + edge_type (str): [optional] # noqa: E501 + eq_partner_port (EquinixPartnerPort): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + mp_partner_port (MegaportPartnerPort): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/name_value_pair.py b/openapi_client/model/name_value_pair.py new file mode 100644 index 0000000..2df07c0 --- /dev/null +++ b/openapi_client/model/name_value_pair.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class NameValuePair(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'value': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NameValuePair - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NameValuePair - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/nat_rule.py b/openapi_client/model/nat_rule.py new file mode 100644 index 0000000..c609eef --- /dev/null +++ b/openapi_client/model/nat_rule.py @@ -0,0 +1,313 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class NATRule(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('in_port',): { + 'inclusive_maximum': 65535, + 'inclusive_minimum': 1, + }, + ('out_port',): { + 'inclusive_maximum': 65535, + 'inclusive_minimum': 1, + }, + ('protocol',): { + 'regex': { + 'pattern': r'^udp$|^tcp$|^icmp$', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'description': (str,), # noqa: E501 + 'in_port': (int,), # noqa: E501 + 'inside_ip': (str,), # noqa: E501 + 'interface': (str,), # noqa: E501 + 'out_port': (int,), # noqa: E501 + 'protocol': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'in_port': 'inPort', # noqa: E501 + 'inside_ip': 'insideIp', # noqa: E501 + 'interface': 'interface', # noqa: E501 + 'out_port': 'outPort', # noqa: E501 + 'protocol': 'protocol', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, description, in_port, inside_ip, interface, out_port, protocol, *args, **kwargs): # noqa: E501 + """NATRule - a model defined in OpenAPI + + Args: + description (str): + in_port (int): + inside_ip (str): + interface (str): + out_port (int): + protocol (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.description = description + self.in_port = in_port + self.inside_ip = inside_ip + self.interface = interface + self.out_port = out_port + self.protocol = protocol + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, description, in_port, inside_ip, interface, out_port, protocol, *args, **kwargs): # noqa: E501 + """NATRule - a model defined in OpenAPI + + Args: + description (str): + in_port (int): + inside_ip (str): + interface (str): + out_port (int): + protocol (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.description = description + self.in_port = in_port + self.inside_ip = inside_ip + self.interface = interface + self.out_port = out_port + self.protocol = protocol + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/network_protocol.py b/openapi_client/model/network_protocol.py new file mode 100644 index 0000000..99553ed --- /dev/null +++ b/openapi_client/model/network_protocol.py @@ -0,0 +1,397 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.dhcp_pool import DHCPPool + from openapi_client.model.nat_rule import NATRule + from openapi_client.model.network_protocol_all_of import NetworkProtocolAllOf + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.variable import Variable + globals()['DHCPPool'] = DHCPPool + globals()['NATRule'] = NATRule + globals()['NetworkProtocolAllOf'] = NetworkProtocolAllOf + globals()['ProfileParcel'] = ProfileParcel + globals()['Variable'] = Variable + + +class NetworkProtocol(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + ('ntp_settings',): { + 'max_items': 4, + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'dhcp_pool': (DHCPPool,), # noqa: E501 + 'dns_settings': (str,), # noqa: E501 + 'ntp_settings': ([str],), # noqa: E501 + 'nat_rules': ([NATRule],), # noqa: E501 + 'ntp_inherit': (bool,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'dhcp_pool': 'DHCPPool', # noqa: E501 + 'dns_settings': 'DNSSettings', # noqa: E501 + 'ntp_settings': 'NTPSettings', # noqa: E501 + 'nat_rules': 'NATRules', # noqa: E501 + 'ntp_inherit': 'NTPInherit', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NetworkProtocol - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dhcp_pool (DHCPPool): [optional] # noqa: E501 + dns_settings (str): [optional] # noqa: E501 + ntp_settings ([str]): [optional] # noqa: E501 + nat_rules ([NATRule]): [optional] # noqa: E501 + ntp_inherit (bool): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NetworkProtocol - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dhcp_pool (DHCPPool): [optional] # noqa: E501 + dns_settings (str): [optional] # noqa: E501 + ntp_settings ([str]): [optional] # noqa: E501 + nat_rules ([NATRule]): [optional] # noqa: E501 + ntp_inherit (bool): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + NetworkProtocolAllOf, + ProfileParcel, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/network_protocol_all_of.py b/openapi_client/model/network_protocol_all_of.py new file mode 100644 index 0000000..f43fdc8 --- /dev/null +++ b/openapi_client/model/network_protocol_all_of.py @@ -0,0 +1,292 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.dhcp_pool import DHCPPool + from openapi_client.model.nat_rule import NATRule + globals()['DHCPPool'] = DHCPPool + globals()['NATRule'] = NATRule + + +class NetworkProtocolAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('ntp_settings',): { + 'max_items': 4, + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'dhcp_pool': (DHCPPool,), # noqa: E501 + 'dns_settings': (str,), # noqa: E501 + 'ntp_settings': ([str],), # noqa: E501 + 'nat_rules': ([NATRule],), # noqa: E501 + 'ntp_inherit': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dhcp_pool': 'DHCPPool', # noqa: E501 + 'dns_settings': 'DNSSettings', # noqa: E501 + 'ntp_settings': 'NTPSettings', # noqa: E501 + 'nat_rules': 'NATRules', # noqa: E501 + 'ntp_inherit': 'NTPInherit', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NetworkProtocolAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dhcp_pool (DHCPPool): [optional] # noqa: E501 + dns_settings (str): [optional] # noqa: E501 + ntp_settings ([str]): [optional] # noqa: E501 + nat_rules ([NATRule]): [optional] # noqa: E501 + ntp_inherit (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NetworkProtocolAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dhcp_pool (DHCPPool): [optional] # noqa: E501 + dns_settings (str): [optional] # noqa: E501 + ntp_settings ([str]): [optional] # noqa: E501 + nat_rules ([NATRule]): [optional] # noqa: E501 + ntp_inherit (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/node.py b/openapi_client/model/node.py new file mode 100644 index 0000000..83340b4 --- /dev/null +++ b/openapi_client/model/node.py @@ -0,0 +1,288 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Node(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'ip': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'password': (str,), # noqa: E501 + 'serialno': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'username': (str,), # noqa: E501 + 'uuid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'ip': 'ip', # noqa: E501 + 'name': 'name', # noqa: E501 + 'password': 'password', # noqa: E501 + 'serialno': 'serialno', # noqa: E501 + 'status': 'status', # noqa: E501 + 'username': 'username', # noqa: E501 + 'uuid': 'uuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Node - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ip (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + serialno (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Node - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ip (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + serialno (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/nwpi_domain_monitor.py b/openapi_client/model/nwpi_domain_monitor.py new file mode 100644 index 0000000..d9b0e42 --- /dev/null +++ b/openapi_client/model/nwpi_domain_monitor.py @@ -0,0 +1,294 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.domain_detail import DomainDetail + from openapi_client.model.uuid_to_domain_id import UuidToDomainId + globals()['DomainDetail'] = DomainDetail + globals()['UuidToDomainId'] = UuidToDomainId + + +class NwpiDomainMonitor(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('device_to_domain_id',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'client_ip': (str,), # noqa: E501 + 'device_to_domain_id': ([UuidToDomainId],), # noqa: E501 + 'domain_app_grp': (str,), # noqa: E501 + 'domain_app_vis': (str,), # noqa: E501 + 'domain_list': ([DomainDetail],), # noqa: E501 + 'trace_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'client_ip': 'clientIp', # noqa: E501 + 'device_to_domain_id': 'deviceToDomainId', # noqa: E501 + 'domain_app_grp': 'domainAppGrp', # noqa: E501 + 'domain_app_vis': 'domainAppVis', # noqa: E501 + 'domain_list': 'domainList', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NwpiDomainMonitor - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_ip (str): [optional] # noqa: E501 + device_to_domain_id ([UuidToDomainId]): [optional] # noqa: E501 + domain_app_grp (str): [optional] # noqa: E501 + domain_app_vis (str): [optional] # noqa: E501 + domain_list ([DomainDetail]): [optional] # noqa: E501 + trace_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NwpiDomainMonitor - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + client_ip (str): [optional] # noqa: E501 + device_to_domain_id ([UuidToDomainId]): [optional] # noqa: E501 + domain_app_grp (str): [optional] # noqa: E501 + domain_app_vis (str): [optional] # noqa: E501 + domain_list ([DomainDetail]): [optional] # noqa: E501 + trace_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/omp.py b/openapi_client/model/omp.py new file mode 100644 index 0000000..3837603 --- /dev/null +++ b/openapi_client/model/omp.py @@ -0,0 +1,293 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class OMP(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('advertisements',): { + 'regex': { + 'pattern': r'(IPv4|BGP|OSPF|Connected|Static)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'advertisement_interval': (int,), # noqa: E501 + 'advertisements': (str,), # noqa: E501 + 'ecmp_limit': (int,), # noqa: E501 + 'eor_timer': (int,), # noqa: E501 + 'graceful_restart': (int,), # noqa: E501 + 'hold_time': (int,), # noqa: E501 + 'paths_advertised_per_prefix': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'advertisement_interval': 'advertisementInterval', # noqa: E501 + 'advertisements': 'advertisements', # noqa: E501 + 'ecmp_limit': 'ecmpLimit', # noqa: E501 + 'eor_timer': 'eorTimer', # noqa: E501 + 'graceful_restart': 'gracefulRestart', # noqa: E501 + 'hold_time': 'holdTime', # noqa: E501 + 'paths_advertised_per_prefix': 'pathsAdvertisedPerPrefix', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OMP - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + advertisement_interval (int): [optional] # noqa: E501 + advertisements (str): [optional] # noqa: E501 + ecmp_limit (int): [optional] # noqa: E501 + eor_timer (int): [optional] # noqa: E501 + graceful_restart (int): [optional] # noqa: E501 + hold_time (int): [optional] # noqa: E501 + paths_advertised_per_prefix (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OMP - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + advertisement_interval (int): [optional] # noqa: E501 + advertisements (str): [optional] # noqa: E501 + ecmp_limit (int): [optional] # noqa: E501 + eor_timer (int): [optional] # noqa: E501 + graceful_restart (int): [optional] # noqa: E501 + hold_time (int): [optional] # noqa: E501 + paths_advertised_per_prefix (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/on_demand_queue_entry.py b/openapi_client/model/on_demand_queue_entry.py new file mode 100644 index 0000000..498ee1c --- /dev/null +++ b/openapi_client/model/on_demand_queue_entry.py @@ -0,0 +1,326 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class OnDemandQueueEntry(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('data_type',): { + 'DPI': "DPI", + 'CONNECTIONEVENTS': "ConnectionEvents", + }, + ('status',): { + 'QUEUED': "QUEUED", + 'IN_PROGRESS': "IN_PROGRESS", + 'COMPLETED': "COMPLETED", + 'FAILED': "FAILED", + }, + ('time_period',): { + 'LAST_N_HOURS': "LAST_N_HOURS", + 'CUSTOM': "CUSTOM", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'complete': (bool,), # noqa: E501 + 'completion_time': (int,), # noqa: E501 + 'creation_time': (int,), # noqa: E501 + 'data_type': (str,), # noqa: E501 + 'device_id': (str,), # noqa: E501 + 'end_time': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'start_processing_time': (int,), # noqa: E501 + 'start_time': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'tenant_id': (str,), # noqa: E501 + 'time_period': (str,), # noqa: E501 + 'value': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'complete': 'complete', # noqa: E501 + 'completion_time': 'completionTime', # noqa: E501 + 'creation_time': 'creationTime', # noqa: E501 + 'data_type': 'data_type', # noqa: E501 + 'device_id': 'device_id', # noqa: E501 + 'end_time': 'end_time', # noqa: E501 + 'id': 'id', # noqa: E501 + 'start_processing_time': 'startProcessingTime', # noqa: E501 + 'start_time': 'start_time', # noqa: E501 + 'status': 'status', # noqa: E501 + 'tenant_id': 'tenant_id', # noqa: E501 + 'time_period': 'time_period', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OnDemandQueueEntry - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + complete (bool): [optional] # noqa: E501 + completion_time (int): [optional] # noqa: E501 + creation_time (int): [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + device_id (str): [optional] # noqa: E501 + end_time (int): [optional] # noqa: E501 + id (str): [optional] # noqa: E501 + start_processing_time (int): [optional] # noqa: E501 + start_time (int): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + tenant_id (str): [optional] # noqa: E501 + time_period (str): [optional] # noqa: E501 + value (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OnDemandQueueEntry - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + complete (bool): [optional] # noqa: E501 + completion_time (int): [optional] # noqa: E501 + creation_time (int): [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + device_id (str): [optional] # noqa: E501 + end_time (int): [optional] # noqa: E501 + id (str): [optional] # noqa: E501 + start_processing_time (int): [optional] # noqa: E501 + start_time (int): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + tenant_id (str): [optional] # noqa: E501 + time_period (str): [optional] # noqa: E501 + value (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/partner_type.py b/openapi_client/model/partner_type.py new file mode 100644 index 0000000..7befe72 --- /dev/null +++ b/openapi_client/model/partner_type.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class PartnerType(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('partner_type',): { + 'ACI': "aci", + 'DNAC': "dnac", + 'WCM': "wcm", + 'MDP': "mdp", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'partner_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'partner_type': 'partnerType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PartnerType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + partner_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PartnerType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + partner_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/policy_rule.py b/openapi_client/model/policy_rule.py new file mode 100644 index 0000000..e3a72bf --- /dev/null +++ b/openapi_client/model/policy_rule.py @@ -0,0 +1,289 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class PolicyRule(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('action',): { + 'regex': { + 'pattern': r'(drop|pass)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'action': (str,), # noqa: E501 + 'dest_ip': (str,), # noqa: E501 + 'dest_port': (int,), # noqa: E501 + 'protocol_type': ([str],), # noqa: E501 + 'source_ip': (str,), # noqa: E501 + 'source_port': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'action': 'action', # noqa: E501 + 'dest_ip': 'destIp', # noqa: E501 + 'dest_port': 'destPort', # noqa: E501 + 'protocol_type': 'protocolType', # noqa: E501 + 'source_ip': 'sourceIp', # noqa: E501 + 'source_port': 'sourcePort', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PolicyRule - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + action (str): [optional] # noqa: E501 + dest_ip (str): [optional] # noqa: E501 + dest_port (int): [optional] # noqa: E501 + protocol_type ([str]): [optional] # noqa: E501 + source_ip (str): [optional] # noqa: E501 + source_port (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PolicyRule - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + action (str): [optional] # noqa: E501 + dest_ip (str): [optional] # noqa: E501 + dest_port (int): [optional] # noqa: E501 + protocol_type ([str]): [optional] # noqa: E501 + source_ip (str): [optional] # noqa: E501 + source_port (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/profile_parcel.py b/openapi_client/model/profile_parcel.py new file mode 100644 index 0000000..909b9e1 --- /dev/null +++ b/openapi_client/model/profile_parcel.py @@ -0,0 +1,344 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.cellular import Cellular + from openapi_client.model.ethernet import Ethernet + from openapi_client.model.global_settings import GlobalSettings + from openapi_client.model.network_protocol import NetworkProtocol + from openapi_client.model.security_policy import SecurityPolicy + from openapi_client.model.variable import Variable + from openapi_client.model.vpn import Vpn + from openapi_client.model.wifi import Wifi + globals()['Cellular'] = Cellular + globals()['Ethernet'] = Ethernet + globals()['GlobalSettings'] = GlobalSettings + globals()['NetworkProtocol'] = NetworkProtocol + globals()['SecurityPolicy'] = SecurityPolicy + globals()['Variable'] = Variable + globals()['Vpn'] = Vpn + globals()['Wifi'] = Wifi + + +class ProfileParcel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'Cellular': Cellular, + 'Ethernet': Ethernet, + 'GlobalSettings': GlobalSettings, + 'NetworkProtocol': NetworkProtocol, + 'SecurityPolicy': SecurityPolicy, + 'Vpn': Vpn, + 'Wifi': Wifi, + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, type, *args, **kwargs): # noqa: E501 + """ProfileParcel - a model defined in OpenAPI + + Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, type, *args, **kwargs): # noqa: E501 + """ProfileParcel - a model defined in OpenAPI + + Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/property_definition.py b/openapi_client/model/property_definition.py new file mode 100644 index 0000000..a667d7c --- /dev/null +++ b/openapi_client/model/property_definition.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class PropertyDefinition(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'samples': ([str],), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'samples': 'samples', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PropertyDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + samples ([str]): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PropertyDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + samples ([str]): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/public_internet_timer.py b/openapi_client/model/public_internet_timer.py new file mode 100644 index 0000000..0be42e7 --- /dev/null +++ b/openapi_client/model/public_internet_timer.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class PublicInternetTimer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'dscp': (int,), # noqa: E501 + 'hello_interval': (int,), # noqa: E501 + 'multiplier': (int,), # noqa: E501 + 'path_mtu': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dscp': 'dscp', # noqa: E501 + 'hello_interval': 'helloInterval', # noqa: E501 + 'multiplier': 'multiplier', # noqa: E501 + 'path_mtu': 'pathMtu', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublicInternetTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PublicInternetTimer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + dscp (int): [optional] # noqa: E501 + hello_interval (int): [optional] # noqa: E501 + multiplier (int): [optional] # noqa: E501 + path_mtu (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/queue_entries.py b/openapi_client/model/queue_entries.py new file mode 100644 index 0000000..32b25df --- /dev/null +++ b/openapi_client/model/queue_entries.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.on_demand_queue_entry import OnDemandQueueEntry + globals()['OnDemandQueueEntry'] = OnDemandQueueEntry + + +class QueueEntries(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'entries': ([OnDemandQueueEntry],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'entries': 'entries', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """QueueEntries - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + entries ([OnDemandQueueEntry]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """QueueEntries - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + entries ([OnDemandQueueEntry]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/queue_properties.py b/openapi_client/model/queue_properties.py new file mode 100644 index 0000000..ba1aee6 --- /dev/null +++ b/openapi_client/model/queue_properties.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class QueueProperties(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'current_size': (int,), # noqa: E501 + 'max_size': (int,), # noqa: E501 + 'tenant_current_size': (int,), # noqa: E501 + 'tenant_max_size': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'current_size': 'current_size', # noqa: E501 + 'max_size': 'max_size', # noqa: E501 + 'tenant_current_size': 'tenant_current_size', # noqa: E501 + 'tenant_max_size': 'tenant_max_size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """QueueProperties - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + current_size (int): [optional] # noqa: E501 + max_size (int): [optional] # noqa: E501 + tenant_current_size (int): [optional] # noqa: E501 + tenant_max_size (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """QueueProperties - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + current_size (int): [optional] # noqa: E501 + max_size (int): [optional] # noqa: E501 + tenant_current_size (int): [optional] # noqa: E501 + tenant_max_size (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/radio_band_setting24_g.py b/openapi_client/model/radio_band_setting24_g.py new file mode 100644 index 0000000..ce3c3ea --- /dev/null +++ b/openapi_client/model/radio_band_setting24_g.py @@ -0,0 +1,296 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class RadioBandSetting24G(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('band',): { + 'regex': { + 'pattern': r'(RADIO_2_DOT_4_GHZ)', # noqa: E501 + }, + }, + ('channel',): { + 'regex': { + 'pattern': r'(auto|1|2|3|4|5|6|7|8|9|10|11)', # noqa: E501 + }, + }, + ('channel_width',): { + 'regex': { + 'pattern': r'(RADIO_CHANNEL_WIDTH_20_MHZ)', # noqa: E501 + }, + }, + ('transmit_power',): { + 'regex': { + 'pattern': r'(auto|1|2|3|4|5|6|7)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'band': (str,), # noqa: E501 + 'channel': (str,), # noqa: E501 + 'channel_width': (str,), # noqa: E501 + 'transmit_power': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'band': 'band', # noqa: E501 + 'channel': 'channel', # noqa: E501 + 'channel_width': 'channelWidth', # noqa: E501 + 'transmit_power': 'transmitPower', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RadioBandSetting24G - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + band (str): [optional] # noqa: E501 + channel (str): [optional] # noqa: E501 + channel_width (str): [optional] # noqa: E501 + transmit_power (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RadioBandSetting24G - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + band (str): [optional] # noqa: E501 + channel (str): [optional] # noqa: E501 + channel_width (str): [optional] # noqa: E501 + transmit_power (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/radio_band_setting5_g.py b/openapi_client/model/radio_band_setting5_g.py new file mode 100644 index 0000000..ed1c6ad --- /dev/null +++ b/openapi_client/model/radio_band_setting5_g.py @@ -0,0 +1,296 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class RadioBandSetting5G(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('band',): { + 'regex': { + 'pattern': r'(RADIO_5_GHZ)', # noqa: E501 + }, + }, + ('channel',): { + 'regex': { + 'pattern': r'(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)', # noqa: E501 + }, + }, + ('channel_width',): { + 'regex': { + 'pattern': r'(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)', # noqa: E501 + }, + }, + ('transmit_power',): { + 'regex': { + 'pattern': r'(auto|1|2|3|4|5|6|7)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'band': (str,), # noqa: E501 + 'channel': (str,), # noqa: E501 + 'channel_width': (str,), # noqa: E501 + 'transmit_power': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'band': 'band', # noqa: E501 + 'channel': 'channel', # noqa: E501 + 'channel_width': 'channelWidth', # noqa: E501 + 'transmit_power': 'transmitPower', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RadioBandSetting5G - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + band (str): [optional] # noqa: E501 + channel (str): [optional] # noqa: E501 + channel_width (str): [optional] # noqa: E501 + transmit_power (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RadioBandSetting5G - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + band (str): [optional] # noqa: E501 + channel (str): [optional] # noqa: E501 + channel_width (str): [optional] # noqa: E501 + transmit_power (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/radius_server.py b/openapi_client/model/radius_server.py new file mode 100644 index 0000000..fea82a3 --- /dev/null +++ b/openapi_client/model/radius_server.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class RadiusServer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'host': (str,), # noqa: E501 + 'port': (int,), # noqa: E501 + 'secret': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'host': 'host', # noqa: E501 + 'port': 'port', # noqa: E501 + 'secret': 'secret', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RadiusServer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + host (str): [optional] # noqa: E501 + port (int): [optional] # noqa: E501 + secret (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RadiusServer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + host (str): [optional] # noqa: E501 + port (int): [optional] # noqa: E501 + secret (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/resource_group.py b/openapi_client/model/resource_group.py new file mode 100644 index 0000000..5c2256c --- /dev/null +++ b/openapi_client/model/resource_group.py @@ -0,0 +1,298 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class ResourceGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('device_ips',): { + }, + ('device_ips',): { + }, + ('site_ids',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'desc': (str,), # noqa: E501 + 'device_ips': ([str],), # noqa: E501 + 'device_ips': ([str],), # noqa: E501 + 'id': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'mgmt_sytem_ips_map': ({str: (str,)},), # noqa: E501 + 'name': (str,), # noqa: E501 + 'site_ids': ([int],), # noqa: E501 + 'uuid_sytem_ips_map': ({str: (str,)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'desc': 'desc', # noqa: E501 + 'device_ips': 'deviceIPs', # noqa: E501 + 'device_ips': 'deviceIps', # noqa: E501 + 'id': 'id', # noqa: E501 + 'mgmt_sytem_ips_map': 'mgmtSytemIpsMap', # noqa: E501 + 'name': 'name', # noqa: E501 + 'site_ids': 'siteIds', # noqa: E501 + 'uuid_sytem_ips_map': 'uuidSytemIpsMap', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + desc (str): [optional] # noqa: E501 + device_ips ([str]): [optional] # noqa: E501 + device_ips ([str]): [optional] # noqa: E501 + id ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + mgmt_sytem_ips_map ({str: (str,)}): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + site_ids ([int]): [optional] # noqa: E501 + uuid_sytem_ips_map ({str: (str,)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ResourceGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + desc (str): [optional] # noqa: E501 + device_ips ([str]): [optional] # noqa: E501 + device_ips ([str]): [optional] # noqa: E501 + id ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + mgmt_sytem_ips_map ({str: (str,)}): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + site_ids ([int]): [optional] # noqa: E501 + uuid_sytem_ips_map ({str: (str,)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/schema_definition.py b/openapi_client/model/schema_definition.py new file mode 100644 index 0000000..665e2e2 --- /dev/null +++ b/openapi_client/model/schema_definition.py @@ -0,0 +1,294 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.vertex_definition import VertexDefinition + globals()['VertexDefinition'] = VertexDefinition + + +class SchemaDefinition(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'count_of_uniqueu_vertex_and_edge_objects_created': (int,), # noqa: E501 + 'count_of_vertex_and_edges_registered_with_device_data_manager': (int,), # noqa: E501 + 'vertex_definitions_for_data_collection': ([str],), # noqa: E501 + 'vertex_definitions_found_in_db_with_data': ([VertexDefinition],), # noqa: E501 + 'vertex_definitions_found_in_db_without_data': ([str],), # noqa: E501 + 'vertex_definitions_not_found_in_db': ([str],), # noqa: E501 + 'vertex_definitions_not_registered_with_device_data_manager': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'count_of_uniqueu_vertex_and_edge_objects_created': 'countOfUniqueuVertexAndEdgeObjectsCreated', # noqa: E501 + 'count_of_vertex_and_edges_registered_with_device_data_manager': 'countOfVertexAndEdgesRegisteredWithDeviceDataManager', # noqa: E501 + 'vertex_definitions_for_data_collection': 'vertexDefinitionsForDataCollection', # noqa: E501 + 'vertex_definitions_found_in_db_with_data': 'vertexDefinitionsFoundInDBWithData', # noqa: E501 + 'vertex_definitions_found_in_db_without_data': 'vertexDefinitionsFoundInDBWithoutData', # noqa: E501 + 'vertex_definitions_not_found_in_db': 'vertexDefinitionsNotFoundInDB', # noqa: E501 + 'vertex_definitions_not_registered_with_device_data_manager': 'vertexDefinitionsNotRegisteredWithDeviceDataManager', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SchemaDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + count_of_uniqueu_vertex_and_edge_objects_created (int): [optional] # noqa: E501 + count_of_vertex_and_edges_registered_with_device_data_manager (int): [optional] # noqa: E501 + vertex_definitions_for_data_collection ([str]): [optional] # noqa: E501 + vertex_definitions_found_in_db_with_data ([VertexDefinition]): [optional] # noqa: E501 + vertex_definitions_found_in_db_without_data ([str]): [optional] # noqa: E501 + vertex_definitions_not_found_in_db ([str]): [optional] # noqa: E501 + vertex_definitions_not_registered_with_device_data_manager ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SchemaDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + count_of_uniqueu_vertex_and_edge_objects_created (int): [optional] # noqa: E501 + count_of_vertex_and_edges_registered_with_device_data_manager (int): [optional] # noqa: E501 + vertex_definitions_for_data_collection ([str]): [optional] # noqa: E501 + vertex_definitions_found_in_db_with_data ([VertexDefinition]): [optional] # noqa: E501 + vertex_definitions_found_in_db_without_data ([str]): [optional] # noqa: E501 + vertex_definitions_not_found_in_db ([str]): [optional] # noqa: E501 + vertex_definitions_not_registered_with_device_data_manager ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/security_policy.py b/openapi_client/model/security_policy.py new file mode 100644 index 0000000..c60ffdf --- /dev/null +++ b/openapi_client/model/security_policy.py @@ -0,0 +1,388 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.policy_rule import PolicyRule + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.security_policy_all_of import SecurityPolicyAllOf + from openapi_client.model.variable import Variable + globals()['PolicyRule'] = PolicyRule + globals()['ProfileParcel'] = ProfileParcel + globals()['SecurityPolicyAllOf'] = SecurityPolicyAllOf + globals()['Variable'] = Variable + + +class SecurityPolicy(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + ('default_action',): { + 'regex': { + 'pattern': r'(drop|pass)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'policy_name': (str,), # noqa: E501 + 'default_action': (str,), # noqa: E501 + 'policy_rules': ([PolicyRule],), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'policy_name': 'policyName', # noqa: E501 + 'default_action': 'defaultAction', # noqa: E501 + 'policy_rules': 'policyRules', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SecurityPolicy - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + policy_name (str): [optional] # noqa: E501 + default_action (str): [optional] # noqa: E501 + policy_rules ([PolicyRule]): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SecurityPolicy - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + policy_name (str): [optional] # noqa: E501 + default_action (str): [optional] # noqa: E501 + policy_rules ([PolicyRule]): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ProfileParcel, + SecurityPolicyAllOf, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/security_policy_all_of.py b/openapi_client/model/security_policy_all_of.py new file mode 100644 index 0000000..66fd8d3 --- /dev/null +++ b/openapi_client/model/security_policy_all_of.py @@ -0,0 +1,283 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.policy_rule import PolicyRule + globals()['PolicyRule'] = PolicyRule + + +class SecurityPolicyAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('default_action',): { + 'regex': { + 'pattern': r'(drop|pass)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'policy_name': (str,), # noqa: E501 + 'default_action': (str,), # noqa: E501 + 'policy_rules': ([PolicyRule],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'policy_name': 'policyName', # noqa: E501 + 'default_action': 'defaultAction', # noqa: E501 + 'policy_rules': 'policyRules', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SecurityPolicyAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + policy_name (str): [optional] # noqa: E501 + default_action (str): [optional] # noqa: E501 + policy_rules ([PolicyRule]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SecurityPolicyAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + policy_name (str): [optional] # noqa: E501 + default_action (str): [optional] # noqa: E501 + policy_rules ([PolicyRule]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/sim_slot_config.py b/openapi_client/model/sim_slot_config.py new file mode 100644 index 0000000..b217a25 --- /dev/null +++ b/openapi_client/model/sim_slot_config.py @@ -0,0 +1,312 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.cellular_profile import CellularProfile + globals()['CellularProfile'] = CellularProfile + + +class SimSlotConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('attach_profile_id',): { + 'inclusive_maximum': 16, + 'inclusive_minimum': 1, + }, + ('profile_list',): { + 'max_items': 16, + 'min_items': 1, + }, + ('slot_number',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('data_profile_id_list',): { + 'max_items': 16, + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'attach_profile_id': (int,), # noqa: E501 + 'profile_list': ([CellularProfile],), # noqa: E501 + 'slot_number': (int,), # noqa: E501 + 'carrier_name': (str,), # noqa: E501 + 'data_profile_id_list': ([int],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attach_profile_id': 'attachProfileId', # noqa: E501 + 'profile_list': 'profileList', # noqa: E501 + 'slot_number': 'slotNumber', # noqa: E501 + 'carrier_name': 'carrierName', # noqa: E501 + 'data_profile_id_list': 'dataProfileIdList', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attach_profile_id, profile_list, slot_number, *args, **kwargs): # noqa: E501 + """SimSlotConfig - a model defined in OpenAPI + + Args: + attach_profile_id (int): + profile_list ([CellularProfile]): + slot_number (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + carrier_name (str): [optional] # noqa: E501 + data_profile_id_list ([int]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.attach_profile_id = attach_profile_id + self.profile_list = profile_list + self.slot_number = slot_number + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attach_profile_id, profile_list, slot_number, *args, **kwargs): # noqa: E501 + """SimSlotConfig - a model defined in OpenAPI + + Args: + attach_profile_id (int): + profile_list ([CellularProfile]): + slot_number (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + carrier_name (str): [optional] # noqa: E501 + data_profile_id_list ([int]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.attach_profile_id = attach_profile_id + self.profile_list = profile_list + self.slot_number = slot_number + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/site_health.py b/openapi_client/model/site_health.py new file mode 100644 index 0000000..872140b --- /dev/null +++ b/openapi_client/model/site_health.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class SiteHealth(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'full_connectivity': (int,), # noqa: E501 + 'no_connectivity': (int,), # noqa: E501 + 'partial_connectivity': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'full_connectivity': 'fullConnectivity', # noqa: E501 + 'no_connectivity': 'noConnectivity', # noqa: E501 + 'partial_connectivity': 'partialConnectivity', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SiteHealth - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + full_connectivity (int): [optional] # noqa: E501 + no_connectivity (int): [optional] # noqa: E501 + partial_connectivity (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SiteHealth - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + full_connectivity (int): [optional] # noqa: E501 + no_connectivity (int): [optional] # noqa: E501 + partial_connectivity (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/site_to_site_vpn.py b/openapi_client/model/site_to_site_vpn.py new file mode 100644 index 0000000..eb1d1bf --- /dev/null +++ b/openapi_client/model/site_to_site_vpn.py @@ -0,0 +1,307 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class SiteToSiteVpn(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('local_interface',): { + 'regex': { + 'pattern': r'(^Cellular1\/0$|^GigabitEthernet0\/0$)', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'local_interface': (str,), # noqa: E501 + 'local_private_subnet': (str,), # noqa: E501 + 'pre_shared_secret': (str,), # noqa: E501 + 'remote_private_subnets': (str,), # noqa: E501 + 'remote_public_ip': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'tunnel_dns_address': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'local_interface': 'localInterface', # noqa: E501 + 'local_private_subnet': 'localPrivateSubnet', # noqa: E501 + 'pre_shared_secret': 'preSharedSecret', # noqa: E501 + 'remote_private_subnets': 'remotePrivateSubnets', # noqa: E501 + 'remote_public_ip': 'remotePublicIp', # noqa: E501 + 'name': 'name', # noqa: E501 + 'tunnel_dns_address': 'tunnelDnsAddress', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, local_interface, local_private_subnet, pre_shared_secret, remote_private_subnets, remote_public_ip, *args, **kwargs): # noqa: E501 + """SiteToSiteVpn - a model defined in OpenAPI + + Args: + local_interface (str): + local_private_subnet (str): + pre_shared_secret (str): + remote_private_subnets (str): + remote_public_ip (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + tunnel_dns_address (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.local_interface = local_interface + self.local_private_subnet = local_private_subnet + self.pre_shared_secret = pre_shared_secret + self.remote_private_subnets = remote_private_subnets + self.remote_public_ip = remote_public_ip + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, local_interface, local_private_subnet, pre_shared_secret, remote_private_subnets, remote_public_ip, *args, **kwargs): # noqa: E501 + """SiteToSiteVpn - a model defined in OpenAPI + + Args: + local_interface (str): + local_private_subnet (str): + pre_shared_secret (str): + remote_private_subnets (str): + remote_public_ip (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): [optional] # noqa: E501 + tunnel_dns_address (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.local_interface = local_interface + self.local_private_subnet = local_private_subnet + self.pre_shared_secret = pre_shared_secret + self.remote_private_subnets = remote_private_subnets + self.remote_public_ip = remote_public_ip + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/smart_account_model.py b/openapi_client/model/smart_account_model.py new file mode 100644 index 0000000..8c64949 --- /dev/null +++ b/openapi_client/model/smart_account_model.py @@ -0,0 +1,280 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class SmartAccountModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'env': (str,), # noqa: E501 + 'organization_name': (str,), # noqa: E501 + 'password': (str,), # noqa: E501 + 'username': (str,), # noqa: E501 + 'validity_string': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'env': 'env', # noqa: E501 + 'organization_name': 'organization_name', # noqa: E501 + 'password': 'password', # noqa: E501 + 'username': 'username', # noqa: E501 + 'validity_string': 'validity_string', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SmartAccountModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + env (str): [optional] # noqa: E501 + organization_name (str): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + validity_string (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SmartAccountModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + env (str): [optional] # noqa: E501 + organization_name (str): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + username (str): [optional] # noqa: E501 + validity_string (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/software_upload_file_data.py b/openapi_client/model/software_upload_file_data.py new file mode 100644 index 0000000..37c3e40 --- /dev/null +++ b/openapi_client/model/software_upload_file_data.py @@ -0,0 +1,283 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.get_o365_preferred_path_from_v_analytics_request_value import GetO365PreferredPathFromVAnalyticsRequestValue + globals()['GetO365PreferredPathFromVAnalyticsRequestValue'] = GetO365PreferredPathFromVAnalyticsRequestValue + + +class SoftwareUploadFileData(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value_type',): { + 'ARRAY': "ARRAY", + 'OBJECT': "OBJECT", + 'STRING': "STRING", + 'NUMBER': "NUMBER", + 'TRUE': "TRUE", + 'FALSE': "FALSE", + 'NULL': "NULL", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (GetO365PreferredPathFromVAnalyticsRequestValue,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'empty': (bool,), # noqa: E501 + 'value_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'empty': 'empty', # noqa: E501 + 'value_type': 'valueType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SoftwareUploadFileData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + empty (bool): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SoftwareUploadFileData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + empty (bool): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/ssid_config.py b/openapi_client/model/ssid_config.py new file mode 100644 index 0000000..2561959 --- /dev/null +++ b/openapi_client/model/ssid_config.py @@ -0,0 +1,294 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class SSIDConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('qos_settings',): { + 'regex': { + 'pattern': r'(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)', # noqa: E501 + }, + }, + ('security_auth_type',): { + 'regex': { + 'pattern': r'(OPEN|WPA2-PSK_AES)', # noqa: E501 + }, + }, + ('ssid',): { + 'max_length': 32, + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'qos_settings': (str,), # noqa: E501 + 'security_auth_type': (str,), # noqa: E501 + 'ssid': (str,), # noqa: E501 + 'visibility': (bool,), # noqa: E501 + 'wpa_psk_key': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'qos_settings': 'qosSettings', # noqa: E501 + 'security_auth_type': 'securityAuthType', # noqa: E501 + 'ssid': 'ssid', # noqa: E501 + 'visibility': 'visibility', # noqa: E501 + 'wpa_psk_key': 'wpaPskKey', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SSIDConfig - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + qos_settings (str): [optional] # noqa: E501 + security_auth_type (str): [optional] # noqa: E501 + ssid (str): [optional] # noqa: E501 + visibility (bool): [optional] # noqa: E501 + wpa_psk_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SSIDConfig - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + qos_settings (str): [optional] # noqa: E501 + security_auth_type (str): [optional] # noqa: E501 + ssid (str): [optional] # noqa: E501 + visibility (bool): [optional] # noqa: E501 + wpa_psk_key (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/statistics_processing_counters.py b/openapi_client/model/statistics_processing_counters.py new file mode 100644 index 0000000..038e4bf --- /dev/null +++ b/openapi_client/model/statistics_processing_counters.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.stats_type_processing_counters import StatsTypeProcessingCounters + globals()['StatsTypeProcessingCounters'] = StatsTypeProcessingCounters + + +class StatisticsProcessingCounters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'counters': ([StatsTypeProcessingCounters],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'counters': 'counters', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """StatisticsProcessingCounters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + counters ([StatsTypeProcessingCounters]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """StatisticsProcessingCounters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + counters ([StatsTypeProcessingCounters]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/stats_type_processing_counters.py b/openapi_client/model/stats_type_processing_counters.py new file mode 100644 index 0000000..2397878 --- /dev/null +++ b/openapi_client/model/stats_type_processing_counters.py @@ -0,0 +1,284 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class StatsTypeProcessingCounters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'compressed_size': (int,), # noqa: E501 + 'files_number': (int,), # noqa: E501 + 'processing_time': (int,), # noqa: E501 + 'records_number': (int,), # noqa: E501 + 'stats_type': (str,), # noqa: E501 + 'uncompressed_size': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'compressed_size': 'compressed_size', # noqa: E501 + 'files_number': 'files_number', # noqa: E501 + 'processing_time': 'processing_time', # noqa: E501 + 'records_number': 'records_number', # noqa: E501 + 'stats_type': 'stats_type', # noqa: E501 + 'uncompressed_size': 'uncompressed_size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """StatsTypeProcessingCounters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + compressed_size (int): [optional] # noqa: E501 + files_number (int): [optional] # noqa: E501 + processing_time (int): [optional] # noqa: E501 + records_number (int): [optional] # noqa: E501 + stats_type (str): [optional] # noqa: E501 + uncompressed_size (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """StatsTypeProcessingCounters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + compressed_size (int): [optional] # noqa: E501 + files_number (int): [optional] # noqa: E501 + processing_time (int): [optional] # noqa: E501 + records_number (int): [optional] # noqa: E501 + stats_type (str): [optional] # noqa: E501 + uncompressed_size (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/systems.py b/openapi_client/model/systems.py new file mode 100644 index 0000000..7fb1916 --- /dev/null +++ b/openapi_client/model/systems.py @@ -0,0 +1,316 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Systems(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'console_baud_rate': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'device_group': (str,), # noqa: E501 + 'gps_latitude': (str,), # noqa: E501 + 'gps_longitude': (str,), # noqa: E501 + 'host_name': (str,), # noqa: E501 + 'location': (str,), # noqa: E501 + 'on_demand_tunnel': (str,), # noqa: E501 + 'on_demand_tunnel_idle_timeout': (int,), # noqa: E501 + 'port_hopping': (str,), # noqa: E501 + 'port_offset': (int,), # noqa: E501 + 'site_id': (str,), # noqa: E501 + 'system_ip': (str,), # noqa: E501 + 'time_zone': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'console_baud_rate': 'consoleBaudRate', # noqa: E501 + 'description': 'description', # noqa: E501 + 'device_group': 'deviceGroup', # noqa: E501 + 'gps_latitude': 'gpsLatitude', # noqa: E501 + 'gps_longitude': 'gpsLongitude', # noqa: E501 + 'host_name': 'hostName', # noqa: E501 + 'location': 'location', # noqa: E501 + 'on_demand_tunnel': 'onDemandTunnel', # noqa: E501 + 'on_demand_tunnel_idle_timeout': 'onDemandTunnelIdleTimeout', # noqa: E501 + 'port_hopping': 'portHopping', # noqa: E501 + 'port_offset': 'portOffset', # noqa: E501 + 'site_id': 'siteId', # noqa: E501 + 'system_ip': 'systemIp', # noqa: E501 + 'time_zone': 'timeZone', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Systems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + console_baud_rate (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + device_group (str): [optional] # noqa: E501 + gps_latitude (str): [optional] # noqa: E501 + gps_longitude (str): [optional] # noqa: E501 + host_name (str): [optional] # noqa: E501 + location (str): [optional] # noqa: E501 + on_demand_tunnel (str): [optional] # noqa: E501 + on_demand_tunnel_idle_timeout (int): [optional] # noqa: E501 + port_hopping (str): [optional] # noqa: E501 + port_offset (int): [optional] # noqa: E501 + site_id (str): [optional] # noqa: E501 + system_ip (str): [optional] # noqa: E501 + time_zone (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Systems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + console_baud_rate (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + device_group (str): [optional] # noqa: E501 + gps_latitude (str): [optional] # noqa: E501 + gps_longitude (str): [optional] # noqa: E501 + host_name (str): [optional] # noqa: E501 + location (str): [optional] # noqa: E501 + on_demand_tunnel (str): [optional] # noqa: E501 + on_demand_tunnel_idle_timeout (int): [optional] # noqa: E501 + port_hopping (str): [optional] # noqa: E501 + port_offset (int): [optional] # noqa: E501 + site_id (str): [optional] # noqa: E501 + system_ip (str): [optional] # noqa: E501 + time_zone (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/tag_restful_resource.py b/openapi_client/model/tag_restful_resource.py new file mode 100644 index 0000000..dbeb598 --- /dev/null +++ b/openapi_client/model/tag_restful_resource.py @@ -0,0 +1,270 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.software_upload_file_data import SoftwareUploadFileData + globals()['SoftwareUploadFileData'] = SoftwareUploadFileData + + +class TagRestfulResource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'all_groups': (SoftwareUploadFileData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'all_groups': 'allGroups', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TagRestfulResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + all_groups (SoftwareUploadFileData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TagRestfulResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + all_groups (SoftwareUploadFileData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/tenant_status.py b/openapi_client/model/tenant_status.py new file mode 100644 index 0000000..e836e7d --- /dev/null +++ b/openapi_client/model/tenant_status.py @@ -0,0 +1,296 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.control_status import ControlStatus + from openapi_client.model.site_health import SiteHealth + from openapi_client.model.v_edge_health import VEdgeHealth + from openapi_client.model.v_smart_status import VSmartStatus + globals()['ControlStatus'] = ControlStatus + globals()['SiteHealth'] = SiteHealth + globals()['VEdgeHealth'] = VEdgeHealth + globals()['VSmartStatus'] = VSmartStatus + + +class TenantStatus(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'control_status': (ControlStatus,), # noqa: E501 + 'getv_edge_health': (VEdgeHealth,), # noqa: E501 + 'getv_smart_status': (VSmartStatus,), # noqa: E501 + 'site_health': (SiteHealth,), # noqa: E501 + 'tenant_id': (str,), # noqa: E501 + 'tenant_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'control_status': 'controlStatus', # noqa: E501 + 'getv_edge_health': 'getvEdgeHealth', # noqa: E501 + 'getv_smart_status': 'getvSmartStatus', # noqa: E501 + 'site_health': 'siteHealth', # noqa: E501 + 'tenant_id': 'tenantId', # noqa: E501 + 'tenant_name': 'tenantName', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TenantStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + control_status (ControlStatus): [optional] # noqa: E501 + getv_edge_health (VEdgeHealth): [optional] # noqa: E501 + getv_smart_status (VSmartStatus): [optional] # noqa: E501 + site_health (SiteHealth): [optional] # noqa: E501 + tenant_id (str): [optional] # noqa: E501 + tenant_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TenantStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + control_status (ControlStatus): [optional] # noqa: E501 + getv_edge_health (VEdgeHealth): [optional] # noqa: E501 + getv_smart_status (VSmartStatus): [optional] # noqa: E501 + site_health (SiteHealth): [optional] # noqa: E501 + tenant_id (str): [optional] # noqa: E501 + tenant_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/tenant_status_list_model.py b/openapi_client/model/tenant_status_list_model.py new file mode 100644 index 0000000..54805ef --- /dev/null +++ b/openapi_client/model/tenant_status_list_model.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.header import Header + from openapi_client.model.tenant_status import TenantStatus + globals()['Header'] = Header + globals()['TenantStatus'] = TenantStatus + + +class TenantStatusListModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([TenantStatus],), # noqa: E501 + 'header': (Header,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'header': 'header', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TenantStatusListModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([TenantStatus]): [optional] # noqa: E501 + header (Header): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TenantStatusListModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([TenantStatus]): [optional] # noqa: E501 + header (Header): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/thread_pool_definition.py b/openapi_client/model/thread_pool_definition.py new file mode 100644 index 0000000..e9fa852 --- /dev/null +++ b/openapi_client/model/thread_pool_definition.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class ThreadPoolDefinition(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'consumer_class': (str,), # noqa: E501 + 'consumer_method': (str,), # noqa: E501 + 'thread_pool_name': (str,), # noqa: E501 + 'thread_pool_size': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'consumer_class': 'consumerClass', # noqa: E501 + 'consumer_method': 'consumerMethod', # noqa: E501 + 'thread_pool_name': 'threadPoolName', # noqa: E501 + 'thread_pool_size': 'threadPoolSize', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ThreadPoolDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_class (str): [optional] # noqa: E501 + consumer_method (str): [optional] # noqa: E501 + thread_pool_name (str): [optional] # noqa: E501 + thread_pool_size (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ThreadPoolDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_class (str): [optional] # noqa: E501 + consumer_method (str): [optional] # noqa: E501 + thread_pool_name (str): [optional] # noqa: E501 + thread_pool_size (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/thread_pools_definition.py b/openapi_client/model/thread_pools_definition.py new file mode 100644 index 0000000..18db49f --- /dev/null +++ b/openapi_client/model/thread_pools_definition.py @@ -0,0 +1,274 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.thread_pool_definition import ThreadPoolDefinition + globals()['ThreadPoolDefinition'] = ThreadPoolDefinition + + +class ThreadPoolsDefinition(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'thread_pools': ([ThreadPoolDefinition],), # noqa: E501 + 'total_thread_count': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'thread_pools': 'threadPools', # noqa: E501 + 'total_thread_count': 'totalThreadCount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ThreadPoolsDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + thread_pools ([ThreadPoolDefinition]): [optional] # noqa: E501 + total_thread_count (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ThreadPoolsDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + thread_pools ([ThreadPoolDefinition]): [optional] # noqa: E501 + total_thread_count (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/update_tenant_model.py b/openapi_client/model/update_tenant_model.py new file mode 100644 index 0000000..29c31f9 --- /dev/null +++ b/openapi_client/model/update_tenant_model.py @@ -0,0 +1,300 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class UpdateTenantModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'desc': (str,), # noqa: E501 + 'getv_bond_address': (str,), # noqa: E501 + 'getv_smarts': ([str],), # noqa: E501 + 'idp_metadata': (str,), # noqa: E501 + 'mode': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'old_idp_metadata': (str,), # noqa: E501 + 'sp_metadata': (str,), # noqa: E501 + 'sub_domain': (str,), # noqa: E501 + 'wan_edge_forecast': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'desc': 'desc', # noqa: E501 + 'getv_bond_address': 'getvBondAddress', # noqa: E501 + 'getv_smarts': 'getvSmarts', # noqa: E501 + 'idp_metadata': 'idpMetadata', # noqa: E501 + 'mode': 'mode', # noqa: E501 + 'name': 'name', # noqa: E501 + 'old_idp_metadata': 'oldIdpMetadata', # noqa: E501 + 'sp_metadata': 'spMetadata', # noqa: E501 + 'sub_domain': 'subDomain', # noqa: E501 + 'wan_edge_forecast': 'wanEdgeForecast', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UpdateTenantModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + desc (str): [optional] # noqa: E501 + getv_bond_address (str): [optional] # noqa: E501 + getv_smarts ([str]): [optional] # noqa: E501 + idp_metadata (str): [optional] # noqa: E501 + mode (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + old_idp_metadata (str): [optional] # noqa: E501 + sp_metadata (str): [optional] # noqa: E501 + sub_domain (str): [optional] # noqa: E501 + wan_edge_forecast (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UpdateTenantModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + desc (str): [optional] # noqa: E501 + getv_bond_address (str): [optional] # noqa: E501 + getv_smarts ([str]): [optional] # noqa: E501 + idp_metadata (str): [optional] # noqa: E501 + mode (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + old_idp_metadata (str): [optional] # noqa: E501 + sp_metadata (str): [optional] # noqa: E501 + sub_domain (str): [optional] # noqa: E501 + wan_edge_forecast (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/update_tenantv_smart_model.py b/openapi_client/model/update_tenantv_smart_model.py new file mode 100644 index 0000000..d623ed3 --- /dev/null +++ b/openapi_client/model/update_tenantv_smart_model.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class UpdateTenantvSmartModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'destv_smart_uuid': (str,), # noqa: E501 + 'srcv_smart_uuid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'destv_smart_uuid': 'destvSmartUuid', # noqa: E501 + 'srcv_smart_uuid': 'srcvSmartUuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UpdateTenantvSmartModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + destv_smart_uuid (str): [optional] # noqa: E501 + srcv_smart_uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UpdateTenantvSmartModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + destv_smart_uuid (str): [optional] # noqa: E501 + srcv_smart_uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/uuid.py b/openapi_client/model/uuid.py new file mode 100644 index 0000000..e82bf70 --- /dev/null +++ b/openapi_client/model/uuid.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Uuid(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'uuid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'uuid': 'uuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Uuid - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Uuid - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/uuid_to_domain_id.py b/openapi_client/model/uuid_to_domain_id.py new file mode 100644 index 0000000..44904f8 --- /dev/null +++ b/openapi_client/model/uuid_to_domain_id.py @@ -0,0 +1,274 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.uuid_to_domain_id_mapping import UuidToDomainIdMapping + globals()['UuidToDomainIdMapping'] = UuidToDomainIdMapping + + +class UuidToDomainId(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'domain': (str,), # noqa: E501 + 'mapping': ([UuidToDomainIdMapping],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'domain': 'domain', # noqa: E501 + 'mapping': 'mapping', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UuidToDomainId - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + domain (str): [optional] # noqa: E501 + mapping ([UuidToDomainIdMapping]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UuidToDomainId - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + domain (str): [optional] # noqa: E501 + mapping ([UuidToDomainIdMapping]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/uuid_to_domain_id_mapping.py b/openapi_client/model/uuid_to_domain_id_mapping.py new file mode 100644 index 0000000..8710c74 --- /dev/null +++ b/openapi_client/model/uuid_to_domain_id_mapping.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class UuidToDomainIdMapping(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'domain_id': (int,), # noqa: E501 + 'uuid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'domain_id': 'domainId', # noqa: E501 + 'uuid': 'uuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UuidToDomainIdMapping - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + domain_id (int): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UuidToDomainIdMapping - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + domain_id (int): [optional] # noqa: E501 + uuid (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/v_edge_bootstrap_config.py b/openapi_client/model/v_edge_bootstrap_config.py new file mode 100644 index 0000000..207d06a --- /dev/null +++ b/openapi_client/model/v_edge_bootstrap_config.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class VEdgeBootstrapConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'bootstrap_config_type': (str,), # noqa: E501 + 'uuid': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'bootstrap_config_type': 'bootstrapConfigType', # noqa: E501 + 'uuid': 'uuid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VEdgeBootstrapConfig - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bootstrap_config_type (str): [optional] # noqa: E501 + uuid ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VEdgeBootstrapConfig - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bootstrap_config_type (str): [optional] # noqa: E501 + uuid ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/v_edge_health.py b/openapi_client/model/v_edge_health.py new file mode 100644 index 0000000..1db4ef1 --- /dev/null +++ b/openapi_client/model/v_edge_health.py @@ -0,0 +1,272 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class VEdgeHealth(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'error': (int,), # noqa: E501 + 'normal': (int,), # noqa: E501 + 'warning': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'error': 'error', # noqa: E501 + 'normal': 'normal', # noqa: E501 + 'warning': 'warning', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VEdgeHealth - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + error (int): [optional] # noqa: E501 + normal (int): [optional] # noqa: E501 + warning (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VEdgeHealth - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + error (int): [optional] # noqa: E501 + normal (int): [optional] # noqa: E501 + warning (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/v_resource_group_name_model.py b/openapi_client/model/v_resource_group_name_model.py new file mode 100644 index 0000000..912d7ac --- /dev/null +++ b/openapi_client/model/v_resource_group_name_model.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class VResourceGroupNameModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'v_resource_group_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'v_resource_group_name': 'VResourceGroupName', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VResourceGroupNameModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + v_resource_group_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VResourceGroupNameModel - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + v_resource_group_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/v_smart_status.py b/openapi_client/model/v_smart_status.py new file mode 100644 index 0000000..b1bd602 --- /dev/null +++ b/openapi_client/model/v_smart_status.py @@ -0,0 +1,268 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class VSmartStatus(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'down': (int,), # noqa: E501 + 'up': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'down': 'down', # noqa: E501 + 'up': 'up', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VSmartStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + down (int): [optional] # noqa: E501 + up (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VSmartStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + down (int): [optional] # noqa: E501 + up (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/variable.py b/openapi_client/model/variable.py new file mode 100644 index 0000000..e8ddbee --- /dev/null +++ b/openapi_client/model/variable.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class Variable(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'json_path': (str,), # noqa: E501 + 'var_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'json_path': 'jsonPath', # noqa: E501 + 'var_name': 'varName', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, json_path, var_name, *args, **kwargs): # noqa: E501 + """Variable - a model defined in OpenAPI + + Args: + json_path (str): + var_name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.json_path = json_path + self.var_name = var_name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, json_path, var_name, *args, **kwargs): # noqa: E501 + """Variable - a model defined in OpenAPI + + Args: + json_path (str): + var_name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.json_path = json_path + self.var_name = var_name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/vertex_definition.py b/openapi_client/model/vertex_definition.py new file mode 100644 index 0000000..0621fee --- /dev/null +++ b/openapi_client/model/vertex_definition.py @@ -0,0 +1,282 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.property_definition import PropertyDefinition + globals()['PropertyDefinition'] = PropertyDefinition + + +class VertexDefinition(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'in_edges': ([str],), # noqa: E501 + 'name': (str,), # noqa: E501 + 'out_edges': ([str],), # noqa: E501 + 'properties': ([PropertyDefinition],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'in_edges': 'inEdges', # noqa: E501 + 'name': 'name', # noqa: E501 + 'out_edges': 'outEdges', # noqa: E501 + 'properties': 'properties', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VertexDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + in_edges ([str]): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + out_edges ([str]): [optional] # noqa: E501 + properties ([PropertyDefinition]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VertexDefinition - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + in_edges ([str]): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + out_edges ([str]): [optional] # noqa: E501 + properties ([PropertyDefinition]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/vpn.py b/openapi_client/model/vpn.py new file mode 100644 index 0000000..7796f12 --- /dev/null +++ b/openapi_client/model/vpn.py @@ -0,0 +1,381 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.ip_sec_policy import IpSecPolicy + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.site_to_site_vpn import SiteToSiteVpn + from openapi_client.model.variable import Variable + from openapi_client.model.vpn_all_of import VpnAllOf + globals()['IpSecPolicy'] = IpSecPolicy + globals()['ProfileParcel'] = ProfileParcel + globals()['SiteToSiteVpn'] = SiteToSiteVpn + globals()['Variable'] = Variable + globals()['VpnAllOf'] = VpnAllOf + + +class Vpn(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'site_to_site_vpn': (SiteToSiteVpn,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'ip_sec_policy': (IpSecPolicy,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'site_to_site_vpn': 'siteToSiteVpn', # noqa: E501 + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'ip_sec_policy': 'ipSecPolicy', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Vpn - a model defined in OpenAPI + + Keyword Args: + site_to_site_vpn (SiteToSiteVpn): + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ip_sec_policy (IpSecPolicy): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Vpn - a model defined in OpenAPI + + Keyword Args: + site_to_site_vpn (SiteToSiteVpn): + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ip_sec_policy (IpSecPolicy): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ProfileParcel, + VpnAllOf, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/vpn_all_of.py b/openapi_client/model/vpn_all_of.py new file mode 100644 index 0000000..41ccb80 --- /dev/null +++ b/openapi_client/model/vpn_all_of.py @@ -0,0 +1,276 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.ip_sec_policy import IpSecPolicy + from openapi_client.model.site_to_site_vpn import SiteToSiteVpn + globals()['IpSecPolicy'] = IpSecPolicy + globals()['SiteToSiteVpn'] = SiteToSiteVpn + + +class VpnAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'site_to_site_vpn': (SiteToSiteVpn,), # noqa: E501 + 'ip_sec_policy': (IpSecPolicy,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'site_to_site_vpn': 'siteToSiteVpn', # noqa: E501 + 'ip_sec_policy': 'ipSecPolicy', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VpnAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + site_to_site_vpn (SiteToSiteVpn): [optional] # noqa: E501 + ip_sec_policy (IpSecPolicy): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VpnAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + site_to_site_vpn (SiteToSiteVpn): [optional] # noqa: E501 + ip_sec_policy (IpSecPolicy): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/vpnid.py b/openapi_client/model/vpnid.py new file mode 100644 index 0000000..d4e65e3 --- /dev/null +++ b/openapi_client/model/vpnid.py @@ -0,0 +1,264 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class VPNID(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'vpn': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'vpn': 'vpn', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VPNID - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + vpn (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VPNID - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + vpn (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/wan_spec.py b/openapi_client/model/wan_spec.py new file mode 100644 index 0000000..661b420 --- /dev/null +++ b/openapi_client/model/wan_spec.py @@ -0,0 +1,298 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + + +class WanSpec(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'account_id': (str,), # noqa: E501 + 'cloud_region': (str,), # noqa: E501 + 'mapped_branches': (str,), # noqa: E501 + 'resource_group': (str,), # noqa: E501 + 'vpn': (str,), # noqa: E501 + 'wan_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'account_id': 'accountId', # noqa: E501 + 'cloud_region': 'cloudRegion', # noqa: E501 + 'mapped_branches': 'mappedBranches', # noqa: E501 + 'resource_group': 'resourceGroup', # noqa: E501 + 'vpn': 'vpn', # noqa: E501 + 'wan_id': 'wanId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, account_id, cloud_region, mapped_branches, resource_group, vpn, *args, **kwargs): # noqa: E501 + """WanSpec - a model defined in OpenAPI + + Args: + account_id (str): + cloud_region (str): + mapped_branches (str): + resource_group (str): + vpn (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + wan_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.account_id = account_id + self.cloud_region = cloud_region + self.mapped_branches = mapped_branches + self.resource_group = resource_group + self.vpn = vpn + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, account_id, cloud_region, mapped_branches, resource_group, vpn, *args, **kwargs): # noqa: E501 + """WanSpec - a model defined in OpenAPI + + Args: + account_id (str): + cloud_region (str): + mapped_branches (str): + resource_group (str): + vpn (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + wan_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.account_id = account_id + self.cloud_region = cloud_region + self.mapped_branches = mapped_branches + self.resource_group = resource_group + self.vpn = vpn + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model/wifi.py b/openapi_client/model/wifi.py new file mode 100644 index 0000000..d0b0ebf --- /dev/null +++ b/openapi_client/model/wifi.py @@ -0,0 +1,397 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.advanced_radio_setting import AdvancedRadioSetting + from openapi_client.model.corporate_wifi import CorporateWifi + from openapi_client.model.guest_wifi import GuestWifi + from openapi_client.model.profile_parcel import ProfileParcel + from openapi_client.model.ssid_config import SSIDConfig + from openapi_client.model.variable import Variable + from openapi_client.model.wifi_all_of import WifiAllOf + globals()['AdvancedRadioSetting'] = AdvancedRadioSetting + globals()['CorporateWifi'] = CorporateWifi + globals()['GuestWifi'] = GuestWifi + globals()['ProfileParcel'] = ProfileParcel + globals()['SSIDConfig'] = SSIDConfig + globals()['Variable'] = Variable + globals()['WifiAllOf'] = WifiAllOf + + +class Wifi(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CELLULAR': "cellular", + 'WIFI': "wifi", + 'ETHERNET': "ethernet", + 'GLOBALSETTINGS': "globalSettings", + 'NETWORKPROTOCOL': "networkProtocol", + 'SECURITYPOLICY': "securityPolicy", + 'VPN': "vpn", + }, + } + + validations = { + ('ssid_config_list',): { + 'max_items': 14, + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'ssid_config_list': ([SSIDConfig],), # noqa: E501 + 'guest_wifi': (GuestWifi,), # noqa: E501 + 'corporate_wifi': (CorporateWifi,), # noqa: E501 + 'advanced_radio_setting': (AdvancedRadioSetting,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'created_on': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'last_updated_by': (str,), # noqa: E501 + 'last_updated_on': (int,), # noqa: E501 + 'variables': ([Variable],), # noqa: E501 + } + + @cached_property + def discriminator(): + val = { + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'ssid_config_list': 'ssidConfigList', # noqa: E501 + 'guest_wifi': 'guestWifi', # noqa: E501 + 'corporate_wifi': 'corporateWifi', # noqa: E501 + 'advanced_radio_setting': 'advancedRadioSetting', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'created_on': 'createdOn', # noqa: E501 + 'id': 'id', # noqa: E501 + 'last_updated_by': 'lastUpdatedBy', # noqa: E501 + 'last_updated_on': 'lastUpdatedOn', # noqa: E501 + 'variables': 'variables', # noqa: E501 + } + + read_only_vars = { + 'created_by', # noqa: E501 + 'created_on', # noqa: E501 + 'last_updated_by', # noqa: E501 + 'last_updated_on', # noqa: E501 + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Wifi - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ssid_config_list ([SSIDConfig]): [optional] # noqa: E501 + guest_wifi (GuestWifi): [optional] # noqa: E501 + corporate_wifi (CorporateWifi): [optional] # noqa: E501 + advanced_radio_setting (AdvancedRadioSetting): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Wifi - a model defined in OpenAPI + + Keyword Args: + name (str): Name of the Profile Parcel. Must be unique. + type (str): type + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ssid_config_list ([SSIDConfig]): [optional] # noqa: E501 + guest_wifi (GuestWifi): [optional] # noqa: E501 + corporate_wifi (CorporateWifi): [optional] # noqa: E501 + advanced_radio_setting (AdvancedRadioSetting): [optional] # noqa: E501 + created_by (str): User who last created this.. [optional] # noqa: E501 + created_on (int): Timestamp of creation. [optional] # noqa: E501 + id (str): System generated unique identifier of the Profile Parcel in UUID format.. [optional] # noqa: E501 + last_updated_by (str): User who last updated this.. [optional] # noqa: E501 + last_updated_on (int): Timestamp of last update. [optional] # noqa: E501 + variables ([Variable]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ProfileParcel, + WifiAllOf, + ], + 'oneOf': [ + ], + } diff --git a/openapi_client/model/wifi_all_of.py b/openapi_client/model/wifi_all_of.py new file mode 100644 index 0000000..3f2b38b --- /dev/null +++ b/openapi_client/model/wifi_all_of.py @@ -0,0 +1,292 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from openapi_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from openapi_client.exceptions import ApiAttributeError + + +def lazy_import(): + from openapi_client.model.advanced_radio_setting import AdvancedRadioSetting + from openapi_client.model.corporate_wifi import CorporateWifi + from openapi_client.model.guest_wifi import GuestWifi + from openapi_client.model.ssid_config import SSIDConfig + globals()['AdvancedRadioSetting'] = AdvancedRadioSetting + globals()['CorporateWifi'] = CorporateWifi + globals()['GuestWifi'] = GuestWifi + globals()['SSIDConfig'] = SSIDConfig + + +class WifiAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('ssid_config_list',): { + 'max_items': 14, + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'ssid_config_list': ([SSIDConfig],), # noqa: E501 + 'guest_wifi': (GuestWifi,), # noqa: E501 + 'corporate_wifi': (CorporateWifi,), # noqa: E501 + 'advanced_radio_setting': (AdvancedRadioSetting,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'ssid_config_list': 'ssidConfigList', # noqa: E501 + 'guest_wifi': 'guestWifi', # noqa: E501 + 'corporate_wifi': 'corporateWifi', # noqa: E501 + 'advanced_radio_setting': 'advancedRadioSetting', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WifiAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ssid_config_list ([SSIDConfig]): [optional] # noqa: E501 + guest_wifi (GuestWifi): [optional] # noqa: E501 + corporate_wifi (CorporateWifi): [optional] # noqa: E501 + advanced_radio_setting (AdvancedRadioSetting): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WifiAllOf - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + ssid_config_list ([SSIDConfig]): [optional] # noqa: E501 + guest_wifi (GuestWifi): [optional] # noqa: E501 + corporate_wifi (CorporateWifi): [optional] # noqa: E501 + advanced_radio_setting (AdvancedRadioSetting): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/openapi_client/model_utils.py b/openapi_client/model_utils.py new file mode 100644 index 0000000..e4a1e5c --- /dev/null +++ b/openapi_client/model_utils.py @@ -0,0 +1,2059 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +from datetime import date, datetime # noqa: F401 +from copy import deepcopy +import inspect +import io +import os +import pprint +import re +import tempfile +import uuid + +from dateutil.parser import parse + +from openapi_client.exceptions import ( + ApiKeyError, + ApiAttributeError, + ApiTypeError, + ApiValueError, +) + +none_type = type(None) +file_type = io.IOBase + + +def convert_js_args_to_python_args(fn): + from functools import wraps + @wraps(fn) + def wrapped_init(_self, *args, **kwargs): + """ + An attribute named `self` received from the api will conflicts with the reserved `self` + parameter of a class method. During generation, `self` attributes are mapped + to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. + """ + spec_property_naming = kwargs.get('_spec_property_naming', False) + if spec_property_naming: + kwargs = change_keys_js_to_python( + kwargs, _self if isinstance( + _self, type) else _self.__class__) + return fn(_self, *args, **kwargs) + return wrapped_init + + +class cached_property(object): + # this caches the result of the function call for fn with no inputs + # use this as a decorator on function methods that you want converted + # into cached properties + result_key = '_results' + + def __init__(self, fn): + self._fn = fn + + def __get__(self, instance, cls=None): + if self.result_key in vars(self): + return vars(self)[self.result_key] + else: + result = self._fn() + setattr(self, self.result_key, result) + return result + + +PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) + + +def allows_single_value_input(cls): + """ + This function returns True if the input composed schema model or any + descendant model allows a value only input + This is true for cases where oneOf contains items like: + oneOf: + - float + - NumberWithValidation + - StringEnum + - ArrayModel + - null + TODO: lru_cache this + """ + if ( + issubclass(cls, ModelSimple) or + cls in PRIMITIVE_TYPES + ): + return True + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return False + return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) + return False + + +def composed_model_input_classes(cls): + """ + This function returns a list of the possible models that can be accepted as + inputs. + TODO: lru_cache this + """ + if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: + return [cls] + elif issubclass(cls, ModelNormal): + if cls.discriminator is None: + return [cls] + else: + return get_discriminated_classes(cls) + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return [] + if cls.discriminator is None: + input_classes = [] + for c in cls._composed_schemas['oneOf']: + input_classes.extend(composed_model_input_classes(c)) + return input_classes + else: + return get_discriminated_classes(cls) + return [] + + +class OpenApiModel(object): + """The base class for all OpenAPIModels""" + + def set_attribute(self, name, value): + # this is only used to set properties on self + + path_to_item = [] + if self._path_to_item: + path_to_item.extend(self._path_to_item) + path_to_item.append(name) + + if name in self.openapi_types: + required_types_mixed = self.openapi_types[name] + elif self.additional_properties_type is None: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + path_to_item + ) + elif self.additional_properties_type is not None: + required_types_mixed = self.additional_properties_type + + if get_simple_class(name) != str: + error_msg = type_error_message( + var_name=name, + var_value=name, + valid_classes=(str,), + key_type=True + ) + raise ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=(str,), + key_type=True + ) + + if self._check_type: + value = validate_and_convert_types( + value, required_types_mixed, path_to_item, self._spec_property_naming, + self._check_type, configuration=self._configuration) + if (name,) in self.allowed_values: + check_allowed_values( + self.allowed_values, + (name,), + value + ) + if (name,) in self.validations: + check_validations( + self.validations, + (name,), + value, + self._configuration + ) + self.__dict__['_data_store'][name] = value + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other + + def __setattr__(self, attr, value): + """set the value of an attribute using dot notation: `instance.attr = val`""" + self[attr] = value + + def __getattr__(self, attr): + """get the value of an attribute using dot notation: `instance.attr`""" + return self.__getitem__(attr) + + def __copy__(self): + cls = self.__class__ + if self.get("_spec_property_naming", False): + return cls._new_from_openapi_data(**self.__dict__) + else: + return cls.__new__(cls, **self.__dict__) + + def __deepcopy__(self, memo): + cls = self.__class__ + + if self.get("_spec_property_naming", False): + new_inst = cls._new_from_openapi_data() + else: + new_inst = cls.__new__(cls, **self.__dict__) + + for k, v in self.__dict__.items(): + setattr(new_inst, k, deepcopy(v, memo)) + return new_inst + + + def __new__(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: If Animal has a discriminator + # petType and we pass in "Dog", and the class Dog + # allOf includes Animal, we move through Animal + # once using the discriminator, and pick Dog. + # Then in the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return super(OpenApiModel, cls).__new__(cls) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return super(OpenApiModel, cls).__new__(cls) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = super(OpenApiModel, cls).__new__(cls) + self_inst.__init__(*args, **kwargs) + + if kwargs.get("_spec_property_naming", False): + # when true, implies new is from deserialization + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + else: + new_inst = new_cls.__new__(new_cls, *args, **kwargs) + new_inst.__init__(*args, **kwargs) + + return new_inst + + @classmethod + @convert_js_args_to_python_args + def _new_from_openapi_data(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: If Animal has a discriminator + # petType and we pass in "Dog", and the class Dog + # allOf includes Animal, we move through Animal + # once using the discriminator, and pick Dog. + # Then in the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return cls._from_openapi_data(*args, **kwargs) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return cls._from_openapi_data(*args, **kwargs) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = cls._from_openapi_data(*args, **kwargs) + + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + return new_inst + + +class ModelSimple(OpenApiModel): + """the parent class of models whose type != object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_str(self): + """Returns the string representation of the model""" + return str(self.value) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + this_val = self._data_store['value'] + that_val = other._data_store['value'] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + return vals_equal + + +class ModelNormal(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +class ModelComposed(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi and have oneOf/allOf/anyOf + + When one sets a property we use var_name_to_model_instances to store the value in + the correct class instances + run any type checking + validation code. + When one gets a property we use var_name_to_model_instances to get the value + from the correct class instances. + This allows multiple composed schemas to contain the same property with additive + constraints on the value. + + _composed_schemas (dict) stores the anyOf/allOf/oneOf classes + key (str): allOf/oneOf/anyOf + value (list): the classes in the XOf definition. + Note: none_type can be included when the openapi document version >= 3.1.0 + _composed_instances (list): stores a list of instances of the composed schemas + defined in _composed_schemas. When properties are accessed in the self instance, + they are returned from the self._data_store or the data stores in the instances + in self._composed_schemas + _var_name_to_model_instances (dict): maps between a variable name on self and + the composed instances (self included) which contain that data + key (str): property name + value (list): list of class instances, self or instances in _composed_instances + which contain the value that the key is referring to. + """ + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + """ + Use cases: + 1. additional_properties_type is None (additionalProperties == False in spec) + Check for property presence in self.openapi_types + if not present then throw an error + if present set in self, set attribute + always set on composed schemas + 2. additional_properties_type exists + set attribute on self + always set on composed schemas + """ + if self.additional_properties_type is None: + """ + For an attribute to exist on a composed schema it must: + - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND + - fulfill schema_requirements in each oneOf/anyOf/allOf schemas + + schema_requirements: + For an attribute to exist on a schema it must: + - be present in properties at the schema OR + - have additionalProperties unset (defaults additionalProperties = any type) OR + - have additionalProperties set + """ + if name not in self.openapi_types: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + # attribute must be set on self and composed instances + self.set_attribute(name, value) + for model_instance in self._composed_instances: + setattr(model_instance, name, value) + if name not in self._var_name_to_model_instances: + # we assigned an additional property + self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] + return None + + __unset_attribute_value__ = object() + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + # get the attribute from the correct instance + model_instances = self._var_name_to_model_instances.get(name) + values = [] + # A composed model stores self and child (oneof/anyOf/allOf) models under + # self._var_name_to_model_instances. + # Any property must exist in self and all model instances + # The value stored in all model instances must be the same + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + v = model_instance._data_store[name] + if v not in values: + values.append(v) + len_values = len(values) + if len_values == 0: + return default + elif len_values == 1: + return values[0] + elif len_values > 1: + raise ApiValueError( + "Values stored for property {0} in {1} differ when looking " + "at self and self's composed instances. All values must be " + "the same".format(name, type(self).__name__), + [e for e in [self._path_to_item, name] if e] + ) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + value = self.get(name, self.__unset_attribute_value__) + if value is self.__unset_attribute_value__: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + return value + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + + if name in self.required_properties: + return name in self.__dict__ + + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + return True + + return False + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +COERCION_INDEX_BY_TYPE = { + ModelComposed: 0, + ModelNormal: 1, + ModelSimple: 2, + none_type: 3, # The type of 'None'. + list: 4, + dict: 5, + float: 6, + int: 7, + bool: 8, + datetime: 9, + date: 10, + str: 11, + file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. +} + +# these are used to limit what type conversions we try to do +# when we have a valid type already and we want to try converting +# to another type +UPCONVERSION_TYPE_PAIRS = ( + (str, datetime), + (str, date), + # A float may be serialized as an integer, e.g. '3' is a valid serialized float. + (int, float), + (list, ModelComposed), + (dict, ModelComposed), + (str, ModelComposed), + (int, ModelComposed), + (float, ModelComposed), + (list, ModelComposed), + (list, ModelNormal), + (dict, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), +) + +COERCIBLE_TYPE_PAIRS = { + False: ( # client instantiation of a model with client data + # (dict, ModelComposed), + # (list, ModelComposed), + # (dict, ModelNormal), + # (list, ModelNormal), + # (str, ModelSimple), + # (int, ModelSimple), + # (float, ModelSimple), + # (list, ModelSimple), + # (str, int), + # (str, float), + # (str, datetime), + # (str, date), + # (int, str), + # (float, str), + ), + True: ( # server -> client data + (dict, ModelComposed), + (list, ModelComposed), + (dict, ModelNormal), + (list, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), + # (str, int), + # (str, float), + (str, datetime), + (str, date), + # (int, str), + # (float, str), + (str, file_type) + ), +} + + +def get_simple_class(input_value): + """Returns an input_value's simple class that we will use for type checking + Python2: + float and int will return int, where int is the python3 int backport + str and unicode will return str, where str is the python3 str backport + Note: float and int ARE both instances of int backport + Note: str_py2 and unicode_py2 are NOT both instances of str backport + + Args: + input_value (class/class_instance): the item for which we will return + the simple class + """ + if isinstance(input_value, type): + # input_value is a class + return input_value + elif isinstance(input_value, tuple): + return tuple + elif isinstance(input_value, list): + return list + elif isinstance(input_value, dict): + return dict + elif isinstance(input_value, none_type): + return none_type + elif isinstance(input_value, file_type): + return file_type + elif isinstance(input_value, bool): + # this must be higher than the int check because + # isinstance(True, int) == True + return bool + elif isinstance(input_value, int): + return int + elif isinstance(input_value, datetime): + # this must be higher than the date check because + # isinstance(datetime_instance, date) == True + return datetime + elif isinstance(input_value, date): + return date + elif isinstance(input_value, str): + return str + return type(input_value) + + +def check_allowed_values(allowed_values, input_variable_path, input_values): + """Raises an exception if the input_values are not allowed + + Args: + allowed_values (dict): the allowed_values dict + input_variable_path (tuple): the path to the input variable + input_values (list/str/int/float/date/datetime): the values that we + are checking to see if they are in allowed_values + """ + these_allowed_values = list(allowed_values[input_variable_path].values()) + if (isinstance(input_values, list) + and not set(input_values).issubset( + set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values) - set(these_allowed_values))), + raise ApiValueError( + "Invalid values for `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (isinstance(input_values, dict) + and not set( + input_values.keys()).issubset(set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values.keys()) - set(these_allowed_values))) + raise ApiValueError( + "Invalid keys in `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (not isinstance(input_values, (list, dict)) + and input_values not in these_allowed_values): + raise ApiValueError( + "Invalid value for `%s` (%s), must be one of %s" % + ( + input_variable_path[0], + input_values, + these_allowed_values + ) + ) + + +def is_json_validation_enabled(schema_keyword, configuration=None): + """Returns true if JSON schema validation is enabled for the specified + validation keyword. This can be used to skip JSON schema structural validation + as requested in the configuration. + + Args: + schema_keyword (string): the name of a JSON schema validation keyword. + configuration (Configuration): the configuration class. + """ + + return (configuration is None or + not hasattr(configuration, '_disabled_client_side_validations') or + schema_keyword not in configuration._disabled_client_side_validations) + + +def check_validations( + validations, input_variable_path, input_values, + configuration=None): + """Raises an exception if the input_values are invalid + + Args: + validations (dict): the validation dictionary. + input_variable_path (tuple): the path to the input variable. + input_values (list/str/int/float/date/datetime): the values that we + are checking. + configuration (Configuration): the configuration class. + """ + + if input_values is None: + return + + current_validations = validations[input_variable_path] + if (is_json_validation_enabled('multipleOf', configuration) and + 'multiple_of' in current_validations and + isinstance(input_values, (int, float)) and + not (float(input_values) / current_validations['multiple_of']).is_integer()): + # Note 'multipleOf' will be as good as the floating point arithmetic. + raise ApiValueError( + "Invalid value for `%s`, value must be a multiple of " + "`%s`" % ( + input_variable_path[0], + current_validations['multiple_of'] + ) + ) + + if (is_json_validation_enabled('maxLength', configuration) and + 'max_length' in current_validations and + len(input_values) > current_validations['max_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['max_length'] + ) + ) + + if (is_json_validation_enabled('minLength', configuration) and + 'min_length' in current_validations and + len(input_values) < current_validations['min_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be greater than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['min_length'] + ) + ) + + if (is_json_validation_enabled('maxItems', configuration) and + 'max_items' in current_validations and + len(input_values) > current_validations['max_items']): + raise ApiValueError( + "Invalid value for `%s`, number of items must be less than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['max_items'] + ) + ) + + if (is_json_validation_enabled('minItems', configuration) and + 'min_items' in current_validations and + len(input_values) < current_validations['min_items']): + raise ValueError( + "Invalid value for `%s`, number of items must be greater than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['min_items'] + ) + ) + + items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', + 'inclusive_minimum') + if (any(item in current_validations for item in items)): + if isinstance(input_values, list): + max_val = max(input_values) + min_val = min(input_values) + elif isinstance(input_values, dict): + max_val = max(input_values.values()) + min_val = min(input_values.values()) + else: + max_val = input_values + min_val = input_values + + if (is_json_validation_enabled('exclusiveMaximum', configuration) and + 'exclusive_maximum' in current_validations and + max_val >= current_validations['exclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than `%s`" % ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('maximum', configuration) and + 'inclusive_maximum' in current_validations and + max_val > current_validations['inclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['inclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('exclusiveMinimum', configuration) and + 'exclusive_minimum' in current_validations and + min_val <= current_validations['exclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than `%s`" % + ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('minimum', configuration) and + 'inclusive_minimum' in current_validations and + min_val < current_validations['inclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than or equal " + "to `%s`" % ( + input_variable_path[0], + current_validations['inclusive_minimum'] + ) + ) + flags = current_validations.get('regex', {}).get('flags', 0) + if (is_json_validation_enabled('pattern', configuration) and + 'regex' in current_validations and + not re.search(current_validations['regex']['pattern'], + input_values, flags=flags)): + err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( + input_variable_path[0], + current_validations['regex']['pattern'] + ) + if flags != 0: + # Don't print the regex flags if the flags are not + # specified in the OAS document. + err_msg = r"%s with flags=`%s`" % (err_msg, flags) + raise ApiValueError(err_msg) + + +def order_response_types(required_types): + """Returns the required types sorted in coercion order + + Args: + required_types (list/tuple): collection of classes or instance of + list or dict with class information inside it. + + Returns: + (list): coercion order sorted collection of classes or instance + of list or dict with class information inside it. + """ + + def index_getter(class_or_instance): + if isinstance(class_or_instance, list): + return COERCION_INDEX_BY_TYPE[list] + elif isinstance(class_or_instance, dict): + return COERCION_INDEX_BY_TYPE[dict] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelComposed)): + return COERCION_INDEX_BY_TYPE[ModelComposed] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelNormal)): + return COERCION_INDEX_BY_TYPE[ModelNormal] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelSimple)): + return COERCION_INDEX_BY_TYPE[ModelSimple] + elif class_or_instance in COERCION_INDEX_BY_TYPE: + return COERCION_INDEX_BY_TYPE[class_or_instance] + raise ApiValueError("Unsupported type: %s" % class_or_instance) + + sorted_types = sorted( + required_types, + key=lambda class_or_instance: index_getter(class_or_instance) + ) + return sorted_types + + +def remove_uncoercible(required_types_classes, current_item, spec_property_naming, + must_convert=True): + """Only keeps the type conversions that are possible + + Args: + required_types_classes (tuple): tuple of classes that are required + these should be ordered by COERCION_INDEX_BY_TYPE + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + current_item (any): the current item (input data) to be converted + + Keyword Args: + must_convert (bool): if True the item to convert is of the wrong + type and we want a big list of coercibles + if False, we want a limited list of coercibles + + Returns: + (list): the remaining coercible required types, classes only + """ + current_type_simple = get_simple_class(current_item) + + results_classes = [] + for required_type_class in required_types_classes: + # convert our models to OpenApiModel + required_type_class_simplified = required_type_class + if isinstance(required_type_class_simplified, type): + if issubclass(required_type_class_simplified, ModelComposed): + required_type_class_simplified = ModelComposed + elif issubclass(required_type_class_simplified, ModelNormal): + required_type_class_simplified = ModelNormal + elif issubclass(required_type_class_simplified, ModelSimple): + required_type_class_simplified = ModelSimple + + if required_type_class_simplified == current_type_simple: + # don't consider converting to one's own class + continue + + class_pair = (current_type_simple, required_type_class_simplified) + if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: + results_classes.append(required_type_class) + elif class_pair in UPCONVERSION_TYPE_PAIRS: + results_classes.append(required_type_class) + return results_classes + + +def get_discriminated_classes(cls): + """ + Returns all the classes that a discriminator converts to + TODO: lru_cache this + """ + possible_classes = [] + key = list(cls.discriminator.keys())[0] + if is_type_nullable(cls): + possible_classes.append(cls) + for discr_cls in cls.discriminator[key].values(): + if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: + possible_classes.extend(get_discriminated_classes(discr_cls)) + else: + possible_classes.append(discr_cls) + return possible_classes + + +def get_possible_classes(cls, from_server_context): + # TODO: lru_cache this + possible_classes = [cls] + if from_server_context: + return possible_classes + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + possible_classes = [] + possible_classes.extend(get_discriminated_classes(cls)) + elif issubclass(cls, ModelComposed): + possible_classes.extend(composed_model_input_classes(cls)) + return possible_classes + + +def get_required_type_classes(required_types_mixed, spec_property_naming): + """Converts the tuple required_types into a tuple and a dict described + below + + Args: + required_types_mixed (tuple/list): will contain either classes or + instance of list or dict + spec_property_naming (bool): if True these values came from the + server, and we use the data types in our endpoints. + If False, we are client side and we need to include + oneOf and discriminator classes inside the data types in our endpoints + + Returns: + (valid_classes, dict_valid_class_to_child_types_mixed): + valid_classes (tuple): the valid classes that the current item + should be + dict_valid_class_to_child_types_mixed (dict): + valid_class (class): this is the key + child_types_mixed (list/dict/tuple): describes the valid child + types + """ + valid_classes = [] + child_req_types_by_current_type = {} + for required_type in required_types_mixed: + if isinstance(required_type, list): + valid_classes.append(list) + child_req_types_by_current_type[list] = required_type + elif isinstance(required_type, tuple): + valid_classes.append(tuple) + child_req_types_by_current_type[tuple] = required_type + elif isinstance(required_type, dict): + valid_classes.append(dict) + child_req_types_by_current_type[dict] = required_type[str] + else: + valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) + return tuple(valid_classes), child_req_types_by_current_type + + +def change_keys_js_to_python(input_dict, model_class): + """ + Converts from javascript_key keys in the input_dict to python_keys in + the output dict using the mapping in model_class. + If the input_dict contains a key which does not declared in the model_class, + the key is added to the output dict as is. The assumption is the model_class + may have undeclared properties (additionalProperties attribute in the OAS + document). + """ + + if getattr(model_class, 'attribute_map', None) is None: + return input_dict + output_dict = {} + reversed_attr_map = {value: key for key, value in + model_class.attribute_map.items()} + for javascript_key, value in input_dict.items(): + python_key = reversed_attr_map.get(javascript_key) + if python_key is None: + # if the key is unknown, it is in error or it is an + # additionalProperties variable + python_key = javascript_key + output_dict[python_key] = value + return output_dict + + +def get_type_error(var_value, path_to_item, valid_classes, key_type=False): + error_msg = type_error_message( + var_name=path_to_item[-1], + var_value=var_value, + valid_classes=valid_classes, + key_type=key_type + ) + return ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=valid_classes, + key_type=key_type + ) + + +def deserialize_primitive(data, klass, path_to_item): + """Deserializes string to primitive type. + + :param data: str/int/float + :param klass: str/class the class to convert to + + :return: int, float, str, bool, date, datetime + """ + additional_message = "" + try: + if klass in {datetime, date}: + additional_message = ( + "If you need your parameter to have a fallback " + "string value, please set its type as `type: {}` in your " + "spec. That allows the value to be any type. " + ) + if klass == datetime: + if len(data) < 8: + raise ValueError("This is not a datetime") + # The string should be in iso8601 datetime format. + parsed_datetime = parse(data) + date_only = ( + parsed_datetime.hour == 0 and + parsed_datetime.minute == 0 and + parsed_datetime.second == 0 and + parsed_datetime.tzinfo is None and + 8 <= len(data) <= 10 + ) + if date_only: + raise ValueError("This is a date, not a datetime") + return parsed_datetime + elif klass == date: + if len(data) < 8: + raise ValueError("This is not a date") + return parse(data).date() + else: + converted_value = klass(data) + if isinstance(data, str) and klass == float: + if str(converted_value) != data: + # '7' -> 7.0 -> '7.0' != '7' + raise ValueError('This is not a float') + return converted_value + except (OverflowError, ValueError) as ex: + # parse can raise OverflowError + raise ApiValueError( + "{0}Failed to parse {1} as {2}".format( + additional_message, repr(data), klass.__name__ + ), + path_to_item=path_to_item + ) from ex + + +def get_discriminator_class(model_class, + discr_name, + discr_value, cls_visited): + """Returns the child class specified by the discriminator. + + Args: + model_class (OpenApiModel): the model class. + discr_name (string): the name of the discriminator property. + discr_value (any): the discriminator value. + cls_visited (list): list of model classes that have been visited. + Used to determine the discriminator class without + visiting circular references indefinitely. + + Returns: + used_model_class (class/None): the chosen child class that will be used + to deserialize the data, for example dog.Dog. + If a class is not found, None is returned. + """ + + if model_class in cls_visited: + # The class has already been visited and no suitable class was found. + return None + cls_visited.append(model_class) + used_model_class = None + if discr_name in model_class.discriminator: + class_name_to_discr_class = model_class.discriminator[discr_name] + used_model_class = class_name_to_discr_class.get(discr_value) + if used_model_class is None: + # We didn't find a discriminated class in class_name_to_discr_class. + # So look in the ancestor or descendant discriminators + # The discriminator mapping may exist in a descendant (anyOf, oneOf) + # or ancestor (allOf). + # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat + # hierarchy, the discriminator mappings may be defined at any level + # in the hierarchy. + # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig + # if we try to make BasquePig from mammal, we need to travel through + # the oneOf descendant discriminators to find BasquePig + descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ + model_class._composed_schemas.get('anyOf', ()) + ancestor_classes = model_class._composed_schemas.get('allOf', ()) + possible_classes = descendant_classes + ancestor_classes + for cls in possible_classes: + # Check if the schema has inherited discriminators. + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + used_model_class = get_discriminator_class( + cls, discr_name, discr_value, cls_visited) + if used_model_class is not None: + return used_model_class + return used_model_class + + +def deserialize_model(model_data, model_class, path_to_item, check_type, + configuration, spec_property_naming): + """Deserializes model_data to model instance. + + Args: + model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model + model_class (OpenApiModel): the model class + path_to_item (list): path to the model in the received data + check_type (bool): whether to check the data tupe for the values in + the model + configuration (Configuration): the instance to use to convert files + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + + Returns: + model instance + + Raise: + ApiTypeError + ApiValueError + ApiKeyError + """ + + kw_args = dict(_check_type=check_type, + _path_to_item=path_to_item, + _configuration=configuration, + _spec_property_naming=spec_property_naming) + + if issubclass(model_class, ModelSimple): + return model_class._new_from_openapi_data(model_data, **kw_args) + elif isinstance(model_data, list): + return model_class._new_from_openapi_data(*model_data, **kw_args) + if isinstance(model_data, dict): + kw_args.update(model_data) + return model_class._new_from_openapi_data(**kw_args) + elif isinstance(model_data, PRIMITIVE_TYPES): + return model_class._new_from_openapi_data(model_data, **kw_args) + + +def deserialize_file(response_data, configuration, content_disposition=None): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + Args: + param response_data (str): the file data to write + configuration (Configuration): the instance to use to convert files + + Keyword Args: + content_disposition (str): the value of the Content-Disposition + header + + Returns: + (file_type): the deserialized file which is open + The user is responsible for closing and reading the file + """ + fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + if content_disposition: + filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition, + flags=re.I) + if filename is not None: + filename = filename.group(1) + else: + filename = "default_" + str(uuid.uuid4()) + + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + if isinstance(response_data, str): + # change str to bytes so we can write it + response_data = response_data.encode('utf-8') + f.write(response_data) + + f = open(path, "rb") + return f + + +def attempt_convert_item(input_value, valid_classes, path_to_item, + configuration, spec_property_naming, key_type=False, + must_convert=False, check_type=True): + """ + Args: + input_value (any): the data to convert + valid_classes (any): the classes that are valid + path_to_item (list): the path to the item to convert + configuration (Configuration): the instance to use to convert files + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + key_type (bool): if True we need to convert a key type (not supported) + must_convert (bool): if True we must convert + check_type (bool): if True we check the type or the returned data in + ModelComposed/ModelNormal/ModelSimple instances + + Returns: + instance (any) the fixed item + + Raises: + ApiTypeError + ApiValueError + ApiKeyError + """ + valid_classes_ordered = order_response_types(valid_classes) + valid_classes_coercible = remove_uncoercible( + valid_classes_ordered, input_value, spec_property_naming) + if not valid_classes_coercible or key_type: + # we do not handle keytype errors, json will take care + # of this for us + if configuration is None or not configuration.discard_unknown_keys: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=key_type) + for valid_class in valid_classes_coercible: + try: + if issubclass(valid_class, OpenApiModel): + return deserialize_model(input_value, valid_class, + path_to_item, check_type, + configuration, spec_property_naming) + elif valid_class == file_type: + return deserialize_file(input_value, configuration) + return deserialize_primitive(input_value, valid_class, + path_to_item) + except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: + if must_convert: + raise conversion_exc + # if we have conversion errors when must_convert == False + # we ignore the exception and move on to the next class + continue + # we were unable to convert, must_convert == False + return input_value + + +def is_type_nullable(input_type): + """ + Returns true if None is an allowed value for the specified input_type. + + A type is nullable if at least one of the following conditions is true: + 1. The OAS 'nullable' attribute has been specified, + 1. The type is the 'null' type, + 1. The type is a anyOf/oneOf composed schema, and a child schema is + the 'null' type. + Args: + input_type (type): the class of the input_value that we are + checking + Returns: + bool + """ + if input_type is none_type: + return True + if issubclass(input_type, OpenApiModel) and input_type._nullable: + return True + if issubclass(input_type, ModelComposed): + # If oneOf/anyOf, check if the 'null' type is one of the allowed types. + for t in input_type._composed_schemas.get('oneOf', ()): + if is_type_nullable(t): + return True + for t in input_type._composed_schemas.get('anyOf', ()): + if is_type_nullable(t): + return True + return False + + +def is_valid_type(input_class_simple, valid_classes): + """ + Args: + input_class_simple (class): the class of the input_value that we are + checking + valid_classes (tuple): the valid classes that the current item + should be + Returns: + bool + """ + if issubclass(input_class_simple, OpenApiModel) and \ + valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): + return True + valid_type = input_class_simple in valid_classes + if not valid_type and ( + issubclass(input_class_simple, OpenApiModel) or + input_class_simple is none_type): + for valid_class in valid_classes: + if input_class_simple is none_type and is_type_nullable(valid_class): + # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. + return True + if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): + continue + discr_propertyname_py = list(valid_class.discriminator.keys())[0] + discriminator_classes = ( + valid_class.discriminator[discr_propertyname_py].values() + ) + valid_type = is_valid_type(input_class_simple, discriminator_classes) + if valid_type: + return True + return valid_type + + +def validate_and_convert_types(input_value, required_types_mixed, path_to_item, + spec_property_naming, _check_type, configuration=None): + """Raises a TypeError is there is a problem, otherwise returns value + + Args: + input_value (any): the data to validate/convert + required_types_mixed (list/dict/tuple): A list of + valid classes, or a list tuples of valid classes, or a dict where + the value is a tuple of value classes + path_to_item: (list) the path to the data being validated + this stores a list of keys or indices to get to the data being + validated + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + _check_type: (boolean) if true, type will be checked and conversion + will be attempted. + configuration: (Configuration): the configuration class to use + when converting file_type items. + If passed, conversion will be attempted when possible + If not passed, no conversions will be attempted and + exceptions will be raised + + Returns: + the correctly typed value + + Raises: + ApiTypeError + """ + results = get_required_type_classes(required_types_mixed, spec_property_naming) + valid_classes, child_req_types_by_current_type = results + + input_class_simple = get_simple_class(input_value) + valid_type = is_valid_type(input_class_simple, valid_classes) + if not valid_type: + if (configuration + or (input_class_simple == dict + and dict not in valid_classes)): + # if input_value is not valid_type try to convert it + converted_instance = attempt_convert_item( + input_value, + valid_classes, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=True, + check_type=_check_type + ) + return converted_instance + else: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=False) + + # input_value's type is in valid_classes + if len(valid_classes) > 1 and configuration: + # there are valid classes which are not the current class + valid_classes_coercible = remove_uncoercible( + valid_classes, input_value, spec_property_naming, must_convert=False) + if valid_classes_coercible: + converted_instance = attempt_convert_item( + input_value, + valid_classes_coercible, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=False, + check_type=_check_type + ) + return converted_instance + + if child_req_types_by_current_type == {}: + # all types are of the required types and there are no more inner + # variables left to look at + return input_value + inner_required_types = child_req_types_by_current_type.get( + type(input_value) + ) + if inner_required_types is None: + # for this type, there are not more inner variables left to look at + return input_value + if isinstance(input_value, list): + if input_value == []: + # allow an empty list + return input_value + for index, inner_value in enumerate(input_value): + inner_path = list(path_to_item) + inner_path.append(index) + input_value[index] = validate_and_convert_types( + inner_value, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + elif isinstance(input_value, dict): + if input_value == {}: + # allow an empty dict + return input_value + for inner_key, inner_val in input_value.items(): + inner_path = list(path_to_item) + inner_path.append(inner_key) + if get_simple_class(inner_key) != str: + raise get_type_error(inner_key, inner_path, valid_classes, + key_type=True) + input_value[inner_key] = validate_and_convert_types( + inner_val, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + return input_value + + +def model_to_dict(model_instance, serialize=True): + """Returns the model properties as a dict + + Args: + model_instance (one of your model instances): the model instance that + will be converted to a dict. + + Keyword Args: + serialize (bool): if True, the keys in the dict will be values from + attribute_map + """ + result = {} + + def extract_item(item): return ( + item[0], model_to_dict( + item[1], serialize=serialize)) if hasattr( + item[1], '_data_store') else item + + model_instances = [model_instance] + if model_instance._composed_schemas: + model_instances.extend(model_instance._composed_instances) + seen_json_attribute_names = set() + used_fallback_python_attribute_names = set() + py_to_json_map = {} + for model_instance in model_instances: + for attr, value in model_instance._data_store.items(): + if serialize: + # we use get here because additional property key names do not + # exist in attribute_map + try: + attr = model_instance.attribute_map[attr] + py_to_json_map.update(model_instance.attribute_map) + seen_json_attribute_names.add(attr) + except KeyError: + used_fallback_python_attribute_names.add(attr) + if isinstance(value, list): + if not value: + # empty list or None + result[attr] = value + else: + res = [] + for v in value: + if isinstance(v, PRIMITIVE_TYPES) or v is None: + res.append(v) + elif isinstance(v, ModelSimple): + res.append(v.value) + elif isinstance(v, dict): + res.append(dict(map( + extract_item, + v.items() + ))) + else: + res.append(model_to_dict(v, serialize=serialize)) + result[attr] = res + elif isinstance(value, dict): + result[attr] = dict(map( + extract_item, + value.items() + )) + elif isinstance(value, ModelSimple): + result[attr] = value.value + elif hasattr(value, '_data_store'): + result[attr] = model_to_dict(value, serialize=serialize) + else: + result[attr] = value + if serialize: + for python_key in used_fallback_python_attribute_names: + json_key = py_to_json_map.get(python_key) + if json_key is None: + continue + if python_key == json_key: + continue + json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names + if json_key_assigned_no_need_for_python_key: + del result[python_key] + + return result + + +def type_error_message(var_value=None, var_name=None, valid_classes=None, + key_type=None): + """ + Keyword Args: + var_value (any): the variable which has the type_error + var_name (str): the name of the variable which has the typ error + valid_classes (tuple): the accepted classes for current_item's + value + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + """ + key_or_value = 'value' + if key_type: + key_or_value = 'key' + valid_classes_phrase = get_valid_classes_phrase(valid_classes) + msg = ( + "Invalid type for variable '{0}'. Required {1} type {2} and " + "passed type was {3}".format( + var_name, + key_or_value, + valid_classes_phrase, + type(var_value).__name__, + ) + ) + return msg + + +def get_valid_classes_phrase(input_classes): + """Returns a string phrase describing what types are allowed + """ + all_classes = list(input_classes) + all_classes = sorted(all_classes, key=lambda cls: cls.__name__) + all_class_names = [cls.__name__ for cls in all_classes] + if len(all_class_names) == 1: + return 'is {0}'.format(all_class_names[0]) + return "is one of [{0}]".format(", ".join(all_class_names)) + + +def get_allof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + used to make instances + constant_args (dict): + metadata arguments: + _check_type + _path_to_item + _spec_property_naming + _configuration + _visited_composed_classes + + Returns + composed_instances (list) + """ + composed_instances = [] + for allof_class in self._composed_schemas['allOf']: + + try: + if constant_args.get('_spec_property_naming'): + allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) + else: + allof_instance = allof_class(**model_args, **constant_args) + composed_instances.append(allof_instance) + except Exception as ex: + raise ApiValueError( + "Invalid inputs given to generate an instance of '%s'. The " + "input data was invalid for the allOf schema '%s' in the composed " + "schema '%s'. Error=%s" % ( + allof_class.__name__, + allof_class.__name__, + self.__class__.__name__, + str(ex) + ) + ) from ex + return composed_instances + + +def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): + """ + Find the oneOf schema that matches the input data (e.g. payload). + If exactly one schema matches the input data, an instance of that schema + is returned. + If zero or more than one schema match the input data, an exception is raised. + In OAS 3.x, the payload MUST, by validation, match exactly one of the + schemas described by oneOf. + + Args: + cls: the class we are handling + model_kwargs (dict): var_name to var_value + The input data, e.g. the payload that must match a oneOf schema + in the OpenAPI document. + constant_kwargs (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Kwargs: + model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): + the value to assign to a primitive class or ModelSimple class + Notes: + - this is only passed in when oneOf includes types which are not object + - None is used to suppress handling of model_arg, nullable models are handled in __new__ + + Returns + oneof_instance (instance) + """ + if len(cls._composed_schemas['oneOf']) == 0: + return None + + oneof_instances = [] + # Iterate over each oneOf schema and determine if the input data + # matches the oneOf schemas. + for oneof_class in cls._composed_schemas['oneOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if oneof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + single_value_input = allows_single_value_input(oneof_class) + + try: + if not single_value_input: + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data( + **model_kwargs, **constant_kwargs) + else: + oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) + else: + if issubclass(oneof_class, ModelSimple): + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data( + model_arg, **constant_kwargs) + else: + oneof_instance = oneof_class(model_arg, **constant_kwargs) + elif oneof_class in PRIMITIVE_TYPES: + oneof_instance = validate_and_convert_types( + model_arg, + (oneof_class,), + constant_kwargs['_path_to_item'], + constant_kwargs['_spec_property_naming'], + constant_kwargs['_check_type'], + configuration=constant_kwargs['_configuration'] + ) + oneof_instances.append(oneof_instance) + except Exception: + pass + if len(oneof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None " + "of the oneOf schemas matched the input data." % + cls.__name__ + ) + elif len(oneof_instances) > 1: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. Multiple " + "oneOf schemas matched the inputs, but a max of one is allowed." % + cls.__name__ + ) + return oneof_instances[0] + + +def get_anyof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + The input data, e.g. the payload that must match at least one + anyOf child schema in the OpenAPI document. + constant_args (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Returns + anyof_instances (list) + """ + anyof_instances = [] + if len(self._composed_schemas['anyOf']) == 0: + return anyof_instances + + for anyof_class in self._composed_schemas['anyOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if anyof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + try: + if constant_args.get('_spec_property_naming'): + anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) + else: + anyof_instance = anyof_class(**model_args, **constant_args) + anyof_instances.append(anyof_instance) + except Exception: + pass + if len(anyof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None of the " + "anyOf schemas matched the inputs." % + self.__class__.__name__ + ) + return anyof_instances + + +def get_discarded_args(self, composed_instances, model_args): + """ + Gathers the args that were discarded by configuration.discard_unknown_keys + """ + model_arg_keys = model_args.keys() + discarded_args = set() + # arguments passed to self were already converted to python names + # before __init__ was called + for instance in composed_instances: + if instance.__class__ in self._composed_schemas['allOf']: + try: + keys = instance.to_dict().keys() + discarded_keys = model_args - keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + else: + try: + all_keys = set(model_to_dict(instance, serialize=False).keys()) + js_keys = model_to_dict(instance, serialize=True).keys() + all_keys.update(js_keys) + discarded_keys = model_arg_keys - all_keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + return discarded_args + + +def validate_get_composed_info(constant_args, model_args, self): + """ + For composed schemas, generate schema instances for + all schemas in the oneOf/anyOf/allOf definition. If additional + properties are allowed, also assign those properties on + all matched schemas that contain additionalProperties. + Openapi schemas are python classes. + + Exceptions are raised if: + - 0 or > 1 oneOf schema matches the model_args input data + - no anyOf schema matches the model_args input data + - any of the allOf schemas do not match the model_args input data + + Args: + constant_args (dict): these are the args that every model requires + model_args (dict): these are the required and optional spec args that + were passed in to make this model + self (class): the class that we are instantiating + This class contains self._composed_schemas + + Returns: + composed_info (list): length three + composed_instances (list): the composed instances which are not + self + var_name_to_model_instances (dict): a dict going from var_name + to the model_instance which holds that var_name + the model_instance may be self or an instance of one of the + classes in self.composed_instances() + additional_properties_model_instances (list): a list of the + model instances which have the property + additional_properties_type. This list can include self + """ + # create composed_instances + composed_instances = [] + allof_instances = get_allof_instances(self, model_args, constant_args) + composed_instances.extend(allof_instances) + oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) + if oneof_instance is not None: + composed_instances.append(oneof_instance) + anyof_instances = get_anyof_instances(self, model_args, constant_args) + composed_instances.extend(anyof_instances) + """ + set additional_properties_model_instances + additional properties must be evaluated at the schema level + so self's additional properties are most important + If self is a composed schema with: + - no properties defined in self + - additionalProperties: False + Then for object payloads every property is an additional property + and they are not allowed, so only empty dict is allowed + + Properties must be set on all matching schemas + so when a property is assigned toa composed instance, it must be set on all + composed instances regardless of additionalProperties presence + keeping it to prevent breaking changes in v5.0.1 + TODO remove cls._additional_properties_model_instances in 6.0.0 + """ + additional_properties_model_instances = [] + if self.additional_properties_type is not None: + additional_properties_model_instances = [self] + + """ + no need to set properties on self in here, they will be set in __init__ + By here all composed schema oneOf/anyOf/allOf instances have their properties set using + model_args + """ + discarded_args = get_discarded_args(self, composed_instances, model_args) + + # map variable names to composed_instances + var_name_to_model_instances = {} + for prop_name in model_args: + if prop_name not in discarded_args: + var_name_to_model_instances[prop_name] = [self] + list( + filter( + lambda x: prop_name in x.openapi_types, composed_instances)) + + return [ + composed_instances, + var_name_to_model_instances, + additional_properties_model_instances, + discarded_args + ] diff --git a/openapi_client/models/__init__.py b/openapi_client/models/__init__.py new file mode 100644 index 0000000..ee9f8fe --- /dev/null +++ b/openapi_client/models/__init__.py @@ -0,0 +1,138 @@ +# flake8: noqa + +# import all models into this package +# if you have many models here with many references from one model to another this may +# raise a RecursionError +# to avoid this, import only the models that you directly need like: +# from from openapi_client.model.pet import Pet +# or import this package, but before doing it, use: +# import sys +# sys.setrecursionlimit(n) + +from openapi_client.model.advanced_radio_setting import AdvancedRadioSetting +from openapi_client.model.api_re_key_device import ApiReKeyDevice +from openapi_client.model.api_re_key_device_list import ApiReKeyDeviceList +from openapi_client.model.aws_iam_credentials import AwsIamCredentials +from openapi_client.model.aws_key_credentials import AwsKeyCredentials +from openapi_client.model.azure_credentials import AzureCredentials +from openapi_client.model.banner import Banner +from openapi_client.model.bfd import Bfd +from openapi_client.model.bfd_timer_on_transport_tunnels import BfdTimerOnTransportTunnels +from openapi_client.model.biz_internet_timer import BizInternetTimer +from openapi_client.model.cellular import Cellular +from openapi_client.model.cellular_all_of import CellularAllOf +from openapi_client.model.cellular_profile import CellularProfile +from openapi_client.model.certificate_states import CertificateStates +from openapi_client.model.certificate_validity import CertificateValidity +from openapi_client.model.channel_power_settings import ChannelPowerSettings +from openapi_client.model.config_group import ConfigGroup +from openapi_client.model.connect_to_ntp_server import ConnectToNtpServer +from openapi_client.model.control_status import ControlStatus +from openapi_client.model.corporate_wifi import CorporateWifi +from openapi_client.model.country_region_settings import CountryRegionSettings +from openapi_client.model.create_device_params import CreateDeviceParams +from openapi_client.model.create_tenant_model import CreateTenantModel +from openapi_client.model.dhcp_pool import DHCPPool +from openapi_client.model.data_center import DataCenter +from openapi_client.model.data_center_registration import DataCenterRegistration +from openapi_client.model.delete_tenant_bulk_model import DeleteTenantBulkModel +from openapi_client.model.delete_tenant_model import DeleteTenantModel +from openapi_client.model.device import Device +from openapi_client.model.device_health_details import DeviceHealthDetails +from openapi_client.model.device_ip import DeviceIP +from openapi_client.model.device_model import DeviceModel +from openapi_client.model.device_type import DeviceType +from openapi_client.model.device_uuid import DeviceUuid +from openapi_client.model.devices_health import DevicesHealth +from openapi_client.model.devices_health_overview import DevicesHealthOverview +from openapi_client.model.disaster_recovery_settings import DisasterRecoverySettings +from openapi_client.model.domain_detail import DomainDetail +from openapi_client.model.entity_ownership_info import EntityOwnershipInfo +from openapi_client.model.equinix_credentials import EquinixCredentials +from openapi_client.model.equinix_location_info import EquinixLocationInfo +from openapi_client.model.equinix_ne_info import EquinixNEInfo +from openapi_client.model.equinix_partner_port import EquinixPartnerPort +from openapi_client.model.ethernet import Ethernet +from openapi_client.model.ethernet_all_of import EthernetAllOf +from openapi_client.model.ethernet_interface import EthernetInterface +from openapi_client.model.event_name import EventName +from openapi_client.model.feature_profile import FeatureProfile +from openapi_client.model.gcp_credentials import GcpCredentials +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request_value import GetO365PreferredPathFromVAnalyticsRequestValue +from openapi_client.model.global_settings import GlobalSettings +from openapi_client.model.global_settings_all_of import GlobalSettingsAllOf +from openapi_client.model.group_id import GroupId +from openapi_client.model.guest_wifi import GuestWifi +from openapi_client.model.header import Header +from openapi_client.model.header_element import HeaderElement +from openapi_client.model.host import Host +from openapi_client.model.ike_phase import IkePhase +from openapi_client.model.ip_sec_policy import IpSecPolicy +from openapi_client.model.ip_sec_security import IpSecSecurity +from openapi_client.model.logging_system_messages import LoggingSystemMessages +from openapi_client.model.login_access_to_router import LoginAccessToRouter +from openapi_client.model.lte_timer import LteTimer +from openapi_client.model.megaport_credentials import MegaportCredentials +from openapi_client.model.megaport_location_info import MegaportLocationInfo +from openapi_client.model.megaport_mve_info import MegaportMVEInfo +from openapi_client.model.megaport_partner_port import MegaportPartnerPort +from openapi_client.model.mpls_timer import MplsTimer +from openapi_client.model.multi_cloud_account_info import MultiCloudAccountInfo +from openapi_client.model.multi_cloud_edge_account_info import MultiCloudEdgeAccountInfo +from openapi_client.model.multi_cloud_edge_billing_account_info import MultiCloudEdgeBillingAccountInfo +from openapi_client.model.multi_cloud_edge_location_info import MultiCloudEdgeLocationInfo +from openapi_client.model.multi_cloud_edge_partner_port import MultiCloudEdgePartnerPort +from openapi_client.model.nat_rule import NATRule +from openapi_client.model.name_value_pair import NameValuePair +from openapi_client.model.network_protocol import NetworkProtocol +from openapi_client.model.network_protocol_all_of import NetworkProtocolAllOf +from openapi_client.model.node import Node +from openapi_client.model.nwpi_domain_monitor import NwpiDomainMonitor +from openapi_client.model.omp import OMP +from openapi_client.model.on_demand_queue_entry import OnDemandQueueEntry +from openapi_client.model.partner_type import PartnerType +from openapi_client.model.policy_rule import PolicyRule +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.property_definition import PropertyDefinition +from openapi_client.model.public_internet_timer import PublicInternetTimer +from openapi_client.model.queue_entries import QueueEntries +from openapi_client.model.queue_properties import QueueProperties +from openapi_client.model.radio_band_setting24_g import RadioBandSetting24G +from openapi_client.model.radio_band_setting5_g import RadioBandSetting5G +from openapi_client.model.radius_server import RadiusServer +from openapi_client.model.resource_group import ResourceGroup +from openapi_client.model.ssid_config import SSIDConfig +from openapi_client.model.schema_definition import SchemaDefinition +from openapi_client.model.security_policy import SecurityPolicy +from openapi_client.model.security_policy_all_of import SecurityPolicyAllOf +from openapi_client.model.sim_slot_config import SimSlotConfig +from openapi_client.model.site_health import SiteHealth +from openapi_client.model.site_to_site_vpn import SiteToSiteVpn +from openapi_client.model.smart_account_model import SmartAccountModel +from openapi_client.model.software_upload_file_data import SoftwareUploadFileData +from openapi_client.model.statistics_processing_counters import StatisticsProcessingCounters +from openapi_client.model.stats_type_processing_counters import StatsTypeProcessingCounters +from openapi_client.model.systems import Systems +from openapi_client.model.tag_restful_resource import TagRestfulResource +from openapi_client.model.tenant_status import TenantStatus +from openapi_client.model.tenant_status_list_model import TenantStatusListModel +from openapi_client.model.thread_pool_definition import ThreadPoolDefinition +from openapi_client.model.thread_pools_definition import ThreadPoolsDefinition +from openapi_client.model.update_tenant_model import UpdateTenantModel +from openapi_client.model.update_tenantv_smart_model import UpdateTenantvSmartModel +from openapi_client.model.uuid import Uuid +from openapi_client.model.uuid_to_domain_id import UuidToDomainId +from openapi_client.model.uuid_to_domain_id_mapping import UuidToDomainIdMapping +from openapi_client.model.v_edge_bootstrap_config import VEdgeBootstrapConfig +from openapi_client.model.v_edge_health import VEdgeHealth +from openapi_client.model.vpnid import VPNID +from openapi_client.model.v_resource_group_name_model import VResourceGroupNameModel +from openapi_client.model.v_smart_status import VSmartStatus +from openapi_client.model.variable import Variable +from openapi_client.model.vertex_definition import VertexDefinition +from openapi_client.model.vpn import Vpn +from openapi_client.model.vpn_all_of import VpnAllOf +from openapi_client.model.wan_spec import WanSpec +from openapi_client.model.wifi import Wifi +from openapi_client.model.wifi_all_of import WifiAllOf diff --git a/openapi_client/rest.py b/openapi_client/rest.py new file mode 100644 index 0000000..fba6e7d --- /dev/null +++ b/openapi_client/rest.py @@ -0,0 +1,353 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import io +import json +import logging +import re +import ssl +from urllib.parse import urlencode +from urllib.parse import urlparse +from urllib.request import proxy_bypass_environment +import urllib3 +import ipaddress + +from openapi_client.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError + + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp): + self.urllib3_response = resp + self.status = resp.status + self.reason = resp.reason + self.data = resp.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.urllib3_response.getheaders() + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.urllib3_response.getheader(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=None): + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + addition_pool_args = {} + if configuration.assert_hostname is not None: + addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + + if configuration.retries is not None: + addition_pool_args['retries'] = configuration.retries + + if configuration.socket_options is not None: + addition_pool_args['socket_options'] = configuration.socket_options + + if maxsize is None: + if configuration.connection_pool_maxsize is not None: + maxsize = configuration.connection_pool_maxsize + else: + maxsize = 4 + + # https pool manager + if configuration.proxy and not should_bypass_proxies( + configuration.host, no_proxy=configuration.no_proxy or ''): + self.pool_manager = urllib3.ProxyManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + proxy_headers=configuration.proxy_headers, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.PoolManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + **addition_pool_args + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 + timeout = urllib3.Timeout(total=_request_timeout) + elif (isinstance(_request_timeout, tuple) and + len(_request_timeout) == 2): + timeout = urllib3.Timeout( + connect=_request_timeout[0], read=_request_timeout[1]) + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests + if (method != 'DELETE') and ('Content-Type' not in headers): + headers['Content-Type'] = 'application/json' + if query_params: + url += '?' + urlencode(query_params) + if ('Content-Type' not in headers) or (re.search('json', + headers['Content-Type'], re.IGNORECASE)): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=False, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=True, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + # Pass a `string` parameter directly in the body to support + # other content types than Json when `body` argument is + # provided in serialized form + elif isinstance(body, str) or isinstance(body, bytes): + request_body = body + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request(method, url, + fields=query_params, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + except urllib3.exceptions.SSLError as e: + msg = "{0}\n{1}".format(type(e).__name__, str(e)) + raise ApiException(status=0, reason=msg) + + if _preload_content: + r = RESTResponse(r) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + if r.status == 401: + raise UnauthorizedException(http_resp=r) + + if r.status == 403: + raise ForbiddenException(http_resp=r) + + if r.status == 404: + raise NotFoundException(http_resp=r) + + if 500 <= r.status <= 599: + raise ServiceException(http_resp=r) + + raise ApiException(http_resp=r) + + return r + + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + return self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + +# end of class RESTClientObject + + +def is_ipv4(target): + """ Test if IPv4 address or not + """ + try: + chk = ipaddress.IPv4Address(target) + return True + except ipaddress.AddressValueError: + return False + + +def in_ipv4net(target, net): + """ Test if target belongs to given IPv4 network + """ + try: + nw = ipaddress.IPv4Network(net) + ip = ipaddress.IPv4Address(target) + if ip in nw: + return True + return False + except ipaddress.AddressValueError: + return False + except ipaddress.NetmaskValueError: + return False + + +def should_bypass_proxies(url, no_proxy=None): + """ Yet another requests.should_bypass_proxies + Test if proxies should not be used for a particular url. + """ + + parsed = urlparse(url) + + # special cases + if parsed.hostname in [None, '']: + return True + + # special cases + if no_proxy in [None, '']: + return False + if no_proxy == '*': + return True + + no_proxy = no_proxy.lower().replace(' ', ''); + entries = ( + host for host in no_proxy.split(',') if host + ) + + if is_ipv4(parsed.hostname): + for item in entries: + if in_ipv4net(parsed.hostname, item): + return True + return proxy_bypass_environment(parsed.hostname, {'no': no_proxy}) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..96947f6 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +python_dateutil >= 2.5.3 +setuptools >= 21.0.0 +urllib3 >= 1.25.3 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..11433ee --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[flake8] +max-line-length=99 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..36d9a2c --- /dev/null +++ b/setup.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +from setuptools import setup, find_packages # noqa: H301 + +NAME = "openapi-client" +VERSION = "1.0.0" +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools + +REQUIRES = [ + "urllib3 >= 1.25.3", + "python-dateutil", +] + +setup( + name=NAME, + version=VERSION, + description="Cisco SD-WAN vManage API", + author="OpenAPI Generator community", + author_email="vmanage@cisco.com", + url="", + keywords=["OpenAPI", "OpenAPI-Generator", "Cisco SD-WAN vManage API"], + python_requires=">=3.6", + install_requires=REQUIRES, + packages=find_packages(exclude=["test", "tests"]), + include_package_data=True, + license="Commercial License", + long_description="""\ + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + """ +) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..bb4f22b --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +pytest-cov>=2.8.1 diff --git a/test/__init__.py b/test/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_administration_audit_log_api.py b/test/test_administration_audit_log_api.py new file mode 100644 index 0000000..0f7e40a --- /dev/null +++ b/test/test_administration_audit_log_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.administration_audit_log_api import AdministrationAuditLogApi # noqa: E501 + + +class TestAdministrationAuditLogApi(unittest.TestCase): + """AdministrationAuditLogApi unit test stubs""" + + def setUp(self): + self.api = AdministrationAuditLogApi() # noqa: E501 + + def tearDown(self): + pass + + def test_generate_audit_log(self): + """Test case for generate_audit_log + + """ + pass + + def test_get_audit_severity_custom_histogram(self): + """Test case for get_audit_severity_custom_histogram + + """ + pass + + def test_get_count(self): + """Test case for get_count + + """ + pass + + def test_get_count_post(self): + """Test case for get_count_post + + """ + pass + + def test_get_post_property_aggregation_data(self): + """Test case for get_post_property_aggregation_data + + """ + pass + + def test_get_post_stat_bulk_raw_property_data(self): + """Test case for get_post_stat_bulk_raw_property_data + + """ + pass + + def test_get_property_aggregation_data(self): + """Test case for get_property_aggregation_data + + """ + pass + + def test_get_raw_property_data(self): + """Test case for get_raw_property_data + + """ + pass + + def test_get_stat_bulk_raw_property_data(self): + """Test case for get_stat_bulk_raw_property_data + + """ + pass + + def test_get_stat_data_fields(self): + """Test case for get_stat_data_fields + + """ + pass + + def test_get_stat_data_raw_audit_log_data(self): + """Test case for get_stat_data_raw_audit_log_data + + """ + pass + + def test_get_stat_query_fields(self): + """Test case for get_stat_query_fields + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_administration_user_and_group_api.py b/test/test_administration_user_and_group_api.py new file mode 100644 index 0000000..4afdfe6 --- /dev/null +++ b/test/test_administration_user_and_group_api.py @@ -0,0 +1,233 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.administration_user_and_group_api import AdministrationUserAndGroupApi # noqa: E501 + + +class TestAdministrationUserAndGroupApi(unittest.TestCase): + """AdministrationUserAndGroupApi unit test stubs""" + + def setUp(self): + self.api = AdministrationUserAndGroupApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_colo_group(self): + """Test case for create_colo_group + + """ + pass + + def test_create_group_grid_columns(self): + """Test case for create_group_grid_columns + + """ + pass + + def test_create_user(self): + """Test case for create_user + + """ + pass + + def test_create_user_group(self): + """Test case for create_user_group + + """ + pass + + def test_create_vpn_group(self): + """Test case for create_vpn_group + + """ + pass + + def test_delete_colo_group(self): + """Test case for delete_colo_group + + """ + pass + + def test_delete_user(self): + """Test case for delete_user + + """ + pass + + def test_delete_user_group(self): + """Test case for delete_user_group + + """ + pass + + def test_delete_vpn_group(self): + """Test case for delete_vpn_group + + """ + pass + + def test_edit_colo_group(self): + """Test case for edit_colo_group + + """ + pass + + def test_edit_vpn_group(self): + """Test case for edit_vpn_group + + """ + pass + + def test_find_user_auth_type(self): + """Test case for find_user_auth_type + + """ + pass + + def test_find_user_groups(self): + """Test case for find_user_groups + + """ + pass + + def test_find_user_groups_as_key_value(self): + """Test case for find_user_groups_as_key_value + + """ + pass + + def test_find_user_role(self): + """Test case for find_user_role + + """ + pass + + def test_find_users(self): + """Test case for find_users + + """ + pass + + def test_get_active_sessions(self): + """Test case for get_active_sessions + + """ + pass + + def test_get_colo_groups(self): + """Test case for get_colo_groups + + """ + pass + + def test_get_vpn_groups(self): + """Test case for get_vpn_groups + + """ + pass + + def test_remove_sessions(self): + """Test case for remove_sessions + + """ + pass + + def test_reset_user(self): + """Test case for reset_user + + """ + pass + + def test_resource_group(self): + """Test case for resource_group + + """ + pass + + def test_resource_group1(self): + """Test case for resource_group1 + + """ + pass + + def test_resource_group2(self): + """Test case for resource_group2 + + """ + pass + + def test_resource_group3(self): + """Test case for resource_group3 + + """ + pass + + def test_resource_group4(self): + """Test case for resource_group4 + + """ + pass + + def test_resource_group_name(self): + """Test case for resource_group_name + + """ + pass + + def test_update_admin_password(self): + """Test case for update_admin_password + + """ + pass + + def test_update_password(self): + """Test case for update_password + + """ + pass + + def test_update_profile_locale(self): + """Test case for update_profile_locale + + """ + pass + + def test_update_profile_password(self): + """Test case for update_profile_password + + """ + pass + + def test_update_user(self): + """Test case for update_user + + """ + pass + + def test_update_user_group(self): + """Test case for update_user_group + + """ + pass + + def test_validate_password(self): + """Test case for validate_password + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_advanced_radio_setting.py b/test/test_advanced_radio_setting.py new file mode 100644 index 0000000..a924c7c --- /dev/null +++ b/test/test_advanced_radio_setting.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.channel_power_settings import ChannelPowerSettings +from openapi_client.model.country_region_settings import CountryRegionSettings +globals()['ChannelPowerSettings'] = ChannelPowerSettings +globals()['CountryRegionSettings'] = CountryRegionSettings +from openapi_client.model.advanced_radio_setting import AdvancedRadioSetting + + +class TestAdvancedRadioSetting(unittest.TestCase): + """AdvancedRadioSetting unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAdvancedRadioSetting(self): + """Test AdvancedRadioSetting""" + # FIXME: construct object with mandatory attributes with example values + # model = AdvancedRadioSetting() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_api_re_key_device.py b/test/test_api_re_key_device.py new file mode 100644 index 0000000..484b715 --- /dev/null +++ b/test/test_api_re_key_device.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.api_re_key_device import ApiReKeyDevice + + +class TestApiReKeyDevice(unittest.TestCase): + """ApiReKeyDevice unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiReKeyDevice(self): + """Test ApiReKeyDevice""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiReKeyDevice() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_api_re_key_device_list.py b/test/test_api_re_key_device_list.py new file mode 100644 index 0000000..f9f4f75 --- /dev/null +++ b/test/test_api_re_key_device_list.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.api_re_key_device import ApiReKeyDevice +globals()['ApiReKeyDevice'] = ApiReKeyDevice +from openapi_client.model.api_re_key_device_list import ApiReKeyDeviceList + + +class TestApiReKeyDeviceList(unittest.TestCase): + """ApiReKeyDeviceList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiReKeyDeviceList(self): + """Test ApiReKeyDeviceList""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiReKeyDeviceList() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_aws_iam_credentials.py b/test/test_aws_iam_credentials.py new file mode 100644 index 0000000..f397a1d --- /dev/null +++ b/test/test_aws_iam_credentials.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.aws_iam_credentials import AwsIamCredentials + + +class TestAwsIamCredentials(unittest.TestCase): + """AwsIamCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAwsIamCredentials(self): + """Test AwsIamCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = AwsIamCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_aws_key_credentials.py b/test/test_aws_key_credentials.py new file mode 100644 index 0000000..e8264f1 --- /dev/null +++ b/test/test_aws_key_credentials.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.aws_key_credentials import AwsKeyCredentials + + +class TestAwsKeyCredentials(unittest.TestCase): + """AwsKeyCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAwsKeyCredentials(self): + """Test AwsKeyCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = AwsKeyCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_azure_credentials.py b/test/test_azure_credentials.py new file mode 100644 index 0000000..886cff1 --- /dev/null +++ b/test/test_azure_credentials.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.azure_credentials import AzureCredentials + + +class TestAzureCredentials(unittest.TestCase): + """AzureCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAzureCredentials(self): + """Test AzureCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = AzureCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_banner.py b/test/test_banner.py new file mode 100644 index 0000000..d5e9795 --- /dev/null +++ b/test/test_banner.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.banner import Banner + + +class TestBanner(unittest.TestCase): + """Banner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBanner(self): + """Test Banner""" + # FIXME: construct object with mandatory attributes with example values + # model = Banner() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_bfd.py b/test/test_bfd.py new file mode 100644 index 0000000..99ff6b1 --- /dev/null +++ b/test/test_bfd.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.bfd_timer_on_transport_tunnels import BfdTimerOnTransportTunnels +globals()['BfdTimerOnTransportTunnels'] = BfdTimerOnTransportTunnels +from openapi_client.model.bfd import Bfd + + +class TestBfd(unittest.TestCase): + """Bfd unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBfd(self): + """Test Bfd""" + # FIXME: construct object with mandatory attributes with example values + # model = Bfd() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_bfd_timer_on_transport_tunnels.py b/test/test_bfd_timer_on_transport_tunnels.py new file mode 100644 index 0000000..6380a11 --- /dev/null +++ b/test/test_bfd_timer_on_transport_tunnels.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.biz_internet_timer import BizInternetTimer +from openapi_client.model.lte_timer import LteTimer +from openapi_client.model.mpls_timer import MplsTimer +from openapi_client.model.public_internet_timer import PublicInternetTimer +globals()['BizInternetTimer'] = BizInternetTimer +globals()['LteTimer'] = LteTimer +globals()['MplsTimer'] = MplsTimer +globals()['PublicInternetTimer'] = PublicInternetTimer +from openapi_client.model.bfd_timer_on_transport_tunnels import BfdTimerOnTransportTunnels + + +class TestBfdTimerOnTransportTunnels(unittest.TestCase): + """BfdTimerOnTransportTunnels unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBfdTimerOnTransportTunnels(self): + """Test BfdTimerOnTransportTunnels""" + # FIXME: construct object with mandatory attributes with example values + # model = BfdTimerOnTransportTunnels() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_biz_internet_timer.py b/test/test_biz_internet_timer.py new file mode 100644 index 0000000..14357ae --- /dev/null +++ b/test/test_biz_internet_timer.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.biz_internet_timer import BizInternetTimer + + +class TestBizInternetTimer(unittest.TestCase): + """BizInternetTimer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBizInternetTimer(self): + """Test BizInternetTimer""" + # FIXME: construct object with mandatory attributes with example values + # model = BizInternetTimer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cellular.py b/test/test_cellular.py new file mode 100644 index 0000000..854b6e9 --- /dev/null +++ b/test/test_cellular.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.cellular_all_of import CellularAllOf +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.sim_slot_config import SimSlotConfig +from openapi_client.model.variable import Variable +globals()['CellularAllOf'] = CellularAllOf +globals()['ProfileParcel'] = ProfileParcel +globals()['SimSlotConfig'] = SimSlotConfig +globals()['Variable'] = Variable +from openapi_client.model.cellular import Cellular + + +class TestCellular(unittest.TestCase): + """Cellular unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCellular(self): + """Test Cellular""" + # FIXME: construct object with mandatory attributes with example values + # model = Cellular() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cellular_all_of.py b/test/test_cellular_all_of.py new file mode 100644 index 0000000..e984f02 --- /dev/null +++ b/test/test_cellular_all_of.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.sim_slot_config import SimSlotConfig +globals()['SimSlotConfig'] = SimSlotConfig +from openapi_client.model.cellular_all_of import CellularAllOf + + +class TestCellularAllOf(unittest.TestCase): + """CellularAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCellularAllOf(self): + """Test CellularAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = CellularAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cellular_profile.py b/test/test_cellular_profile.py new file mode 100644 index 0000000..85b8425 --- /dev/null +++ b/test/test_cellular_profile.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.cellular_profile import CellularProfile + + +class TestCellularProfile(unittest.TestCase): + """CellularProfile unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCellularProfile(self): + """Test CellularProfile""" + # FIXME: construct object with mandatory attributes with example values + # model = CellularProfile() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_certificate_management_device_api.py b/test/test_certificate_management_device_api.py new file mode 100644 index 0000000..c21f153 --- /dev/null +++ b/test/test_certificate_management_device_api.py @@ -0,0 +1,215 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.certificate_management_device_api import CertificateManagementDeviceApi # noqa: E501 + + +class TestCertificateManagementDeviceApi(unittest.TestCase): + """CertificateManagementDeviceApi unit test stubs""" + + def setUp(self): + self.api = CertificateManagementDeviceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_decommission_enterprise_csr_for_vedge(self): + """Test case for decommission_enterprise_csr_for_vedge + + """ + pass + + def test_delete_configuration(self): + """Test case for delete_configuration + + """ + pass + + def test_force_sync_root_cert(self): + """Test case for force_sync_root_cert + + """ + pass + + def test_generate_csr(self): + """Test case for generate_csr + + """ + pass + + def test_generate_edge_device_csr(self): + """Test case for generate_edge_device_csr + + """ + pass + + def test_generate_enterprise_csr(self): + """Test case for generate_enterprise_csr + + """ + pass + + def test_get_cert_details(self): + """Test case for get_cert_details + + """ + pass + + def test_get_certificate_data(self): + """Test case for get_certificate_data + + """ + pass + + def test_get_certificate_detail(self): + """Test case for get_certificate_detail + + """ + pass + + def test_get_certificate_stats(self): + """Test case for get_certificate_stats + + """ + pass + + def test_get_csr_view_right_menus(self): + """Test case for get_csr_view_right_menus + + """ + pass + + def test_get_device_view_right_menus(self): + """Test case for get_device_view_right_menus + + """ + pass + + def test_get_devices_list(self): + """Test case for get_devices_list + + """ + pass + + def test_get_installed_cert(self): + """Test case for get_installed_cert + + """ + pass + + def test_get_list_status(self): + """Test case for get_list_status + + """ + pass + + def test_get_root_cert_chains(self): + """Test case for get_root_cert_chains + + """ + pass + + def test_get_root_certificate(self): + """Test case for get_root_certificate + + """ + pass + + def test_get_view(self): + """Test case for get_view + + """ + pass + + def test_getc_edge_list(self): + """Test case for getc_edge_list + + """ + pass + + def test_getv_edge_csr(self): + """Test case for getv_edge_csr + + """ + pass + + def test_getv_edge_list(self): + """Test case for getv_edge_list + + """ + pass + + def test_getv_smart_list(self): + """Test case for getv_smart_list + + """ + pass + + def test_install_certificate(self): + """Test case for install_certificate + + """ + pass + + def test_reset_rsa(self): + """Test case for reset_rsa + + """ + pass + + def test_save_root_cert_chain(self): + """Test case for save_root_cert_chain + + """ + pass + + def test_save_v_edge_list(self): + """Test case for save_v_edge_list + + """ + pass + + def test_setv_edge_list(self): + """Test case for setv_edge_list + + """ + pass + + def test_setv_smart_list(self): + """Test case for setv_smart_list + + """ + pass + + def test_setv_smart_list1(self): + """Test case for setv_smart_list1 + + """ + pass + + def test_syncv_bond(self): + """Test case for syncv_bond + + """ + pass + + def test_update_jks(self): + """Test case for update_jks + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_certificate_management_v_manage_api.py b/test/test_certificate_management_v_manage_api.py new file mode 100644 index 0000000..bcb158d --- /dev/null +++ b/test/test_certificate_management_v_manage_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.certificate_management_v_manage_api import CertificateManagementVManageApi # noqa: E501 + + +class TestCertificateManagementVManageApi(unittest.TestCase): + """CertificateManagementVManageApi unit test stubs""" + + def setUp(self): + self.api = CertificateManagementVManageApi() # noqa: E501 + + def tearDown(self): + pass + + def test_dump_certificate(self): + """Test case for dump_certificate + + """ + pass + + def test_get_certificate(self): + """Test case for get_certificate + + """ + pass + + def test_get_csr(self): + """Test case for get_csr + + """ + pass + + def test_import_certificate(self): + """Test case for import_certificate + + """ + pass + + def test_rollback(self): + """Test case for rollback + + """ + pass + + def test_show_info(self): + """Test case for show_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_certificate_states.py b/test/test_certificate_states.py new file mode 100644 index 0000000..678ac9e --- /dev/null +++ b/test/test_certificate_states.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.certificate_states import CertificateStates + + +class TestCertificateStates(unittest.TestCase): + """CertificateStates unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCertificateStates(self): + """Test CertificateStates""" + # FIXME: construct object with mandatory attributes with example values + # model = CertificateStates() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_certificate_validity.py b/test/test_certificate_validity.py new file mode 100644 index 0000000..6a3b224 --- /dev/null +++ b/test/test_certificate_validity.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.certificate_validity import CertificateValidity + + +class TestCertificateValidity(unittest.TestCase): + """CertificateValidity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCertificateValidity(self): + """Test CertificateValidity""" + # FIXME: construct object with mandatory attributes with example values + # model = CertificateValidity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_channel_power_settings.py b/test/test_channel_power_settings.py new file mode 100644 index 0000000..d8ed6ad --- /dev/null +++ b/test/test_channel_power_settings.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.radio_band_setting24_g import RadioBandSetting24G +from openapi_client.model.radio_band_setting5_g import RadioBandSetting5G +globals()['RadioBandSetting24G'] = RadioBandSetting24G +globals()['RadioBandSetting5G'] = RadioBandSetting5G +from openapi_client.model.channel_power_settings import ChannelPowerSettings + + +class TestChannelPowerSettings(unittest.TestCase): + """ChannelPowerSettings unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testChannelPowerSettings(self): + """Test ChannelPowerSettings""" + # FIXME: construct object with mandatory attributes with example values + # model = ChannelPowerSettings() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cluster_management_api.py b/test/test_cluster_management_api.py new file mode 100644 index 0000000..1ad8ab7 --- /dev/null +++ b/test/test_cluster_management_api.py @@ -0,0 +1,155 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.cluster_management_api import ClusterManagementApi # noqa: E501 + + +class TestClusterManagementApi(unittest.TestCase): + """ClusterManagementApi unit test stubs""" + + def setUp(self): + self.api = ClusterManagementApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_or_update_user_credentials(self): + """Test case for add_or_update_user_credentials + + """ + pass + + def test_add_vmanage(self): + """Test case for add_vmanage + + """ + pass + + def test_check_if_cluster_locked(self): + """Test case for check_if_cluster_locked + + """ + pass + + def test_configure_vmanage(self): + """Test case for configure_vmanage + + """ + pass + + def test_edit_vmanage(self): + """Test case for edit_vmanage + + """ + pass + + def test_get_cluster_workflow_version(self): + """Test case for get_cluster_workflow_version + + """ + pass + + def test_get_configured_ip_list(self): + """Test case for get_configured_ip_list + + """ + pass + + def test_get_connected_devices(self): + """Test case for get_connected_devices + + """ + pass + + def test_get_connected_devices_per_tenant(self): + """Test case for get_connected_devices_per_tenant + + """ + pass + + def test_get_tenancy_mode(self): + """Test case for get_tenancy_mode + + """ + pass + + def test_get_tenants_list(self): + """Test case for get_tenants_list + + """ + pass + + def test_get_v_manage_details(self): + """Test case for get_v_manage_details + + """ + pass + + def test_health_details(self): + """Test case for health_details + + """ + pass + + def test_health_status_info(self): + """Test case for health_status_info + + """ + pass + + def test_health_summary(self): + """Test case for health_summary + + """ + pass + + def test_is_cluster_ready(self): + """Test case for is_cluster_ready + + """ + pass + + def test_list_vmanages(self): + """Test case for list_vmanages + + """ + pass + + def test_node_properties(self): + """Test case for node_properties + + """ + pass + + def test_perform_replication_and_rebalance_of_kafka_partitions(self): + """Test case for perform_replication_and_rebalance_of_kafka_partitions + + """ + pass + + def test_remove_vmanage(self): + """Test case for remove_vmanage + + """ + pass + + def test_set_tenancy_mode(self): + """Test case for set_tenancy_mode + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_colocation_api.py b/test/test_colocation_api.py new file mode 100644 index 0000000..71aca25 --- /dev/null +++ b/test/test_colocation_api.py @@ -0,0 +1,239 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.colocation_api import ColocationApi # noqa: E501 + + +class TestColocationApi(unittest.TestCase): + """ColocationApi unit test stubs""" + + def setUp(self): + self.api = ColocationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_acitvate_cloud_dock_cluster(self): + """Test case for acitvate_cloud_dock_cluster + + """ + pass + + def test_attach_service_chain(self): + """Test case for attach_service_chain + + """ + pass + + def test_attach_service_chain1(self): + """Test case for attach_service_chain1 + + """ + pass + + def test_cancel_button(self): + """Test case for cancel_button + + """ + pass + + def test_cloud_dock_cluster_preview(self): + """Test case for cloud_dock_cluster_preview + + """ + pass + + def test_create_cloud_dock_cluster(self): + """Test case for create_cloud_dock_cluster + + """ + pass + + def test_de_acitvate_cloud_dock_cluster(self): + """Test case for de_acitvate_cloud_dock_cluster + + """ + pass + + def test_delete_cloud_dock_cluster_by_name(self): + """Test case for delete_cloud_dock_cluster_by_name + + """ + pass + + def test_detach_service_chain(self): + """Test case for detach_service_chain + + """ + pass + + def test_dummyccm(self): + """Test case for dummyccm + + """ + pass + + def test_dummycsp_state(self): + """Test case for dummycsp_state + + """ + pass + + def test_get_cloud_dock_cluster_detail(self): + """Test case for get_cloud_dock_cluster_detail + + """ + pass + + def test_get_cloud_dock_cluster_detail_by_id(self): + """Test case for get_cloud_dock_cluster_detail_by_id + + """ + pass + + def test_get_cluster_config_by_cluster_id(self): + """Test case for get_cluster_config_by_cluster_id + + """ + pass + + def test_get_cluster_details_by_cluster_id(self): + """Test case for get_cluster_details_by_cluster_id + + """ + pass + + def test_get_cluster_port_mapping_by_cluster_id(self): + """Test case for get_cluster_port_mapping_by_cluster_id + + """ + pass + + def test_get_device_detail_by_device_id(self): + """Test case for get_device_detail_by_device_id + + """ + pass + + def test_get_edge_devices(self): + """Test case for get_edge_devices + + """ + pass + + def test_get_pnf_config(self): + """Test case for get_pnf_config + + """ + pass + + def test_get_service_chain_details(self): + """Test case for get_service_chain_details + + """ + pass + + def test_get_service_group_by_cluster_id(self): + """Test case for get_service_group_by_cluster_id + + """ + pass + + def test_get_system_status_by_device_id(self): + """Test case for get_system_status_by_device_id + + """ + pass + + def test_get_vnf_alarm_count(self): + """Test case for get_vnf_alarm_count + + """ + pass + + def test_get_vnf_events_count_detail(self): + """Test case for get_vnf_events_count_detail + + """ + pass + + def test_get_vnf_events_detail(self): + """Test case for get_vnf_events_detail + + """ + pass + + def test_get_vnf_interface_detail(self): + """Test case for get_vnf_interface_detail + + """ + pass + + def test_getpnf_details(self): + """Test case for getpnf_details + + """ + pass + + def test_getpnf_devices(self): + """Test case for getpnf_devices + + """ + pass + + def test_getvnf_by_device_id(self): + """Test case for getvnf_by_device_id + + """ + pass + + def test_getvnf_details(self): + """Test case for getvnf_details + + """ + pass + + def test_list_network_function_map(self): + """Test case for list_network_function_map + + """ + pass + + def test_rma_cloud_dock_csp(self): + """Test case for rma_cloud_dock_csp + + """ + pass + + def test_update_cloud_dock_cluster(self): + """Test case for update_cloud_dock_cluster + + """ + pass + + def test_update_csp_to_cluster(self): + """Test case for update_csp_to_cluster + + """ + pass + + def test_vnf_actions(self): + """Test case for vnf_actions + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_colocation_service_group_api.py b/test/test_colocation_service_group_api.py new file mode 100644 index 0000000..4f17cdc --- /dev/null +++ b/test/test_colocation_service_group_api.py @@ -0,0 +1,71 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.colocation_service_group_api import ColocationServiceGroupApi # noqa: E501 + + +class TestColocationServiceGroupApi(unittest.TestCase): + """ColocationServiceGroupApi unit test stubs""" + + def setUp(self): + self.api = ColocationServiceGroupApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_service_group_cluster(self): + """Test case for create_service_group_cluster + + """ + pass + + def test_delete_service_group_cluster(self): + """Test case for delete_service_group_cluster + + """ + pass + + def test_get_available_chains(self): + """Test case for get_available_chains + + """ + pass + + def test_get_default_chain(self): + """Test case for get_default_chain + + """ + pass + + def test_get_service_chain(self): + """Test case for get_service_chain + + """ + pass + + def test_get_service_group_in_cluster(self): + """Test case for get_service_group_in_cluster + + """ + pass + + def test_update_service_group_cluster(self): + """Test case for update_service_group_cluster + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_config_group.py b/test/test_config_group.py new file mode 100644 index 0000000..293b310 --- /dev/null +++ b/test/test_config_group.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.feature_profile import FeatureProfile +globals()['FeatureProfile'] = FeatureProfile +from openapi_client.model.config_group import ConfigGroup + + +class TestConfigGroup(unittest.TestCase): + """ConfigGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConfigGroup(self): + """Test ConfigGroup""" + # FIXME: construct object with mandatory attributes with example values + # model = ConfigGroup() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_advanced_inspection_profile_definition_api.py b/test/test_configuration_advanced_inspection_profile_definition_api.py new file mode 100644 index 0000000..9dc0b4f --- /dev/null +++ b/test/test_configuration_advanced_inspection_profile_definition_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_advanced_inspection_profile_definition_api import ConfigurationAdvancedInspectionProfileDefinitionApi # noqa: E501 + + +class TestConfigurationAdvancedInspectionProfileDefinitionApi(unittest.TestCase): + """ConfigurationAdvancedInspectionProfileDefinitionApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationAdvancedInspectionProfileDefinitionApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition10(self): + """Test case for create_policy_definition10 + + """ + pass + + def test_delete_policy_definition10(self): + """Test case for delete_policy_definition10 + + """ + pass + + def test_edit_multiple_policy_definition10(self): + """Test case for edit_multiple_policy_definition10 + + """ + pass + + def test_edit_policy_definition10(self): + """Test case for edit_policy_definition10 + + """ + pass + + def test_get_definitions10(self): + """Test case for get_definitions10 + + """ + pass + + def test_get_policy_definition10(self): + """Test case for get_policy_definition10 + + """ + pass + + def test_preview_policy_definition10(self): + """Test case for preview_policy_definition10 + + """ + pass + + def test_preview_policy_definition_by_id10(self): + """Test case for preview_policy_definition_by_id10 + + """ + pass + + def test_save_policy_definition_in_bulk10(self): + """Test case for save_policy_definition_in_bulk10 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_azure_connect_api.py b/test/test_configuration_azure_connect_api.py new file mode 100644 index 0000000..61bdaf4 --- /dev/null +++ b/test/test_configuration_azure_connect_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_azure_connect_api import ConfigurationAzureConnectApi # noqa: E501 + + +class TestConfigurationAzureConnectApi(unittest.TestCase): + """ConfigurationAzureConnectApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationAzureConnectApi() # noqa: E501 + + def tearDown(self): + pass + + def test_authenticate_azure_connect_cred_and_add(self): + """Test case for authenticate_azure_connect_cred_and_add + + """ + pass + + def test_delete_wan_resource_groups(self): + """Test case for delete_wan_resource_groups + + """ + pass + + def test_edit_wan_resource_groups(self): + """Test case for edit_wan_resource_groups + + """ + pass + + def test_get_cortex_status(self): + """Test case for get_cortex_status + + """ + pass + + def test_get_mapped_wan_resource_groups(self): + """Test case for get_mapped_wan_resource_groups + + """ + pass + + def test_get_wan_resource_groups(self): + """Test case for get_wan_resource_groups + + """ + pass + + def test_save_wan_resource_groups(self): + """Test case for save_wan_resource_groups + + """ + pass + + def test_sync_wan_resource_groups(self): + """Test case for sync_wan_resource_groups + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_circuits_api.py b/test/test_configuration_circuits_api.py new file mode 100644 index 0000000..97321fe --- /dev/null +++ b/test/test_configuration_circuits_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_circuits_api import ConfigurationCircuitsApi # noqa: E501 + + +class TestConfigurationCircuitsApi(unittest.TestCase): + """ConfigurationCircuitsApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationCircuitsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_circuit(self): + """Test case for create_circuit + + """ + pass + + def test_delete_circuit(self): + """Test case for delete_circuit + + """ + pass + + def test_edit_circuit(self): + """Test case for edit_circuit + + """ + pass + + def test_get_circuits(self): + """Test case for get_circuits + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_cloud_express_api.py b/test/test_configuration_cloud_express_api.py new file mode 100644 index 0000000..2fb524d --- /dev/null +++ b/test/test_configuration_cloud_express_api.py @@ -0,0 +1,131 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_cloud_express_api import ConfigurationCloudExpressApi # noqa: E501 + + +class TestConfigurationCloudExpressApi(unittest.TestCase): + """ConfigurationCloudExpressApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationCloudExpressApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_apps(self): + """Test case for add_apps + + """ + pass + + def test_add_cloudx_interfaces(self): + """Test case for add_cloudx_interfaces + + """ + pass + + def test_add_cloudx_type(self): + """Test case for add_cloudx_type + + """ + pass + + def test_delete_webex_prefix_lists(self): + """Test case for delete_webex_prefix_lists + + """ + pass + + def test_edit_apps(self): + """Test case for edit_apps + + """ + pass + + def test_enable_webex(self): + """Test case for enable_webex + + """ + pass + + def test_enable_webex1(self): + """Test case for enable_webex1 + + """ + pass + + def test_get_apps(self): + """Test case for get_apps + + """ + pass + + def test_get_attached_client_list(self): + """Test case for get_attached_client_list + + """ + pass + + def test_get_attached_dia_list(self): + """Test case for get_attached_dia_list + + """ + pass + + def test_get_attached_gateway_list(self): + """Test case for get_attached_gateway_list + + """ + pass + + def test_get_cloud_x_available_apps(self): + """Test case for get_cloud_x_available_apps + + """ + pass + + def test_get_cloud_x_status(self): + """Test case for get_cloud_x_status + + """ + pass + + def test_get_dia_list(self): + """Test case for get_dia_list + + """ + pass + + def test_get_gateway_list(self): + """Test case for get_gateway_list + + """ + pass + + def test_get_site_list(self): + """Test case for get_site_list + + """ + pass + + def test_site_per_app(self): + """Test case for site_per_app + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_cloud_on_ramp_api.py b/test/test_configuration_cloud_on_ramp_api.py new file mode 100644 index 0000000..5bd1614 --- /dev/null +++ b/test/test_configuration_cloud_on_ramp_api.py @@ -0,0 +1,215 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_cloud_on_ramp_api import ConfigurationCloudOnRampApi # noqa: E501 + + +class TestConfigurationCloudOnRampApi(unittest.TestCase): + """ConfigurationCloudOnRampApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationCloudOnRampApi() # noqa: E501 + + def tearDown(self): + pass + + def test_acquire_resource_pool(self): + """Test case for acquire_resource_pool + + """ + pass + + def test_add_device_pair(self): + """Test case for add_device_pair + + """ + pass + + def test_add_transit_vpc(self): + """Test case for add_transit_vpc + + """ + pass + + def test_authenticate_cloud_on_ramp_cred_and_add(self): + """Test case for authenticate_cloud_on_ramp_cred_and_add + + """ + pass + + def test_authenticate_cred_and_update(self): + """Test case for authenticate_cred_and_update + + """ + pass + + def test_create_and_map(self): + """Test case for create_and_map + + """ + pass + + def test_create_resource_pool(self): + """Test case for create_resource_pool + + """ + pass + + def test_get_ami_list(self): + """Test case for get_ami_list + + """ + pass + + def test_get_cloud_accounts(self): + """Test case for get_cloud_accounts + + """ + pass + + def test_get_cloud_host_vpc_account_details(self): + """Test case for get_cloud_host_vpc_account_details + + """ + pass + + def test_get_cloud_host_vpcs(self): + """Test case for get_cloud_host_vpcs + + """ + pass + + def test_get_cloud_list(self): + """Test case for get_cloud_list + + """ + pass + + def test_get_cloud_mapped_host_accounts(self): + """Test case for get_cloud_mapped_host_accounts + + """ + pass + + def test_get_cloud_on_ramp_devices(self): + """Test case for get_cloud_on_ramp_devices + + """ + pass + + def test_get_cor_status(self): + """Test case for get_cor_status + + """ + pass + + def test_get_external_id(self): + """Test case for get_external_id + + """ + pass + + def test_get_host_vpcs(self): + """Test case for get_host_vpcs + + """ + pass + + def test_get_mapped_vpcs(self): + """Test case for get_mapped_vpcs + + """ + pass + + def test_get_pem_key_list(self): + """Test case for get_pem_key_list + + """ + pass + + def test_get_transit_device_pair_and_host_list(self): + """Test case for get_transit_device_pair_and_host_list + + """ + pass + + def test_get_transit_vpc_supported_size(self): + """Test case for get_transit_vpc_supported_size + + """ + pass + + def test_get_transit_vpc_vpn_list(self): + """Test case for get_transit_vpc_vpn_list + + """ + pass + + def test_get_transit_vpcs(self): + """Test case for get_transit_vpcs + + """ + pass + + def test_map_vpcs(self): + """Test case for map_vpcs + + """ + pass + + def test_remove_device_id(self): + """Test case for remove_device_id + + """ + pass + + def test_remove_transit_vpc(self): + """Test case for remove_transit_vpc + + """ + pass + + def test_scale_down(self): + """Test case for scale_down + + """ + pass + + def test_scale_up(self): + """Test case for scale_up + + """ + pass + + def test_unmap_vpcs(self): + """Test case for unmap_vpcs + + """ + pass + + def test_update_transit_vpc(self): + """Test case for update_transit_vpc + + """ + pass + + def test_update_transit_vpc_autoscale_properties(self): + """Test case for update_transit_vpc_autoscale_properties + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_configuration_group_api.py b/test/test_configuration_configuration_group_api.py new file mode 100644 index 0000000..bd89658 --- /dev/null +++ b/test/test_configuration_configuration_group_api.py @@ -0,0 +1,119 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_configuration_group_api import ConfigurationConfigurationGroupApi # noqa: E501 + + +class TestConfigurationConfigurationGroupApi(unittest.TestCase): + """ConfigurationConfigurationGroupApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationConfigurationGroupApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_config_group(self): + """Test case for create_config_group + + """ + pass + + def test_create_config_group_association(self): + """Test case for create_config_group_association + + """ + pass + + def test_create_config_group_device_variables(self): + """Test case for create_config_group_device_variables + + """ + pass + + def test_create_config_group_device_variables1(self): + """Test case for create_config_group_device_variables1 + + """ + pass + + def test_delete_config_group(self): + """Test case for delete_config_group + + """ + pass + + def test_delete_config_group_association(self): + """Test case for delete_config_group_association + + """ + pass + + def test_deploy_config_group(self): + """Test case for deploy_config_group + + """ + pass + + def test_edit_config_group(self): + """Test case for edit_config_group + + """ + pass + + def test_get_cedge_config_group_schema_by_schema_type(self): + """Test case for get_cedge_config_group_schema_by_schema_type + + """ + pass + + def test_get_config_group(self): + """Test case for get_config_group + + """ + pass + + def test_get_config_group_association(self): + """Test case for get_config_group_association + + """ + pass + + def test_get_config_group_by_solution(self): + """Test case for get_config_group_by_solution + + """ + pass + + def test_get_config_group_device_configuration_preview(self): + """Test case for get_config_group_device_configuration_preview + + """ + pass + + def test_get_config_group_device_variables(self): + """Test case for get_config_group_device_variables + + """ + pass + + def test_update_config_group_association(self): + """Test case for update_config_group_association + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_dashboard_status_api.py b/test/test_configuration_dashboard_status_api.py new file mode 100644 index 0000000..0134382 --- /dev/null +++ b/test/test_configuration_dashboard_status_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_dashboard_status_api import ConfigurationDashboardStatusApi # noqa: E501 + + +class TestConfigurationDashboardStatusApi(unittest.TestCase): + """ConfigurationDashboardStatusApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDashboardStatusApi() # noqa: E501 + + def tearDown(self): + pass + + def test_cancel_pending_tasks(self): + """Test case for cancel_pending_tasks + + """ + pass + + def test_clean_status(self): + """Test case for clean_status + + """ + pass + + def test_delete_status(self): + """Test case for delete_status + + """ + pass + + def test_find_running_tasks(self): + """Test case for find_running_tasks + + """ + pass + + def test_find_status(self): + """Test case for find_status + + """ + pass + + def test_get_active_task_count(self): + """Test case for get_active_task_count + + """ + pass + + def test_get_clean_status(self): + """Test case for get_clean_status + + """ + pass + + def test_update_device_action_status(self): + """Test case for update_device_action_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_actions_api.py b/test/test_configuration_device_actions_api.py new file mode 100644 index 0000000..4cf54fd --- /dev/null +++ b/test/test_configuration_device_actions_api.py @@ -0,0 +1,269 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_actions_api import ConfigurationDeviceActionsApi # noqa: E501 + + +class TestConfigurationDeviceActionsApi(unittest.TestCase): + """ConfigurationDeviceActionsApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceActionsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_filter_vpn_list(self): + """Test case for create_filter_vpn_list + + """ + pass + + def test_create_unique_vpn_list(self): + """Test case for create_unique_vpn_list + + """ + pass + + def test_create_vpn_list(self): + """Test case for create_vpn_list + + """ + pass + + def test_generate_change_partition_info(self): + """Test case for generate_change_partition_info + + """ + pass + + def test_generate_deactivate_info(self): + """Test case for generate_deactivate_info + + """ + pass + + def test_generate_device_action_list(self): + """Test case for generate_device_action_list + + """ + pass + + def test_generate_device_list(self): + """Test case for generate_device_list + + """ + pass + + def test_generate_install_info(self): + """Test case for generate_install_info + + """ + pass + + def test_generate_reboot_device_list(self): + """Test case for generate_reboot_device_list + + """ + pass + + def test_generate_reboot_info(self): + """Test case for generate_reboot_info + + """ + pass + + def test_generate_rediscover_info(self): + """Test case for generate_rediscover_info + + """ + pass + + def test_generate_remove_partition_info(self): + """Test case for generate_remove_partition_info + + """ + pass + + def test_generate_security_devices_list(self): + """Test case for generate_security_devices_list + + """ + pass + + def test_get_ztp_upgrade_config(self): + """Test case for get_ztp_upgrade_config + + """ + pass + + def test_get_ztp_upgrade_config_setting(self): + """Test case for get_ztp_upgrade_config_setting + + """ + pass + + def test_initiate_image_download(self): + """Test case for initiate_image_download + + """ + pass + + def test_process_amp_api_re_key(self): + """Test case for process_amp_api_re_key + + """ + pass + + def test_process_cancel_task(self): + """Test case for process_cancel_task + + """ + pass + + def test_process_change_partition(self): + """Test case for process_change_partition + + """ + pass + + def test_process_deactivate_smu(self): + """Test case for process_deactivate_smu + + """ + pass + + def test_process_default_partition(self): + """Test case for process_default_partition + + """ + pass + + def test_process_delete_amp_api_key(self): + """Test case for process_delete_amp_api_key + + """ + pass + + def test_process_install(self): + """Test case for process_install + + """ + pass + + def test_process_lxc_activate(self): + """Test case for process_lxc_activate + + """ + pass + + def test_process_lxc_delete(self): + """Test case for process_lxc_delete + + """ + pass + + def test_process_lxc_install(self): + """Test case for process_lxc_install + + """ + pass + + def test_process_lxc_reload(self): + """Test case for process_lxc_reload + + """ + pass + + def test_process_lxc_reset(self): + """Test case for process_lxc_reset + + """ + pass + + def test_process_lxc_upgrade(self): + """Test case for process_lxc_upgrade + + """ + pass + + def test_process_reboot(self): + """Test case for process_reboot + + """ + pass + + def test_process_remove_partition(self): + """Test case for process_remove_partition + + """ + pass + + def test_process_remove_software_image(self): + """Test case for process_remove_software_image + + """ + pass + + def test_process_vnf_install(self): + """Test case for process_vnf_install + + """ + pass + + def test_process_ztp_upgrade_config(self): + """Test case for process_ztp_upgrade_config + + """ + pass + + def test_process_ztp_upgrade_config_setting(self): + """Test case for process_ztp_upgrade_config_setting + + """ + pass + + def test_re_discover_all_device(self): + """Test case for re_discover_all_device + + """ + pass + + def test_re_discover_devices(self): + """Test case for re_discover_devices + + """ + pass + + def test_test_api_key(self): + """Test case for test_api_key + + """ + pass + + def test_test_iox_config(self): + """Test case for test_iox_config + + """ + pass + + def test_trigger_pending_tasks_monitoring(self): + """Test case for trigger_pending_tasks_monitoring + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_config_history_api.py b/test/test_configuration_device_config_history_api.py new file mode 100644 index 0000000..f21b4b4 --- /dev/null +++ b/test/test_configuration_device_config_history_api.py @@ -0,0 +1,119 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_config_history_api import ConfigurationDeviceConfigHistoryApi # noqa: E501 + + +class TestConfigurationDeviceConfigHistoryApi(unittest.TestCase): + """ConfigurationDeviceConfigHistoryApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceConfigHistoryApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query20(self): + """Test case for get_aggregation_data_by_query20 + + """ + pass + + def test_get_config_diff(self): + """Test case for get_config_diff + + """ + pass + + def test_get_count22(self): + """Test case for get_count22 + + """ + pass + + def test_get_count_post22(self): + """Test case for get_count_post22 + + """ + pass + + def test_get_device_config(self): + """Test case for get_device_config + + """ + pass + + def test_get_last_thousand_config_list(self): + """Test case for get_last_thousand_config_list + + """ + pass + + def test_get_post_aggregation_app_data_by_query19(self): + """Test case for get_post_aggregation_app_data_by_query19 + + """ + pass + + def test_get_post_aggregation_data_by_query19(self): + """Test case for get_post_aggregation_data_by_query19 + + """ + pass + + def test_get_post_stat_bulk_raw_data20(self): + """Test case for get_post_stat_bulk_raw_data20 + + """ + pass + + def test_get_stat_bulk_raw_data20(self): + """Test case for get_stat_bulk_raw_data20 + + """ + pass + + def test_get_stat_data_fields22(self): + """Test case for get_stat_data_fields22 + + """ + pass + + def test_get_stat_data_raw_data19(self): + """Test case for get_stat_data_raw_data19 + + """ + pass + + def test_get_stat_data_raw_data_as_csv20(self): + """Test case for get_stat_data_raw_data_as_csv20 + + """ + pass + + def test_get_stat_query_fields22(self): + """Test case for get_stat_query_fields22 + + """ + pass + + def test_get_stats_raw_data20(self): + """Test case for get_stats_raw_data20 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_connectivity_api.py b/test/test_configuration_device_connectivity_api.py new file mode 100644 index 0000000..2ef52bc --- /dev/null +++ b/test/test_configuration_device_connectivity_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_connectivity_api import ConfigurationDeviceConnectivityApi # noqa: E501 + + +class TestConfigurationDeviceConnectivityApi(unittest.TestCase): + """ConfigurationDeviceConnectivityApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceConnectivityApi() # noqa: E501 + + def tearDown(self): + pass + + def test_invalidate_device(self): + """Test case for invalidate_device + + """ + pass + + def test_stage_device(self): + """Test case for stage_device + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_firmware_update_api.py b/test/test_configuration_device_firmware_update_api.py new file mode 100644 index 0000000..573dade --- /dev/null +++ b/test/test_configuration_device_firmware_update_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_firmware_update_api import ConfigurationDeviceFirmwareUpdateApi # noqa: E501 + + +class TestConfigurationDeviceFirmwareUpdateApi(unittest.TestCase): + """ConfigurationDeviceFirmwareUpdateApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceFirmwareUpdateApi() # noqa: E501 + + def tearDown(self): + pass + + def test_activate_firmware_image(self): + """Test case for activate_firmware_image + + """ + pass + + def test_delete_firmware_image(self): + """Test case for delete_firmware_image + + """ + pass + + def test_get_devices_fw_upgrade(self): + """Test case for get_devices_fw_upgrade + + """ + pass + + def test_get_firmware_image_details(self): + """Test case for get_firmware_image_details + + """ + pass + + def test_get_firmware_images(self): + """Test case for get_firmware_images + + """ + pass + + def test_install_firmware_image(self): + """Test case for install_firmware_image + + """ + pass + + def test_process_firmware_image(self): + """Test case for process_firmware_image + + """ + pass + + def test_remove_firmware_image(self): + """Test case for remove_firmware_image + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_inventory_api.py b/test/test_configuration_device_inventory_api.py new file mode 100644 index 0000000..38dc77b --- /dev/null +++ b/test/test_configuration_device_inventory_api.py @@ -0,0 +1,209 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_inventory_api import ConfigurationDeviceInventoryApi # noqa: E501 + + +class TestConfigurationDeviceInventoryApi(unittest.TestCase): + """ConfigurationDeviceInventoryApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceInventoryApi() # noqa: E501 + + def tearDown(self): + pass + + def test_check_self_signed_cert(self): + """Test case for check_self_signed_cert + + """ + pass + + def test_claim_devices(self): + """Test case for claim_devices + + """ + pass + + def test_create_device(self): + """Test case for create_device + + """ + pass + + def test_decommission_vedge_cloud(self): + """Test case for decommission_vedge_cloud + + """ + pass + + def test_delete_device(self): + """Test case for delete_device + + """ + pass + + def test_devices_without_subject_sudi(self): + """Test case for devices_without_subject_sudi + + """ + pass + + def test_edit_device(self): + """Test case for edit_device + + """ + pass + + def test_form_post(self): + """Test case for form_post + + """ + pass + + def test_generate_bootstrap_config_for_vedge(self): + """Test case for generate_bootstrap_config_for_vedge + + """ + pass + + def test_generate_bootstrap_config_for_vedges(self): + """Test case for generate_bootstrap_config_for_vedges + + """ + pass + + def test_generate_generic_bootstrap_config_for_vedges(self): + """Test case for generate_generic_bootstrap_config_for_vedges + + """ + pass + + def test_get_all_unclaimed_devices(self): + """Test case for get_all_unclaimed_devices + + """ + pass + + def test_get_bootstrap_config_zip(self): + """Test case for get_bootstrap_config_zip + + """ + pass + + def test_get_cloud_dock_data_based_on_device_type(self): + """Test case for get_cloud_dock_data_based_on_device_type + + """ + pass + + def test_get_cloud_dock_default_config_based_on_device_type(self): + """Test case for get_cloud_dock_default_config_based_on_device_type + + """ + pass + + def test_get_controller_v_edge_sync_status(self): + """Test case for get_controller_v_edge_sync_status + + """ + pass + + def test_get_devices_details(self): + """Test case for get_devices_details + + """ + pass + + def test_get_management_system_ip_info(self): + """Test case for get_management_system_ip_info + + """ + pass + + def test_get_rma_candidates(self): + """Test case for get_rma_candidates + + """ + pass + + def test_get_root_cert_status_all(self): + """Test case for get_root_cert_status_all + + """ + pass + + def test_get_tenant_management_system_ips(self): + """Test case for get_tenant_management_system_ips + + """ + pass + + def test_invalidate_vmanage_root_ca(self): + """Test case for invalidate_vmanage_root_ca + + """ + pass + + def test_migrate_device(self): + """Test case for migrate_device + + """ + pass + + def test_reset_vedge_cloud(self): + """Test case for reset_vedge_cloud + + """ + pass + + def test_set_life_cycle(self): + """Test case for set_life_cycle + + """ + pass + + def test_sync_devices(self): + """Test case for sync_devices + + """ + pass + + def test_sync_root_cert_chain(self): + """Test case for sync_root_cert_chain + + """ + pass + + def test_update_device_subject_sudi(self): + """Test case for update_device_subject_sudi + + """ + pass + + def test_validate_user(self): + """Test case for validate_user + + """ + pass + + def test_validate_user1(self): + """Test case for validate_user1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_software_package_api.py b/test/test_configuration_device_software_package_api.py new file mode 100644 index 0000000..b7787a1 --- /dev/null +++ b/test/test_configuration_device_software_package_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_software_package_api import ConfigurationDeviceSoftwarePackageApi # noqa: E501 + + +class TestConfigurationDeviceSoftwarePackageApi(unittest.TestCase): + """ConfigurationDeviceSoftwarePackageApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceSoftwarePackageApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_vnf_package(self): + """Test case for create_vnf_package + + """ + pass + + def test_edit_config_file(self): + """Test case for edit_config_file + + """ + pass + + def test_get_file_contents(self): + """Test case for get_file_contents + + """ + pass + + def test_upload_image_file(self): + """Test case for upload_image_file + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_software_update_api.py b/test/test_configuration_device_software_update_api.py new file mode 100644 index 0000000..4589fa4 --- /dev/null +++ b/test/test_configuration_device_software_update_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_software_update_api import ConfigurationDeviceSoftwareUpdateApi # noqa: E501 + + +class TestConfigurationDeviceSoftwareUpdateApi(unittest.TestCase): + """ConfigurationDeviceSoftwareUpdateApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceSoftwareUpdateApi() # noqa: E501 + + def tearDown(self): + pass + + def test_download_package_file(self): + """Test case for download_package_file + + """ + pass + + def test_edit_image_metadata(self): + """Test case for edit_image_metadata + + """ + pass + + def test_get_image_metadata(self): + """Test case for get_image_metadata + + """ + pass + + def test_get_upload_images_count(self): + """Test case for get_upload_images_count + + """ + pass + + def test_install_pkg(self): + """Test case for install_pkg + + """ + pass + + def test_process_software_image(self): + """Test case for process_software_image + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_ssl_proxy_certificate_management_api.py b/test/test_configuration_device_ssl_proxy_certificate_management_api.py new file mode 100644 index 0000000..16abd8d --- /dev/null +++ b/test/test_configuration_device_ssl_proxy_certificate_management_api.py @@ -0,0 +1,173 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_ssl_proxy_certificate_management_api import ConfigurationDeviceSSLProxyCertificateManagementApi # noqa: E501 + + +class TestConfigurationDeviceSSLProxyCertificateManagementApi(unittest.TestCase): + """ConfigurationDeviceSSLProxyCertificateManagementApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceSSLProxyCertificateManagementApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_wan_edge(self): + """Test case for add_wan_edge + + """ + pass + + def test_generate_ssl_proxy_csr(self): + """Test case for generate_ssl_proxy_csr + + """ + pass + + def test_generate_ssl_proxy_csr_0(self): + """Test case for generate_ssl_proxy_csr_0 + + """ + pass + + def test_get_all_device_certificates(self): + """Test case for get_all_device_certificates + + """ + pass + + def test_get_all_device_csr(self): + """Test case for get_all_device_csr + + """ + pass + + def test_get_certificate_state(self): + """Test case for get_certificate_state + + """ + pass + + def test_get_enterprise_certificate(self): + """Test case for get_enterprise_certificate + + """ + pass + + def test_get_proxy_cert_of_edge(self): + """Test case for get_proxy_cert_of_edge + + """ + pass + + def test_get_self_signed_cert(self): + """Test case for get_self_signed_cert + + """ + pass + + def test_get_ssl_proxy_csr(self): + """Test case for get_ssl_proxy_csr + + """ + pass + + def test_get_ssl_proxy_list(self): + """Test case for get_ssl_proxy_list + + """ + pass + + def test_get_v_manage_enterprise_root_certificate(self): + """Test case for get_v_manage_enterprise_root_certificate + + """ + pass + + def test_getv_manage_certificate(self): + """Test case for getv_manage_certificate + + """ + pass + + def test_getv_manage_csr(self): + """Test case for getv_manage_csr + + """ + pass + + def test_getv_manage_root_ca(self): + """Test case for getv_manage_root_ca + + """ + pass + + def test_renew_certificate(self): + """Test case for renew_certificate + + """ + pass + + def test_revoke_certificate(self): + """Test case for revoke_certificate + + """ + pass + + def test_revoke_renew_certificate(self): + """Test case for revoke_renew_certificate + + """ + pass + + def test_set_enterprise_cert(self): + """Test case for set_enterprise_cert + + """ + pass + + def test_set_enterprise_root_ca_cert(self): + """Test case for set_enterprise_root_ca_cert + + """ + pass + + def test_setv_manage_root_ca(self): + """Test case for setv_manage_root_ca + + """ + pass + + def test_setv_manageintermediate_cert(self): + """Test case for setv_manageintermediate_cert + + """ + pass + + def test_update_certificate(self): + """Test case for update_certificate + + """ + pass + + def test_upload_certificiates(self): + """Test case for upload_certificiates + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_device_template_api.py b/test/test_configuration_device_template_api.py new file mode 100644 index 0000000..993b3ab --- /dev/null +++ b/test/test_configuration_device_template_api.py @@ -0,0 +1,149 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_device_template_api import ConfigurationDeviceTemplateApi # noqa: E501 + + +class TestConfigurationDeviceTemplateApi(unittest.TestCase): + """ConfigurationDeviceTemplateApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDeviceTemplateApi() # noqa: E501 + + def tearDown(self): + pass + + def test_attach_device_template(self): + """Test case for attach_device_template + + """ + pass + + def test_check_vbond(self): + """Test case for check_vbond + + """ + pass + + def test_create_device_input(self): + """Test case for create_device_input + + """ + pass + + def test_create_input_without_device(self): + """Test case for create_input_without_device + + """ + pass + + def test_detach_device_template(self): + """Test case for detach_device_template + + """ + pass + + def test_detach_sites(self): + """Test case for detach_sites + + """ + pass + + def test_edit_cloudx_config(self): + """Test case for edit_cloudx_config + + """ + pass + + def test_get_attached_config_to_device(self): + """Test case for get_attached_config_to_device + + """ + pass + + def test_get_attached_device_list(self): + """Test case for get_attached_device_list + + """ + pass + + def test_get_device_configuration_preview(self): + """Test case for get_device_configuration_preview + + """ + pass + + def test_get_device_list_by_master_template_id(self): + """Test case for get_device_list_by_master_template_id + + """ + pass + + def test_get_devices_with_duplicate_ip(self): + """Test case for get_devices_with_duplicate_ip + + """ + pass + + def test_get_devices_with_duplicate_location_name(self): + """Test case for get_devices_with_duplicate_location_name + + """ + pass + + def test_get_quick_connect_variables(self): + """Test case for get_quick_connect_variables + + """ + pass + + def test_process_input_comma_sep_file(self): + """Test case for process_input_comma_sep_file + + """ + pass + + def test_push_cli_template(self): + """Test case for push_cli_template + + """ + pass + + def test_push_cloudx_config(self): + """Test case for push_cloudx_config + + """ + pass + + def test_push_master_template(self): + """Test case for push_master_template + + """ + pass + + def test_push_master_template1(self): + """Test case for push_master_template1 + + """ + pass + + def test_validate_template(self): + """Test case for validate_template + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_disaster_recovery_api.py b/test/test_configuration_disaster_recovery_api.py new file mode 100644 index 0000000..be049fa --- /dev/null +++ b/test/test_configuration_disaster_recovery_api.py @@ -0,0 +1,269 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_disaster_recovery_api import ConfigurationDisasterRecoveryApi # noqa: E501 + + +class TestConfigurationDisasterRecoveryApi(unittest.TestCase): + """ConfigurationDisasterRecoveryApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDisasterRecoveryApi() # noqa: E501 + + def tearDown(self): + pass + + def test_activate(self): + """Test case for activate + + """ + pass + + def test_delete(self): + """Test case for delete + + """ + pass + + def test_delete_dc(self): + """Test case for delete_dc + + """ + pass + + def test_delete_local_dc(self): + """Test case for delete_local_dc + + """ + pass + + def test_disaster_recovery_pause_replication(self): + """Test case for disaster_recovery_pause_replication + + """ + pass + + def test_disaster_recovery_replication_request(self): + """Test case for disaster_recovery_replication_request + + """ + pass + + def test_disaster_recovery_un_pause_replication(self): + """Test case for disaster_recovery_un_pause_replication + + """ + pass + + def test_download(self): + """Test case for download + + """ + pass + + def test_download_replication_data(self): + """Test case for download_replication_data + + """ + pass + + def test_get(self): + """Test case for get + + """ + pass + + def test_get_cluster_info(self): + """Test case for get_cluster_info + + """ + pass + + def test_get_config_db_restore_status(self): + """Test case for get_config_db_restore_status + + """ + pass + + def test_get_details(self): + """Test case for get_details + + """ + pass + + def test_get_disaster_recovery_local_replication_schedule(self): + """Test case for get_disaster_recovery_local_replication_schedule + + """ + pass + + def test_get_disaster_recovery_status(self): + """Test case for get_disaster_recovery_status + + """ + pass + + def test_get_history(self): + """Test case for get_history + + """ + pass + + def test_get_local_data_center_state(self): + """Test case for get_local_data_center_state + + """ + pass + + def test_get_local_history(self): + """Test case for get_local_history + + """ + pass + + def test_get_reachability_info(self): + """Test case for get_reachability_info + + """ + pass + + def test_get_remote_data_center_state(self): + """Test case for get_remote_data_center_state + + """ + pass + + def test_get_remote_data_center_version(self): + """Test case for get_remote_data_center_version + + """ + pass + + def test_get_remote_dc_members_state(self): + """Test case for get_remote_dc_members_state + + """ + pass + + def test_getdr_status(self): + """Test case for getdr_status + + """ + pass + + def test_pause_dr(self): + """Test case for pause_dr + + """ + pass + + def test_pause_local_arbitrator(self): + """Test case for pause_local_arbitrator + + """ + pass + + def test_pause_local_dc_for_dr(self): + """Test case for pause_local_dc_for_dr + + """ + pass + + def test_pause_local_dc_replication(self): + """Test case for pause_local_dc_replication + + """ + pass + + def test_register(self): + """Test case for register + + """ + pass + + def test_restart_data_center(self): + """Test case for restart_data_center + + """ + pass + + def test_restore_config_db(self): + """Test case for restore_config_db + + """ + pass + + def test_unpause_dr(self): + """Test case for unpause_dr + + """ + pass + + def test_unpause_local_arbitrator(self): + """Test case for unpause_local_arbitrator + + """ + pass + + def test_unpause_local_dc_for_dr(self): + """Test case for unpause_local_dc_for_dr + + """ + pass + + def test_unpause_local_dc_replication(self): + """Test case for unpause_local_dc_replication + + """ + pass + + def test_update(self): + """Test case for update + + """ + pass + + def test_update1(self): + """Test case for update1 + + """ + pass + + def test_update_disaster_recovery_state(self): + """Test case for update_disaster_recovery_state + + """ + pass + + def test_update_disaster_recovery_state1(self): + """Test case for update_disaster_recovery_state1 + + """ + pass + + def test_update_dr_state(self): + """Test case for update_dr_state + + """ + pass + + def test_update_replication(self): + """Test case for update_replication + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_downloaded_images_api.py b/test/test_configuration_downloaded_images_api.py new file mode 100644 index 0000000..da0988b --- /dev/null +++ b/test/test_configuration_downloaded_images_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_downloaded_images_api import ConfigurationDownloadedImagesApi # noqa: E501 + + +class TestConfigurationDownloadedImagesApi(unittest.TestCase): + """ConfigurationDownloadedImagesApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationDownloadedImagesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_software_list(self): + """Test case for create_software_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_feature_certificate_api.py b/test/test_configuration_feature_certificate_api.py new file mode 100644 index 0000000..4e7abc7 --- /dev/null +++ b/test/test_configuration_feature_certificate_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_feature_certificate_api import ConfigurationFeatureCertificateApi # noqa: E501 + + +class TestConfigurationFeatureCertificateApi(unittest.TestCase): + """ConfigurationFeatureCertificateApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationFeatureCertificateApi() # noqa: E501 + + def tearDown(self): + pass + + def test_gen_device_csr(self): + """Test case for gen_device_csr + + """ + pass + + def test_get_device_certificate(self): + """Test case for get_device_certificate + + """ + pass + + def test_get_device_csr(self): + """Test case for get_device_csr + + """ + pass + + def test_get_feature_ca_state(self): + """Test case for get_feature_ca_state + + """ + pass + + def test_install_feature_certificate(self): + """Test case for install_feature_certificate + + """ + pass + + def test_revoke_feature_certificate(self): + """Test case for revoke_feature_certificate + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_feature_profile_mobility_api.py b/test/test_configuration_feature_profile_mobility_api.py new file mode 100644 index 0000000..26fd9df --- /dev/null +++ b/test/test_configuration_feature_profile_mobility_api.py @@ -0,0 +1,251 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_feature_profile_mobility_api import ConfigurationFeatureProfileMobilityApi # noqa: E501 + + +class TestConfigurationFeatureProfileMobilityApi(unittest.TestCase): + """ConfigurationFeatureProfileMobilityApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationFeatureProfileMobilityApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_basic_profile_parcel_for_mobility(self): + """Test case for create_basic_profile_parcel_for_mobility + + """ + pass + + def test_create_cellular_profile_parcel_for_mobility(self): + """Test case for create_cellular_profile_parcel_for_mobility + + """ + pass + + def test_create_ethernet_profile_parcel_for_mobility(self): + """Test case for create_ethernet_profile_parcel_for_mobility + + """ + pass + + def test_create_network_protocol_profile_parcel_for_mobility(self): + """Test case for create_network_protocol_profile_parcel_for_mobility + + """ + pass + + def test_create_security_policy_profile_parcel_for_mobility(self): + """Test case for create_security_policy_profile_parcel_for_mobility + + """ + pass + + def test_create_vpn_profile_parcel_for_mobility(self): + """Test case for create_vpn_profile_parcel_for_mobility + + """ + pass + + def test_create_wifi_profile_parcel_for_mobility(self): + """Test case for create_wifi_profile_parcel_for_mobility + + """ + pass + + def test_delete_a_cellular_profile_parcel_for_mobility(self): + """Test case for delete_a_cellular_profile_parcel_for_mobility + + """ + pass + + def test_delete_a_vpn_profile_parcel_for_mobility(self): + """Test case for delete_a_vpn_profile_parcel_for_mobility + + """ + pass + + def test_delete_basic_profile_parcel_for_mobility(self): + """Test case for delete_basic_profile_parcel_for_mobility + + """ + pass + + def test_delete_ethernet_profile_parcel_for_system(self): + """Test case for delete_ethernet_profile_parcel_for_system + + """ + pass + + def test_delete_network_protocol_profile_parcel_for_mobility(self): + """Test case for delete_network_protocol_profile_parcel_for_mobility + + """ + pass + + def test_delete_security_policy_profile_parcel_for_mobility(self): + """Test case for delete_security_policy_profile_parcel_for_mobility + + """ + pass + + def test_delete_wifi_profile_parcel_for_mobility(self): + """Test case for delete_wifi_profile_parcel_for_mobility + + """ + pass + + def test_edit_basic_profile_parcel_for_mobility(self): + """Test case for edit_basic_profile_parcel_for_mobility + + """ + pass + + def test_edit_cellular_profile_parcel_for_mobility(self): + """Test case for edit_cellular_profile_parcel_for_mobility + + """ + pass + + def test_edit_ethernet_profile_parcel_for_system(self): + """Test case for edit_ethernet_profile_parcel_for_system + + """ + pass + + def test_edit_network_protocol_profile_parcel_for_mobility(self): + """Test case for edit_network_protocol_profile_parcel_for_mobility + + """ + pass + + def test_edit_security_policy_profile_parcel_for_mobility(self): + """Test case for edit_security_policy_profile_parcel_for_mobility + + """ + pass + + def test_edit_vpn_profile_parcel_for_mobility(self): + """Test case for edit_vpn_profile_parcel_for_mobility + + """ + pass + + def test_edit_wifi_profile_parcel_for_mobility(self): + """Test case for edit_wifi_profile_parcel_for_mobility + + """ + pass + + def test_get_basic_profile_parcel_by_parcel_id_for_mobility(self): + """Test case for get_basic_profile_parcel_by_parcel_id_for_mobility + + """ + pass + + def test_get_basic_profile_parcel_for_mobility(self): + """Test case for get_basic_profile_parcel_for_mobility + + """ + pass + + def test_get_cellular_profile_parcel_for_mobility(self): + """Test case for get_cellular_profile_parcel_for_mobility + + """ + pass + + def test_get_cellular_profile_parcel_list_for_mobility(self): + """Test case for get_cellular_profile_parcel_list_for_mobility + + """ + pass + + def test_get_ethernet_profile_parcel(self): + """Test case for get_ethernet_profile_parcel + + """ + pass + + def test_get_ethernet_profile_parcels(self): + """Test case for get_ethernet_profile_parcels + + """ + pass + + def test_get_mobility_feature_profile_by_global_id(self): + """Test case for get_mobility_feature_profile_by_global_id + + """ + pass + + def test_get_mobility_global_basic_parcel_schema_by_schema_type(self): + """Test case for get_mobility_global_basic_parcel_schema_by_schema_type + + """ + pass + + def test_get_network_protocol_profile_parcel_for_mobility(self): + """Test case for get_network_protocol_profile_parcel_for_mobility + + """ + pass + + def test_get_network_protocol_profile_parcel_list_for_mobility(self): + """Test case for get_network_protocol_profile_parcel_list_for_mobility + + """ + pass + + def test_get_security_policy_profile_parcel_for_mobility(self): + """Test case for get_security_policy_profile_parcel_for_mobility + + """ + pass + + def test_get_security_policy_profile_parcel_list_for_mobility(self): + """Test case for get_security_policy_profile_parcel_list_for_mobility + + """ + pass + + def test_get_vpn_profile_parcel_for_mobility(self): + """Test case for get_vpn_profile_parcel_for_mobility + + """ + pass + + def test_get_vpn_profile_parcel_list_for_mobility(self): + """Test case for get_vpn_profile_parcel_list_for_mobility + + """ + pass + + def test_get_wifi_profile_parcel_for_mobility(self): + """Test case for get_wifi_profile_parcel_for_mobility + + """ + pass + + def test_get_wifi_profile_parcel_list_for_mobility(self): + """Test case for get_wifi_profile_parcel_list_for_mobility + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_feature_profile_sdwan_api.py b/test/test_configuration_feature_profile_sdwan_api.py new file mode 100644 index 0000000..102afa2 --- /dev/null +++ b/test/test_configuration_feature_profile_sdwan_api.py @@ -0,0 +1,1427 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_feature_profile_sdwan_api import ConfigurationFeatureProfileSDWANApi # noqa: E501 + + +class TestConfigurationFeatureProfileSDWANApi(unittest.TestCase): + """ConfigurationFeatureProfileSDWANApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationFeatureProfileSDWANApi() # noqa: E501 + + def tearDown(self): + pass + + def test_cedge_service_profile_switchport_parcel_restful_resource(self): + """Test case for cedge_service_profile_switchport_parcel_restful_resource + + """ + pass + + def test_create_aaa_profile_parcel_for_system(self): + """Test case for create_aaa_profile_parcel_for_system + + """ + pass + + def test_create_banner_profile_parcel_for_system(self): + """Test case for create_banner_profile_parcel_for_system + + """ + pass + + def test_create_basic_profile_parcel_for_system(self): + """Test case for create_basic_profile_parcel_for_system + + """ + pass + + def test_create_bfd_profile_parcel_for_system(self): + """Test case for create_bfd_profile_parcel_for_system + + """ + pass + + def test_create_cellular_controller_and_cellular_profile_parcel_association_for_transport(self): + """Test case for create_cellular_controller_and_cellular_profile_parcel_association_for_transport + + """ + pass + + def test_create_cellular_controller_profile_parcel_for_transport(self): + """Test case for create_cellular_controller_profile_parcel_for_transport + + """ + pass + + def test_create_cellular_profile_profile_parcel_for_transport(self): + """Test case for create_cellular_profile_profile_parcel_for_transport + + """ + pass + + def test_create_dhcp_server_profile_parcel_for_service(self): + """Test case for create_dhcp_server_profile_parcel_for_service + + """ + pass + + def test_create_global_profile_parcel_for_system(self): + """Test case for create_global_profile_parcel_for_system + + """ + pass + + def test_create_lan_vpn_and_routing_bgp_parcel_association_for_service(self): + """Test case for create_lan_vpn_and_routing_bgp_parcel_association_for_service + + """ + pass + + def test_create_lan_vpn_and_routing_ospf_parcel_association_for_service(self): + """Test case for create_lan_vpn_and_routing_ospf_parcel_association_for_service + + """ + pass + + def test_create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(self): + """Test case for create_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport + + """ + pass + + def test_create_lan_vpn_interface_ethernet_parcel_for_service(self): + """Test case for create_lan_vpn_interface_ethernet_parcel_for_service + + """ + pass + + def test_create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(self): + """Test case for create_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport + + """ + pass + + def test_create_lan_vpn_interface_svi_parcel_for_service(self): + """Test case for create_lan_vpn_interface_svi_parcel_for_service + + """ + pass + + def test_create_lan_vpn_profile_parcel_for_service(self): + """Test case for create_lan_vpn_profile_parcel_for_service + + """ + pass + + def test_create_logging_profile_parcel_for_system(self): + """Test case for create_logging_profile_parcel_for_system + + """ + pass + + def test_create_management_vpn_interface_ethernet_parcel_for_transport(self): + """Test case for create_management_vpn_interface_ethernet_parcel_for_transport + + """ + pass + + def test_create_management_vpn_profile_parcel_for_transport(self): + """Test case for create_management_vpn_profile_parcel_for_transport + + """ + pass + + def test_create_ntp_profile_parcel_for_system(self): + """Test case for create_ntp_profile_parcel_for_system + + """ + pass + + def test_create_omp_profile_parcel_for_system(self): + """Test case for create_omp_profile_parcel_for_system + + """ + pass + + def test_create_routing_bgp_profile_parcel_for_service(self): + """Test case for create_routing_bgp_profile_parcel_for_service + + """ + pass + + def test_create_routing_bgp_profile_parcel_for_transport(self): + """Test case for create_routing_bgp_profile_parcel_for_transport + + """ + pass + + def test_create_routing_ospf_profile_parcel_for_service(self): + """Test case for create_routing_ospf_profile_parcel_for_service + + """ + pass + + def test_create_sdwan_config_profile_parcel_for_cli(self): + """Test case for create_sdwan_config_profile_parcel_for_cli + + """ + pass + + def test_create_sdwan_feature_profile(self): + """Test case for create_sdwan_feature_profile + + """ + pass + + def test_create_sdwan_other_feature_profile(self): + """Test case for create_sdwan_other_feature_profile + + """ + pass + + def test_create_sdwan_service_feature_profile(self): + """Test case for create_sdwan_service_feature_profile + + """ + pass + + def test_create_sdwan_system_feature_profile(self): + """Test case for create_sdwan_system_feature_profile + + """ + pass + + def test_create_sdwan_transport_feature_profile(self): + """Test case for create_sdwan_transport_feature_profile + + """ + pass + + def test_create_snmp_profile_parcel_for_system(self): + """Test case for create_snmp_profile_parcel_for_system + + """ + pass + + def test_create_thousandeyes_profile_parcel_for_other(self): + """Test case for create_thousandeyes_profile_parcel_for_other + + """ + pass + + def test_create_tracker_profile_parcel_for_transport(self): + """Test case for create_tracker_profile_parcel_for_transport + + """ + pass + + def test_create_wan_vpn_and_routing_bgp_parcel_association_for_transport(self): + """Test case for create_wan_vpn_and_routing_bgp_parcel_association_for_transport + + """ + pass + + def test_create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(self): + """Test case for create_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport + + """ + pass + + def test_create_wan_vpn_interface_cellular_parcel_for_transport(self): + """Test case for create_wan_vpn_interface_cellular_parcel_for_transport + + """ + pass + + def test_create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(self): + """Test case for create_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport + + """ + pass + + def test_create_wan_vpn_interface_ethernet_parcel_for_transport(self): + """Test case for create_wan_vpn_interface_ethernet_parcel_for_transport + + """ + pass + + def test_create_wan_vpn_profile_parcel_for_transport(self): + """Test case for create_wan_vpn_profile_parcel_for_transport + + """ + pass + + def test_create_wirelesslan_profile_parcel_for_service(self): + """Test case for create_wirelesslan_profile_parcel_for_service + + """ + pass + + def test_delete_aaa_profile_parcel_for_system(self): + """Test case for delete_aaa_profile_parcel_for_system + + """ + pass + + def test_delete_banner_profile_parcel_for_system(self): + """Test case for delete_banner_profile_parcel_for_system + + """ + pass + + def test_delete_basic_profile_parcel_for_system(self): + """Test case for delete_basic_profile_parcel_for_system + + """ + pass + + def test_delete_bfd_profile_parcel_for_system(self): + """Test case for delete_bfd_profile_parcel_for_system + + """ + pass + + def test_delete_cellular_controller_and_cellular_profile_association_for_transport(self): + """Test case for delete_cellular_controller_and_cellular_profile_association_for_transport + + """ + pass + + def test_delete_cellular_controller_profile_parcel_for_transport(self): + """Test case for delete_cellular_controller_profile_parcel_for_transport + + """ + pass + + def test_delete_cellular_profile_profile_parcel_for_transport(self): + """Test case for delete_cellular_profile_profile_parcel_for_transport + + """ + pass + + def test_delete_config_profile_parcel_for_cli(self): + """Test case for delete_config_profile_parcel_for_cli + + """ + pass + + def test_delete_dhcp_server_profile_parcel_for_service(self): + """Test case for delete_dhcp_server_profile_parcel_for_service + + """ + pass + + def test_delete_global_profile_parcel_for_system(self): + """Test case for delete_global_profile_parcel_for_system + + """ + pass + + def test_delete_lan_vpn_and_routing_bgp_association_for_service(self): + """Test case for delete_lan_vpn_and_routing_bgp_association_for_service + + """ + pass + + def test_delete_lan_vpn_and_routing_ospf_association_for_service(self): + """Test case for delete_lan_vpn_and_routing_ospf_association_for_service + + """ + pass + + def test_delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport(self): + """Test case for delete_lan_vpn_interface_ethernet_and_dhcp_server_association_for_transport + + """ + pass + + def test_delete_lan_vpn_interface_ethernet_for_service(self): + """Test case for delete_lan_vpn_interface_ethernet_for_service + + """ + pass + + def test_delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport(self): + """Test case for delete_lan_vpn_interface_svi_and_dhcp_server_association_for_transport + + """ + pass + + def test_delete_lan_vpn_interface_svi_for_service(self): + """Test case for delete_lan_vpn_interface_svi_for_service + + """ + pass + + def test_delete_lan_vpn_profile_parcel_for_service(self): + """Test case for delete_lan_vpn_profile_parcel_for_service + + """ + pass + + def test_delete_logging_profile_parcel_for_system(self): + """Test case for delete_logging_profile_parcel_for_system + + """ + pass + + def test_delete_management_vpn_interface_ethernet_for_transport(self): + """Test case for delete_management_vpn_interface_ethernet_for_transport + + """ + pass + + def test_delete_management_vpn_profile_parcel_for_transport(self): + """Test case for delete_management_vpn_profile_parcel_for_transport + + """ + pass + + def test_delete_ntp_profile_parcel_for_system(self): + """Test case for delete_ntp_profile_parcel_for_system + + """ + pass + + def test_delete_omp_profile_parcel_for_system(self): + """Test case for delete_omp_profile_parcel_for_system + + """ + pass + + def test_delete_routing_bgp_profile_parcel_for_service(self): + """Test case for delete_routing_bgp_profile_parcel_for_service + + """ + pass + + def test_delete_routing_bgp_profile_parcel_for_transport(self): + """Test case for delete_routing_bgp_profile_parcel_for_transport + + """ + pass + + def test_delete_routing_ospf_profile_parcel_for_service(self): + """Test case for delete_routing_ospf_profile_parcel_for_service + + """ + pass + + def test_delete_sdwan_feature_profile_for_cli(self): + """Test case for delete_sdwan_feature_profile_for_cli + + """ + pass + + def test_delete_sdwan_other_feature_profile(self): + """Test case for delete_sdwan_other_feature_profile + + """ + pass + + def test_delete_sdwan_service_feature_profile(self): + """Test case for delete_sdwan_service_feature_profile + + """ + pass + + def test_delete_sdwan_system_feature_profile(self): + """Test case for delete_sdwan_system_feature_profile + + """ + pass + + def test_delete_sdwan_transport_feature_profile(self): + """Test case for delete_sdwan_transport_feature_profile + + """ + pass + + def test_delete_snmp_profile_parcel_for_system(self): + """Test case for delete_snmp_profile_parcel_for_system + + """ + pass + + def test_delete_switchport_profile_parcel_for_service(self): + """Test case for delete_switchport_profile_parcel_for_service + + """ + pass + + def test_delete_thousandeyes_profile_parcel_for_other(self): + """Test case for delete_thousandeyes_profile_parcel_for_other + + """ + pass + + def test_delete_tracker_profile_parcel_for_transport(self): + """Test case for delete_tracker_profile_parcel_for_transport + + """ + pass + + def test_delete_wan_vpn_and_routing_bgp_association_for_transport(self): + """Test case for delete_wan_vpn_and_routing_bgp_association_for_transport + + """ + pass + + def test_delete_wan_vpn_interface_cellular_and_tracker_association_for_transport(self): + """Test case for delete_wan_vpn_interface_cellular_and_tracker_association_for_transport + + """ + pass + + def test_delete_wan_vpn_interface_cellular_for_transport(self): + """Test case for delete_wan_vpn_interface_cellular_for_transport + + """ + pass + + def test_delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport(self): + """Test case for delete_wan_vpn_interface_ethernet_and_tracker_association_for_transport + + """ + pass + + def test_delete_wan_vpn_interface_ethernet_for_transport(self): + """Test case for delete_wan_vpn_interface_ethernet_for_transport + + """ + pass + + def test_delete_wan_vpn_profile_parcel_for_transport(self): + """Test case for delete_wan_vpn_profile_parcel_for_transport + + """ + pass + + def test_delete_wirelesslan_profile_parcel_for_service(self): + """Test case for delete_wirelesslan_profile_parcel_for_service + + """ + pass + + def test_edit_aaa_profile_parcel_for_system(self): + """Test case for edit_aaa_profile_parcel_for_system + + """ + pass + + def test_edit_banner_profile_parcel_for_system(self): + """Test case for edit_banner_profile_parcel_for_system + + """ + pass + + def test_edit_basic_profile_parcel_for_system(self): + """Test case for edit_basic_profile_parcel_for_system + + """ + pass + + def test_edit_bfd_profile_parcel_for_system(self): + """Test case for edit_bfd_profile_parcel_for_system + + """ + pass + + def test_edit_cellular_controller_and_cellular_profile_parcel_association_for_transport(self): + """Test case for edit_cellular_controller_and_cellular_profile_parcel_association_for_transport + + """ + pass + + def test_edit_cellular_controller_profile_parcel_for_transport(self): + """Test case for edit_cellular_controller_profile_parcel_for_transport + + """ + pass + + def test_edit_cellular_profile_profile_parcel_for_transport(self): + """Test case for edit_cellular_profile_profile_parcel_for_transport + + """ + pass + + def test_edit_config_profile_parcel_for_cli(self): + """Test case for edit_config_profile_parcel_for_cli + + """ + pass + + def test_edit_dhcp_server_profile_parcel_for_service(self): + """Test case for edit_dhcp_server_profile_parcel_for_service + + """ + pass + + def test_edit_global_profile_parcel_for_system(self): + """Test case for edit_global_profile_parcel_for_system + + """ + pass + + def test_edit_lan_vpn_and_routing_bgp_parcel_association_for_service(self): + """Test case for edit_lan_vpn_and_routing_bgp_parcel_association_for_service + + """ + pass + + def test_edit_lan_vpn_and_routing_ospf_parcel_association_for_service(self): + """Test case for edit_lan_vpn_and_routing_ospf_parcel_association_for_service + + """ + pass + + def test_edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport(self): + """Test case for edit_lan_vpn_interface_ethernet_and_dhcp_server_parcel_association_for_transport + + """ + pass + + def test_edit_lan_vpn_interface_ethernet_parcel_for_service(self): + """Test case for edit_lan_vpn_interface_ethernet_parcel_for_service + + """ + pass + + def test_edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport(self): + """Test case for edit_lan_vpn_interface_svi_and_dhcp_server_parcel_association_for_transport + + """ + pass + + def test_edit_lan_vpn_interface_svi_parcel_for_service(self): + """Test case for edit_lan_vpn_interface_svi_parcel_for_service + + """ + pass + + def test_edit_lan_vpn_profile_parcel_for_service(self): + """Test case for edit_lan_vpn_profile_parcel_for_service + + """ + pass + + def test_edit_logging_profile_parcel_for_system(self): + """Test case for edit_logging_profile_parcel_for_system + + """ + pass + + def test_edit_management_vpn_interface_ethernet_parcel_for_transport(self): + """Test case for edit_management_vpn_interface_ethernet_parcel_for_transport + + """ + pass + + def test_edit_management_vpn_profile_parcel_for_transport(self): + """Test case for edit_management_vpn_profile_parcel_for_transport + + """ + pass + + def test_edit_ntp_profile_parcel_for_system(self): + """Test case for edit_ntp_profile_parcel_for_system + + """ + pass + + def test_edit_omp_profile_parcel_for_system(self): + """Test case for edit_omp_profile_parcel_for_system + + """ + pass + + def test_edit_routing_bgp_profile_parcel_for_service(self): + """Test case for edit_routing_bgp_profile_parcel_for_service + + """ + pass + + def test_edit_routing_bgp_profile_parcel_for_transport(self): + """Test case for edit_routing_bgp_profile_parcel_for_transport + + """ + pass + + def test_edit_routing_ospf_profile_parcel_for_service(self): + """Test case for edit_routing_ospf_profile_parcel_for_service + + """ + pass + + def test_edit_sdwan_feature_profile(self): + """Test case for edit_sdwan_feature_profile + + """ + pass + + def test_edit_sdwan_other_feature_profile(self): + """Test case for edit_sdwan_other_feature_profile + + """ + pass + + def test_edit_sdwan_service_feature_profile(self): + """Test case for edit_sdwan_service_feature_profile + + """ + pass + + def test_edit_sdwan_system_feature_profile(self): + """Test case for edit_sdwan_system_feature_profile + + """ + pass + + def test_edit_sdwan_transport_feature_profile(self): + """Test case for edit_sdwan_transport_feature_profile + + """ + pass + + def test_edit_snmp_profile_parcel_for_system(self): + """Test case for edit_snmp_profile_parcel_for_system + + """ + pass + + def test_edit_switchport_parcel_association_for_service(self): + """Test case for edit_switchport_parcel_association_for_service + + """ + pass + + def test_edit_thousandeyes_profile_parcel_for_other(self): + """Test case for edit_thousandeyes_profile_parcel_for_other + + """ + pass + + def test_edit_tracker_profile_parcel_for_transport(self): + """Test case for edit_tracker_profile_parcel_for_transport + + """ + pass + + def test_edit_wan_vpn_and_routing_bgp_parcel_association_for_transport(self): + """Test case for edit_wan_vpn_and_routing_bgp_parcel_association_for_transport + + """ + pass + + def test_edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport(self): + """Test case for edit_wan_vpn_interface_cellular_and_tracker_parcel_association_for_transport + + """ + pass + + def test_edit_wan_vpn_interface_cellular_parcel_for_transport(self): + """Test case for edit_wan_vpn_interface_cellular_parcel_for_transport + + """ + pass + + def test_edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport(self): + """Test case for edit_wan_vpn_interface_ethernet_and_tracker_parcel_association_for_transport + + """ + pass + + def test_edit_wan_vpn_interface_ethernet_parcel_for_transport(self): + """Test case for edit_wan_vpn_interface_ethernet_parcel_for_transport + + """ + pass + + def test_edit_wan_vpn_profile_parcel_for_transport(self): + """Test case for edit_wan_vpn_profile_parcel_for_transport + + """ + pass + + def test_edit_wirelesslan_profile_parcel_for_service(self): + """Test case for edit_wirelesslan_profile_parcel_for_service + + """ + pass + + def test_get_aaa_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_aaa_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_aaa_profile_parcel_for_system(self): + """Test case for get_aaa_profile_parcel_for_system + + """ + pass + + def test_get_banner_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_banner_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_banner_profile_parcel_for_system(self): + """Test case for get_banner_profile_parcel_for_system + + """ + pass + + def test_get_basic_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_basic_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_basic_profile_parcel_for_system(self): + """Test case for get_basic_profile_parcel_for_system + + """ + pass + + def test_get_bfd_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_bfd_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_bfd_profile_parcel_for_system(self): + """Test case for get_bfd_profile_parcel_for_system + + """ + pass + + def test_get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema(self): + """Test case for get_cedge_service_lan_vpn_interface_svi_parcel_schema_by_schema + + """ + pass + + def test_get_cedge_service_switchport_parcel_schema_by_schema_type(self): + """Test case for get_cedge_service_switchport_parcel_schema_by_schema_type + + """ + pass + + def test_get_cedge_system_global_parcel_schema_by_schema_type(self): + """Test case for get_cedge_system_global_parcel_schema_by_schema_type + + """ + pass + + def test_get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_cellular_controller_associated_cellular_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_cellular_controller_associated_cellular_profile_parcels_for_transport(self): + """Test case for get_cellular_controller_associated_cellular_profile_parcels_for_transport + + """ + pass + + def test_get_cellular_controller_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_cellular_controller_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_cellular_controller_profile_parcel_for_transport(self): + """Test case for get_cellular_controller_profile_parcel_for_transport + + """ + pass + + def test_get_cellular_profile_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_cellular_profile_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_cellular_profile_profile_parcel_for_transport(self): + """Test case for get_cellular_profile_profile_parcel_for_transport + + """ + pass + + def test_get_config_profile_parcel_by_parcel_id_for_cli(self): + """Test case for get_config_profile_parcel_by_parcel_id_for_cli + + """ + pass + + def test_get_config_profile_parcel_for_cli(self): + """Test case for get_config_profile_parcel_for_cli + + """ + pass + + def test_get_dhcp_server_profile_parcel_by_parcel_id_for_service(self): + """Test case for get_dhcp_server_profile_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_dhcp_server_profile_parcel_for_service(self): + """Test case for get_dhcp_server_profile_parcel_for_service + + """ + pass + + def test_get_global_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_global_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_global_profile_parcel_for_system(self): + """Test case for get_global_profile_parcel_for_system + + """ + pass + + def test_get_interface_cellular_parcels_for_transport_wan_vpn(self): + """Test case for get_interface_cellular_parcels_for_transport_wan_vpn + + """ + pass + + def test_get_interface_ethernet_parcels_for_service_lan_vpn(self): + """Test case for get_interface_ethernet_parcels_for_service_lan_vpn + + """ + pass + + def test_get_interface_ethernet_parcels_for_transport_management_vpn(self): + """Test case for get_interface_ethernet_parcels_for_transport_management_vpn + + """ + pass + + def test_get_interface_ethernet_parcels_for_transport_wan_vpn(self): + """Test case for get_interface_ethernet_parcels_for_transport_wan_vpn + + """ + pass + + def test_get_interface_svi_parcels_for_service_lan_vpn(self): + """Test case for get_interface_svi_parcels_for_service_lan_vpn + + """ + pass + + def test_get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service(self): + """Test case for get_lan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_lan_vpn_associated_routing_bgp_parcels_for_service(self): + """Test case for get_lan_vpn_associated_routing_bgp_parcels_for_service + + """ + pass + + def test_get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service(self): + """Test case for get_lan_vpn_associated_routing_ospf_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_lan_vpn_associated_routing_ospf_parcels_for_service(self): + """Test case for get_lan_vpn_associated_routing_ospf_parcels_for_service + + """ + pass + + def test_get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport(self): + """Test case for get_lan_vpn_interface_ethernet_associated_dhcp_server_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport(self): + """Test case for get_lan_vpn_interface_ethernet_associated_dhcp_server_parcels_for_transport + + """ + pass + + def test_get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service(self): + """Test case for get_lan_vpn_interface_ethernet_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport(self): + """Test case for get_lan_vpn_interface_svi_associated_dhcp_server_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport(self): + """Test case for get_lan_vpn_interface_svi_associated_dhcp_server_parcels_for_transport + + """ + pass + + def test_get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service(self): + """Test case for get_lan_vpn_interface_svi_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_lan_vpn_profile_parcel_by_parcel_id_for_service(self): + """Test case for get_lan_vpn_profile_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_lan_vpn_profile_parcel_for_service(self): + """Test case for get_lan_vpn_profile_parcel_for_service + + """ + pass + + def test_get_logging_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_logging_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_logging_profile_parcel_for_system(self): + """Test case for get_logging_profile_parcel_for_system + + """ + pass + + def test_get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(self): + """Test case for get_management_vpn_interface_ethernet_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_management_vpn_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_management_vpn_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_management_vpn_profile_parcel_for_transport(self): + """Test case for get_management_vpn_profile_parcel_for_transport + + """ + pass + + def test_get_ntp_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_ntp_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_ntp_profile_parcel_for_system(self): + """Test case for get_ntp_profile_parcel_for_system + + """ + pass + + def test_get_omp_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_omp_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_omp_profile_parcel_for_system(self): + """Test case for get_omp_profile_parcel_for_system + + """ + pass + + def test_get_routing_bgp_profile_parcel_by_parcel_id_for_service(self): + """Test case for get_routing_bgp_profile_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_routing_bgp_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_routing_bgp_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_routing_bgp_profile_parcel_for_service(self): + """Test case for get_routing_bgp_profile_parcel_for_service + + """ + pass + + def test_get_routing_bgp_profile_parcel_for_transport(self): + """Test case for get_routing_bgp_profile_parcel_for_transport + + """ + pass + + def test_get_routing_ospf_profile_parcel_by_parcel_id_for_service(self): + """Test case for get_routing_ospf_profile_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_routing_ospf_profile_parcel_for_service(self): + """Test case for get_routing_ospf_profile_parcel_for_service + + """ + pass + + def test_get_sdwan_feature_profile_by_profile_id(self): + """Test case for get_sdwan_feature_profile_by_profile_id + + """ + pass + + def test_get_sdwan_feature_profile_by_sdwan_family(self): + """Test case for get_sdwan_feature_profile_by_sdwan_family + + """ + pass + + def test_get_sdwan_feature_profiles_by_family_and_type(self): + """Test case for get_sdwan_feature_profiles_by_family_and_type + + """ + pass + + def test_get_sdwan_other_feature_profile_by_profile_id(self): + """Test case for get_sdwan_other_feature_profile_by_profile_id + + """ + pass + + def test_get_sdwan_other_feature_profiles(self): + """Test case for get_sdwan_other_feature_profiles + + """ + pass + + def test_get_sdwan_other_thousandeyes_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_other_thousandeyes_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_service_dhcp_server_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_service_dhcp_server_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_service_feature_profile_by_profile_id(self): + """Test case for get_sdwan_service_feature_profile_by_profile_id + + """ + pass + + def test_get_sdwan_service_feature_profiles(self): + """Test case for get_sdwan_service_feature_profiles + + """ + pass + + def test_get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema(self): + """Test case for get_sdwan_service_lan_vpn_interface_ethernet_parcel_schema_by_schema + + """ + pass + + def test_get_sdwan_service_lan_vpn_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_service_lan_vpn_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_service_routing_bgp_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_service_routing_bgp_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_service_routing_ospf_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_service_routing_ospf_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_service_wirelesslan_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_service_wirelesslan_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_aaa_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_aaa_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_banner_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_banner_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_basic_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_basic_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_bfd_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_bfd_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_feature_profile_by_profile_id(self): + """Test case for get_sdwan_system_feature_profile_by_profile_id + + """ + pass + + def test_get_sdwan_system_feature_profiles(self): + """Test case for get_sdwan_system_feature_profiles + + """ + pass + + def test_get_sdwan_system_logging_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_logging_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_ntp_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_ntp_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_omp_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_omp_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_system_snmp_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_system_snmp_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_transport_cellular_controller_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_transport_cellular_profile_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_transport_feature_profile_by_profile_id(self): + """Test case for get_sdwan_transport_feature_profile_by_profile_id + + """ + pass + + def test_get_sdwan_transport_feature_profiles(self): + """Test case for get_sdwan_transport_feature_profiles + + """ + pass + + def test_get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema(self): + """Test case for get_sdwan_transport_management_vpn_interface_ethernet_parcel_schema_by_schema + + """ + pass + + def test_get_sdwan_transport_management_vpn_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_transport_management_vpn_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_transport_routing_bgp_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_transport_tracker_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_transport_tracker_parcel_schema_by_schema_type + + """ + pass + + def test_get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema(self): + """Test case for get_sdwan_transport_wan_vpn_cellular_interface_parcel_schema_by_schema + + """ + pass + + def test_get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema(self): + """Test case for get_sdwan_transport_wan_vpn_interface_ethernet_parcel_schema_by_schema + + """ + pass + + def test_get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type(self): + """Test case for get_sdwan_transport_wan_vpn_parcel_schema_by_schema_type + + """ + pass + + def test_get_snmp_profile_parcel_by_parcel_id_for_system(self): + """Test case for get_snmp_profile_parcel_by_parcel_id_for_system + + """ + pass + + def test_get_snmp_profile_parcel_for_system(self): + """Test case for get_snmp_profile_parcel_for_system + + """ + pass + + def test_get_switchport_parcel_by_parcel_id_for_service(self): + """Test case for get_switchport_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_switchport_parcels_for_service(self): + """Test case for get_switchport_parcels_for_service + + """ + pass + + def test_get_thousandeyes_profile_parcel_by_parcel_id_for_other(self): + """Test case for get_thousandeyes_profile_parcel_by_parcel_id_for_other + + """ + pass + + def test_get_thousandeyes_profile_parcel_for_other(self): + """Test case for get_thousandeyes_profile_parcel_for_other + + """ + pass + + def test_get_tracker_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_tracker_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_tracker_profile_parcel_for_transport(self): + """Test case for get_tracker_profile_parcel_for_transport + + """ + pass + + def test_get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport(self): + """Test case for get_wan_vpn_associated_routing_bgp_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_wan_vpn_associated_routing_bgp_parcels_for_transport(self): + """Test case for get_wan_vpn_associated_routing_bgp_parcels_for_transport + + """ + pass + + def test_get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport(self): + """Test case for get_wan_vpn_interface_cellular_associated_tracker_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport(self): + """Test case for get_wan_vpn_interface_cellular_associated_tracker_parcels_for_transport + + """ + pass + + def test_get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport(self): + """Test case for get_wan_vpn_interface_cellular_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport(self): + """Test case for get_wan_vpn_interface_ethernet_associated_tracker_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport(self): + """Test case for get_wan_vpn_interface_ethernet_associated_tracker_parcels_for_transport + + """ + pass + + def test_get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport(self): + """Test case for get_wan_vpn_interface_ethernet_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_wan_vpn_profile_parcel_by_parcel_id_for_transport(self): + """Test case for get_wan_vpn_profile_parcel_by_parcel_id_for_transport + + """ + pass + + def test_get_wan_vpn_profile_parcel_for_transport(self): + """Test case for get_wan_vpn_profile_parcel_for_transport + + """ + pass + + def test_get_wirelesslan_profile_parcel_by_parcel_id_for_service(self): + """Test case for get_wirelesslan_profile_parcel_by_parcel_id_for_service + + """ + pass + + def test_get_wirelesslan_profile_parcel_for_service(self): + """Test case for get_wirelesslan_profile_parcel_for_service + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_fqdn_list_builder_api.py b/test/test_configuration_fqdn_list_builder_api.py new file mode 100644 index 0000000..90447d5 --- /dev/null +++ b/test/test_configuration_fqdn_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_fqdn_list_builder_api import ConfigurationFQDNListBuilderApi # noqa: E501 + + +class TestConfigurationFQDNListBuilderApi(unittest.TestCase): + """ConfigurationFQDNListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationFQDNListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list16(self): + """Test case for create_policy_list16 + + """ + pass + + def test_delete_policy_list16(self): + """Test case for delete_policy_list16 + + """ + pass + + def test_delete_policy_lists_with_info_tag16(self): + """Test case for delete_policy_lists_with_info_tag16 + + """ + pass + + def test_edit_policy_list16(self): + """Test case for edit_policy_list16 + + """ + pass + + def test_get_lists_by_id16(self): + """Test case for get_lists_by_id16 + + """ + pass + + def test_get_policy_lists14(self): + """Test case for get_policy_lists14 + + """ + pass + + def test_get_policy_lists_with_info_tag16(self): + """Test case for get_policy_lists_with_info_tag16 + + """ + pass + + def test_preview_policy_list16(self): + """Test case for preview_policy_list16 + + """ + pass + + def test_preview_policy_list_by_id16(self): + """Test case for preview_policy_list_by_id16 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_general_template_api.py b/test/test_configuration_general_template_api.py new file mode 100644 index 0000000..39e9e62 --- /dev/null +++ b/test/test_configuration_general_template_api.py @@ -0,0 +1,149 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_general_template_api import ConfigurationGeneralTemplateApi # noqa: E501 + + +class TestConfigurationGeneralTemplateApi(unittest.TestCase): + """ConfigurationGeneralTemplateApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationGeneralTemplateApi() # noqa: E501 + + def tearDown(self): + pass + + def test_change_template_resource_group(self): + """Test case for change_template_resource_group + + """ + pass + + def test_clone_template(self): + """Test case for clone_template + + """ + pass + + def test_create_feature_template(self): + """Test case for create_feature_template + + """ + pass + + def test_create_li_template(self): + """Test case for create_li_template + + """ + pass + + def test_delete_general_template(self): + """Test case for delete_general_template + + """ + pass + + def test_edit_feature_template(self): + """Test case for edit_feature_template + + """ + pass + + def test_edit_li_template(self): + """Test case for edit_li_template + + """ + pass + + def test_generate_feature_template_list(self): + """Test case for generate_feature_template_list + + """ + pass + + def test_generate_master_template_definition(self): + """Test case for generate_master_template_definition + + """ + pass + + def test_generate_template_by_device_type(self): + """Test case for generate_template_by_device_type + + """ + pass + + def test_generate_template_type_definition(self): + """Test case for generate_template_type_definition + + """ + pass + + def test_generate_template_types(self): + """Test case for generate_template_types + + """ + pass + + def test_get_default_networks(self): + """Test case for get_default_networks + + """ + pass + + def test_get_device_templates_attached_to_feature(self): + """Test case for get_device_templates_attached_to_feature + + """ + pass + + def test_get_encrypted_string(self): + """Test case for get_encrypted_string + + """ + pass + + def test_get_general_template(self): + """Test case for get_general_template + + """ + pass + + def test_get_network_interface(self): + """Test case for get_network_interface + + """ + pass + + def test_get_template_definition(self): + """Test case for get_template_definition + + """ + pass + + def test_get_template_for_migration(self): + """Test case for get_template_for_migration + + """ + pass + + def test_list_li_template(self): + """Test case for list_li_template + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_identity_service_engine_api.py b/test/test_configuration_identity_service_engine_api.py new file mode 100644 index 0000000..46f5167 --- /dev/null +++ b/test/test_configuration_identity_service_engine_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_identity_service_engine_api import ConfigurationIdentityServiceEngineApi # noqa: E501 + + +class TestConfigurationIdentityServiceEngineApi(unittest.TestCase): + """ConfigurationIdentityServiceEngineApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationIdentityServiceEngineApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_all_identity_lists(self): + """Test case for delete_all_identity_lists + + """ + pass + + def test_get_identity_list_reference(self): + """Test case for get_identity_list_reference + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_ise_server_api.py b/test/test_configuration_ise_server_api.py new file mode 100644 index 0000000..1c4ad5a --- /dev/null +++ b/test/test_configuration_ise_server_api.py @@ -0,0 +1,113 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_ise_server_api import ConfigurationIseServerApi # noqa: E501 + + +class TestConfigurationIseServerApi(unittest.TestCase): + """ConfigurationIseServerApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationIseServerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_account_activate(self): + """Test case for account_activate + + """ + pass + + def test_account_create(self): + """Test case for account_create + + """ + pass + + def test_add_ise_server_credentials(self): + """Test case for add_ise_server_credentials + + """ + pass + + def test_approve(self): + """Test case for approve + + """ + pass + + def test_connect1(self): + """Test case for connect1 + + """ + pass + + def test_delete_ise_and_px_grid_account(self): + """Test case for delete_ise_and_px_grid_account + + """ + pass + + def test_delete_px_grid(self): + """Test case for delete_px_grid + + """ + pass + + def test_get_identity_user_groups(self): + """Test case for get_identity_user_groups + + """ + pass + + def test_get_identity_users(self): + """Test case for get_identity_users + + """ + pass + + def test_get_ise_server_credentials(self): + """Test case for get_ise_server_credentials + + """ + pass + + def test_get_p_xgrid_cert(self): + """Test case for get_p_xgrid_cert + + """ + pass + + def test_get_px_grid_account(self): + """Test case for get_px_grid_account + + """ + pass + + def test_sync_vsmart(self): + """Test case for sync_vsmart + + """ + pass + + def test_update_ise_server_credentials(self): + """Test case for update_ise_server_credentials + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_multi_cloud_api.py b/test/test_configuration_multi_cloud_api.py new file mode 100644 index 0000000..240826d --- /dev/null +++ b/test/test_configuration_multi_cloud_api.py @@ -0,0 +1,725 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_multi_cloud_api import ConfigurationMultiCloudApi # noqa: E501 + + +class TestConfigurationMultiCloudApi(unittest.TestCase): + """ConfigurationMultiCloudApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationMultiCloudApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_edge_global_settings(self): + """Test case for add_edge_global_settings + + """ + pass + + def test_add_global_settings(self): + """Test case for add_global_settings + + """ + pass + + def test_attach_sites(self): + """Test case for attach_sites + + """ + pass + + def test_audit(self): + """Test case for audit + + """ + pass + + def test_audit_dry_run(self): + """Test case for audit_dry_run + + """ + pass + + def test_clean_up_all_connectivity_gateways_in_local_db(self): + """Test case for clean_up_all_connectivity_gateways_in_local_db + + """ + pass + + def test_create_cgw(self): + """Test case for create_cgw + + """ + pass + + def test_create_connectivity_gateway(self): + """Test case for create_connectivity_gateway + + """ + pass + + def test_create_device_link(self): + """Test case for create_device_link + + """ + pass + + def test_create_edge_connectivity(self): + """Test case for create_edge_connectivity + + """ + pass + + def test_create_icgw(self): + """Test case for create_icgw + + """ + pass + + def test_create_virtual_wan(self): + """Test case for create_virtual_wan + + """ + pass + + def test_delete_account(self): + """Test case for delete_account + + """ + pass + + def test_delete_cgw(self): + """Test case for delete_cgw + + """ + pass + + def test_delete_connectivity_gateway(self): + """Test case for delete_connectivity_gateway + + """ + pass + + def test_delete_device_link(self): + """Test case for delete_device_link + + """ + pass + + def test_delete_edge_account(self): + """Test case for delete_edge_account + + """ + pass + + def test_delete_edge_account1(self): + """Test case for delete_edge_account1 + + """ + pass + + def test_delete_edge_connectivity(self): + """Test case for delete_edge_connectivity + + """ + pass + + def test_delete_icgw(self): + """Test case for delete_icgw + + """ + pass + + def test_delete_virtual_wan(self): + """Test case for delete_virtual_wan + + """ + pass + + def test_detach_sites1(self): + """Test case for detach_sites1 + + """ + pass + + def test_edge_audit(self): + """Test case for edge_audit + + """ + pass + + def test_edge_audit_dry_run(self): + """Test case for edge_audit_dry_run + + """ + pass + + def test_edit_tag(self): + """Test case for edit_tag + + """ + pass + + def test_get_all_cloud_accounts(self): + """Test case for get_all_cloud_accounts + + """ + pass + + def test_get_azure_network_virtual_appliances(self): + """Test case for get_azure_network_virtual_appliances + + """ + pass + + def test_get_azure_nva_sku_list(self): + """Test case for get_azure_nva_sku_list + + """ + pass + + def test_get_azure_resource_groups(self): + """Test case for get_azure_resource_groups + + """ + pass + + def test_get_azure_virtual_hubs(self): + """Test case for get_azure_virtual_hubs + + """ + pass + + def test_get_azure_virtual_wans(self): + """Test case for get_azure_virtual_wans + + """ + pass + + def test_get_cgw_associated_mappings(self): + """Test case for get_cgw_associated_mappings + + """ + pass + + def test_get_cgw_custom_setting_details(self): + """Test case for get_cgw_custom_setting_details + + """ + pass + + def test_get_cgw_details(self): + """Test case for get_cgw_details + + """ + pass + + def test_get_cgw_org_resources(self): + """Test case for get_cgw_org_resources + + """ + pass + + def test_get_cgw_types(self): + """Test case for get_cgw_types + + """ + pass + + def test_get_cgws(self): + """Test case for get_cgws + + """ + pass + + def test_get_cloud_account_details(self): + """Test case for get_cloud_account_details + + """ + pass + + def test_get_cloud_connected_sites(self): + """Test case for get_cloud_connected_sites + + """ + pass + + def test_get_cloud_connected_sites1(self): + """Test case for get_cloud_connected_sites1 + + """ + pass + + def test_get_cloud_devices(self): + """Test case for get_cloud_devices + + """ + pass + + def test_get_cloud_devices1(self): + """Test case for get_cloud_devices1 + + """ + pass + + def test_get_cloud_gateways(self): + """Test case for get_cloud_gateways + + """ + pass + + def test_get_cloud_regions(self): + """Test case for get_cloud_regions + + """ + pass + + def test_get_cloud_routers_and_attachments(self): + """Test case for get_cloud_routers_and_attachments + + """ + pass + + def test_get_cloud_types(self): + """Test case for get_cloud_types + + """ + pass + + def test_get_cloud_widget(self): + """Test case for get_cloud_widget + + """ + pass + + def test_get_connectivity_gateway_creation_options(self): + """Test case for get_connectivity_gateway_creation_options + + """ + pass + + def test_get_connectivity_gateways(self): + """Test case for get_connectivity_gateways + + """ + pass + + def test_get_dashboard_edge_info(self): + """Test case for get_dashboard_edge_info + + """ + pass + + def test_get_default_mapping_values(self): + """Test case for get_default_mapping_values + + """ + pass + + def test_get_device_link_metro_speed(self): + """Test case for get_device_link_metro_speed + + """ + pass + + def test_get_device_links(self): + """Test case for get_device_links + + """ + pass + + def test_get_dl_port_speed(self): + """Test case for get_dl_port_speed + + """ + pass + + def test_get_edge_account_details(self): + """Test case for get_edge_account_details + + """ + pass + + def test_get_edge_accounts(self): + """Test case for get_edge_accounts + + """ + pass + + def test_get_edge_billing_accounts(self): + """Test case for get_edge_billing_accounts + + """ + pass + + def test_get_edge_connectivity_detail_by_name(self): + """Test case for get_edge_connectivity_detail_by_name + + """ + pass + + def test_get_edge_connectivity_details(self): + """Test case for get_edge_connectivity_details + + """ + pass + + def test_get_edge_gateways(self): + """Test case for get_edge_gateways + + """ + pass + + def test_get_edge_global_settings(self): + """Test case for get_edge_global_settings + + """ + pass + + def test_get_edge_locations_info(self): + """Test case for get_edge_locations_info + + """ + pass + + def test_get_edge_mapping_tags(self): + """Test case for get_edge_mapping_tags + + """ + pass + + def test_get_edge_types(self): + """Test case for get_edge_types + + """ + pass + + def test_get_edge_wan_devices(self): + """Test case for get_edge_wan_devices + + """ + pass + + def test_get_edge_widget(self): + """Test case for get_edge_widget + + """ + pass + + def test_get_global_settings(self): + """Test case for get_global_settings + + """ + pass + + def test_get_host_vpcs(self): + """Test case for get_host_vpcs + + """ + pass + + def test_get_icgw_custom_setting_details(self): + """Test case for get_icgw_custom_setting_details + + """ + pass + + def test_get_icgw_details(self): + """Test case for get_icgw_details + + """ + pass + + def test_get_icgw_types(self): + """Test case for get_icgw_types + + """ + pass + + def test_get_icgws(self): + """Test case for get_icgws + + """ + pass + + def test_get_licenses(self): + """Test case for get_licenses + + """ + pass + + def test_get_mapping_matrix(self): + """Test case for get_mapping_matrix + + """ + pass + + def test_get_mapping_status(self): + """Test case for get_mapping_status + + """ + pass + + def test_get_mapping_summary(self): + """Test case for get_mapping_summary + + """ + pass + + def test_get_mapping_tags(self): + """Test case for get_mapping_tags + + """ + pass + + def test_get_mapping_vpns(self): + """Test case for get_mapping_vpns + + """ + pass + + def test_get_nva_security_rules(self): + """Test case for get_nva_security_rules + + """ + pass + + def test_get_partner_ports(self): + """Test case for get_partner_ports + + """ + pass + + def test_get_port_speed(self): + """Test case for get_port_speed + + """ + pass + + def test_get_post_aggregation_data_by_query25(self): + """Test case for get_post_aggregation_data_by_query25 + + """ + pass + + def test_get_sites(self): + """Test case for get_sites + + """ + pass + + def test_get_sites1(self): + """Test case for get_sites1 + + """ + pass + + def test_get_ssh_key_list(self): + """Test case for get_ssh_key_list + + """ + pass + + def test_get_supported_edge_image_names(self): + """Test case for get_supported_edge_image_names + + """ + pass + + def test_get_supported_edge_instance_size(self): + """Test case for get_supported_edge_instance_size + + """ + pass + + def test_get_supported_instance_size(self): + """Test case for get_supported_instance_size + + """ + pass + + def test_get_supported_loopback_cgw_colors(self): + """Test case for get_supported_loopback_cgw_colors + + """ + pass + + def test_get_supported_loopback_transport_colors(self): + """Test case for get_supported_loopback_transport_colors + + """ + pass + + def test_get_supported_software_image_list(self): + """Test case for get_supported_software_image_list + + """ + pass + + def test_get_tunnel_names(self): + """Test case for get_tunnel_names + + """ + pass + + def test_get_v_hubs(self): + """Test case for get_v_hubs + + """ + pass + + def test_get_v_wans(self): + """Test case for get_v_wans + + """ + pass + + def test_get_vpc_tags(self): + """Test case for get_vpc_tags + + """ + pass + + def test_get_wan_devices(self): + """Test case for get_wan_devices + + """ + pass + + def test_get_wan_interface_colors(self): + """Test case for get_wan_interface_colors + + """ + pass + + def test_hostvpc_tagging(self): + """Test case for hostvpc_tagging + + """ + pass + + def test_process_mapping(self): + """Test case for process_mapping + + """ + pass + + def test_telemetry(self): + """Test case for telemetry + + """ + pass + + def test_tunnel_scaling(self): + """Test case for tunnel_scaling + + """ + pass + + def test_un_tag(self): + """Test case for un_tag + + """ + pass + + def test_update_account(self): + """Test case for update_account + + """ + pass + + def test_update_cgw(self): + """Test case for update_cgw + + """ + pass + + def test_update_device_link(self): + """Test case for update_device_link + + """ + pass + + def test_update_edge_account(self): + """Test case for update_edge_account + + """ + pass + + def test_update_edge_connectivity(self): + """Test case for update_edge_connectivity + + """ + pass + + def test_update_edge_global_settings(self): + """Test case for update_edge_global_settings + + """ + pass + + def test_update_edge_locations_info(self): + """Test case for update_edge_locations_info + + """ + pass + + def test_update_global_settings(self): + """Test case for update_global_settings + + """ + pass + + def test_update_icgw(self): + """Test case for update_icgw + + """ + pass + + def test_update_nva_security_rules(self): + """Test case for update_nva_security_rules + + """ + pass + + def test_validate_account_add(self): + """Test case for validate_account_add + + """ + pass + + def test_validate_account_update_credentials(self): + """Test case for validate_account_update_credentials + + """ + pass + + def test_validate_edge_account_add(self): + """Test case for validate_edge_account_add + + """ + pass + + def test_validate_edge_account_update_credentials(self): + """Test case for validate_edge_account_update_credentials + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_multidomain_policy_api.py b/test/test_configuration_multidomain_policy_api.py new file mode 100644 index 0000000..50360df --- /dev/null +++ b/test/test_configuration_multidomain_policy_api.py @@ -0,0 +1,113 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_multidomain_policy_api import ConfigurationMultidomainPolicyApi # noqa: E501 + + +class TestConfigurationMultidomainPolicyApi(unittest.TestCase): + """ConfigurationMultidomainPolicyApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationMultidomainPolicyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_internal_policy(self): + """Test case for add_internal_policy + + """ + pass + + def test_attach_devices(self): + """Test case for attach_devices + + """ + pass + + def test_detach_devices(self): + """Test case for detach_devices + + """ + pass + + def test_disconnect_from_mdp(self): + """Test case for disconnect_from_mdp + + """ + pass + + def test_edit_attached_devices(self): + """Test case for edit_attached_devices + + """ + pass + + def test_get_mdp_onboarding_status(self): + """Test case for get_mdp_onboarding_status + + """ + pass + + def test_offboard(self): + """Test case for offboard + + """ + pass + + def test_onboard_mdp(self): + """Test case for onboard_mdp + + """ + pass + + def test_retrieve_mdp_attached_devices(self): + """Test case for retrieve_mdp_attached_devices + + """ + pass + + def test_retrieve_mdp_config_object(self): + """Test case for retrieve_mdp_config_object + + """ + pass + + def test_retrieve_mdp_policies(self): + """Test case for retrieve_mdp_policies + + """ + pass + + def test_retrieve_mdp_supported_devices_(self): + """Test case for retrieve_mdp_supported_devices_ + + """ + pass + + def test_update_onboarding_payload(self): + """Test case for update_onboarding_payload + + """ + pass + + def test_update_policy_status(self): + """Test case for update_policy_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_network_design_api.py b/test/test_configuration_network_design_api.py new file mode 100644 index 0000000..1e95b57 --- /dev/null +++ b/test/test_configuration_network_design_api.py @@ -0,0 +1,119 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_network_design_api import ConfigurationNetworkDesignApi # noqa: E501 + + +class TestConfigurationNetworkDesignApi(unittest.TestCase): + """ConfigurationNetworkDesignApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationNetworkDesignApi() # noqa: E501 + + def tearDown(self): + pass + + def test_acquire_attach_lock(self): + """Test case for acquire_attach_lock + + """ + pass + + def test_acquire_edit_lock(self): + """Test case for acquire_edit_lock + + """ + pass + + def test_create_network_design(self): + """Test case for create_network_design + + """ + pass + + def test_edit_network_design(self): + """Test case for edit_network_design + + """ + pass + + def test_get_device_profile_config_status(self): + """Test case for get_device_profile_config_status + + """ + pass + + def test_get_device_profile_config_status_by_profile_id(self): + """Test case for get_device_profile_config_status_by_profile_id + + """ + pass + + def test_get_device_profile_task_count(self): + """Test case for get_device_profile_task_count + + """ + pass + + def test_get_device_profile_task_status(self): + """Test case for get_device_profile_task_status + + """ + pass + + def test_get_device_profile_task_status_by_profile_id(self): + """Test case for get_device_profile_task_status_by_profile_id + + """ + pass + + def test_get_global_parameters(self): + """Test case for get_global_parameters + + """ + pass + + def test_get_network_design(self): + """Test case for get_network_design + + """ + pass + + def test_get_service_profile_config(self): + """Test case for get_service_profile_config + + """ + pass + + def test_push_device_profile_template(self): + """Test case for push_device_profile_template + + """ + pass + + def test_push_network_design(self): + """Test case for push_network_design + + """ + pass + + def test_run_my_test(self): + """Test case for run_my_test + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_network_design_templates_api.py b/test/test_configuration_network_design_templates_api.py new file mode 100644 index 0000000..405d533 --- /dev/null +++ b/test/test_configuration_network_design_templates_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_network_design_templates_api import ConfigurationNetworkDesignTemplatesApi # noqa: E501 + + +class TestConfigurationNetworkDesignTemplatesApi(unittest.TestCase): + """ConfigurationNetworkDesignTemplatesApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationNetworkDesignTemplatesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_edit_device_profile_template(self): + """Test case for edit_device_profile_template + + """ + pass + + def test_edit_global_template(self): + """Test case for edit_global_template + + """ + pass + + def test_generate_profile_template_list(self): + """Test case for generate_profile_template_list + + """ + pass + + def test_get_device_profile_feature_template_list(self): + """Test case for get_device_profile_feature_template_list + + """ + pass + + def test_get_device_profile_template(self): + """Test case for get_device_profile_template + + """ + pass + + def test_get_global_template(self): + """Test case for get_global_template + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_access_list_definition_builder_api.py b/test/test_configuration_policy_access_list_definition_builder_api.py new file mode 100644 index 0000000..554344d --- /dev/null +++ b/test/test_configuration_policy_access_list_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_access_list_definition_builder_api import ConfigurationPolicyAccessListDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyAccessListDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyAccessListDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyAccessListDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition8(self): + """Test case for create_policy_definition8 + + """ + pass + + def test_delete_policy_definition8(self): + """Test case for delete_policy_definition8 + + """ + pass + + def test_edit_multiple_policy_definition8(self): + """Test case for edit_multiple_policy_definition8 + + """ + pass + + def test_edit_policy_definition8(self): + """Test case for edit_policy_definition8 + + """ + pass + + def test_get_definitions8(self): + """Test case for get_definitions8 + + """ + pass + + def test_get_policy_definition8(self): + """Test case for get_policy_definition8 + + """ + pass + + def test_preview_policy_definition8(self): + """Test case for preview_policy_definition8 + + """ + pass + + def test_preview_policy_definition_by_id8(self): + """Test case for preview_policy_definition_by_id8 + + """ + pass + + def test_save_policy_definition_in_bulk8(self): + """Test case for save_policy_definition_in_bulk8 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_amp_definition_builder_api.py b/test/test_configuration_policy_amp_definition_builder_api.py new file mode 100644 index 0000000..09addca --- /dev/null +++ b/test/test_configuration_policy_amp_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_amp_definition_builder_api import ConfigurationPolicyAMPDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyAMPDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyAMPDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyAMPDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition11(self): + """Test case for create_policy_definition11 + + """ + pass + + def test_delete_policy_definition11(self): + """Test case for delete_policy_definition11 + + """ + pass + + def test_edit_multiple_policy_definition11(self): + """Test case for edit_multiple_policy_definition11 + + """ + pass + + def test_edit_policy_definition11(self): + """Test case for edit_policy_definition11 + + """ + pass + + def test_get_definitions11(self): + """Test case for get_definitions11 + + """ + pass + + def test_get_policy_definition11(self): + """Test case for get_policy_definition11 + + """ + pass + + def test_preview_policy_definition11(self): + """Test case for preview_policy_definition11 + + """ + pass + + def test_preview_policy_definition_by_id11(self): + """Test case for preview_policy_definition_by_id11 + + """ + pass + + def test_save_policy_definition_in_bulk11(self): + """Test case for save_policy_definition_in_bulk11 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_app_probe_class_list_builder_api.py b/test/test_configuration_policy_app_probe_class_list_builder_api.py new file mode 100644 index 0000000..bdcd0ef --- /dev/null +++ b/test/test_configuration_policy_app_probe_class_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_app_probe_class_list_builder_api import ConfigurationPolicyAppProbeClassListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyAppProbeClassListBuilderApi(unittest.TestCase): + """ConfigurationPolicyAppProbeClassListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyAppProbeClassListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list4(self): + """Test case for create_policy_list4 + + """ + pass + + def test_delete_policy_list4(self): + """Test case for delete_policy_list4 + + """ + pass + + def test_delete_policy_lists_with_info_tag4(self): + """Test case for delete_policy_lists_with_info_tag4 + + """ + pass + + def test_edit_policy_list4(self): + """Test case for edit_policy_list4 + + """ + pass + + def test_get_lists_by_id4(self): + """Test case for get_lists_by_id4 + + """ + pass + + def test_get_policy_lists4(self): + """Test case for get_policy_lists4 + + """ + pass + + def test_get_policy_lists_with_info_tag4(self): + """Test case for get_policy_lists_with_info_tag4 + + """ + pass + + def test_preview_policy_list4(self): + """Test case for preview_policy_list4 + + """ + pass + + def test_preview_policy_list_by_id4(self): + """Test case for preview_policy_list_by_id4 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_app_route_definition_builder_api.py b/test/test_configuration_policy_app_route_definition_builder_api.py new file mode 100644 index 0000000..f0d76be --- /dev/null +++ b/test/test_configuration_policy_app_route_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_app_route_definition_builder_api import ConfigurationPolicyAppRouteDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyAppRouteDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyAppRouteDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyAppRouteDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition12(self): + """Test case for create_policy_definition12 + + """ + pass + + def test_delete_policy_definition12(self): + """Test case for delete_policy_definition12 + + """ + pass + + def test_edit_multiple_policy_definition12(self): + """Test case for edit_multiple_policy_definition12 + + """ + pass + + def test_edit_policy_definition12(self): + """Test case for edit_policy_definition12 + + """ + pass + + def test_get_definitions12(self): + """Test case for get_definitions12 + + """ + pass + + def test_get_policy_definition12(self): + """Test case for get_policy_definition12 + + """ + pass + + def test_preview_policy_definition12(self): + """Test case for preview_policy_definition12 + + """ + pass + + def test_preview_policy_definition_by_id12(self): + """Test case for preview_policy_definition_by_id12 + + """ + pass + + def test_save_policy_definition_in_bulk12(self): + """Test case for save_policy_definition_in_bulk12 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_application_list_builder_api.py b/test/test_configuration_policy_application_list_builder_api.py new file mode 100644 index 0000000..bbc81b2 --- /dev/null +++ b/test/test_configuration_policy_application_list_builder_api.py @@ -0,0 +1,137 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_application_list_builder_api import ConfigurationPolicyApplicationListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyApplicationListBuilderApi(unittest.TestCase): + """ConfigurationPolicyApplicationListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyApplicationListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list22(self): + """Test case for create_policy_list22 + + """ + pass + + def test_create_policy_list3(self): + """Test case for create_policy_list3 + + """ + pass + + def test_delete_policy_list22(self): + """Test case for delete_policy_list22 + + """ + pass + + def test_delete_policy_list3(self): + """Test case for delete_policy_list3 + + """ + pass + + def test_delete_policy_lists_with_info_tag22(self): + """Test case for delete_policy_lists_with_info_tag22 + + """ + pass + + def test_delete_policy_lists_with_info_tag3(self): + """Test case for delete_policy_lists_with_info_tag3 + + """ + pass + + def test_edit_policy_list22(self): + """Test case for edit_policy_list22 + + """ + pass + + def test_edit_policy_list3(self): + """Test case for edit_policy_list3 + + """ + pass + + def test_get_lists_by_id22(self): + """Test case for get_lists_by_id22 + + """ + pass + + def test_get_lists_by_id3(self): + """Test case for get_lists_by_id3 + + """ + pass + + def test_get_policy_lists19(self): + """Test case for get_policy_lists19 + + """ + pass + + def test_get_policy_lists3(self): + """Test case for get_policy_lists3 + + """ + pass + + def test_get_policy_lists_with_info_tag22(self): + """Test case for get_policy_lists_with_info_tag22 + + """ + pass + + def test_get_policy_lists_with_info_tag3(self): + """Test case for get_policy_lists_with_info_tag3 + + """ + pass + + def test_preview_policy_list22(self): + """Test case for preview_policy_list22 + + """ + pass + + def test_preview_policy_list3(self): + """Test case for preview_policy_list3 + + """ + pass + + def test_preview_policy_list_by_id22(self): + """Test case for preview_policy_list_by_id22 + + """ + pass + + def test_preview_policy_list_by_id3(self): + """Test case for preview_policy_list_by_id3 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_as_path_list_builder_api.py b/test/test_configuration_policy_as_path_list_builder_api.py new file mode 100644 index 0000000..ba21272 --- /dev/null +++ b/test/test_configuration_policy_as_path_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_as_path_list_builder_api import ConfigurationPolicyASPathListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyASPathListBuilderApi(unittest.TestCase): + """ConfigurationPolicyASPathListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyASPathListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list5(self): + """Test case for create_policy_list5 + + """ + pass + + def test_delete_policy_list5(self): + """Test case for delete_policy_list5 + + """ + pass + + def test_delete_policy_lists_with_info_tag5(self): + """Test case for delete_policy_lists_with_info_tag5 + + """ + pass + + def test_edit_policy_list5(self): + """Test case for edit_policy_list5 + + """ + pass + + def test_get_lists_by_id5(self): + """Test case for get_lists_by_id5 + + """ + pass + + def test_get_policy_lists5(self): + """Test case for get_policy_lists5 + + """ + pass + + def test_get_policy_lists_with_info_tag5(self): + """Test case for get_policy_lists_with_info_tag5 + + """ + pass + + def test_preview_policy_list5(self): + """Test case for preview_policy_list5 + + """ + pass + + def test_preview_policy_list_by_id5(self): + """Test case for preview_policy_list_by_id5 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_cflowd_definition_builder_api.py b/test/test_configuration_policy_cflowd_definition_builder_api.py new file mode 100644 index 0000000..ab350a1 --- /dev/null +++ b/test/test_configuration_policy_cflowd_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_cflowd_definition_builder_api import ConfigurationPolicyCflowdDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyCflowdDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyCflowdDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyCflowdDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition13(self): + """Test case for create_policy_definition13 + + """ + pass + + def test_delete_policy_definition13(self): + """Test case for delete_policy_definition13 + + """ + pass + + def test_edit_multiple_policy_definition13(self): + """Test case for edit_multiple_policy_definition13 + + """ + pass + + def test_edit_policy_definition13(self): + """Test case for edit_policy_definition13 + + """ + pass + + def test_get_definitions13(self): + """Test case for get_definitions13 + + """ + pass + + def test_get_policy_definition13(self): + """Test case for get_policy_definition13 + + """ + pass + + def test_preview_policy_definition13(self): + """Test case for preview_policy_definition13 + + """ + pass + + def test_preview_policy_definition_by_id13(self): + """Test case for preview_policy_definition_by_id13 + + """ + pass + + def test_save_policy_definition_in_bulk13(self): + """Test case for save_policy_definition_in_bulk13 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_cloud_application_builder_api.py b/test/test_configuration_policy_cloud_application_builder_api.py new file mode 100644 index 0000000..9ca5d45 --- /dev/null +++ b/test/test_configuration_policy_cloud_application_builder_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_cloud_application_builder_api import ConfigurationPolicyCloudApplicationBuilderApi # noqa: E501 + + +class TestConfigurationPolicyCloudApplicationBuilderApi(unittest.TestCase): + """ConfigurationPolicyCloudApplicationBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyCloudApplicationBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_cloud_discovered_apps(self): + """Test case for get_cloud_discovered_apps + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_color_list_builder_api.py b/test/test_configuration_policy_color_list_builder_api.py new file mode 100644 index 0000000..833a259 --- /dev/null +++ b/test/test_configuration_policy_color_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_color_list_builder_api import ConfigurationPolicyColorListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyColorListBuilderApi(unittest.TestCase): + """ConfigurationPolicyColorListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyColorListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list6(self): + """Test case for create_policy_list6 + + """ + pass + + def test_delete_policy_list6(self): + """Test case for delete_policy_list6 + + """ + pass + + def test_delete_policy_lists_with_info_tag6(self): + """Test case for delete_policy_lists_with_info_tag6 + + """ + pass + + def test_edit_policy_list6(self): + """Test case for edit_policy_list6 + + """ + pass + + def test_get_lists_by_id6(self): + """Test case for get_lists_by_id6 + + """ + pass + + def test_get_policy_lists6(self): + """Test case for get_policy_lists6 + + """ + pass + + def test_get_policy_lists_with_info_tag6(self): + """Test case for get_policy_lists_with_info_tag6 + + """ + pass + + def test_preview_policy_list6(self): + """Test case for preview_policy_list6 + + """ + pass + + def test_preview_policy_list_by_id6(self): + """Test case for preview_policy_list_by_id6 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_community_list_builder_api.py b/test/test_configuration_policy_community_list_builder_api.py new file mode 100644 index 0000000..4e9156e --- /dev/null +++ b/test/test_configuration_policy_community_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_community_list_builder_api import ConfigurationPolicyCommunityListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyCommunityListBuilderApi(unittest.TestCase): + """ConfigurationPolicyCommunityListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyCommunityListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list7(self): + """Test case for create_policy_list7 + + """ + pass + + def test_delete_policy_list7(self): + """Test case for delete_policy_list7 + + """ + pass + + def test_delete_policy_lists_with_info_tag7(self): + """Test case for delete_policy_lists_with_info_tag7 + + """ + pass + + def test_edit_policy_list7(self): + """Test case for edit_policy_list7 + + """ + pass + + def test_get_lists_by_id7(self): + """Test case for get_lists_by_id7 + + """ + pass + + def test_get_policy_lists7(self): + """Test case for get_policy_lists7 + + """ + pass + + def test_get_policy_lists_with_info_tag7(self): + """Test case for get_policy_lists_with_info_tag7 + + """ + pass + + def test_preview_policy_list7(self): + """Test case for preview_policy_list7 + + """ + pass + + def test_preview_policy_list_by_id7(self): + """Test case for preview_policy_list_by_id7 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_control_definition_builder_api.py b/test/test_configuration_policy_control_definition_builder_api.py new file mode 100644 index 0000000..3830fbb --- /dev/null +++ b/test/test_configuration_policy_control_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_control_definition_builder_api import ConfigurationPolicyControlDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyControlDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyControlDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyControlDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition14(self): + """Test case for create_policy_definition14 + + """ + pass + + def test_delete_policy_definition14(self): + """Test case for delete_policy_definition14 + + """ + pass + + def test_edit_multiple_policy_definition14(self): + """Test case for edit_multiple_policy_definition14 + + """ + pass + + def test_edit_policy_definition14(self): + """Test case for edit_policy_definition14 + + """ + pass + + def test_get_definitions14(self): + """Test case for get_definitions14 + + """ + pass + + def test_get_policy_definition14(self): + """Test case for get_policy_definition14 + + """ + pass + + def test_preview_policy_definition14(self): + """Test case for preview_policy_definition14 + + """ + pass + + def test_preview_policy_definition_by_id14(self): + """Test case for preview_policy_definition_by_id14 + + """ + pass + + def test_save_policy_definition_in_bulk14(self): + """Test case for save_policy_definition_in_bulk14 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_custom_application_builder_api.py b/test/test_configuration_policy_custom_application_builder_api.py new file mode 100644 index 0000000..49dd3c6 --- /dev/null +++ b/test/test_configuration_policy_custom_application_builder_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_custom_application_builder_api import ConfigurationPolicyCustomApplicationBuilderApi # noqa: E501 + + +class TestConfigurationPolicyCustomApplicationBuilderApi(unittest.TestCase): + """ConfigurationPolicyCustomApplicationBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyCustomApplicationBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_custom_app(self): + """Test case for create_custom_app + + """ + pass + + def test_delete_custom_app(self): + """Test case for delete_custom_app + + """ + pass + + def test_edit_custom_app(self): + """Test case for edit_custom_app + + """ + pass + + def test_get_custom_app_by_id(self): + """Test case for get_custom_app_by_id + + """ + pass + + def test_get_custom_apps(self): + """Test case for get_custom_apps + + """ + pass + + def test_map_traffic_profiles(self): + """Test case for map_traffic_profiles + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_data_definition_builder_api.py b/test/test_configuration_policy_data_definition_builder_api.py new file mode 100644 index 0000000..103c735 --- /dev/null +++ b/test/test_configuration_policy_data_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_data_definition_builder_api import ConfigurationPolicyDataDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDataDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyDataDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDataDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition15(self): + """Test case for create_policy_definition15 + + """ + pass + + def test_delete_policy_definition15(self): + """Test case for delete_policy_definition15 + + """ + pass + + def test_edit_multiple_policy_definition15(self): + """Test case for edit_multiple_policy_definition15 + + """ + pass + + def test_edit_policy_definition15(self): + """Test case for edit_policy_definition15 + + """ + pass + + def test_get_definitions15(self): + """Test case for get_definitions15 + + """ + pass + + def test_get_policy_definition15(self): + """Test case for get_policy_definition15 + + """ + pass + + def test_preview_policy_definition15(self): + """Test case for preview_policy_definition15 + + """ + pass + + def test_preview_policy_definition_by_id15(self): + """Test case for preview_policy_definition_by_id15 + + """ + pass + + def test_save_policy_definition_in_bulk15(self): + """Test case for save_policy_definition_in_bulk15 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_data_ipv6_prefix_list_builder_api.py b/test/test_configuration_policy_data_ipv6_prefix_list_builder_api.py new file mode 100644 index 0000000..4733122 --- /dev/null +++ b/test/test_configuration_policy_data_ipv6_prefix_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_data_ipv6_prefix_list_builder_api import ConfigurationPolicyDataIPV6PrefixListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDataIPV6PrefixListBuilderApi(unittest.TestCase): + """ConfigurationPolicyDataIPV6PrefixListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDataIPV6PrefixListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list8(self): + """Test case for create_policy_list8 + + """ + pass + + def test_delete_policy_list8(self): + """Test case for delete_policy_list8 + + """ + pass + + def test_delete_policy_lists_with_info_tag8(self): + """Test case for delete_policy_lists_with_info_tag8 + + """ + pass + + def test_edit_policy_list8(self): + """Test case for edit_policy_list8 + + """ + pass + + def test_get_lists_by_id8(self): + """Test case for get_lists_by_id8 + + """ + pass + + def test_get_policy_lists8(self): + """Test case for get_policy_lists8 + + """ + pass + + def test_get_policy_lists_with_info_tag8(self): + """Test case for get_policy_lists_with_info_tag8 + + """ + pass + + def test_preview_policy_list8(self): + """Test case for preview_policy_list8 + + """ + pass + + def test_preview_policy_list_by_id8(self): + """Test case for preview_policy_list_by_id8 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_data_prefix_all_types_of_lists_builder_api.py b/test/test_configuration_policy_data_prefix_all_types_of_lists_builder_api.py new file mode 100644 index 0000000..5e92e9a --- /dev/null +++ b/test/test_configuration_policy_data_prefix_all_types_of_lists_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_data_prefix_all_types_of_lists_builder_api import ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi(unittest.TestCase): + """ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDataPrefixAllTypesOfListsBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list9(self): + """Test case for create_policy_list9 + + """ + pass + + def test_delete_policy_list9(self): + """Test case for delete_policy_list9 + + """ + pass + + def test_delete_policy_lists_with_info_tag9(self): + """Test case for delete_policy_lists_with_info_tag9 + + """ + pass + + def test_edit_policy_list9(self): + """Test case for edit_policy_list9 + + """ + pass + + def test_get_lists_by_id9(self): + """Test case for get_lists_by_id9 + + """ + pass + + def test_get_lists_for_all_data_prefixes(self): + """Test case for get_lists_for_all_data_prefixes + + """ + pass + + def test_get_policy_lists_with_info_tag9(self): + """Test case for get_policy_lists_with_info_tag9 + + """ + pass + + def test_preview_policy_list9(self): + """Test case for preview_policy_list9 + + """ + pass + + def test_preview_policy_list_by_id9(self): + """Test case for preview_policy_list_by_id9 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py b/test/test_configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py new file mode 100644 index 0000000..4a2eb66 --- /dev/null +++ b/test/test_configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_data_prefix_and_fqdn_all_types_of_lists_builder_api import ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi(unittest.TestCase): + """ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDataPrefixAndFQDNAllTypesOfListsBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list15(self): + """Test case for create_policy_list15 + + """ + pass + + def test_delete_policy_list15(self): + """Test case for delete_policy_list15 + + """ + pass + + def test_delete_policy_lists_with_info_tag15(self): + """Test case for delete_policy_lists_with_info_tag15 + + """ + pass + + def test_edit_policy_list15(self): + """Test case for edit_policy_list15 + + """ + pass + + def test_get_all_data_prefix_and_fqdn_lists(self): + """Test case for get_all_data_prefix_and_fqdn_lists + + """ + pass + + def test_get_lists_by_id15(self): + """Test case for get_lists_by_id15 + + """ + pass + + def test_get_policy_lists_with_info_tag15(self): + """Test case for get_policy_lists_with_info_tag15 + + """ + pass + + def test_preview_policy_list15(self): + """Test case for preview_policy_list15 + + """ + pass + + def test_preview_policy_list_by_id15(self): + """Test case for preview_policy_list_by_id15 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_data_prefix_list_builder_api.py b/test/test_configuration_policy_data_prefix_list_builder_api.py new file mode 100644 index 0000000..e6185a0 --- /dev/null +++ b/test/test_configuration_policy_data_prefix_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_data_prefix_list_builder_api import ConfigurationPolicyDataPrefixListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDataPrefixListBuilderApi(unittest.TestCase): + """ConfigurationPolicyDataPrefixListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDataPrefixListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list10(self): + """Test case for create_policy_list10 + + """ + pass + + def test_delete_policy_list10(self): + """Test case for delete_policy_list10 + + """ + pass + + def test_delete_policy_lists_with_info_tag10(self): + """Test case for delete_policy_lists_with_info_tag10 + + """ + pass + + def test_edit_policy_list10(self): + """Test case for edit_policy_list10 + + """ + pass + + def test_get_lists_by_id10(self): + """Test case for get_lists_by_id10 + + """ + pass + + def test_get_policy_lists9(self): + """Test case for get_policy_lists9 + + """ + pass + + def test_get_policy_lists_with_info_tag10(self): + """Test case for get_policy_lists_with_info_tag10 + + """ + pass + + def test_preview_policy_list10(self): + """Test case for preview_policy_list10 + + """ + pass + + def test_preview_policy_list_by_id10(self): + """Test case for preview_policy_list_by_id10 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_device_access_definition_builder_api.py b/test/test_configuration_policy_device_access_definition_builder_api.py new file mode 100644 index 0000000..02964b8 --- /dev/null +++ b/test/test_configuration_policy_device_access_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_device_access_definition_builder_api import ConfigurationPolicyDeviceAccessDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDeviceAccessDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyDeviceAccessDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDeviceAccessDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition16(self): + """Test case for create_policy_definition16 + + """ + pass + + def test_delete_policy_definition16(self): + """Test case for delete_policy_definition16 + + """ + pass + + def test_edit_multiple_policy_definition16(self): + """Test case for edit_multiple_policy_definition16 + + """ + pass + + def test_edit_policy_definition16(self): + """Test case for edit_policy_definition16 + + """ + pass + + def test_get_definitions16(self): + """Test case for get_definitions16 + + """ + pass + + def test_get_policy_definition16(self): + """Test case for get_policy_definition16 + + """ + pass + + def test_preview_policy_definition16(self): + """Test case for preview_policy_definition16 + + """ + pass + + def test_preview_policy_definition_by_id16(self): + """Test case for preview_policy_definition_by_id16 + + """ + pass + + def test_save_policy_definition_in_bulk16(self): + """Test case for save_policy_definition_in_bulk16 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_dial_peer_definition_builder_api.py b/test/test_configuration_policy_dial_peer_definition_builder_api.py new file mode 100644 index 0000000..47b400c --- /dev/null +++ b/test/test_configuration_policy_dial_peer_definition_builder_api.py @@ -0,0 +1,137 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_dial_peer_definition_builder_api import ConfigurationPolicyDialPeerDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyDialPeerDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyDialPeerDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyDialPeerDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition25(self): + """Test case for create_policy_definition25 + + """ + pass + + def test_create_policy_definition30(self): + """Test case for create_policy_definition30 + + """ + pass + + def test_delete_policy_definition25(self): + """Test case for delete_policy_definition25 + + """ + pass + + def test_delete_policy_definition30(self): + """Test case for delete_policy_definition30 + + """ + pass + + def test_edit_multiple_policy_definition25(self): + """Test case for edit_multiple_policy_definition25 + + """ + pass + + def test_edit_multiple_policy_definition30(self): + """Test case for edit_multiple_policy_definition30 + + """ + pass + + def test_edit_policy_definition25(self): + """Test case for edit_policy_definition25 + + """ + pass + + def test_edit_policy_definition30(self): + """Test case for edit_policy_definition30 + + """ + pass + + def test_get_definitions25(self): + """Test case for get_definitions25 + + """ + pass + + def test_get_definitions30(self): + """Test case for get_definitions30 + + """ + pass + + def test_get_policy_definition25(self): + """Test case for get_policy_definition25 + + """ + pass + + def test_get_policy_definition30(self): + """Test case for get_policy_definition30 + + """ + pass + + def test_preview_policy_definition25(self): + """Test case for preview_policy_definition25 + + """ + pass + + def test_preview_policy_definition30(self): + """Test case for preview_policy_definition30 + + """ + pass + + def test_preview_policy_definition_by_id25(self): + """Test case for preview_policy_definition_by_id25 + + """ + pass + + def test_preview_policy_definition_by_id30(self): + """Test case for preview_policy_definition_by_id30 + + """ + pass + + def test_save_policy_definition_in_bulk25(self): + """Test case for save_policy_definition_in_bulk25 + + """ + pass + + def test_save_policy_definition_in_bulk30(self): + """Test case for save_policy_definition_in_bulk30 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_expanded_community_list_builder_api.py b/test/test_configuration_policy_expanded_community_list_builder_api.py new file mode 100644 index 0000000..28c64e2 --- /dev/null +++ b/test/test_configuration_policy_expanded_community_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_expanded_community_list_builder_api import ConfigurationPolicyExpandedCommunityListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyExpandedCommunityListBuilderApi(unittest.TestCase): + """ConfigurationPolicyExpandedCommunityListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyExpandedCommunityListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list11(self): + """Test case for create_policy_list11 + + """ + pass + + def test_delete_policy_list11(self): + """Test case for delete_policy_list11 + + """ + pass + + def test_delete_policy_lists_with_info_tag11(self): + """Test case for delete_policy_lists_with_info_tag11 + + """ + pass + + def test_edit_policy_list11(self): + """Test case for edit_policy_list11 + + """ + pass + + def test_get_lists_by_id11(self): + """Test case for get_lists_by_id11 + + """ + pass + + def test_get_policy_lists10(self): + """Test case for get_policy_lists10 + + """ + pass + + def test_get_policy_lists_with_info_tag11(self): + """Test case for get_policy_lists_with_info_tag11 + + """ + pass + + def test_preview_policy_list11(self): + """Test case for preview_policy_list11 + + """ + pass + + def test_preview_policy_list_by_id11(self): + """Test case for preview_policy_list_by_id11 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_extended_community_list_builder_api.py b/test/test_configuration_policy_extended_community_list_builder_api.py new file mode 100644 index 0000000..9ca733e --- /dev/null +++ b/test/test_configuration_policy_extended_community_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_extended_community_list_builder_api import ConfigurationPolicyExtendedCommunityListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyExtendedCommunityListBuilderApi(unittest.TestCase): + """ConfigurationPolicyExtendedCommunityListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyExtendedCommunityListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list12(self): + """Test case for create_policy_list12 + + """ + pass + + def test_delete_policy_list12(self): + """Test case for delete_policy_list12 + + """ + pass + + def test_delete_policy_lists_with_info_tag12(self): + """Test case for delete_policy_lists_with_info_tag12 + + """ + pass + + def test_edit_policy_list12(self): + """Test case for edit_policy_list12 + + """ + pass + + def test_get_lists_by_id12(self): + """Test case for get_lists_by_id12 + + """ + pass + + def test_get_policy_lists11(self): + """Test case for get_policy_lists11 + + """ + pass + + def test_get_policy_lists_with_info_tag12(self): + """Test case for get_policy_lists_with_info_tag12 + + """ + pass + + def test_preview_policy_list12(self): + """Test case for preview_policy_list12 + + """ + pass + + def test_preview_policy_list_by_id12(self): + """Test case for preview_policy_list_by_id12 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_fax_protocol_list_builder_api.py b/test/test_configuration_policy_fax_protocol_list_builder_api.py new file mode 100644 index 0000000..3fc5f2d --- /dev/null +++ b/test/test_configuration_policy_fax_protocol_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_fax_protocol_list_builder_api import ConfigurationPolicyFaxProtocolListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyFaxProtocolListBuilderApi(unittest.TestCase): + """ConfigurationPolicyFaxProtocolListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyFaxProtocolListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list13(self): + """Test case for create_policy_list13 + + """ + pass + + def test_delete_policy_list13(self): + """Test case for delete_policy_list13 + + """ + pass + + def test_delete_policy_lists_with_info_tag13(self): + """Test case for delete_policy_lists_with_info_tag13 + + """ + pass + + def test_edit_policy_list13(self): + """Test case for edit_policy_list13 + + """ + pass + + def test_get_lists_by_id13(self): + """Test case for get_lists_by_id13 + + """ + pass + + def test_get_policy_lists12(self): + """Test case for get_policy_lists12 + + """ + pass + + def test_get_policy_lists_with_info_tag13(self): + """Test case for get_policy_lists_with_info_tag13 + + """ + pass + + def test_preview_policy_list13(self): + """Test case for preview_policy_list13 + + """ + pass + + def test_preview_policy_list_by_id13(self): + """Test case for preview_policy_list_by_id13 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_forwarding_class_list_builder_api.py b/test/test_configuration_policy_forwarding_class_list_builder_api.py new file mode 100644 index 0000000..6434c7e --- /dev/null +++ b/test/test_configuration_policy_forwarding_class_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_forwarding_class_list_builder_api import ConfigurationPolicyForwardingClassListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyForwardingClassListBuilderApi(unittest.TestCase): + """ConfigurationPolicyForwardingClassListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyForwardingClassListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list14(self): + """Test case for create_policy_list14 + + """ + pass + + def test_delete_policy_list14(self): + """Test case for delete_policy_list14 + + """ + pass + + def test_delete_policy_lists_with_info_tag14(self): + """Test case for delete_policy_lists_with_info_tag14 + + """ + pass + + def test_edit_policy_list14(self): + """Test case for edit_policy_list14 + + """ + pass + + def test_get_lists_by_id14(self): + """Test case for get_lists_by_id14 + + """ + pass + + def test_get_policy_lists13(self): + """Test case for get_policy_lists13 + + """ + pass + + def test_get_policy_lists_with_info_tag14(self): + """Test case for get_policy_lists_with_info_tag14 + + """ + pass + + def test_preview_policy_list14(self): + """Test case for preview_policy_list14 + + """ + pass + + def test_preview_policy_list_by_id14(self): + """Test case for preview_policy_list_by_id14 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_fxo_port_definition_builder_api.py b/test/test_configuration_policy_fxo_port_definition_builder_api.py new file mode 100644 index 0000000..e1d4af5 --- /dev/null +++ b/test/test_configuration_policy_fxo_port_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_fxo_port_definition_builder_api import ConfigurationPolicyFXOPortDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyFXOPortDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyFXOPortDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyFXOPortDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition26(self): + """Test case for create_policy_definition26 + + """ + pass + + def test_delete_policy_definition26(self): + """Test case for delete_policy_definition26 + + """ + pass + + def test_edit_multiple_policy_definition26(self): + """Test case for edit_multiple_policy_definition26 + + """ + pass + + def test_edit_policy_definition26(self): + """Test case for edit_policy_definition26 + + """ + pass + + def test_get_definitions26(self): + """Test case for get_definitions26 + + """ + pass + + def test_get_policy_definition26(self): + """Test case for get_policy_definition26 + + """ + pass + + def test_preview_policy_definition26(self): + """Test case for preview_policy_definition26 + + """ + pass + + def test_preview_policy_definition_by_id26(self): + """Test case for preview_policy_definition_by_id26 + + """ + pass + + def test_save_policy_definition_in_bulk26(self): + """Test case for save_policy_definition_in_bulk26 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_fxs_port_definition_builder_api.py b/test/test_configuration_policy_fxs_port_definition_builder_api.py new file mode 100644 index 0000000..3defca5 --- /dev/null +++ b/test/test_configuration_policy_fxs_port_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_fxs_port_definition_builder_api import ConfigurationPolicyFXSPortDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyFXSPortDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyFXSPortDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyFXSPortDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition27(self): + """Test case for create_policy_definition27 + + """ + pass + + def test_delete_policy_definition27(self): + """Test case for delete_policy_definition27 + + """ + pass + + def test_edit_multiple_policy_definition27(self): + """Test case for edit_multiple_policy_definition27 + + """ + pass + + def test_edit_policy_definition27(self): + """Test case for edit_policy_definition27 + + """ + pass + + def test_get_definitions27(self): + """Test case for get_definitions27 + + """ + pass + + def test_get_policy_definition27(self): + """Test case for get_policy_definition27 + + """ + pass + + def test_preview_policy_definition27(self): + """Test case for preview_policy_definition27 + + """ + pass + + def test_preview_policy_definition_by_id27(self): + """Test case for preview_policy_definition_by_id27 + + """ + pass + + def test_save_policy_definition_in_bulk27(self): + """Test case for save_policy_definition_in_bulk27 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_fxsdid_port_definition_builder_api.py b/test/test_configuration_policy_fxsdid_port_definition_builder_api.py new file mode 100644 index 0000000..131732a --- /dev/null +++ b/test/test_configuration_policy_fxsdid_port_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_fxsdid_port_definition_builder_api import ConfigurationPolicyFXSDIDPortDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyFXSDIDPortDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyFXSDIDPortDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyFXSDIDPortDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition28(self): + """Test case for create_policy_definition28 + + """ + pass + + def test_delete_policy_definition28(self): + """Test case for delete_policy_definition28 + + """ + pass + + def test_edit_multiple_policy_definition28(self): + """Test case for edit_multiple_policy_definition28 + + """ + pass + + def test_edit_policy_definition28(self): + """Test case for edit_policy_definition28 + + """ + pass + + def test_get_definitions28(self): + """Test case for get_definitions28 + + """ + pass + + def test_get_policy_definition28(self): + """Test case for get_policy_definition28 + + """ + pass + + def test_preview_policy_definition28(self): + """Test case for preview_policy_definition28 + + """ + pass + + def test_preview_policy_definition_by_id28(self): + """Test case for preview_policy_definition_by_id28 + + """ + pass + + def test_save_policy_definition_in_bulk28(self): + """Test case for save_policy_definition_in_bulk28 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_geo_location_list_builder_api.py b/test/test_configuration_policy_geo_location_list_builder_api.py new file mode 100644 index 0000000..37ed124 --- /dev/null +++ b/test/test_configuration_policy_geo_location_list_builder_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_geo_location_list_builder_api import ConfigurationPolicyGeoLocationListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyGeoLocationListBuilderApi(unittest.TestCase): + """ConfigurationPolicyGeoLocationListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyGeoLocationListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list17(self): + """Test case for create_policy_list17 + + """ + pass + + def test_delete_policy_list17(self): + """Test case for delete_policy_list17 + + """ + pass + + def test_delete_policy_lists_with_info_tag17(self): + """Test case for delete_policy_lists_with_info_tag17 + + """ + pass + + def test_edit_policy_list17(self): + """Test case for edit_policy_list17 + + """ + pass + + def test_get_geo_location_lists(self): + """Test case for get_geo_location_lists + + """ + pass + + def test_get_lists_by_id17(self): + """Test case for get_lists_by_id17 + + """ + pass + + def test_get_policy_lists15(self): + """Test case for get_policy_lists15 + + """ + pass + + def test_get_policy_lists_with_info_tag17(self): + """Test case for get_policy_lists_with_info_tag17 + + """ + pass + + def test_preview_policy_list17(self): + """Test case for preview_policy_list17 + + """ + pass + + def test_preview_policy_list_by_id17(self): + """Test case for preview_policy_list_by_id17 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_hub_and_spoke_definition_builder_api.py b/test/test_configuration_policy_hub_and_spoke_definition_builder_api.py new file mode 100644 index 0000000..1dc9c9d --- /dev/null +++ b/test/test_configuration_policy_hub_and_spoke_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_hub_and_spoke_definition_builder_api import ConfigurationPolicyHubAndSpokeDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyHubAndSpokeDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyHubAndSpokeDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyHubAndSpokeDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition4(self): + """Test case for create_policy_definition4 + + """ + pass + + def test_delete_policy_definition4(self): + """Test case for delete_policy_definition4 + + """ + pass + + def test_edit_multiple_policy_definition4(self): + """Test case for edit_multiple_policy_definition4 + + """ + pass + + def test_edit_policy_definition4(self): + """Test case for edit_policy_definition4 + + """ + pass + + def test_get_definitions4(self): + """Test case for get_definitions4 + + """ + pass + + def test_get_policy_definition4(self): + """Test case for get_policy_definition4 + + """ + pass + + def test_preview_policy_definition4(self): + """Test case for preview_policy_definition4 + + """ + pass + + def test_preview_policy_definition_by_id4(self): + """Test case for preview_policy_definition_by_id4 + + """ + pass + + def test_save_policy_definition_in_bulk4(self): + """Test case for save_policy_definition_in_bulk4 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_identity_list_builder_api.py b/test/test_configuration_policy_identity_list_builder_api.py new file mode 100644 index 0000000..3cd6802 --- /dev/null +++ b/test/test_configuration_policy_identity_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_identity_list_builder_api import ConfigurationPolicyIdentityListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyIdentityListBuilderApi(unittest.TestCase): + """ConfigurationPolicyIdentityListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyIdentityListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list18(self): + """Test case for create_policy_list18 + + """ + pass + + def test_delete_policy_list18(self): + """Test case for delete_policy_list18 + + """ + pass + + def test_delete_policy_lists_with_info_tag18(self): + """Test case for delete_policy_lists_with_info_tag18 + + """ + pass + + def test_edit_policy_list18(self): + """Test case for edit_policy_list18 + + """ + pass + + def test_get_lists_by_id18(self): + """Test case for get_lists_by_id18 + + """ + pass + + def test_get_policy_lists16(self): + """Test case for get_policy_lists16 + + """ + pass + + def test_get_policy_lists_with_info_tag18(self): + """Test case for get_policy_lists_with_info_tag18 + + """ + pass + + def test_preview_policy_list18(self): + """Test case for preview_policy_list18 + + """ + pass + + def test_preview_policy_list_by_id18(self): + """Test case for preview_policy_list_by_id18 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_intrusion_prevention_definition_builder_api.py b/test/test_configuration_policy_intrusion_prevention_definition_builder_api.py new file mode 100644 index 0000000..a115892 --- /dev/null +++ b/test/test_configuration_policy_intrusion_prevention_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_intrusion_prevention_definition_builder_api import ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyIntrusionPreventionDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyIntrusionPreventionDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition18(self): + """Test case for create_policy_definition18 + + """ + pass + + def test_delete_policy_definition18(self): + """Test case for delete_policy_definition18 + + """ + pass + + def test_edit_multiple_policy_definition18(self): + """Test case for edit_multiple_policy_definition18 + + """ + pass + + def test_edit_policy_definition18(self): + """Test case for edit_policy_definition18 + + """ + pass + + def test_get_definitions18(self): + """Test case for get_definitions18 + + """ + pass + + def test_get_policy_definition18(self): + """Test case for get_policy_definition18 + + """ + pass + + def test_preview_policy_definition18(self): + """Test case for preview_policy_definition18 + + """ + pass + + def test_preview_policy_definition_by_id18(self): + """Test case for preview_policy_definition_by_id18 + + """ + pass + + def test_save_policy_definition_in_bulk18(self): + """Test case for save_policy_definition_in_bulk18 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_ips_signature_list_builder_api.py b/test/test_configuration_policy_ips_signature_list_builder_api.py new file mode 100644 index 0000000..9e45505 --- /dev/null +++ b/test/test_configuration_policy_ips_signature_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_ips_signature_list_builder_api import ConfigurationPolicyIPSSignatureListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyIPSSignatureListBuilderApi(unittest.TestCase): + """ConfigurationPolicyIPSSignatureListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyIPSSignatureListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list19(self): + """Test case for create_policy_list19 + + """ + pass + + def test_delete_policy_list19(self): + """Test case for delete_policy_list19 + + """ + pass + + def test_delete_policy_lists_with_info_tag19(self): + """Test case for delete_policy_lists_with_info_tag19 + + """ + pass + + def test_edit_policy_list19(self): + """Test case for edit_policy_list19 + + """ + pass + + def test_get_lists_by_id19(self): + """Test case for get_lists_by_id19 + + """ + pass + + def test_get_policy_lists17(self): + """Test case for get_policy_lists17 + + """ + pass + + def test_get_policy_lists_with_info_tag19(self): + """Test case for get_policy_lists_with_info_tag19 + + """ + pass + + def test_preview_policy_list19(self): + """Test case for preview_policy_list19 + + """ + pass + + def test_preview_policy_list_by_id19(self): + """Test case for preview_policy_list_by_id19 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_ipv6_access_definition_builder_api.py b/test/test_configuration_policy_ipv6_access_definition_builder_api.py new file mode 100644 index 0000000..7dd9750 --- /dev/null +++ b/test/test_configuration_policy_ipv6_access_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_ipv6_access_definition_builder_api import ConfigurationPolicyIPv6AccessDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyIPv6AccessDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyIPv6AccessDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyIPv6AccessDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition9(self): + """Test case for create_policy_definition9 + + """ + pass + + def test_delete_policy_definition9(self): + """Test case for delete_policy_definition9 + + """ + pass + + def test_edit_multiple_policy_definition9(self): + """Test case for edit_multiple_policy_definition9 + + """ + pass + + def test_edit_policy_definition9(self): + """Test case for edit_policy_definition9 + + """ + pass + + def test_get_definitions9(self): + """Test case for get_definitions9 + + """ + pass + + def test_get_policy_definition9(self): + """Test case for get_policy_definition9 + + """ + pass + + def test_preview_policy_definition9(self): + """Test case for preview_policy_definition9 + + """ + pass + + def test_preview_policy_definition_by_id9(self): + """Test case for preview_policy_definition_by_id9 + + """ + pass + + def test_save_policy_definition_in_bulk9(self): + """Test case for save_policy_definition_in_bulk9 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_ipv6_device_access_definition_builder_api.py b/test/test_configuration_policy_ipv6_device_access_definition_builder_api.py new file mode 100644 index 0000000..02ffe01 --- /dev/null +++ b/test/test_configuration_policy_ipv6_device_access_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_ipv6_device_access_definition_builder_api import ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyIPv6DeviceAccessDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition17(self): + """Test case for create_policy_definition17 + + """ + pass + + def test_delete_policy_definition17(self): + """Test case for delete_policy_definition17 + + """ + pass + + def test_edit_multiple_policy_definition17(self): + """Test case for edit_multiple_policy_definition17 + + """ + pass + + def test_edit_policy_definition17(self): + """Test case for edit_policy_definition17 + + """ + pass + + def test_get_definitions17(self): + """Test case for get_definitions17 + + """ + pass + + def test_get_policy_definition17(self): + """Test case for get_policy_definition17 + + """ + pass + + def test_preview_policy_definition17(self): + """Test case for preview_policy_definition17 + + """ + pass + + def test_preview_policy_definition_by_id17(self): + """Test case for preview_policy_definition_by_id17 + + """ + pass + + def test_save_policy_definition_in_bulk17(self): + """Test case for save_policy_definition_in_bulk17 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_ipv6_prefix_list_builder_api.py b/test/test_configuration_policy_ipv6_prefix_list_builder_api.py new file mode 100644 index 0000000..dbf1c6a --- /dev/null +++ b/test/test_configuration_policy_ipv6_prefix_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_ipv6_prefix_list_builder_api import ConfigurationPolicyIPv6PrefixListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyIPv6PrefixListBuilderApi(unittest.TestCase): + """ConfigurationPolicyIPv6PrefixListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyIPv6PrefixListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list20(self): + """Test case for create_policy_list20 + + """ + pass + + def test_delete_policy_list20(self): + """Test case for delete_policy_list20 + + """ + pass + + def test_delete_policy_lists_with_info_tag20(self): + """Test case for delete_policy_lists_with_info_tag20 + + """ + pass + + def test_edit_policy_list20(self): + """Test case for edit_policy_list20 + + """ + pass + + def test_get_lists_by_id20(self): + """Test case for get_lists_by_id20 + + """ + pass + + def test_get_policy_lists18(self): + """Test case for get_policy_lists18 + + """ + pass + + def test_get_policy_lists_with_info_tag20(self): + """Test case for get_policy_lists_with_info_tag20 + + """ + pass + + def test_preview_policy_list20(self): + """Test case for preview_policy_list20 + + """ + pass + + def test_preview_policy_list_by_id20(self): + """Test case for preview_policy_list_by_id20 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_list_builder_api.py b/test/test_configuration_policy_list_builder_api.py new file mode 100644 index 0000000..38a7806 --- /dev/null +++ b/test/test_configuration_policy_list_builder_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_list_builder_api import ConfigurationPolicyListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyListBuilderApi(unittest.TestCase): + """ConfigurationPolicyListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_webex_prefix_lists(self): + """Test case for create_webex_prefix_lists + + """ + pass + + def test_create_webex_prefix_lists1(self): + """Test case for create_webex_prefix_lists1 + + """ + pass + + def test_get_all_policy_lists(self): + """Test case for get_all_policy_lists + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_local_domain_definition_builder_api.py b/test/test_configuration_policy_local_domain_definition_builder_api.py new file mode 100644 index 0000000..66211a6 --- /dev/null +++ b/test/test_configuration_policy_local_domain_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_local_domain_definition_builder_api import ConfigurationPolicyLocalDomainDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyLocalDomainDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyLocalDomainDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyLocalDomainDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition(self): + """Test case for create_policy_definition + + """ + pass + + def test_delete_policy_definition(self): + """Test case for delete_policy_definition + + """ + pass + + def test_edit_multiple_policy_definition(self): + """Test case for edit_multiple_policy_definition + + """ + pass + + def test_edit_policy_definition(self): + """Test case for edit_policy_definition + + """ + pass + + def test_get_definitions(self): + """Test case for get_definitions + + """ + pass + + def test_get_policy_definition(self): + """Test case for get_policy_definition + + """ + pass + + def test_preview_policy_definition(self): + """Test case for preview_policy_definition + + """ + pass + + def test_preview_policy_definition_by_id(self): + """Test case for preview_policy_definition_by_id + + """ + pass + + def test_save_policy_definition_in_bulk(self): + """Test case for save_policy_definition_in_bulk + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_local_domain_name_list_builder_api.py b/test/test_configuration_policy_local_domain_name_list_builder_api.py new file mode 100644 index 0000000..305d19b --- /dev/null +++ b/test/test_configuration_policy_local_domain_name_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_local_domain_name_list_builder_api import ConfigurationPolicyLocalDomainNameListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyLocalDomainNameListBuilderApi(unittest.TestCase): + """ConfigurationPolicyLocalDomainNameListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyLocalDomainNameListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list23(self): + """Test case for create_policy_list23 + + """ + pass + + def test_delete_policy_list23(self): + """Test case for delete_policy_list23 + + """ + pass + + def test_delete_policy_lists_with_info_tag23(self): + """Test case for delete_policy_lists_with_info_tag23 + + """ + pass + + def test_edit_policy_list23(self): + """Test case for edit_policy_list23 + + """ + pass + + def test_get_lists_by_id23(self): + """Test case for get_lists_by_id23 + + """ + pass + + def test_get_policy_lists20(self): + """Test case for get_policy_lists20 + + """ + pass + + def test_get_policy_lists_with_info_tag23(self): + """Test case for get_policy_lists_with_info_tag23 + + """ + pass + + def test_preview_policy_list23(self): + """Test case for preview_policy_list23 + + """ + pass + + def test_preview_policy_list_by_id23(self): + """Test case for preview_policy_list_by_id23 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_media_profile_list_builder_api.py b/test/test_configuration_policy_media_profile_list_builder_api.py new file mode 100644 index 0000000..4ae6426 --- /dev/null +++ b/test/test_configuration_policy_media_profile_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_media_profile_list_builder_api import ConfigurationPolicyMediaProfileListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyMediaProfileListBuilderApi(unittest.TestCase): + """ConfigurationPolicyMediaProfileListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyMediaProfileListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list(self): + """Test case for create_policy_list + + """ + pass + + def test_delete_policy_list(self): + """Test case for delete_policy_list + + """ + pass + + def test_delete_policy_lists_with_info_tag(self): + """Test case for delete_policy_lists_with_info_tag + + """ + pass + + def test_edit_policy_list(self): + """Test case for edit_policy_list + + """ + pass + + def test_get_lists_by_id(self): + """Test case for get_lists_by_id + + """ + pass + + def test_get_policy_lists(self): + """Test case for get_policy_lists + + """ + pass + + def test_get_policy_lists_with_info_tag(self): + """Test case for get_policy_lists_with_info_tag + + """ + pass + + def test_preview_policy_list(self): + """Test case for preview_policy_list + + """ + pass + + def test_preview_policy_list_by_id(self): + """Test case for preview_policy_list_by_id + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_mesh_definition_builder_api.py b/test/test_configuration_policy_mesh_definition_builder_api.py new file mode 100644 index 0000000..b98ccd3 --- /dev/null +++ b/test/test_configuration_policy_mesh_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_mesh_definition_builder_api import ConfigurationPolicyMeshDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyMeshDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyMeshDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyMeshDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition5(self): + """Test case for create_policy_definition5 + + """ + pass + + def test_delete_policy_definition5(self): + """Test case for delete_policy_definition5 + + """ + pass + + def test_edit_multiple_policy_definition5(self): + """Test case for edit_multiple_policy_definition5 + + """ + pass + + def test_edit_policy_definition5(self): + """Test case for edit_policy_definition5 + + """ + pass + + def test_get_definitions5(self): + """Test case for get_definitions5 + + """ + pass + + def test_get_policy_definition5(self): + """Test case for get_policy_definition5 + + """ + pass + + def test_preview_policy_definition5(self): + """Test case for preview_policy_definition5 + + """ + pass + + def test_preview_policy_definition_by_id5(self): + """Test case for preview_policy_definition_by_id5 + + """ + pass + + def test_save_policy_definition_in_bulk5(self): + """Test case for save_policy_definition_in_bulk5 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_mirror_list_builder_api.py b/test/test_configuration_policy_mirror_list_builder_api.py new file mode 100644 index 0000000..959fa6c --- /dev/null +++ b/test/test_configuration_policy_mirror_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_mirror_list_builder_api import ConfigurationPolicyMirrorListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyMirrorListBuilderApi(unittest.TestCase): + """ConfigurationPolicyMirrorListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyMirrorListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list24(self): + """Test case for create_policy_list24 + + """ + pass + + def test_delete_policy_list24(self): + """Test case for delete_policy_list24 + + """ + pass + + def test_delete_policy_lists_with_info_tag24(self): + """Test case for delete_policy_lists_with_info_tag24 + + """ + pass + + def test_edit_policy_list24(self): + """Test case for edit_policy_list24 + + """ + pass + + def test_get_lists_by_id24(self): + """Test case for get_lists_by_id24 + + """ + pass + + def test_get_policy_lists21(self): + """Test case for get_policy_lists21 + + """ + pass + + def test_get_policy_lists_with_info_tag24(self): + """Test case for get_policy_lists_with_info_tag24 + + """ + pass + + def test_preview_policy_list24(self): + """Test case for preview_policy_list24 + + """ + pass + + def test_preview_policy_list_by_id24(self): + """Test case for preview_policy_list_by_id24 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_modem_passthrough_list_builder_api.py b/test/test_configuration_policy_modem_passthrough_list_builder_api.py new file mode 100644 index 0000000..5177425 --- /dev/null +++ b/test/test_configuration_policy_modem_passthrough_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_modem_passthrough_list_builder_api import ConfigurationPolicyModemPassthroughListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyModemPassthroughListBuilderApi(unittest.TestCase): + """ConfigurationPolicyModemPassthroughListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyModemPassthroughListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list25(self): + """Test case for create_policy_list25 + + """ + pass + + def test_delete_policy_list25(self): + """Test case for delete_policy_list25 + + """ + pass + + def test_delete_policy_lists_with_info_tag25(self): + """Test case for delete_policy_lists_with_info_tag25 + + """ + pass + + def test_edit_policy_list25(self): + """Test case for edit_policy_list25 + + """ + pass + + def test_get_lists_by_id25(self): + """Test case for get_lists_by_id25 + + """ + pass + + def test_get_policy_lists22(self): + """Test case for get_policy_lists22 + + """ + pass + + def test_get_policy_lists_with_info_tag25(self): + """Test case for get_policy_lists_with_info_tag25 + + """ + pass + + def test_preview_policy_list25(self): + """Test case for preview_policy_list25 + + """ + pass + + def test_preview_policy_list_by_id25(self): + """Test case for preview_policy_list_by_id25 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_policer_class_list_builder_api.py b/test/test_configuration_policy_policer_class_list_builder_api.py new file mode 100644 index 0000000..a54d264 --- /dev/null +++ b/test/test_configuration_policy_policer_class_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_policer_class_list_builder_api import ConfigurationPolicyPolicerClassListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyPolicerClassListBuilderApi(unittest.TestCase): + """ConfigurationPolicyPolicerClassListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyPolicerClassListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list26(self): + """Test case for create_policy_list26 + + """ + pass + + def test_delete_policy_list26(self): + """Test case for delete_policy_list26 + + """ + pass + + def test_delete_policy_lists_with_info_tag26(self): + """Test case for delete_policy_lists_with_info_tag26 + + """ + pass + + def test_edit_policy_list26(self): + """Test case for edit_policy_list26 + + """ + pass + + def test_get_lists_by_id26(self): + """Test case for get_lists_by_id26 + + """ + pass + + def test_get_policy_lists23(self): + """Test case for get_policy_lists23 + + """ + pass + + def test_get_policy_lists_with_info_tag26(self): + """Test case for get_policy_lists_with_info_tag26 + + """ + pass + + def test_preview_policy_list26(self): + """Test case for preview_policy_list26 + + """ + pass + + def test_preview_policy_list_by_id26(self): + """Test case for preview_policy_list_by_id26 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_port_list_builder_api.py b/test/test_configuration_policy_port_list_builder_api.py new file mode 100644 index 0000000..bd7972d --- /dev/null +++ b/test/test_configuration_policy_port_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_port_list_builder_api import ConfigurationPolicyPortListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyPortListBuilderApi(unittest.TestCase): + """ConfigurationPolicyPortListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyPortListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list27(self): + """Test case for create_policy_list27 + + """ + pass + + def test_delete_policy_list27(self): + """Test case for delete_policy_list27 + + """ + pass + + def test_delete_policy_lists_with_info_tag27(self): + """Test case for delete_policy_lists_with_info_tag27 + + """ + pass + + def test_edit_policy_list27(self): + """Test case for edit_policy_list27 + + """ + pass + + def test_get_lists_by_id27(self): + """Test case for get_lists_by_id27 + + """ + pass + + def test_get_policy_lists24(self): + """Test case for get_policy_lists24 + + """ + pass + + def test_get_policy_lists_with_info_tag27(self): + """Test case for get_policy_lists_with_info_tag27 + + """ + pass + + def test_preview_policy_list27(self): + """Test case for preview_policy_list27 + + """ + pass + + def test_preview_policy_list_by_id27(self): + """Test case for preview_policy_list_by_id27 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_prefix_for_all_types_of_lists_builder_api.py b/test/test_configuration_policy_prefix_for_all_types_of_lists_builder_api.py new file mode 100644 index 0000000..5a03a0b --- /dev/null +++ b/test/test_configuration_policy_prefix_for_all_types_of_lists_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_prefix_for_all_types_of_lists_builder_api import ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi # noqa: E501 + + +class TestConfigurationPolicyPrefixForAllTypesOfListsBuilderApi(unittest.TestCase): + """ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyPrefixForAllTypesOfListsBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list21(self): + """Test case for create_policy_list21 + + """ + pass + + def test_delete_policy_list21(self): + """Test case for delete_policy_list21 + + """ + pass + + def test_delete_policy_lists_with_info_tag21(self): + """Test case for delete_policy_lists_with_info_tag21 + + """ + pass + + def test_edit_policy_list21(self): + """Test case for edit_policy_list21 + + """ + pass + + def test_get_lists_by_id21(self): + """Test case for get_lists_by_id21 + + """ + pass + + def test_get_lists_for_all_prefixes(self): + """Test case for get_lists_for_all_prefixes + + """ + pass + + def test_get_policy_lists_with_info_tag21(self): + """Test case for get_policy_lists_with_info_tag21 + + """ + pass + + def test_preview_policy_list21(self): + """Test case for preview_policy_list21 + + """ + pass + + def test_preview_policy_list_by_id21(self): + """Test case for preview_policy_list_by_id21 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_prefix_list_builder_api.py b/test/test_configuration_policy_prefix_list_builder_api.py new file mode 100644 index 0000000..abdbc0d --- /dev/null +++ b/test/test_configuration_policy_prefix_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_prefix_list_builder_api import ConfigurationPolicyPrefixListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyPrefixListBuilderApi(unittest.TestCase): + """ConfigurationPolicyPrefixListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyPrefixListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list29(self): + """Test case for create_policy_list29 + + """ + pass + + def test_delete_policy_list29(self): + """Test case for delete_policy_list29 + + """ + pass + + def test_delete_policy_lists_with_info_tag29(self): + """Test case for delete_policy_lists_with_info_tag29 + + """ + pass + + def test_edit_policy_list29(self): + """Test case for edit_policy_list29 + + """ + pass + + def test_get_lists_by_id29(self): + """Test case for get_lists_by_id29 + + """ + pass + + def test_get_policy_lists26(self): + """Test case for get_policy_lists26 + + """ + pass + + def test_get_policy_lists_with_info_tag29(self): + """Test case for get_policy_lists_with_info_tag29 + + """ + pass + + def test_preview_policy_list29(self): + """Test case for preview_policy_list29 + + """ + pass + + def test_preview_policy_list_by_id29(self): + """Test case for preview_policy_list_by_id29 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_priisdn_port_definition_builder_api.py b/test/test_configuration_policy_priisdn_port_definition_builder_api.py new file mode 100644 index 0000000..9d5d3b3 --- /dev/null +++ b/test/test_configuration_policy_priisdn_port_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_priisdn_port_definition_builder_api import ConfigurationPolicyPRIISDNPortDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyPRIISDNPortDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyPRIISDNPortDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyPRIISDNPortDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition29(self): + """Test case for create_policy_definition29 + + """ + pass + + def test_delete_policy_definition29(self): + """Test case for delete_policy_definition29 + + """ + pass + + def test_edit_multiple_policy_definition29(self): + """Test case for edit_multiple_policy_definition29 + + """ + pass + + def test_edit_policy_definition29(self): + """Test case for edit_policy_definition29 + + """ + pass + + def test_get_definitions29(self): + """Test case for get_definitions29 + + """ + pass + + def test_get_policy_definition29(self): + """Test case for get_policy_definition29 + + """ + pass + + def test_preview_policy_definition29(self): + """Test case for preview_policy_definition29 + + """ + pass + + def test_preview_policy_definition_by_id29(self): + """Test case for preview_policy_definition_by_id29 + + """ + pass + + def test_save_policy_definition_in_bulk29(self): + """Test case for save_policy_definition_in_bulk29 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_protocol_name_list_builder_api.py b/test/test_configuration_policy_protocol_name_list_builder_api.py new file mode 100644 index 0000000..0779c6a --- /dev/null +++ b/test/test_configuration_policy_protocol_name_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_protocol_name_list_builder_api import ConfigurationPolicyProtocolNameListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyProtocolNameListBuilderApi(unittest.TestCase): + """ConfigurationPolicyProtocolNameListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyProtocolNameListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list30(self): + """Test case for create_policy_list30 + + """ + pass + + def test_delete_policy_list30(self): + """Test case for delete_policy_list30 + + """ + pass + + def test_delete_policy_lists_with_info_tag30(self): + """Test case for delete_policy_lists_with_info_tag30 + + """ + pass + + def test_edit_policy_list30(self): + """Test case for edit_policy_list30 + + """ + pass + + def test_get_lists_by_id30(self): + """Test case for get_lists_by_id30 + + """ + pass + + def test_get_policy_lists27(self): + """Test case for get_policy_lists27 + + """ + pass + + def test_get_policy_lists_with_info_tag30(self): + """Test case for get_policy_lists_with_info_tag30 + + """ + pass + + def test_preview_policy_list30(self): + """Test case for preview_policy_list30 + + """ + pass + + def test_preview_policy_list_by_id30(self): + """Test case for preview_policy_list_by_id30 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_qos_map_definition_builder_api.py b/test/test_configuration_policy_qos_map_definition_builder_api.py new file mode 100644 index 0000000..4d0c581 --- /dev/null +++ b/test/test_configuration_policy_qos_map_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_qos_map_definition_builder_api import ConfigurationPolicyQosMapDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyQosMapDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyQosMapDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyQosMapDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition1(self): + """Test case for create_policy_definition1 + + """ + pass + + def test_delete_policy_definition1(self): + """Test case for delete_policy_definition1 + + """ + pass + + def test_edit_multiple_policy_definition1(self): + """Test case for edit_multiple_policy_definition1 + + """ + pass + + def test_edit_policy_definition1(self): + """Test case for edit_policy_definition1 + + """ + pass + + def test_get_definitions1(self): + """Test case for get_definitions1 + + """ + pass + + def test_get_policy_definition1(self): + """Test case for get_policy_definition1 + + """ + pass + + def test_preview_policy_definition1(self): + """Test case for preview_policy_definition1 + + """ + pass + + def test_preview_policy_definition_by_id1(self): + """Test case for preview_policy_definition_by_id1 + + """ + pass + + def test_save_policy_definition_in_bulk1(self): + """Test case for save_policy_definition_in_bulk1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_region_list_builder_api.py b/test/test_configuration_policy_region_list_builder_api.py new file mode 100644 index 0000000..d19a0fd --- /dev/null +++ b/test/test_configuration_policy_region_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_region_list_builder_api import ConfigurationPolicyRegionListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyRegionListBuilderApi(unittest.TestCase): + """ConfigurationPolicyRegionListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyRegionListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list31(self): + """Test case for create_policy_list31 + + """ + pass + + def test_delete_policy_list31(self): + """Test case for delete_policy_list31 + + """ + pass + + def test_delete_policy_lists_with_info_tag31(self): + """Test case for delete_policy_lists_with_info_tag31 + + """ + pass + + def test_edit_policy_list31(self): + """Test case for edit_policy_list31 + + """ + pass + + def test_get_lists_by_id31(self): + """Test case for get_lists_by_id31 + + """ + pass + + def test_get_policy_lists28(self): + """Test case for get_policy_lists28 + + """ + pass + + def test_get_policy_lists_with_info_tag31(self): + """Test case for get_policy_lists_with_info_tag31 + + """ + pass + + def test_preview_policy_list31(self): + """Test case for preview_policy_list31 + + """ + pass + + def test_preview_policy_list_by_id31(self): + """Test case for preview_policy_list_by_id31 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_rewrite_rule_definition_builder_api.py b/test/test_configuration_policy_rewrite_rule_definition_builder_api.py new file mode 100644 index 0000000..78676c8 --- /dev/null +++ b/test/test_configuration_policy_rewrite_rule_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_rewrite_rule_definition_builder_api import ConfigurationPolicyRewriteRuleDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyRewriteRuleDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyRewriteRuleDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyRewriteRuleDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition19(self): + """Test case for create_policy_definition19 + + """ + pass + + def test_delete_policy_definition19(self): + """Test case for delete_policy_definition19 + + """ + pass + + def test_edit_multiple_policy_definition19(self): + """Test case for edit_multiple_policy_definition19 + + """ + pass + + def test_edit_policy_definition19(self): + """Test case for edit_policy_definition19 + + """ + pass + + def test_get_definitions19(self): + """Test case for get_definitions19 + + """ + pass + + def test_get_policy_definition19(self): + """Test case for get_policy_definition19 + + """ + pass + + def test_preview_policy_definition19(self): + """Test case for preview_policy_definition19 + + """ + pass + + def test_preview_policy_definition_by_id19(self): + """Test case for preview_policy_definition_by_id19 + + """ + pass + + def test_save_policy_definition_in_bulk19(self): + """Test case for save_policy_definition_in_bulk19 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_secure_internet_gateway_data_centers_builder_api.py b/test/test_configuration_policy_secure_internet_gateway_data_centers_builder_api.py new file mode 100644 index 0000000..c08e8a0 --- /dev/null +++ b/test/test_configuration_policy_secure_internet_gateway_data_centers_builder_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_secure_internet_gateway_data_centers_builder_api import ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi # noqa: E501 + + +class TestConfigurationPolicySecureInternetGatewayDataCentersBuilderApi(unittest.TestCase): + """ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicySecureInternetGatewayDataCentersBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_sig_data_center_list(self): + """Test case for get_sig_data_center_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_security_assembler_api.py b/test/test_configuration_policy_security_assembler_api.py new file mode 100644 index 0000000..52094ae --- /dev/null +++ b/test/test_configuration_policy_security_assembler_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_security_assembler_api import ConfigurationPolicySecurityAssemblerApi # noqa: E501 + + +class TestConfigurationPolicySecurityAssemblerApi(unittest.TestCase): + """ConfigurationPolicySecurityAssemblerApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicySecurityAssemblerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_preview(self): + """Test case for preview + + """ + pass + + def test_preview_by_id(self): + """Test case for preview_by_id + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_site_list_builder_api.py b/test/test_configuration_policy_site_list_builder_api.py new file mode 100644 index 0000000..2adf0b2 --- /dev/null +++ b/test/test_configuration_policy_site_list_builder_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_site_list_builder_api import ConfigurationPolicySiteListBuilderApi # noqa: E501 + + +class TestConfigurationPolicySiteListBuilderApi(unittest.TestCase): + """ConfigurationPolicySiteListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicySiteListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_default_site_list(self): + """Test case for create_default_site_list + + """ + pass + + def test_create_policy_list32(self): + """Test case for create_policy_list32 + + """ + pass + + def test_delete_policy_list32(self): + """Test case for delete_policy_list32 + + """ + pass + + def test_delete_policy_lists_with_info_tag32(self): + """Test case for delete_policy_lists_with_info_tag32 + + """ + pass + + def test_edit_policy_list32(self): + """Test case for edit_policy_list32 + + """ + pass + + def test_get_lists_by_id32(self): + """Test case for get_lists_by_id32 + + """ + pass + + def test_get_policy_lists29(self): + """Test case for get_policy_lists29 + + """ + pass + + def test_get_policy_lists_with_info_tag32(self): + """Test case for get_policy_lists_with_info_tag32 + + """ + pass + + def test_preview_policy_list32(self): + """Test case for preview_policy_list32 + + """ + pass + + def test_preview_policy_list_by_id32(self): + """Test case for preview_policy_list_by_id32 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_sla_class_list_builder_api.py b/test/test_configuration_policy_sla_class_list_builder_api.py new file mode 100644 index 0000000..d98f217 --- /dev/null +++ b/test/test_configuration_policy_sla_class_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_sla_class_list_builder_api import ConfigurationPolicySLAClassListBuilderApi # noqa: E501 + + +class TestConfigurationPolicySLAClassListBuilderApi(unittest.TestCase): + """ConfigurationPolicySLAClassListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicySLAClassListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list33(self): + """Test case for create_policy_list33 + + """ + pass + + def test_delete_policy_list33(self): + """Test case for delete_policy_list33 + + """ + pass + + def test_delete_policy_lists_with_info_tag33(self): + """Test case for delete_policy_lists_with_info_tag33 + + """ + pass + + def test_edit_policy_list33(self): + """Test case for edit_policy_list33 + + """ + pass + + def test_get_lists_by_id33(self): + """Test case for get_lists_by_id33 + + """ + pass + + def test_get_policy_lists30(self): + """Test case for get_policy_lists30 + + """ + pass + + def test_get_policy_lists_with_info_tag33(self): + """Test case for get_policy_lists_with_info_tag33 + + """ + pass + + def test_preview_policy_list33(self): + """Test case for preview_policy_list33 + + """ + pass + + def test_preview_policy_list_by_id33(self): + """Test case for preview_policy_list_by_id33 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_supervisory_disc_list_builder_api.py b/test/test_configuration_policy_supervisory_disc_list_builder_api.py new file mode 100644 index 0000000..d79693b --- /dev/null +++ b/test/test_configuration_policy_supervisory_disc_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_supervisory_disc_list_builder_api import ConfigurationPolicySupervisoryDiscListBuilderApi # noqa: E501 + + +class TestConfigurationPolicySupervisoryDiscListBuilderApi(unittest.TestCase): + """ConfigurationPolicySupervisoryDiscListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicySupervisoryDiscListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list34(self): + """Test case for create_policy_list34 + + """ + pass + + def test_delete_policy_list34(self): + """Test case for delete_policy_list34 + + """ + pass + + def test_delete_policy_lists_with_info_tag34(self): + """Test case for delete_policy_lists_with_info_tag34 + + """ + pass + + def test_edit_policy_list34(self): + """Test case for edit_policy_list34 + + """ + pass + + def test_get_lists_by_id34(self): + """Test case for get_lists_by_id34 + + """ + pass + + def test_get_policy_lists31(self): + """Test case for get_policy_lists31 + + """ + pass + + def test_get_policy_lists_with_info_tag34(self): + """Test case for get_policy_lists_with_info_tag34 + + """ + pass + + def test_preview_policy_list34(self): + """Test case for preview_policy_list34 + + """ + pass + + def test_preview_policy_list_by_id34(self): + """Test case for preview_policy_list_by_id34 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_threat_grid_api_key_list_api.py b/test/test_configuration_policy_threat_grid_api_key_list_api.py new file mode 100644 index 0000000..359fb1f --- /dev/null +++ b/test/test_configuration_policy_threat_grid_api_key_list_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_threat_grid_api_key_list_api import ConfigurationPolicyThreatGridApiKeyListApi # noqa: E501 + + +class TestConfigurationPolicyThreatGridApiKeyListApi(unittest.TestCase): + """ConfigurationPolicyThreatGridApiKeyListApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyThreatGridApiKeyListApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list35(self): + """Test case for create_policy_list35 + + """ + pass + + def test_delete_policy_list35(self): + """Test case for delete_policy_list35 + + """ + pass + + def test_delete_policy_lists_with_info_tag35(self): + """Test case for delete_policy_lists_with_info_tag35 + + """ + pass + + def test_edit_policy_list35(self): + """Test case for edit_policy_list35 + + """ + pass + + def test_get_lists_by_id35(self): + """Test case for get_lists_by_id35 + + """ + pass + + def test_get_policy_lists32(self): + """Test case for get_policy_lists32 + + """ + pass + + def test_get_policy_lists_with_info_tag35(self): + """Test case for get_policy_lists_with_info_tag35 + + """ + pass + + def test_preview_policy_list35(self): + """Test case for preview_policy_list35 + + """ + pass + + def test_preview_policy_list_by_id35(self): + """Test case for preview_policy_list_by_id35 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_tloc_list_builder_api.py b/test/test_configuration_policy_tloc_list_builder_api.py new file mode 100644 index 0000000..b5252c7 --- /dev/null +++ b/test/test_configuration_policy_tloc_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_tloc_list_builder_api import ConfigurationPolicyTLOCListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyTLOCListBuilderApi(unittest.TestCase): + """ConfigurationPolicyTLOCListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyTLOCListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list36(self): + """Test case for create_policy_list36 + + """ + pass + + def test_delete_policy_list36(self): + """Test case for delete_policy_list36 + + """ + pass + + def test_delete_policy_lists_with_info_tag36(self): + """Test case for delete_policy_lists_with_info_tag36 + + """ + pass + + def test_edit_policy_list36(self): + """Test case for edit_policy_list36 + + """ + pass + + def test_get_lists_by_id36(self): + """Test case for get_lists_by_id36 + + """ + pass + + def test_get_policy_lists33(self): + """Test case for get_policy_lists33 + + """ + pass + + def test_get_policy_lists_with_info_tag36(self): + """Test case for get_policy_lists_with_info_tag36 + + """ + pass + + def test_preview_policy_list36(self): + """Test case for preview_policy_list36 + + """ + pass + + def test_preview_policy_list_by_id36(self): + """Test case for preview_policy_list_by_id36 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_translation_profile_list_builder_api.py b/test/test_configuration_policy_translation_profile_list_builder_api.py new file mode 100644 index 0000000..d9541e1 --- /dev/null +++ b/test/test_configuration_policy_translation_profile_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_translation_profile_list_builder_api import ConfigurationPolicyTranslationProfileListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyTranslationProfileListBuilderApi(unittest.TestCase): + """ConfigurationPolicyTranslationProfileListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyTranslationProfileListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list1(self): + """Test case for create_policy_list1 + + """ + pass + + def test_delete_policy_list1(self): + """Test case for delete_policy_list1 + + """ + pass + + def test_delete_policy_lists_with_info_tag1(self): + """Test case for delete_policy_lists_with_info_tag1 + + """ + pass + + def test_edit_policy_list1(self): + """Test case for edit_policy_list1 + + """ + pass + + def test_get_lists_by_id1(self): + """Test case for get_lists_by_id1 + + """ + pass + + def test_get_policy_lists1(self): + """Test case for get_policy_lists1 + + """ + pass + + def test_get_policy_lists_with_info_tag1(self): + """Test case for get_policy_lists_with_info_tag1 + + """ + pass + + def test_preview_policy_list1(self): + """Test case for preview_policy_list1 + + """ + pass + + def test_preview_policy_list_by_id1(self): + """Test case for preview_policy_list_by_id1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_translation_rules_list_builder_api.py b/test/test_configuration_policy_translation_rules_list_builder_api.py new file mode 100644 index 0000000..83e6d61 --- /dev/null +++ b/test/test_configuration_policy_translation_rules_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_translation_rules_list_builder_api import ConfigurationPolicyTranslationRulesListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyTranslationRulesListBuilderApi(unittest.TestCase): + """ConfigurationPolicyTranslationRulesListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyTranslationRulesListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list2(self): + """Test case for create_policy_list2 + + """ + pass + + def test_delete_policy_list2(self): + """Test case for delete_policy_list2 + + """ + pass + + def test_delete_policy_lists_with_info_tag2(self): + """Test case for delete_policy_lists_with_info_tag2 + + """ + pass + + def test_edit_policy_list2(self): + """Test case for edit_policy_list2 + + """ + pass + + def test_get_lists_by_id2(self): + """Test case for get_lists_by_id2 + + """ + pass + + def test_get_policy_lists2(self): + """Test case for get_policy_lists2 + + """ + pass + + def test_get_policy_lists_with_info_tag2(self): + """Test case for get_policy_lists_with_info_tag2 + + """ + pass + + def test_preview_policy_list2(self): + """Test case for preview_policy_list2 + + """ + pass + + def test_preview_policy_list_by_id2(self): + """Test case for preview_policy_list_by_id2 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_trunk_group_list_builder_api.py b/test/test_configuration_policy_trunk_group_list_builder_api.py new file mode 100644 index 0000000..a9676c5 --- /dev/null +++ b/test/test_configuration_policy_trunk_group_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_trunk_group_list_builder_api import ConfigurationPolicyTrunkGroupListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyTrunkGroupListBuilderApi(unittest.TestCase): + """ConfigurationPolicyTrunkGroupListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyTrunkGroupListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list37(self): + """Test case for create_policy_list37 + + """ + pass + + def test_delete_policy_list37(self): + """Test case for delete_policy_list37 + + """ + pass + + def test_delete_policy_lists_with_info_tag37(self): + """Test case for delete_policy_lists_with_info_tag37 + + """ + pass + + def test_edit_policy_list37(self): + """Test case for edit_policy_list37 + + """ + pass + + def test_get_lists_by_id37(self): + """Test case for get_lists_by_id37 + + """ + pass + + def test_get_policy_lists34(self): + """Test case for get_policy_lists34 + + """ + pass + + def test_get_policy_lists_with_info_tag37(self): + """Test case for get_policy_lists_with_info_tag37 + + """ + pass + + def test_preview_policy_list37(self): + """Test case for preview_policy_list37 + + """ + pass + + def test_preview_policy_list_by_id37(self): + """Test case for preview_policy_list_by_id37 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_umbrella_data_list_builder_api.py b/test/test_configuration_policy_umbrella_data_list_builder_api.py new file mode 100644 index 0000000..fa9b362 --- /dev/null +++ b/test/test_configuration_policy_umbrella_data_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_umbrella_data_list_builder_api import ConfigurationPolicyUmbrellaDataListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyUmbrellaDataListBuilderApi(unittest.TestCase): + """ConfigurationPolicyUmbrellaDataListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyUmbrellaDataListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list38(self): + """Test case for create_policy_list38 + + """ + pass + + def test_delete_policy_list38(self): + """Test case for delete_policy_list38 + + """ + pass + + def test_delete_policy_lists_with_info_tag38(self): + """Test case for delete_policy_lists_with_info_tag38 + + """ + pass + + def test_edit_policy_list38(self): + """Test case for edit_policy_list38 + + """ + pass + + def test_get_lists_by_id38(self): + """Test case for get_lists_by_id38 + + """ + pass + + def test_get_policy_lists35(self): + """Test case for get_policy_lists35 + + """ + pass + + def test_get_policy_lists_with_info_tag38(self): + """Test case for get_policy_lists_with_info_tag38 + + """ + pass + + def test_preview_policy_list38(self): + """Test case for preview_policy_list38 + + """ + pass + + def test_preview_policy_list_by_id38(self): + """Test case for preview_policy_list_by_id38 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_url_black_list_builder_api.py b/test/test_configuration_policy_url_black_list_builder_api.py new file mode 100644 index 0000000..7edabe5 --- /dev/null +++ b/test/test_configuration_policy_url_black_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_url_black_list_builder_api import ConfigurationPolicyURLBlackListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyURLBlackListBuilderApi(unittest.TestCase): + """ConfigurationPolicyURLBlackListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyURLBlackListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list39(self): + """Test case for create_policy_list39 + + """ + pass + + def test_delete_policy_list39(self): + """Test case for delete_policy_list39 + + """ + pass + + def test_delete_policy_lists_with_info_tag39(self): + """Test case for delete_policy_lists_with_info_tag39 + + """ + pass + + def test_edit_policy_list39(self): + """Test case for edit_policy_list39 + + """ + pass + + def test_get_lists_by_id39(self): + """Test case for get_lists_by_id39 + + """ + pass + + def test_get_policy_lists36(self): + """Test case for get_policy_lists36 + + """ + pass + + def test_get_policy_lists_with_info_tag39(self): + """Test case for get_policy_lists_with_info_tag39 + + """ + pass + + def test_preview_policy_list39(self): + """Test case for preview_policy_list39 + + """ + pass + + def test_preview_policy_list_by_id39(self): + """Test case for preview_policy_list_by_id39 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_url_filtering_definition_builder_api.py b/test/test_configuration_policy_url_filtering_definition_builder_api.py new file mode 100644 index 0000000..1438d61 --- /dev/null +++ b/test/test_configuration_policy_url_filtering_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_url_filtering_definition_builder_api import ConfigurationPolicyURLFilteringDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyURLFilteringDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyURLFilteringDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyURLFilteringDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition23(self): + """Test case for create_policy_definition23 + + """ + pass + + def test_delete_policy_definition23(self): + """Test case for delete_policy_definition23 + + """ + pass + + def test_edit_multiple_policy_definition23(self): + """Test case for edit_multiple_policy_definition23 + + """ + pass + + def test_edit_policy_definition23(self): + """Test case for edit_policy_definition23 + + """ + pass + + def test_get_definitions23(self): + """Test case for get_definitions23 + + """ + pass + + def test_get_policy_definition23(self): + """Test case for get_policy_definition23 + + """ + pass + + def test_preview_policy_definition23(self): + """Test case for preview_policy_definition23 + + """ + pass + + def test_preview_policy_definition_by_id23(self): + """Test case for preview_policy_definition_by_id23 + + """ + pass + + def test_save_policy_definition_in_bulk23(self): + """Test case for save_policy_definition_in_bulk23 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_url_white_list_builder_api.py b/test/test_configuration_policy_url_white_list_builder_api.py new file mode 100644 index 0000000..df65ffa --- /dev/null +++ b/test/test_configuration_policy_url_white_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_url_white_list_builder_api import ConfigurationPolicyURLWhiteListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyURLWhiteListBuilderApi(unittest.TestCase): + """ConfigurationPolicyURLWhiteListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyURLWhiteListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list40(self): + """Test case for create_policy_list40 + + """ + pass + + def test_delete_policy_list40(self): + """Test case for delete_policy_list40 + + """ + pass + + def test_delete_policy_lists_with_info_tag40(self): + """Test case for delete_policy_lists_with_info_tag40 + + """ + pass + + def test_edit_policy_list40(self): + """Test case for edit_policy_list40 + + """ + pass + + def test_get_lists_by_id40(self): + """Test case for get_lists_by_id40 + + """ + pass + + def test_get_policy_lists37(self): + """Test case for get_policy_lists37 + + """ + pass + + def test_get_policy_lists_with_info_tag40(self): + """Test case for get_policy_lists_with_info_tag40 + + """ + pass + + def test_preview_policy_list40(self): + """Test case for preview_policy_list40 + + """ + pass + + def test_preview_policy_list_by_id40(self): + """Test case for preview_policy_list_by_id40 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_v_edge_assembler_api.py b/test/test_configuration_policy_v_edge_assembler_api.py new file mode 100644 index 0000000..cc318fe --- /dev/null +++ b/test/test_configuration_policy_v_edge_assembler_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_v_edge_assembler_api import ConfigurationPolicyVEdgeAssemblerApi # noqa: E501 + + +class TestConfigurationPolicyVEdgeAssemblerApi(unittest.TestCase): + """ConfigurationPolicyVEdgeAssemblerApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVEdgeAssemblerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_preview1(self): + """Test case for preview1 + + """ + pass + + def test_preview_by_id1(self): + """Test case for preview_by_id1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_v_edge_route_definition_builder_api.py b/test/test_configuration_policy_v_edge_route_definition_builder_api.py new file mode 100644 index 0000000..58bbd59 --- /dev/null +++ b/test/test_configuration_policy_v_edge_route_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_v_edge_route_definition_builder_api import ConfigurationPolicyVEdgeRouteDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyVEdgeRouteDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyVEdgeRouteDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVEdgeRouteDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition24(self): + """Test case for create_policy_definition24 + + """ + pass + + def test_delete_policy_definition24(self): + """Test case for delete_policy_definition24 + + """ + pass + + def test_edit_multiple_policy_definition24(self): + """Test case for edit_multiple_policy_definition24 + + """ + pass + + def test_edit_policy_definition24(self): + """Test case for edit_policy_definition24 + + """ + pass + + def test_get_definitions24(self): + """Test case for get_definitions24 + + """ + pass + + def test_get_policy_definition24(self): + """Test case for get_policy_definition24 + + """ + pass + + def test_preview_policy_definition24(self): + """Test case for preview_policy_definition24 + + """ + pass + + def test_preview_policy_definition_by_id24(self): + """Test case for preview_policy_definition_by_id24 + + """ + pass + + def test_save_policy_definition_in_bulk24(self): + """Test case for save_policy_definition_in_bulk24 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_v_smart_assembler_api.py b/test/test_configuration_policy_v_smart_assembler_api.py new file mode 100644 index 0000000..2328f5d --- /dev/null +++ b/test/test_configuration_policy_v_smart_assembler_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_v_smart_assembler_api import ConfigurationPolicyVSmartAssemblerApi # noqa: E501 + + +class TestConfigurationPolicyVSmartAssemblerApi(unittest.TestCase): + """ConfigurationPolicyVSmartAssemblerApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVSmartAssemblerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_preview3(self): + """Test case for preview3 + + """ + pass + + def test_preview_by_id3(self): + """Test case for preview_by_id3 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_voice_assembler_api.py b/test/test_configuration_policy_voice_assembler_api.py new file mode 100644 index 0000000..7ea73c6 --- /dev/null +++ b/test/test_configuration_policy_voice_assembler_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_voice_assembler_api import ConfigurationPolicyVoiceAssemblerApi # noqa: E501 + + +class TestConfigurationPolicyVoiceAssemblerApi(unittest.TestCase): + """ConfigurationPolicyVoiceAssemblerApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVoiceAssemblerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_preview2(self): + """Test case for preview2 + + """ + pass + + def test_preview_by_id2(self): + """Test case for preview_by_id2 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_vpn_list_builder_api.py b/test/test_configuration_policy_vpn_list_builder_api.py new file mode 100644 index 0000000..4fdf8f6 --- /dev/null +++ b/test/test_configuration_policy_vpn_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_vpn_list_builder_api import ConfigurationPolicyVPNListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyVPNListBuilderApi(unittest.TestCase): + """ConfigurationPolicyVPNListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVPNListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list41(self): + """Test case for create_policy_list41 + + """ + pass + + def test_delete_policy_list41(self): + """Test case for delete_policy_list41 + + """ + pass + + def test_delete_policy_lists_with_info_tag41(self): + """Test case for delete_policy_lists_with_info_tag41 + + """ + pass + + def test_edit_policy_list41(self): + """Test case for edit_policy_list41 + + """ + pass + + def test_get_lists_by_id41(self): + """Test case for get_lists_by_id41 + + """ + pass + + def test_get_policy_lists38(self): + """Test case for get_policy_lists38 + + """ + pass + + def test_get_policy_lists_with_info_tag41(self): + """Test case for get_policy_lists_with_info_tag41 + + """ + pass + + def test_preview_policy_list41(self): + """Test case for preview_policy_list41 + + """ + pass + + def test_preview_policy_list_by_id41(self): + """Test case for preview_policy_list_by_id41 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_vpn_membership_group_definition_builder_api.py b/test/test_configuration_policy_vpn_membership_group_definition_builder_api.py new file mode 100644 index 0000000..8b3815a --- /dev/null +++ b/test/test_configuration_policy_vpn_membership_group_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_vpn_membership_group_definition_builder_api import ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition6(self): + """Test case for create_policy_definition6 + + """ + pass + + def test_delete_policy_definition6(self): + """Test case for delete_policy_definition6 + + """ + pass + + def test_edit_multiple_policy_definition6(self): + """Test case for edit_multiple_policy_definition6 + + """ + pass + + def test_edit_policy_definition6(self): + """Test case for edit_policy_definition6 + + """ + pass + + def test_get_definitions6(self): + """Test case for get_definitions6 + + """ + pass + + def test_get_policy_definition6(self): + """Test case for get_policy_definition6 + + """ + pass + + def test_preview_policy_definition6(self): + """Test case for preview_policy_definition6 + + """ + pass + + def test_preview_policy_definition_by_id6(self): + """Test case for preview_policy_definition_by_id6 + + """ + pass + + def test_save_policy_definition_in_bulk6(self): + """Test case for save_policy_definition_in_bulk6 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_vpn_qos_map_definition_builder_api.py b/test/test_configuration_policy_vpn_qos_map_definition_builder_api.py new file mode 100644 index 0000000..60dd5ba --- /dev/null +++ b/test/test_configuration_policy_vpn_qos_map_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_vpn_qos_map_definition_builder_api import ConfigurationPolicyVPNQosMapDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyVPNQosMapDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyVPNQosMapDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyVPNQosMapDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition2(self): + """Test case for create_policy_definition2 + + """ + pass + + def test_delete_policy_definition2(self): + """Test case for delete_policy_definition2 + + """ + pass + + def test_edit_multiple_policy_definition2(self): + """Test case for edit_multiple_policy_definition2 + + """ + pass + + def test_edit_policy_definition2(self): + """Test case for edit_policy_definition2 + + """ + pass + + def test_get_definitions2(self): + """Test case for get_definitions2 + + """ + pass + + def test_get_policy_definition2(self): + """Test case for get_policy_definition2 + + """ + pass + + def test_preview_policy_definition2(self): + """Test case for preview_policy_definition2 + + """ + pass + + def test_preview_policy_definition_by_id2(self): + """Test case for preview_policy_definition_by_id2 + + """ + pass + + def test_save_policy_definition_in_bulk2(self): + """Test case for save_policy_definition_in_bulk2 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_zone_based_firewall_definition_builder_api.py b/test/test_configuration_policy_zone_based_firewall_definition_builder_api.py new file mode 100644 index 0000000..3821cd3 --- /dev/null +++ b/test/test_configuration_policy_zone_based_firewall_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_zone_based_firewall_definition_builder_api import ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi(unittest.TestCase): + """ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyZoneBasedFirewallDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition7(self): + """Test case for create_policy_definition7 + + """ + pass + + def test_delete_policy_definition7(self): + """Test case for delete_policy_definition7 + + """ + pass + + def test_edit_multiple_policy_definition7(self): + """Test case for edit_multiple_policy_definition7 + + """ + pass + + def test_edit_policy_definition7(self): + """Test case for edit_policy_definition7 + + """ + pass + + def test_get_definitions7(self): + """Test case for get_definitions7 + + """ + pass + + def test_get_policy_definition7(self): + """Test case for get_policy_definition7 + + """ + pass + + def test_preview_policy_definition7(self): + """Test case for preview_policy_definition7 + + """ + pass + + def test_preview_policy_definition_by_id7(self): + """Test case for preview_policy_definition_by_id7 + + """ + pass + + def test_save_policy_definition_in_bulk7(self): + """Test case for save_policy_definition_in_bulk7 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_policy_zone_list_builder_api.py b/test/test_configuration_policy_zone_list_builder_api.py new file mode 100644 index 0000000..9b64477 --- /dev/null +++ b/test/test_configuration_policy_zone_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_policy_zone_list_builder_api import ConfigurationPolicyZoneListBuilderApi # noqa: E501 + + +class TestConfigurationPolicyZoneListBuilderApi(unittest.TestCase): + """ConfigurationPolicyZoneListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPolicyZoneListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list42(self): + """Test case for create_policy_list42 + + """ + pass + + def test_delete_policy_list42(self): + """Test case for delete_policy_list42 + + """ + pass + + def test_delete_policy_lists_with_info_tag42(self): + """Test case for delete_policy_lists_with_info_tag42 + + """ + pass + + def test_edit_policy_list42(self): + """Test case for edit_policy_list42 + + """ + pass + + def test_get_lists_by_id42(self): + """Test case for get_lists_by_id42 + + """ + pass + + def test_get_policy_lists39(self): + """Test case for get_policy_lists39 + + """ + pass + + def test_get_policy_lists_with_info_tag42(self): + """Test case for get_policy_lists_with_info_tag42 + + """ + pass + + def test_preview_policy_list42(self): + """Test case for preview_policy_list42 + + """ + pass + + def test_preview_policy_list_by_id42(self): + """Test case for preview_policy_list_by_id42 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_pre_upgrade_check_status_api.py b/test/test_configuration_pre_upgrade_check_status_api.py new file mode 100644 index 0000000..5f9d71b --- /dev/null +++ b/test/test_configuration_pre_upgrade_check_status_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_pre_upgrade_check_status_api import ConfigurationPreUpgradeCheckStatusApi # noqa: E501 + + +class TestConfigurationPreUpgradeCheckStatusApi(unittest.TestCase): + """ConfigurationPreUpgradeCheckStatusApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPreUpgradeCheckStatusApi() # noqa: E501 + + def tearDown(self): + pass + + def test_update_pre_upgrade_check_status(self): + """Test case for update_pre_upgrade_check_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_preferred_color_group_list_builder_api.py b/test/test_configuration_preferred_color_group_list_builder_api.py new file mode 100644 index 0000000..ab86318 --- /dev/null +++ b/test/test_configuration_preferred_color_group_list_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_preferred_color_group_list_builder_api import ConfigurationPreferredColorGroupListBuilderApi # noqa: E501 + + +class TestConfigurationPreferredColorGroupListBuilderApi(unittest.TestCase): + """ConfigurationPreferredColorGroupListBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationPreferredColorGroupListBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_list28(self): + """Test case for create_policy_list28 + + """ + pass + + def test_delete_policy_list28(self): + """Test case for delete_policy_list28 + + """ + pass + + def test_delete_policy_lists_with_info_tag28(self): + """Test case for delete_policy_lists_with_info_tag28 + + """ + pass + + def test_edit_policy_list28(self): + """Test case for edit_policy_list28 + + """ + pass + + def test_get_lists_by_id28(self): + """Test case for get_lists_by_id28 + + """ + pass + + def test_get_policy_lists25(self): + """Test case for get_policy_lists25 + + """ + pass + + def test_get_policy_lists_with_info_tag28(self): + """Test case for get_policy_lists_with_info_tag28 + + """ + pass + + def test_preview_policy_list28(self): + """Test case for preview_policy_list28 + + """ + pass + + def test_preview_policy_list_by_id28(self): + """Test case for preview_policy_list_by_id28 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_quick_connect_api.py b/test/test_configuration_quick_connect_api.py new file mode 100644 index 0000000..aa00c21 --- /dev/null +++ b/test/test_configuration_quick_connect_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_quick_connect_api import ConfigurationQuickConnectApi # noqa: E501 + + +class TestConfigurationQuickConnectApi(unittest.TestCase): + """ConfigurationQuickConnectApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationQuickConnectApi() # noqa: E501 + + def tearDown(self): + pass + + def test_submit_day0_config(self): + """Test case for submit_day0_config + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_rule_set_definition_api.py b/test/test_configuration_rule_set_definition_api.py new file mode 100644 index 0000000..ff3b8bd --- /dev/null +++ b/test/test_configuration_rule_set_definition_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_rule_set_definition_api import ConfigurationRuleSetDefinitionApi # noqa: E501 + + +class TestConfigurationRuleSetDefinitionApi(unittest.TestCase): + """ConfigurationRuleSetDefinitionApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationRuleSetDefinitionApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition20(self): + """Test case for create_policy_definition20 + + """ + pass + + def test_delete_policy_definition20(self): + """Test case for delete_policy_definition20 + + """ + pass + + def test_edit_multiple_policy_definition20(self): + """Test case for edit_multiple_policy_definition20 + + """ + pass + + def test_edit_policy_definition20(self): + """Test case for edit_policy_definition20 + + """ + pass + + def test_get_definitions20(self): + """Test case for get_definitions20 + + """ + pass + + def test_get_policy_definition20(self): + """Test case for get_policy_definition20 + + """ + pass + + def test_preview_policy_definition20(self): + """Test case for preview_policy_definition20 + + """ + pass + + def test_preview_policy_definition_by_id20(self): + """Test case for preview_policy_definition_by_id20 + + """ + pass + + def test_save_policy_definition_in_bulk20(self): + """Test case for save_policy_definition_in_bulk20 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_secure_internet_gateway_tunnels_api.py b/test/test_configuration_secure_internet_gateway_tunnels_api.py new file mode 100644 index 0000000..5a0b6d9 --- /dev/null +++ b/test/test_configuration_secure_internet_gateway_tunnels_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_secure_internet_gateway_tunnels_api import ConfigurationSecureInternetGatewayTunnelsApi # noqa: E501 + + +class TestConfigurationSecureInternetGatewayTunnelsApi(unittest.TestCase): + """ConfigurationSecureInternetGatewayTunnelsApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSecureInternetGatewayTunnelsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_sig_tunnel_list1(self): + """Test case for get_sig_tunnel_list1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_security_group_definition_api.py b/test/test_configuration_security_group_definition_api.py new file mode 100644 index 0000000..d81216c --- /dev/null +++ b/test/test_configuration_security_group_definition_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_security_group_definition_api import ConfigurationSecurityGroupDefinitionApi # noqa: E501 + + +class TestConfigurationSecurityGroupDefinitionApi(unittest.TestCase): + """ConfigurationSecurityGroupDefinitionApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSecurityGroupDefinitionApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition21(self): + """Test case for create_policy_definition21 + + """ + pass + + def test_delete_policy_definition21(self): + """Test case for delete_policy_definition21 + + """ + pass + + def test_edit_multiple_policy_definition21(self): + """Test case for edit_multiple_policy_definition21 + + """ + pass + + def test_edit_policy_definition21(self): + """Test case for edit_policy_definition21 + + """ + pass + + def test_get_definitions21(self): + """Test case for get_definitions21 + + """ + pass + + def test_get_policy_definition21(self): + """Test case for get_policy_definition21 + + """ + pass + + def test_preview_policy_definition21(self): + """Test case for preview_policy_definition21 + + """ + pass + + def test_preview_policy_definition_by_id21(self): + """Test case for preview_policy_definition_by_id21 + + """ + pass + + def test_save_policy_definition_in_bulk21(self): + """Test case for save_policy_definition_in_bulk21 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_security_template_policy_api.py b/test/test_configuration_security_template_policy_api.py new file mode 100644 index 0000000..ec7b323 --- /dev/null +++ b/test/test_configuration_security_template_policy_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_security_template_policy_api import ConfigurationSecurityTemplatePolicyApi # noqa: E501 + + +class TestConfigurationSecurityTemplatePolicyApi(unittest.TestCase): + """ConfigurationSecurityTemplatePolicyApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSecurityTemplatePolicyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_security_template(self): + """Test case for create_security_template + + """ + pass + + def test_delete_security_template(self): + """Test case for delete_security_template + + """ + pass + + def test_edit_security_template(self): + """Test case for edit_security_template + + """ + pass + + def test_edit_template_with_lenient_lock(self): + """Test case for edit_template_with_lenient_lock + + """ + pass + + def test_generate_security_policy_summary(self): + """Test case for generate_security_policy_summary + + """ + pass + + def test_generate_security_template_list(self): + """Test case for generate_security_template_list + + """ + pass + + def test_get_device_list_by_id(self): + """Test case for get_device_list_by_id + + """ + pass + + def test_get_security_policy_device_list(self): + """Test case for get_security_policy_device_list + + """ + pass + + def test_get_security_template(self): + """Test case for get_security_template + + """ + pass + + def test_get_security_templates_for_device(self): + """Test case for get_security_templates_for_device + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_segments_api.py b/test/test_configuration_segments_api.py new file mode 100644 index 0000000..46d8a11 --- /dev/null +++ b/test/test_configuration_segments_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_segments_api import ConfigurationSegmentsApi # noqa: E501 + + +class TestConfigurationSegmentsApi(unittest.TestCase): + """ConfigurationSegmentsApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSegmentsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_segment(self): + """Test case for create_segment + + """ + pass + + def test_delete_segment(self): + """Test case for delete_segment + + """ + pass + + def test_edit_segment(self): + """Test case for edit_segment + + """ + pass + + def test_get_segment(self): + """Test case for get_segment + + """ + pass + + def test_get_segments(self): + """Test case for get_segments + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_settings_api.py b/test/test_configuration_settings_api.py new file mode 100644 index 0000000..213104c --- /dev/null +++ b/test/test_configuration_settings_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_settings_api import ConfigurationSettingsApi # noqa: E501 + + +class TestConfigurationSettingsApi(unittest.TestCase): + """ConfigurationSettingsApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSettingsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_analytics_data_file(self): + """Test case for create_analytics_data_file + + """ + pass + + def test_edit_cert_configuration(self): + """Test case for edit_cert_configuration + + """ + pass + + def test_edit_configuration(self): + """Test case for edit_configuration + + """ + pass + + def test_get_banner(self): + """Test case for get_banner + + """ + pass + + def test_get_cert_configuration(self): + """Test case for get_cert_configuration + + """ + pass + + def test_get_configuration_by_setting_type(self): + """Test case for get_configuration_by_setting_type + + """ + pass + + def test_get_google_map_key(self): + """Test case for get_google_map_key + + """ + pass + + def test_get_maintenance_window(self): + """Test case for get_maintenance_window + + """ + pass + + def test_get_password_policy(self): + """Test case for get_password_policy + + """ + pass + + def test_get_session_timout(self): + """Test case for get_session_timout + + """ + pass + + def test_new_cert_configuration(self): + """Test case for new_cert_configuration + + """ + pass + + def test_new_configuration(self): + """Test case for new_configuration + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_software_actions_api.py b/test/test_configuration_software_actions_api.py new file mode 100644 index 0000000..642e000 --- /dev/null +++ b/test/test_configuration_software_actions_api.py @@ -0,0 +1,137 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_software_actions_api import ConfigurationSoftwareActionsApi # noqa: E501 + + +class TestConfigurationSoftwareActionsApi(unittest.TestCase): + """ConfigurationSoftwareActionsApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSoftwareActionsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_remote_server(self): + """Test case for add_remote_server + + """ + pass + + def test_create_image_url(self): + """Test case for create_image_url + + """ + pass + + def test_delete_image_url(self): + """Test case for delete_image_url + + """ + pass + + def test_delete_remote_server(self): + """Test case for delete_remote_server + + """ + pass + + def test_edit_image_remote_server(self): + """Test case for edit_image_remote_server + + """ + pass + + def test_find_software_images(self): + """Test case for find_software_images + + """ + pass + + def test_find_software_images_with_filters(self): + """Test case for find_software_images_with_filters + + """ + pass + + def test_find_software_version(self): + """Test case for find_software_version + + """ + pass + + def test_find_v_edge_software_version(self): + """Test case for find_v_edge_software_version + + """ + pass + + def test_find_ztp_software_version(self): + """Test case for find_ztp_software_version + + """ + pass + + def test_get_image_properties(self): + """Test case for get_image_properties + + """ + pass + + def test_get_image_remote_server(self): + """Test case for get_image_remote_server + + """ + pass + + def test_get_pnf_properties(self): + """Test case for get_pnf_properties + + """ + pass + + def test_get_remote_server_by_id(self): + """Test case for get_remote_server_by_id + + """ + pass + + def test_get_remote_server_list(self): + """Test case for get_remote_server_list + + """ + pass + + def test_get_vnf_properties(self): + """Test case for get_vnf_properties + + """ + pass + + def test_update_image_url(self): + """Test case for update_image_url + + """ + pass + + def test_update_remote_server(self): + """Test case for update_remote_server + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_ssl_decryption_policy_definition_builder_api.py b/test/test_configuration_ssl_decryption_policy_definition_builder_api.py new file mode 100644 index 0000000..36e1d29 --- /dev/null +++ b/test/test_configuration_ssl_decryption_policy_definition_builder_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_ssl_decryption_policy_definition_builder_api import ConfigurationSSLDecryptionPolicyDefinitionBuilderApi # noqa: E501 + + +class TestConfigurationSSLDecryptionPolicyDefinitionBuilderApi(unittest.TestCase): + """ConfigurationSSLDecryptionPolicyDefinitionBuilderApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSSLDecryptionPolicyDefinitionBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition3(self): + """Test case for create_policy_definition3 + + """ + pass + + def test_delete_policy_definition3(self): + """Test case for delete_policy_definition3 + + """ + pass + + def test_edit_multiple_policy_definition3(self): + """Test case for edit_multiple_policy_definition3 + + """ + pass + + def test_edit_policy_definition3(self): + """Test case for edit_policy_definition3 + + """ + pass + + def test_get_definitions3(self): + """Test case for get_definitions3 + + """ + pass + + def test_get_policy_definition3(self): + """Test case for get_policy_definition3 + + """ + pass + + def test_preview_policy_definition3(self): + """Test case for preview_policy_definition3 + + """ + pass + + def test_preview_policy_definition_by_id3(self): + """Test case for preview_policy_definition_by_id3 + + """ + pass + + def test_save_policy_definition_in_bulk3(self): + """Test case for save_policy_definition_in_bulk3 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_ssl_decryption_utd_profile_definition_api.py b/test/test_configuration_ssl_decryption_utd_profile_definition_api.py new file mode 100644 index 0000000..fa6eee3 --- /dev/null +++ b/test/test_configuration_ssl_decryption_utd_profile_definition_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_ssl_decryption_utd_profile_definition_api import ConfigurationSSLDecryptionUTDProfileDefinitionApi # noqa: E501 + + +class TestConfigurationSSLDecryptionUTDProfileDefinitionApi(unittest.TestCase): + """ConfigurationSSLDecryptionUTDProfileDefinitionApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationSSLDecryptionUTDProfileDefinitionApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_policy_definition22(self): + """Test case for create_policy_definition22 + + """ + pass + + def test_delete_policy_definition22(self): + """Test case for delete_policy_definition22 + + """ + pass + + def test_edit_multiple_policy_definition22(self): + """Test case for edit_multiple_policy_definition22 + + """ + pass + + def test_edit_policy_definition22(self): + """Test case for edit_policy_definition22 + + """ + pass + + def test_get_definitions22(self): + """Test case for get_definitions22 + + """ + pass + + def test_get_policy_definition22(self): + """Test case for get_policy_definition22 + + """ + pass + + def test_preview_policy_definition22(self): + """Test case for preview_policy_definition22 + + """ + pass + + def test_preview_policy_definition_by_id22(self): + """Test case for preview_policy_definition_by_id22 + + """ + pass + + def test_save_policy_definition_in_bulk22(self): + """Test case for save_policy_definition_in_bulk22 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_template_configuration_api.py b/test/test_configuration_template_configuration_api.py new file mode 100644 index 0000000..303539d --- /dev/null +++ b/test/test_configuration_template_configuration_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_template_configuration_api import ConfigurationTemplateConfigurationApi # noqa: E501 + + +class TestConfigurationTemplateConfigurationApi(unittest.TestCase): + """ConfigurationTemplateConfigurationApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationTemplateConfigurationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_generate_cli_mode_devices(self): + """Test case for generate_cli_mode_devices + + """ + pass + + def test_generatev_manage_mode_devices(self): + """Test case for generatev_manage_mode_devices + + """ + pass + + def test_get_attached_config(self): + """Test case for get_attached_config + + """ + pass + + def test_get_compatible_devices(self): + """Test case for get_compatible_devices + + """ + pass + + def test_get_device_diff(self): + """Test case for get_device_diff + + """ + pass + + def test_get_running_config(self): + """Test case for get_running_config + + """ + pass + + def test_get_vpn_for_device(self): + """Test case for get_vpn_for_device + + """ + pass + + def test_rma_update(self): + """Test case for rma_update + + """ + pass + + def test_update_device_to_cli_mode(self): + """Test case for update_device_to_cli_mode + + """ + pass + + def test_upload_config(self): + """Test case for upload_config + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_template_lock_api.py b/test/test_configuration_template_lock_api.py new file mode 100644 index 0000000..ab0cbb4 --- /dev/null +++ b/test/test_configuration_template_lock_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_template_lock_api import ConfigurationTemplateLockApi # noqa: E501 + + +class TestConfigurationTemplateLockApi(unittest.TestCase): + """ConfigurationTemplateLockApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationTemplateLockApi() # noqa: E501 + + def tearDown(self): + pass + + def test_remove_lock(self): + """Test case for remove_lock + + """ + pass + + def test_update_lease_time(self): + """Test case for update_lease_time + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_template_master_api.py b/test/test_configuration_template_master_api.py new file mode 100644 index 0000000..d2061fb --- /dev/null +++ b/test/test_configuration_template_master_api.py @@ -0,0 +1,107 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_template_master_api import ConfigurationTemplateMasterApi # noqa: E501 + + +class TestConfigurationTemplateMasterApi(unittest.TestCase): + """ConfigurationTemplateMasterApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationTemplateMasterApi() # noqa: E501 + + def tearDown(self): + pass + + def test_change_template_resource_group1(self): + """Test case for change_template_resource_group1 + + """ + pass + + def test_create_cli_template(self): + """Test case for create_cli_template + + """ + pass + + def test_create_master_template(self): + """Test case for create_master_template + + """ + pass + + def test_delete_master_template(self): + """Test case for delete_master_template + + """ + pass + + def test_edit_master_template(self): + """Test case for edit_master_template + + """ + pass + + def test_generate_master_template_list(self): + """Test case for generate_master_template_list + + """ + pass + + def test_generate_template_for_migration(self): + """Test case for generate_template_for_migration + + """ + pass + + def test_get_master_template_definition(self): + """Test case for get_master_template_definition + + """ + pass + + def test_get_out_of_sync_devices(self): + """Test case for get_out_of_sync_devices + + """ + pass + + def test_get_out_of_sync_templates(self): + """Test case for get_out_of_sync_templates + + """ + pass + + def test_is_migration_required(self): + """Test case for is_migration_required + + """ + pass + + def test_migrate_templates(self): + """Test case for migrate_templates + + """ + pass + + def test_migration_info(self): + """Test case for migration_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_topology_api.py b/test/test_configuration_topology_api.py new file mode 100644 index 0000000..5924ce8 --- /dev/null +++ b/test/test_configuration_topology_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_topology_api import ConfigurationTopologyApi # noqa: E501 + + +class TestConfigurationTopologyApi(unittest.TestCase): + """ConfigurationTopologyApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationTopologyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_device_topology(self): + """Test case for create_device_topology + + """ + pass + + def test_create_full_topology(self): + """Test case for create_full_topology + + """ + pass + + def test_create_physical_topology(self): + """Test case for create_physical_topology + + """ + pass + + def test_get_site_topology(self): + """Test case for get_site_topology + + """ + pass + + def test_get_site_topology_monitor_data(self): + """Test case for get_site_topology_monitor_data + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_v_edge_template_policy_api.py b/test/test_configuration_v_edge_template_policy_api.py new file mode 100644 index 0000000..cf33d11 --- /dev/null +++ b/test/test_configuration_v_edge_template_policy_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_v_edge_template_policy_api import ConfigurationVEdgeTemplatePolicyApi # noqa: E501 + + +class TestConfigurationVEdgeTemplatePolicyApi(unittest.TestCase): + """ConfigurationVEdgeTemplatePolicyApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationVEdgeTemplatePolicyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_change_policy_resource_group(self): + """Test case for change_policy_resource_group + + """ + pass + + def test_create_v_edge_template(self): + """Test case for create_v_edge_template + + """ + pass + + def test_delete_v_edge_template(self): + """Test case for delete_v_edge_template + + """ + pass + + def test_edit_v_edge_template(self): + """Test case for edit_v_edge_template + + """ + pass + + def test_generate_policy_template_list(self): + """Test case for generate_policy_template_list + + """ + pass + + def test_get_device_list_by_policy(self): + """Test case for get_device_list_by_policy + + """ + pass + + def test_get_v_edge_policy_device_list(self): + """Test case for get_v_edge_policy_device_list + + """ + pass + + def test_get_v_edge_template(self): + """Test case for get_v_edge_template + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_v_smart_template_policy_api.py b/test/test_configuration_v_smart_template_policy_api.py new file mode 100644 index 0000000..4881a46 --- /dev/null +++ b/test/test_configuration_v_smart_template_policy_api.py @@ -0,0 +1,95 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_v_smart_template_policy_api import ConfigurationVSmartTemplatePolicyApi # noqa: E501 + + +class TestConfigurationVSmartTemplatePolicyApi(unittest.TestCase): + """ConfigurationVSmartTemplatePolicyApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationVSmartTemplatePolicyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_activate_policy(self): + """Test case for activate_policy + + """ + pass + + def test_activate_policy_for_cloud_services(self): + """Test case for activate_policy_for_cloud_services + + """ + pass + + def test_check_v_smart_connectivity_status(self): + """Test case for check_v_smart_connectivity_status + + """ + pass + + def test_create_v_smart_template(self): + """Test case for create_v_smart_template + + """ + pass + + def test_de_activate_policy(self): + """Test case for de_activate_policy + + """ + pass + + def test_delete_v_smart_template(self): + """Test case for delete_v_smart_template + + """ + pass + + def test_edit_template_without_lock_checks(self): + """Test case for edit_template_without_lock_checks + + """ + pass + + def test_edit_v_smart_template(self): + """Test case for edit_v_smart_template + + """ + pass + + def test_generate_v_smart_policy_template_list(self): + """Test case for generate_v_smart_policy_template_list + + """ + pass + + def test_get_template_by_policy_id(self): + """Test case for get_template_by_policy_id + + """ + pass + + def test_qosmos_nbar_migration_warning(self): + """Test case for qosmos_nbar_migration_warning + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_configuration_voice_template_policy_api.py b/test/test_configuration_voice_template_policy_api.py new file mode 100644 index 0000000..4b19995 --- /dev/null +++ b/test/test_configuration_voice_template_policy_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.configuration_voice_template_policy_api import ConfigurationVoiceTemplatePolicyApi # noqa: E501 + + +class TestConfigurationVoiceTemplatePolicyApi(unittest.TestCase): + """ConfigurationVoiceTemplatePolicyApi unit test stubs""" + + def setUp(self): + self.api = ConfigurationVoiceTemplatePolicyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_voice_template(self): + """Test case for create_voice_template + + """ + pass + + def test_delete_voice_template(self): + """Test case for delete_voice_template + + """ + pass + + def test_edit_voice_template(self): + """Test case for edit_voice_template + + """ + pass + + def test_generate_voice_policy_summary(self): + """Test case for generate_voice_policy_summary + + """ + pass + + def test_generate_voice_template_list(self): + """Test case for generate_voice_template_list + + """ + pass + + def test_get_device_list_by_policy_id(self): + """Test case for get_device_list_by_policy_id + + """ + pass + + def test_get_template_by_id(self): + """Test case for get_template_by_id + + """ + pass + + def test_get_voice_policy_device_list(self): + """Test case for get_voice_policy_device_list + + """ + pass + + def test_get_voice_templates_for_device(self): + """Test case for get_voice_templates_for_device + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_connect_to_ntp_server.py b/test/test_connect_to_ntp_server.py new file mode 100644 index 0000000..00c367c --- /dev/null +++ b/test/test_connect_to_ntp_server.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.connect_to_ntp_server import ConnectToNtpServer + + +class TestConnectToNtpServer(unittest.TestCase): + """ConnectToNtpServer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectToNtpServer(self): + """Test ConnectToNtpServer""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectToNtpServer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_control_status.py b/test/test_control_status.py new file mode 100644 index 0000000..4aac058 --- /dev/null +++ b/test/test_control_status.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.control_status import ControlStatus + + +class TestControlStatus(unittest.TestCase): + """ControlStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testControlStatus(self): + """Test ControlStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = ControlStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_corporate_wifi.py b/test/test_corporate_wifi.py new file mode 100644 index 0000000..95ace9b --- /dev/null +++ b/test/test_corporate_wifi.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.radius_server import RadiusServer +globals()['RadiusServer'] = RadiusServer +from openapi_client.model.corporate_wifi import CorporateWifi + + +class TestCorporateWifi(unittest.TestCase): + """CorporateWifi unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCorporateWifi(self): + """Test CorporateWifi""" + # FIXME: construct object with mandatory attributes with example values + # model = CorporateWifi() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_country_region_settings.py b/test/test_country_region_settings.py new file mode 100644 index 0000000..364322d --- /dev/null +++ b/test/test_country_region_settings.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.country_region_settings import CountryRegionSettings + + +class TestCountryRegionSettings(unittest.TestCase): + """CountryRegionSettings unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCountryRegionSettings(self): + """Test CountryRegionSettings""" + # FIXME: construct object with mandatory attributes with example values + # model = CountryRegionSettings() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_device_params.py b/test/test_create_device_params.py new file mode 100644 index 0000000..5c1eaa6 --- /dev/null +++ b/test/test_create_device_params.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.create_device_params import CreateDeviceParams + + +class TestCreateDeviceParams(unittest.TestCase): + """CreateDeviceParams unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateDeviceParams(self): + """Test CreateDeviceParams""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateDeviceParams() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_tenant_model.py b/test/test_create_tenant_model.py new file mode 100644 index 0000000..f78473e --- /dev/null +++ b/test/test_create_tenant_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.create_tenant_model import CreateTenantModel + + +class TestCreateTenantModel(unittest.TestCase): + """CreateTenantModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateTenantModel(self): + """Test CreateTenantModel""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateTenantModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_data_center.py b/test/test_data_center.py new file mode 100644 index 0000000..fc0bd32 --- /dev/null +++ b/test/test_data_center.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.node import Node +globals()['Node'] = Node +from openapi_client.model.data_center import DataCenter + + +class TestDataCenter(unittest.TestCase): + """DataCenter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDataCenter(self): + """Test DataCenter""" + # FIXME: construct object with mandatory attributes with example values + # model = DataCenter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_data_center_registration.py b/test/test_data_center_registration.py new file mode 100644 index 0000000..8a1bf7b --- /dev/null +++ b/test/test_data_center_registration.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.data_center import DataCenter +from openapi_client.model.disaster_recovery_settings import DisasterRecoverySettings +from openapi_client.model.host import Host +from openapi_client.model.node import Node +globals()['DataCenter'] = DataCenter +globals()['DisasterRecoverySettings'] = DisasterRecoverySettings +globals()['Host'] = Host +globals()['Node'] = Node +from openapi_client.model.data_center_registration import DataCenterRegistration + + +class TestDataCenterRegistration(unittest.TestCase): + """DataCenterRegistration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDataCenterRegistration(self): + """Test DataCenterRegistration""" + # FIXME: construct object with mandatory attributes with example values + # model = DataCenterRegistration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_data_collection_agent_api.py b/test/test_data_collection_agent_api.py new file mode 100644 index 0000000..87494f7 --- /dev/null +++ b/test/test_data_collection_agent_api.py @@ -0,0 +1,167 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.data_collection_agent_api import DataCollectionAgentApi # noqa: E501 + + +class TestDataCollectionAgentApi(unittest.TestCase): + """DataCollectionAgentApi unit test stubs""" + + def setUp(self): + self.api = DataCollectionAgentApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_dca_analytics_data_file(self): + """Test case for create_dca_analytics_data_file + + """ + pass + + def test_create_stats(self): + """Test case for create_stats + + """ + pass + + def test_generate_alarm(self): + """Test case for generate_alarm + + """ + pass + + def test_generate_dca_device_state_data(self): + """Test case for generate_dca_device_state_data + + """ + pass + + def test_generate_dca_device_statistics_data(self): + """Test case for generate_dca_device_statistics_data + + """ + pass + + def test_get_access_token(self): + """Test case for get_access_token + + """ + pass + + def test_get_all_stats_data_dca(self): + """Test case for get_all_stats_data_dca + + """ + pass + + def test_get_cloud_services_configuration_dca(self): + """Test case for get_cloud_services_configuration_dca + + """ + pass + + def test_get_crash_logs(self): + """Test case for get_crash_logs + + """ + pass + + def test_get_crash_logs_synced(self): + """Test case for get_crash_logs_synced + + """ + pass + + def test_get_dca_attached_config_to_device(self): + """Test case for get_dca_attached_config_to_device + + """ + pass + + def test_get_dca_tenant_owners(self): + """Test case for get_dca_tenant_owners + + """ + pass + + def test_get_devices_details_dca(self): + """Test case for get_devices_details_dca + + """ + pass + + def test_get_id_token(self): + """Test case for get_id_token + + """ + pass + + def test_get_stats_db_index_status(self): + """Test case for get_stats_db_index_status + + """ + pass + + def test_get_telemetry_settings(self): + """Test case for get_telemetry_settings + + """ + pass + + def test_get_template_policy_definitions_dca(self): + """Test case for get_template_policy_definitions_dca + + """ + pass + + def test_get_vedge_template_list_dca(self): + """Test case for get_vedge_template_list_dca + + """ + pass + + def test_get_vpn_lists_dca(self): + """Test case for get_vpn_lists_dca + + """ + pass + + def test_get_vsmart_template_list_dca(self): + """Test case for get_vsmart_template_list_dca + + """ + pass + + def test_list_all_devices_dca(self): + """Test case for list_all_devices_dca + + """ + pass + + def test_store_access_token(self): + """Test case for store_access_token + + """ + pass + + def test_store_id_token(self): + """Test case for store_id_token + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_tenant_bulk_model.py b/test/test_delete_tenant_bulk_model.py new file mode 100644 index 0000000..ccd1944 --- /dev/null +++ b/test/test_delete_tenant_bulk_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.delete_tenant_bulk_model import DeleteTenantBulkModel + + +class TestDeleteTenantBulkModel(unittest.TestCase): + """DeleteTenantBulkModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteTenantBulkModel(self): + """Test DeleteTenantBulkModel""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteTenantBulkModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_tenant_model.py b/test/test_delete_tenant_model.py new file mode 100644 index 0000000..aea2524 --- /dev/null +++ b/test/test_delete_tenant_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.delete_tenant_model import DeleteTenantModel + + +class TestDeleteTenantModel(unittest.TestCase): + """DeleteTenantModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteTenantModel(self): + """Test DeleteTenantModel""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteTenantModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_deployment_mode_api.py b/test/test_deployment_mode_api.py new file mode 100644 index 0000000..04f5c9a --- /dev/null +++ b/test/test_deployment_mode_api.py @@ -0,0 +1,71 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.deployment_mode_api import DeploymentModeApi # noqa: E501 + + +class TestDeploymentModeApi(unittest.TestCase): + """DeploymentModeApi unit test stubs""" + + def setUp(self): + self.api = DeploymentModeApi() # noqa: E501 + + def tearDown(self): + pass + + def test_config_fedramp_mode(self): + """Test case for config_fedramp_mode + + """ + pass + + def test_configure_dns_sec(self): + """Test case for configure_dns_sec + + """ + pass + + def test_configure_wazuh_client(self): + """Test case for configure_wazuh_client + + """ + pass + + def test_get_dns_sec_status(self): + """Test case for get_dns_sec_status + + """ + pass + + def test_get_wazuh_agent_status(self): + """Test case for get_wazuh_agent_status + + """ + pass + + def test_reques_dns_sec_actions(self): + """Test case for reques_dns_sec_actions + + """ + pass + + def test_request_wazuh_actions(self): + """Test case for request_wazuh_actions + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device.py b/test/test_device.py new file mode 100644 index 0000000..e59222b --- /dev/null +++ b/test/test_device.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device import Device + + +class TestDevice(unittest.TestCase): + """Device unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDevice(self): + """Test Device""" + # FIXME: construct object with mandatory attributes with example values + # model = Device() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_health_details.py b/test/test_device_health_details.py new file mode 100644 index 0000000..12fc2e6 --- /dev/null +++ b/test/test_device_health_details.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device_health_details import DeviceHealthDetails + + +class TestDeviceHealthDetails(unittest.TestCase): + """DeviceHealthDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeviceHealthDetails(self): + """Test DeviceHealthDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = DeviceHealthDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_ip.py b/test/test_device_ip.py new file mode 100644 index 0000000..9b23a73 --- /dev/null +++ b/test/test_device_ip.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device_ip import DeviceIP + + +class TestDeviceIP(unittest.TestCase): + """DeviceIP unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeviceIP(self): + """Test DeviceIP""" + # FIXME: construct object with mandatory attributes with example values + # model = DeviceIP() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_messaging_api.py b/test/test_device_messaging_api.py new file mode 100644 index 0000000..6a304b8 --- /dev/null +++ b/test/test_device_messaging_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.device_messaging_api import DeviceMessagingApi # noqa: E501 + + +class TestDeviceMessagingApi(unittest.TestCase): + """DeviceMessagingApi unit test stubs""" + + def setUp(self): + self.api = DeviceMessagingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_device_vmanage_connection_list(self): + """Test case for create_device_vmanage_connection_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_model.py b/test/test_device_model.py new file mode 100644 index 0000000..f2d5d9e --- /dev/null +++ b/test/test_device_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device_model import DeviceModel + + +class TestDeviceModel(unittest.TestCase): + """DeviceModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeviceModel(self): + """Test DeviceModel""" + # FIXME: construct object with mandatory attributes with example values + # model = DeviceModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_network_api.py b/test/test_device_network_api.py new file mode 100644 index 0000000..632c22c --- /dev/null +++ b/test/test_device_network_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.device_network_api import DeviceNetworkApi # noqa: E501 + + +class TestDeviceNetworkApi(unittest.TestCase): + """DeviceNetworkApi unit test stubs""" + + def setUp(self): + self.api = DeviceNetworkApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_network_issues_summary(self): + """Test case for get_network_issues_summary + + """ + pass + + def test_get_network_status_summary(self): + """Test case for get_network_status_summary + + """ + pass + + def test_get_reboot_count(self): + """Test case for get_reboot_count + + """ + pass + + def test_get_vmanage_control_status(self): + """Test case for get_vmanage_control_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_type.py b/test/test_device_type.py new file mode 100644 index 0000000..073917d --- /dev/null +++ b/test/test_device_type.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device_type import DeviceType + + +class TestDeviceType(unittest.TestCase): + """DeviceType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeviceType(self): + """Test DeviceType""" + # FIXME: construct object with mandatory attributes with example values + # model = DeviceType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_device_uuid.py b/test/test_device_uuid.py new file mode 100644 index 0000000..bd3921f --- /dev/null +++ b/test/test_device_uuid.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device_uuid import DeviceUuid + + +class TestDeviceUuid(unittest.TestCase): + """DeviceUuid unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeviceUuid(self): + """Test DeviceUuid""" + # FIXME: construct object with mandatory attributes with example values + # model = DeviceUuid() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_devices_health.py b/test/test_devices_health.py new file mode 100644 index 0000000..7925495 --- /dev/null +++ b/test/test_devices_health.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.device_health_details import DeviceHealthDetails +globals()['DeviceHealthDetails'] = DeviceHealthDetails +from openapi_client.model.devices_health import DevicesHealth + + +class TestDevicesHealth(unittest.TestCase): + """DevicesHealth unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDevicesHealth(self): + """Test DevicesHealth""" + # FIXME: construct object with mandatory attributes with example values + # model = DevicesHealth() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_devices_health_overview.py b/test/test_devices_health_overview.py new file mode 100644 index 0000000..879db99 --- /dev/null +++ b/test/test_devices_health_overview.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.devices_health_overview import DevicesHealthOverview + + +class TestDevicesHealthOverview(unittest.TestCase): + """DevicesHealthOverview unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDevicesHealthOverview(self): + """Test DevicesHealthOverview""" + # FIXME: construct object with mandatory attributes with example values + # model = DevicesHealthOverview() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_dhcp_pool.py b/test/test_dhcp_pool.py new file mode 100644 index 0000000..06a54cc --- /dev/null +++ b/test/test_dhcp_pool.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.dhcp_pool import DHCPPool + + +class TestDHCPPool(unittest.TestCase): + """DHCPPool unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDHCPPool(self): + """Test DHCPPool""" + # FIXME: construct object with mandatory attributes with example values + # model = DHCPPool() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_disaster_recovery_settings.py b/test/test_disaster_recovery_settings.py new file mode 100644 index 0000000..4cb75e5 --- /dev/null +++ b/test/test_disaster_recovery_settings.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.disaster_recovery_settings import DisasterRecoverySettings + + +class TestDisasterRecoverySettings(unittest.TestCase): + """DisasterRecoverySettings unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDisasterRecoverySettings(self): + """Test DisasterRecoverySettings""" + # FIXME: construct object with mandatory attributes with example values + # model = DisasterRecoverySettings() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_domain_detail.py b/test/test_domain_detail.py new file mode 100644 index 0000000..ebabeb4 --- /dev/null +++ b/test/test_domain_detail.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.domain_detail import DomainDetail + + +class TestDomainDetail(unittest.TestCase): + """DomainDetail unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDomainDetail(self): + """Test DomainDetail""" + # FIXME: construct object with mandatory attributes with example values + # model = DomainDetail() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_entity_ownership_info.py b/test/test_entity_ownership_info.py new file mode 100644 index 0000000..216a46c --- /dev/null +++ b/test/test_entity_ownership_info.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.entity_ownership_info import EntityOwnershipInfo + + +class TestEntityOwnershipInfo(unittest.TestCase): + """EntityOwnershipInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEntityOwnershipInfo(self): + """Test EntityOwnershipInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = EntityOwnershipInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_equinix_credentials.py b/test/test_equinix_credentials.py new file mode 100644 index 0000000..d201841 --- /dev/null +++ b/test/test_equinix_credentials.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_credentials import EquinixCredentials + + +class TestEquinixCredentials(unittest.TestCase): + """EquinixCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEquinixCredentials(self): + """Test EquinixCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = EquinixCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_equinix_location_info.py b/test/test_equinix_location_info.py new file mode 100644 index 0000000..7f5f94b --- /dev/null +++ b/test/test_equinix_location_info.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_ne_info import EquinixNEInfo +from openapi_client.model.multi_cloud_edge_billing_account_info import MultiCloudEdgeBillingAccountInfo +globals()['EquinixNEInfo'] = EquinixNEInfo +globals()['MultiCloudEdgeBillingAccountInfo'] = MultiCloudEdgeBillingAccountInfo +from openapi_client.model.equinix_location_info import EquinixLocationInfo + + +class TestEquinixLocationInfo(unittest.TestCase): + """EquinixLocationInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEquinixLocationInfo(self): + """Test EquinixLocationInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = EquinixLocationInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_equinix_ne_info.py b/test/test_equinix_ne_info.py new file mode 100644 index 0000000..77824f9 --- /dev/null +++ b/test/test_equinix_ne_info.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_ne_info import EquinixNEInfo + + +class TestEquinixNEInfo(unittest.TestCase): + """EquinixNEInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEquinixNEInfo(self): + """Test EquinixNEInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = EquinixNEInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_equinix_partner_port.py b/test/test_equinix_partner_port.py new file mode 100644 index 0000000..f88db3b --- /dev/null +++ b/test/test_equinix_partner_port.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_partner_port import EquinixPartnerPort + + +class TestEquinixPartnerPort(unittest.TestCase): + """EquinixPartnerPort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEquinixPartnerPort(self): + """Test EquinixPartnerPort""" + # FIXME: construct object with mandatory attributes with example values + # model = EquinixPartnerPort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ethernet.py b/test/test_ethernet.py new file mode 100644 index 0000000..ef69930 --- /dev/null +++ b/test/test_ethernet.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ethernet_all_of import EthernetAllOf +from openapi_client.model.ethernet_interface import EthernetInterface +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.variable import Variable +globals()['EthernetAllOf'] = EthernetAllOf +globals()['EthernetInterface'] = EthernetInterface +globals()['ProfileParcel'] = ProfileParcel +globals()['Variable'] = Variable +from openapi_client.model.ethernet import Ethernet + + +class TestEthernet(unittest.TestCase): + """Ethernet unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEthernet(self): + """Test Ethernet""" + # FIXME: construct object with mandatory attributes with example values + # model = Ethernet() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ethernet_all_of.py b/test/test_ethernet_all_of.py new file mode 100644 index 0000000..f585e72 --- /dev/null +++ b/test/test_ethernet_all_of.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ethernet_interface import EthernetInterface +globals()['EthernetInterface'] = EthernetInterface +from openapi_client.model.ethernet_all_of import EthernetAllOf + + +class TestEthernetAllOf(unittest.TestCase): + """EthernetAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEthernetAllOf(self): + """Test EthernetAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = EthernetAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ethernet_interface.py b/test/test_ethernet_interface.py new file mode 100644 index 0000000..96665fe --- /dev/null +++ b/test/test_ethernet_interface.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ethernet_interface import EthernetInterface + + +class TestEthernetInterface(unittest.TestCase): + """EthernetInterface unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEthernetInterface(self): + """Test EthernetInterface""" + # FIXME: construct object with mandatory attributes with example values + # model = EthernetInterface() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_event_name.py b/test/test_event_name.py new file mode 100644 index 0000000..e9f3bb0 --- /dev/null +++ b/test/test_event_name.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.event_name import EventName + + +class TestEventName(unittest.TestCase): + """EventName unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEventName(self): + """Test EventName""" + # FIXME: construct object with mandatory attributes with example values + # model = EventName() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_feature_profile.py b/test/test_feature_profile.py new file mode 100644 index 0000000..0d06ec7 --- /dev/null +++ b/test/test_feature_profile.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.feature_profile import FeatureProfile + + +class TestFeatureProfile(unittest.TestCase): + """FeatureProfile unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFeatureProfile(self): + """Test FeatureProfile""" + # FIXME: construct object with mandatory attributes with example values + # model = FeatureProfile() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_gcp_credentials.py b/test/test_gcp_credentials.py new file mode 100644 index 0000000..67f4fca --- /dev/null +++ b/test/test_gcp_credentials.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.gcp_credentials import GcpCredentials + + +class TestGcpCredentials(unittest.TestCase): + """GcpCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGcpCredentials(self): + """Test GcpCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = GcpCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_o365_preferred_path_from_v_analytics_request.py b/test/test_get_o365_preferred_path_from_v_analytics_request.py new file mode 100644 index 0000000..43879f7 --- /dev/null +++ b/test/test_get_o365_preferred_path_from_v_analytics_request.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request_value import GetO365PreferredPathFromVAnalyticsRequestValue +globals()['GetO365PreferredPathFromVAnalyticsRequestValue'] = GetO365PreferredPathFromVAnalyticsRequestValue +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request import GetO365PreferredPathFromVAnalyticsRequest + + +class TestGetO365PreferredPathFromVAnalyticsRequest(unittest.TestCase): + """GetO365PreferredPathFromVAnalyticsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetO365PreferredPathFromVAnalyticsRequest(self): + """Test GetO365PreferredPathFromVAnalyticsRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = GetO365PreferredPathFromVAnalyticsRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_o365_preferred_path_from_v_analytics_request_value.py b/test/test_get_o365_preferred_path_from_v_analytics_request_value.py new file mode 100644 index 0000000..cf21c97 --- /dev/null +++ b/test/test_get_o365_preferred_path_from_v_analytics_request_value.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request_value import GetO365PreferredPathFromVAnalyticsRequestValue + + +class TestGetO365PreferredPathFromVAnalyticsRequestValue(unittest.TestCase): + """GetO365PreferredPathFromVAnalyticsRequestValue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetO365PreferredPathFromVAnalyticsRequestValue(self): + """Test GetO365PreferredPathFromVAnalyticsRequestValue""" + # FIXME: construct object with mandatory attributes with example values + # model = GetO365PreferredPathFromVAnalyticsRequestValue() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_global_settings.py b/test/test_global_settings.py new file mode 100644 index 0000000..b8760c7 --- /dev/null +++ b/test/test_global_settings.py @@ -0,0 +1,58 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.banner import Banner +from openapi_client.model.bfd import Bfd +from openapi_client.model.connect_to_ntp_server import ConnectToNtpServer +from openapi_client.model.global_settings_all_of import GlobalSettingsAllOf +from openapi_client.model.ip_sec_security import IpSecSecurity +from openapi_client.model.logging_system_messages import LoggingSystemMessages +from openapi_client.model.login_access_to_router import LoginAccessToRouter +from openapi_client.model.omp import OMP +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.systems import Systems +from openapi_client.model.variable import Variable +globals()['Banner'] = Banner +globals()['Bfd'] = Bfd +globals()['ConnectToNtpServer'] = ConnectToNtpServer +globals()['GlobalSettingsAllOf'] = GlobalSettingsAllOf +globals()['IpSecSecurity'] = IpSecSecurity +globals()['LoggingSystemMessages'] = LoggingSystemMessages +globals()['LoginAccessToRouter'] = LoginAccessToRouter +globals()['OMP'] = OMP +globals()['ProfileParcel'] = ProfileParcel +globals()['Systems'] = Systems +globals()['Variable'] = Variable +from openapi_client.model.global_settings import GlobalSettings + + +class TestGlobalSettings(unittest.TestCase): + """GlobalSettings unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGlobalSettings(self): + """Test GlobalSettings""" + # FIXME: construct object with mandatory attributes with example values + # model = GlobalSettings() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_global_settings_all_of.py b/test/test_global_settings_all_of.py new file mode 100644 index 0000000..ac31b18 --- /dev/null +++ b/test/test_global_settings_all_of.py @@ -0,0 +1,52 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.banner import Banner +from openapi_client.model.bfd import Bfd +from openapi_client.model.connect_to_ntp_server import ConnectToNtpServer +from openapi_client.model.ip_sec_security import IpSecSecurity +from openapi_client.model.logging_system_messages import LoggingSystemMessages +from openapi_client.model.login_access_to_router import LoginAccessToRouter +from openapi_client.model.omp import OMP +from openapi_client.model.systems import Systems +globals()['Banner'] = Banner +globals()['Bfd'] = Bfd +globals()['ConnectToNtpServer'] = ConnectToNtpServer +globals()['IpSecSecurity'] = IpSecSecurity +globals()['LoggingSystemMessages'] = LoggingSystemMessages +globals()['LoginAccessToRouter'] = LoginAccessToRouter +globals()['OMP'] = OMP +globals()['Systems'] = Systems +from openapi_client.model.global_settings_all_of import GlobalSettingsAllOf + + +class TestGlobalSettingsAllOf(unittest.TestCase): + """GlobalSettingsAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGlobalSettingsAllOf(self): + """Test GlobalSettingsAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = GlobalSettingsAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_group_id.py b/test/test_group_id.py new file mode 100644 index 0000000..722eccd --- /dev/null +++ b/test/test_group_id.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.group_id import GroupId + + +class TestGroupId(unittest.TestCase): + """GroupId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGroupId(self): + """Test GroupId""" + # FIXME: construct object with mandatory attributes with example values + # model = GroupId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_guest_wifi.py b/test/test_guest_wifi.py new file mode 100644 index 0000000..3643414 --- /dev/null +++ b/test/test_guest_wifi.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.guest_wifi import GuestWifi + + +class TestGuestWifi(unittest.TestCase): + """GuestWifi unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGuestWifi(self): + """Test GuestWifi""" + # FIXME: construct object with mandatory attributes with example values + # model = GuestWifi() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_header.py b/test/test_header.py new file mode 100644 index 0000000..7622ad7 --- /dev/null +++ b/test/test_header.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.header_element import HeaderElement +globals()['HeaderElement'] = HeaderElement +from openapi_client.model.header import Header + + +class TestHeader(unittest.TestCase): + """Header unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHeader(self): + """Test Header""" + # FIXME: construct object with mandatory attributes with example values + # model = Header() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_header_element.py b/test/test_header_element.py new file mode 100644 index 0000000..1dd5cb6 --- /dev/null +++ b/test/test_header_element.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.name_value_pair import NameValuePair +globals()['NameValuePair'] = NameValuePair +from openapi_client.model.header_element import HeaderElement + + +class TestHeaderElement(unittest.TestCase): + """HeaderElement unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHeaderElement(self): + """Test HeaderElement""" + # FIXME: construct object with mandatory attributes with example values + # model = HeaderElement() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_host.py b/test/test_host.py new file mode 100644 index 0000000..c641062 --- /dev/null +++ b/test/test_host.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.host import Host + + +class TestHost(unittest.TestCase): + """Host unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHost(self): + """Test Host""" + # FIXME: construct object with mandatory attributes with example values + # model = Host() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_hsec_activate_api.py b/test/test_hsec_activate_api.py new file mode 100644 index 0000000..3522572 --- /dev/null +++ b/test/test_hsec_activate_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.hsec_activate_api import HsecActivateApi # noqa: E501 + + +class TestHsecActivateApi(unittest.TestCase): + """HsecActivateApi unit test stubs""" + + def setUp(self): + self.api = HsecActivateApi() # noqa: E501 + + def tearDown(self): + pass + + def test_activate_hsec_licenses(self): + """Test case for activate_hsec_licenses + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_hsec_api.py b/test/test_hsec_api.py new file mode 100644 index 0000000..f24d04e --- /dev/null +++ b/test/test_hsec_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.hsec_api import HSECApi # noqa: E501 + + +class TestHSECApi(unittest.TestCase): + """HSECApi unit test stubs""" + + def setUp(self): + self.api = HSECApi() # noqa: E501 + + def tearDown(self): + pass + + def test_assign_slac(self): + """Test case for assign_slac + + """ + pass + + def test_device_summmary(self): + """Test case for device_summmary + + """ + pass + + def test_device_summmary1(self): + """Test case for device_summmary1 + + """ + pass + + def test_download_slac_request_file(self): + """Test case for download_slac_request_file + + """ + pass + + def test_fetch_accounts1(self): + """Test case for fetch_accounts1 + + """ + pass + + def test_upload_slac_file(self): + """Test case for upload_slac_file + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_hsec_license_api.py b/test/test_hsec_license_api.py new file mode 100644 index 0000000..ee17bfe --- /dev/null +++ b/test/test_hsec_license_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.hsec_license_api import HSECLicenseApi # noqa: E501 + + +class TestHSECLicenseApi(unittest.TestCase): + """HSECLicenseApi unit test stubs""" + + def setUp(self): + self.api = HSECLicenseApi() # noqa: E501 + + def tearDown(self): + pass + + def test_hsecassign(self): + """Test case for hsecassign + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ike_phase.py b/test/test_ike_phase.py new file mode 100644 index 0000000..6b826ba --- /dev/null +++ b/test/test_ike_phase.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ike_phase import IkePhase + + +class TestIkePhase(unittest.TestCase): + """IkePhase unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIkePhase(self): + """Test IkePhase""" + # FIXME: construct object with mandatory attributes with example values + # model = IkePhase() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ip_sec_policy.py b/test/test_ip_sec_policy.py new file mode 100644 index 0000000..a682d73 --- /dev/null +++ b/test/test_ip_sec_policy.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ike_phase import IkePhase +globals()['IkePhase'] = IkePhase +from openapi_client.model.ip_sec_policy import IpSecPolicy + + +class TestIpSecPolicy(unittest.TestCase): + """IpSecPolicy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIpSecPolicy(self): + """Test IpSecPolicy""" + # FIXME: construct object with mandatory attributes with example values + # model = IpSecPolicy() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ip_sec_security.py b/test/test_ip_sec_security.py new file mode 100644 index 0000000..427dd1a --- /dev/null +++ b/test/test_ip_sec_security.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ip_sec_security import IpSecSecurity + + +class TestIpSecSecurity(unittest.TestCase): + """IpSecSecurity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIpSecSecurity(self): + """Test IpSecSecurity""" + # FIXME: construct object with mandatory attributes with example values + # model = IpSecSecurity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_locale_api.py b/test/test_locale_api.py new file mode 100644 index 0000000..6aefdf5 --- /dev/null +++ b/test/test_locale_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.locale_api import LocaleApi # noqa: E501 + + +class TestLocaleApi(unittest.TestCase): + """LocaleApi unit test stubs""" + + def setUp(self): + self.api = LocaleApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_supported_locales(self): + """Test case for get_supported_locales + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_logging_system_messages.py b/test/test_logging_system_messages.py new file mode 100644 index 0000000..1dfd94d --- /dev/null +++ b/test/test_logging_system_messages.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.logging_system_messages import LoggingSystemMessages + + +class TestLoggingSystemMessages(unittest.TestCase): + """LoggingSystemMessages unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLoggingSystemMessages(self): + """Test LoggingSystemMessages""" + # FIXME: construct object with mandatory attributes with example values + # model = LoggingSystemMessages() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_login_access_to_router.py b/test/test_login_access_to_router.py new file mode 100644 index 0000000..bf2c081 --- /dev/null +++ b/test/test_login_access_to_router.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.login_access_to_router import LoginAccessToRouter + + +class TestLoginAccessToRouter(unittest.TestCase): + """LoginAccessToRouter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLoginAccessToRouter(self): + """Test LoginAccessToRouter""" + # FIXME: construct object with mandatory attributes with example values + # model = LoginAccessToRouter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_lte_timer.py b/test/test_lte_timer.py new file mode 100644 index 0000000..41ae29b --- /dev/null +++ b/test/test_lte_timer.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.lte_timer import LteTimer + + +class TestLteTimer(unittest.TestCase): + """LteTimer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLteTimer(self): + """Test LteTimer""" + # FIXME: construct object with mandatory attributes with example values + # model = LteTimer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_megaport_credentials.py b/test/test_megaport_credentials.py new file mode 100644 index 0000000..2be9403 --- /dev/null +++ b/test/test_megaport_credentials.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.megaport_credentials import MegaportCredentials + + +class TestMegaportCredentials(unittest.TestCase): + """MegaportCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMegaportCredentials(self): + """Test MegaportCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = MegaportCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_megaport_location_info.py b/test/test_megaport_location_info.py new file mode 100644 index 0000000..b9053dd --- /dev/null +++ b/test/test_megaport_location_info.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.megaport_mve_info import MegaportMVEInfo +globals()['MegaportMVEInfo'] = MegaportMVEInfo +from openapi_client.model.megaport_location_info import MegaportLocationInfo + + +class TestMegaportLocationInfo(unittest.TestCase): + """MegaportLocationInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMegaportLocationInfo(self): + """Test MegaportLocationInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = MegaportLocationInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_megaport_mve_info.py b/test/test_megaport_mve_info.py new file mode 100644 index 0000000..9096b6a --- /dev/null +++ b/test/test_megaport_mve_info.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.megaport_mve_info import MegaportMVEInfo + + +class TestMegaportMVEInfo(unittest.TestCase): + """MegaportMVEInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMegaportMVEInfo(self): + """Test MegaportMVEInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = MegaportMVEInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_megaport_partner_port.py b/test/test_megaport_partner_port.py new file mode 100644 index 0000000..ee73a07 --- /dev/null +++ b/test/test_megaport_partner_port.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.megaport_partner_port import MegaportPartnerPort + + +class TestMegaportPartnerPort(unittest.TestCase): + """MegaportPartnerPort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMegaportPartnerPort(self): + """Test MegaportPartnerPort""" + # FIXME: construct object with mandatory attributes with example values + # model = MegaportPartnerPort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_alarms_details_api.py b/test/test_monitoring_alarms_details_api.py new file mode 100644 index 0000000..ddf9bdf --- /dev/null +++ b/test/test_monitoring_alarms_details_api.py @@ -0,0 +1,233 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_alarms_details_api import MonitoringAlarmsDetailsApi # noqa: E501 + + +class TestMonitoringAlarmsDetailsApi(unittest.TestCase): + """MonitoringAlarmsDetailsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringAlarmsDetailsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_clear_stale_alarm(self): + """Test case for clear_stale_alarm + + """ + pass + + def test_correl_anti_entropy(self): + """Test case for correl_anti_entropy + + """ + pass + + def test_create_alarm_query_config(self): + """Test case for create_alarm_query_config + + """ + pass + + def test_disable_enable_alarm(self): + """Test case for disable_enable_alarm + + """ + pass + + def test_dump_correlation_engine_data(self): + """Test case for dump_correlation_engine_data + + """ + pass + + def test_enable_disable_link_state_alarm(self): + """Test case for enable_disable_link_state_alarm + + """ + pass + + def test_get_alarm_aggregation_data(self): + """Test case for get_alarm_aggregation_data + + """ + pass + + def test_get_alarm_details(self): + """Test case for get_alarm_details + + """ + pass + + def test_get_alarm_severity_custom_histogram(self): + """Test case for get_alarm_severity_custom_histogram + + """ + pass + + def test_get_alarm_severity_mappings(self): + """Test case for get_alarm_severity_mappings + + """ + pass + + def test_get_alarm_types_as_key_value(self): + """Test case for get_alarm_types_as_key_value + + """ + pass + + def test_get_alarms(self): + """Test case for get_alarms + + """ + pass + + def test_get_alarms_by_severity(self): + """Test case for get_alarms_by_severity + + """ + pass + + def test_get_count1(self): + """Test case for get_count1 + + """ + pass + + def test_get_count_post1(self): + """Test case for get_count_post1 + + """ + pass + + def test_get_device_topic(self): + """Test case for get_device_topic + + """ + pass + + def test_get_link_state_alarm_config(self): + """Test case for get_link_state_alarm_config + + """ + pass + + def test_get_master_manager_state(self): + """Test case for get_master_manager_state + + """ + pass + + def test_get_non_viewed_active_alarms_count(self): + """Test case for get_non_viewed_active_alarms_count + + """ + pass + + def test_get_non_viewed_alarms(self): + """Test case for get_non_viewed_alarms + + """ + pass + + def test_get_post_alarm_aggregation_data(self): + """Test case for get_post_alarm_aggregation_data + + """ + pass + + def test_get_post_stat_bulk_alarm_raw_data(self): + """Test case for get_post_stat_bulk_alarm_raw_data + + """ + pass + + def test_get_raw_alarm_data(self): + """Test case for get_raw_alarm_data + + """ + pass + + def test_get_stat_bulk_alarm_raw_data(self): + """Test case for get_stat_bulk_alarm_raw_data + + """ + pass + + def test_get_stat_data_fields1(self): + """Test case for get_stat_data_fields1 + + """ + pass + + def test_get_stat_query_fields1(self): + """Test case for get_stat_query_fields1 + + """ + pass + + def test_get_stats(self): + """Test case for get_stats + + """ + pass + + def test_list_disabled_alarm(self): + """Test case for list_disabled_alarm + + """ + pass + + def test_mark_alarms_as_viewed(self): + """Test case for mark_alarms_as_viewed + + """ + pass + + def test_mark_all_alarms_as_viewed(self): + """Test case for mark_all_alarms_as_viewed + + """ + pass + + def test_restart_correlation_engine(self): + """Test case for restart_correlation_engine + + """ + pass + + def test_set_periodic_purge_timer(self): + """Test case for set_periodic_purge_timer + + """ + pass + + def test_start_tracking(self): + """Test case for start_tracking + + """ + pass + + def test_stop_tracking(self): + """Test case for stop_tracking + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_alarms_notification_api.py b/test/test_monitoring_alarms_notification_api.py new file mode 100644 index 0000000..1dc9386 --- /dev/null +++ b/test/test_monitoring_alarms_notification_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_alarms_notification_api import MonitoringAlarmsNotificationApi # noqa: E501 + + +class TestMonitoringAlarmsNotificationApi(unittest.TestCase): + """MonitoringAlarmsNotificationApi unit test stubs""" + + def setUp(self): + self.api = MonitoringAlarmsNotificationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_notification_rule(self): + """Test case for create_notification_rule + + """ + pass + + def test_delete_notification_rule(self): + """Test case for delete_notification_rule + + """ + pass + + def test_get_notification_rule(self): + """Test case for get_notification_rule + + """ + pass + + def test_update_notification_rule(self): + """Test case for update_notification_rule + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_app_hosting_api.py b/test/test_monitoring_app_hosting_api.py new file mode 100644 index 0000000..c5744bd --- /dev/null +++ b/test/test_monitoring_app_hosting_api.py @@ -0,0 +1,173 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_app_hosting_api import MonitoringAppHostingApi # noqa: E501 + + +class TestMonitoringAppHostingApi(unittest.TestCase): + """MonitoringAppHostingApi unit test stubs""" + + def setUp(self): + self.api = MonitoringAppHostingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query(self): + """Test case for get_aggregation_data_by_query + + """ + pass + + def test_get_aggregation_data_by_query1(self): + """Test case for get_aggregation_data_by_query1 + + """ + pass + + def test_get_count2(self): + """Test case for get_count2 + + """ + pass + + def test_get_count3(self): + """Test case for get_count3 + + """ + pass + + def test_get_count_post2(self): + """Test case for get_count_post2 + + """ + pass + + def test_get_count_post3(self): + """Test case for get_count_post3 + + """ + pass + + def test_get_post_aggregation_app_data_by_query(self): + """Test case for get_post_aggregation_app_data_by_query + + """ + pass + + def test_get_post_aggregation_app_data_by_query1(self): + """Test case for get_post_aggregation_app_data_by_query1 + + """ + pass + + def test_get_post_aggregation_data_by_query(self): + """Test case for get_post_aggregation_data_by_query + + """ + pass + + def test_get_post_aggregation_data_by_query1(self): + """Test case for get_post_aggregation_data_by_query1 + + """ + pass + + def test_get_post_stat_bulk_raw_data(self): + """Test case for get_post_stat_bulk_raw_data + + """ + pass + + def test_get_post_stat_bulk_raw_data1(self): + """Test case for get_post_stat_bulk_raw_data1 + + """ + pass + + def test_get_stat_bulk_raw_data(self): + """Test case for get_stat_bulk_raw_data + + """ + pass + + def test_get_stat_bulk_raw_data1(self): + """Test case for get_stat_bulk_raw_data1 + + """ + pass + + def test_get_stat_data_fields2(self): + """Test case for get_stat_data_fields2 + + """ + pass + + def test_get_stat_data_fields3(self): + """Test case for get_stat_data_fields3 + + """ + pass + + def test_get_stat_data_raw_data(self): + """Test case for get_stat_data_raw_data + + """ + pass + + def test_get_stat_data_raw_data1(self): + """Test case for get_stat_data_raw_data1 + + """ + pass + + def test_get_stat_data_raw_data_as_csv(self): + """Test case for get_stat_data_raw_data_as_csv + + """ + pass + + def test_get_stat_data_raw_data_as_csv1(self): + """Test case for get_stat_data_raw_data_as_csv1 + + """ + pass + + def test_get_stat_query_fields2(self): + """Test case for get_stat_query_fields2 + + """ + pass + + def test_get_stat_query_fields3(self): + """Test case for get_stat_query_fields3 + + """ + pass + + def test_get_stats_raw_data(self): + """Test case for get_stats_raw_data + + """ + pass + + def test_get_stats_raw_data1(self): + """Test case for get_stats_raw_data1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_application_aware_routing_api.py b/test/test_monitoring_application_aware_routing_api.py new file mode 100644 index 0000000..1e619b1 --- /dev/null +++ b/test/test_monitoring_application_aware_routing_api.py @@ -0,0 +1,155 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_application_aware_routing_api import MonitoringApplicationAwareRoutingApi # noqa: E501 + + +class TestMonitoringApplicationAwareRoutingApi(unittest.TestCase): + """MonitoringApplicationAwareRoutingApi unit test stubs""" + + def setUp(self): + self.api = MonitoringApplicationAwareRoutingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_app_route(self): + """Test case for get_aggregation_data_app_route + + """ + pass + + def test_get_aggregation_data_by_query2(self): + """Test case for get_aggregation_data_by_query2 + + """ + pass + + def test_get_approute_grid_stat(self): + """Test case for get_approute_grid_stat + + """ + pass + + def test_get_count4(self): + """Test case for get_count4 + + """ + pass + + def test_get_count_post4(self): + """Test case for get_count_post4 + + """ + pass + + def test_get_post_aggregation_app_data_by_query2(self): + """Test case for get_post_aggregation_app_data_by_query2 + + """ + pass + + def test_get_post_aggregation_data_by_query2(self): + """Test case for get_post_aggregation_data_by_query2 + + """ + pass + + def test_get_post_stat_bulk_raw_data2(self): + """Test case for get_post_stat_bulk_raw_data2 + + """ + pass + + def test_get_stat_bulk_raw_data2(self): + """Test case for get_stat_bulk_raw_data2 + + """ + pass + + def test_get_stat_data_fields4(self): + """Test case for get_stat_data_fields4 + + """ + pass + + def test_get_stat_data_raw_data2(self): + """Test case for get_stat_data_raw_data2 + + """ + pass + + def test_get_stat_data_raw_data_as_csv2(self): + """Test case for get_stat_data_raw_data_as_csv2 + + """ + pass + + def test_get_stat_query_fields4(self): + """Test case for get_stat_query_fields4 + + """ + pass + + def test_get_stats_raw_data2(self): + """Test case for get_stats_raw_data2 + + """ + pass + + def test_get_transport_health(self): + """Test case for get_transport_health + + """ + pass + + def test_get_transport_health_summary(self): + """Test case for get_transport_health_summary + + """ + pass + + def test_get_tunnel(self): + """Test case for get_tunnel + + """ + pass + + def test_get_tunnel_chart(self): + """Test case for get_tunnel_chart + + """ + pass + + def test_get_tunnels(self): + """Test case for get_tunnels + + """ + pass + + def test_get_tunnels_health(self): + """Test case for get_tunnels_health + + """ + pass + + def test_get_tunnels_summary(self): + """Test case for get_tunnels_summary + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_application_aware_routing_statistics_api.py b/test/test_monitoring_application_aware_routing_statistics_api.py new file mode 100644 index 0000000..9ff55c8 --- /dev/null +++ b/test/test_monitoring_application_aware_routing_statistics_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_application_aware_routing_statistics_api import MonitoringApplicationAwareRoutingStatisticsApi # noqa: E501 + + +class TestMonitoringApplicationAwareRoutingStatisticsApi(unittest.TestCase): + """MonitoringApplicationAwareRoutingStatisticsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringApplicationAwareRoutingStatisticsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_transport_health(self): + """Test case for get_transport_health + + """ + pass + + def test_get_transport_health_summary(self): + """Test case for get_transport_health_summary + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_art_api.py b/test/test_monitoring_art_api.py new file mode 100644 index 0000000..fd138fb --- /dev/null +++ b/test/test_monitoring_art_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_art_api import MonitoringARTApi # noqa: E501 + + +class TestMonitoringARTApi(unittest.TestCase): + """MonitoringARTApi unit test stubs""" + + def setUp(self): + self.api = MonitoringARTApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query3(self): + """Test case for get_aggregation_data_by_query3 + + """ + pass + + def test_get_count5(self): + """Test case for get_count5 + + """ + pass + + def test_get_count_post5(self): + """Test case for get_count_post5 + + """ + pass + + def test_get_post_aggregation_app_data_by_query3(self): + """Test case for get_post_aggregation_app_data_by_query3 + + """ + pass + + def test_get_post_aggregation_data_by_query3(self): + """Test case for get_post_aggregation_data_by_query3 + + """ + pass + + def test_get_post_stat_bulk_raw_data3(self): + """Test case for get_post_stat_bulk_raw_data3 + + """ + pass + + def test_get_stat_bulk_raw_data3(self): + """Test case for get_stat_bulk_raw_data3 + + """ + pass + + def test_get_stat_data_fields5(self): + """Test case for get_stat_data_fields5 + + """ + pass + + def test_get_stat_data_raw_data3(self): + """Test case for get_stat_data_raw_data3 + + """ + pass + + def test_get_stat_data_raw_data_as_csv3(self): + """Test case for get_stat_data_raw_data_as_csv3 + + """ + pass + + def test_get_stat_query_fields5(self): + """Test case for get_stat_query_fields5 + + """ + pass + + def test_get_stats_raw_data3(self): + """Test case for get_stats_raw_data3 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_bfd_api.py b/test/test_monitoring_bfd_api.py new file mode 100644 index 0000000..e437ad9 --- /dev/null +++ b/test/test_monitoring_bfd_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_bfd_api import MonitoringBFDApi # noqa: E501 + + +class TestMonitoringBFDApi(unittest.TestCase): + """MonitoringBFDApi unit test stubs""" + + def setUp(self): + self.api = MonitoringBFDApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query4(self): + """Test case for get_aggregation_data_by_query4 + + """ + pass + + def test_get_count6(self): + """Test case for get_count6 + + """ + pass + + def test_get_count_post6(self): + """Test case for get_count_post6 + + """ + pass + + def test_get_post_aggregation_app_data_by_query4(self): + """Test case for get_post_aggregation_app_data_by_query4 + + """ + pass + + def test_get_post_aggregation_data_by_query4(self): + """Test case for get_post_aggregation_data_by_query4 + + """ + pass + + def test_get_post_stat_bulk_raw_data4(self): + """Test case for get_post_stat_bulk_raw_data4 + + """ + pass + + def test_get_stat_bulk_raw_data4(self): + """Test case for get_stat_bulk_raw_data4 + + """ + pass + + def test_get_stat_data_fields6(self): + """Test case for get_stat_data_fields6 + + """ + pass + + def test_get_stat_data_raw_data4(self): + """Test case for get_stat_data_raw_data4 + + """ + pass + + def test_get_stat_data_raw_data_as_csv4(self): + """Test case for get_stat_data_raw_data_as_csv4 + + """ + pass + + def test_get_stat_query_fields6(self): + """Test case for get_stat_query_fields6 + + """ + pass + + def test_get_stats_raw_data4(self): + """Test case for get_stats_raw_data4 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_bridge_api.py b/test/test_monitoring_bridge_api.py new file mode 100644 index 0000000..908cb0e --- /dev/null +++ b/test/test_monitoring_bridge_api.py @@ -0,0 +1,173 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_bridge_api import MonitoringBridgeApi # noqa: E501 + + +class TestMonitoringBridgeApi(unittest.TestCase): + """MonitoringBridgeApi unit test stubs""" + + def setUp(self): + self.api = MonitoringBridgeApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query5(self): + """Test case for get_aggregation_data_by_query5 + + """ + pass + + def test_get_aggregation_data_by_query6(self): + """Test case for get_aggregation_data_by_query6 + + """ + pass + + def test_get_count7(self): + """Test case for get_count7 + + """ + pass + + def test_get_count8(self): + """Test case for get_count8 + + """ + pass + + def test_get_count_post7(self): + """Test case for get_count_post7 + + """ + pass + + def test_get_count_post8(self): + """Test case for get_count_post8 + + """ + pass + + def test_get_post_aggregation_app_data_by_query5(self): + """Test case for get_post_aggregation_app_data_by_query5 + + """ + pass + + def test_get_post_aggregation_app_data_by_query6(self): + """Test case for get_post_aggregation_app_data_by_query6 + + """ + pass + + def test_get_post_aggregation_data_by_query5(self): + """Test case for get_post_aggregation_data_by_query5 + + """ + pass + + def test_get_post_aggregation_data_by_query6(self): + """Test case for get_post_aggregation_data_by_query6 + + """ + pass + + def test_get_post_stat_bulk_raw_data5(self): + """Test case for get_post_stat_bulk_raw_data5 + + """ + pass + + def test_get_post_stat_bulk_raw_data6(self): + """Test case for get_post_stat_bulk_raw_data6 + + """ + pass + + def test_get_stat_bulk_raw_data5(self): + """Test case for get_stat_bulk_raw_data5 + + """ + pass + + def test_get_stat_bulk_raw_data6(self): + """Test case for get_stat_bulk_raw_data6 + + """ + pass + + def test_get_stat_data_fields7(self): + """Test case for get_stat_data_fields7 + + """ + pass + + def test_get_stat_data_fields8(self): + """Test case for get_stat_data_fields8 + + """ + pass + + def test_get_stat_data_raw_data5(self): + """Test case for get_stat_data_raw_data5 + + """ + pass + + def test_get_stat_data_raw_data6(self): + """Test case for get_stat_data_raw_data6 + + """ + pass + + def test_get_stat_data_raw_data_as_csv5(self): + """Test case for get_stat_data_raw_data_as_csv5 + + """ + pass + + def test_get_stat_data_raw_data_as_csv6(self): + """Test case for get_stat_data_raw_data_as_csv6 + + """ + pass + + def test_get_stat_query_fields7(self): + """Test case for get_stat_query_fields7 + + """ + pass + + def test_get_stat_query_fields8(self): + """Test case for get_stat_query_fields8 + + """ + pass + + def test_get_stats_raw_data5(self): + """Test case for get_stats_raw_data5 + + """ + pass + + def test_get_stats_raw_data6(self): + """Test case for get_stats_raw_data6 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_cellular_eiolte_api.py b/test/test_monitoring_cellular_eiolte_api.py new file mode 100644 index 0000000..908875b --- /dev/null +++ b/test/test_monitoring_cellular_eiolte_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_cellular_eiolte_api import MonitoringCellularEIOLTEApi # noqa: E501 + + +class TestMonitoringCellularEIOLTEApi(unittest.TestCase): + """MonitoringCellularEIOLTEApi unit test stubs""" + + def setUp(self): + self.api = MonitoringCellularEIOLTEApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query7(self): + """Test case for get_aggregation_data_by_query7 + + """ + pass + + def test_get_count9(self): + """Test case for get_count9 + + """ + pass + + def test_get_count_post9(self): + """Test case for get_count_post9 + + """ + pass + + def test_get_post_aggregation_app_data_by_query7(self): + """Test case for get_post_aggregation_app_data_by_query7 + + """ + pass + + def test_get_post_aggregation_data_by_query7(self): + """Test case for get_post_aggregation_data_by_query7 + + """ + pass + + def test_get_post_stat_bulk_raw_data7(self): + """Test case for get_post_stat_bulk_raw_data7 + + """ + pass + + def test_get_stat_bulk_raw_data7(self): + """Test case for get_stat_bulk_raw_data7 + + """ + pass + + def test_get_stat_data_fields9(self): + """Test case for get_stat_data_fields9 + + """ + pass + + def test_get_stat_data_raw_data7(self): + """Test case for get_stat_data_raw_data7 + + """ + pass + + def test_get_stat_data_raw_data_as_csv7(self): + """Test case for get_stat_data_raw_data_as_csv7 + + """ + pass + + def test_get_stat_query_fields9(self): + """Test case for get_stat_query_fields9 + + """ + pass + + def test_get_stats_raw_data7(self): + """Test case for get_stats_raw_data7 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_cflowd_api.py b/test/test_monitoring_cflowd_api.py new file mode 100644 index 0000000..b5aee52 --- /dev/null +++ b/test/test_monitoring_cflowd_api.py @@ -0,0 +1,191 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_cflowd_api import MonitoringCflowdApi # noqa: E501 + + +class TestMonitoringCflowdApi(unittest.TestCase): + """MonitoringCflowdApi unit test stubs""" + + def setUp(self): + self.api = MonitoringCflowdApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_cflow_collector_list(self): + """Test case for create_cflow_collector_list + + """ + pass + + def test_create_cflowd_collector_list(self): + """Test case for create_cflowd_collector_list + + """ + pass + + def test_create_cflowd_flows_count_list(self): + """Test case for create_cflowd_flows_count_list + + """ + pass + + def test_create_cflowd_statistics(self): + """Test case for create_cflowd_statistics + + """ + pass + + def test_create_cflowd_template(self): + """Test case for create_cflowd_template + + """ + pass + + def test_create_flow_device_data(self): + """Test case for create_flow_device_data + + """ + pass + + def test_create_flows_grid(self): + """Test case for create_flows_grid + + """ + pass + + def test_create_flowssummary(self): + """Test case for create_flowssummary + + """ + pass + + def test_get_aggregation_data_by_query8(self): + """Test case for get_aggregation_data_by_query8 + + """ + pass + + def test_get_cflowd_dpi_device_field_json(self): + """Test case for get_cflowd_dpi_device_field_json + + """ + pass + + def test_get_cflowd_dpi_field_json(self): + """Test case for get_cflowd_dpi_field_json + + """ + pass + + def test_get_count10(self): + """Test case for get_count10 + + """ + pass + + def test_get_count_post10(self): + """Test case for get_count_post10 + + """ + pass + + def test_get_fn_f_cache_stats(self): + """Test case for get_fn_f_cache_stats + + """ + pass + + def test_get_fn_f_export_client_stats(self): + """Test case for get_fn_f_export_client_stats + + """ + pass + + def test_get_fn_f_export_stats(self): + """Test case for get_fn_f_export_stats + + """ + pass + + def test_get_fn_f_monitor_stats(self): + """Test case for get_fn_f_monitor_stats + + """ + pass + + def test_get_fnf(self): + """Test case for get_fnf + + """ + pass + + def test_get_post_aggregation_app_data_by_query8(self): + """Test case for get_post_aggregation_app_data_by_query8 + + """ + pass + + def test_get_post_aggregation_data_by_query8(self): + """Test case for get_post_aggregation_data_by_query8 + + """ + pass + + def test_get_post_stat_bulk_raw_data8(self): + """Test case for get_post_stat_bulk_raw_data8 + + """ + pass + + def test_get_stat_bulk_raw_data8(self): + """Test case for get_stat_bulk_raw_data8 + + """ + pass + + def test_get_stat_data_fields10(self): + """Test case for get_stat_data_fields10 + + """ + pass + + def test_get_stat_data_raw_data8(self): + """Test case for get_stat_data_raw_data8 + + """ + pass + + def test_get_stat_data_raw_data_as_csv8(self): + """Test case for get_stat_data_raw_data_as_csv8 + + """ + pass + + def test_get_stat_query_fields10(self): + """Test case for get_stat_query_fields10 + + """ + pass + + def test_get_stats_raw_data8(self): + """Test case for get_stats_raw_data8 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_cloud_express_api.py b/test/test_monitoring_cloud_express_api.py new file mode 100644 index 0000000..2829e79 --- /dev/null +++ b/test/test_monitoring_cloud_express_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_cloud_express_api import MonitoringCloudExpressApi # noqa: E501 + + +class TestMonitoringCloudExpressApi(unittest.TestCase): + """MonitoringCloudExpressApi unit test stubs""" + + def setUp(self): + self.api = MonitoringCloudExpressApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query9(self): + """Test case for get_aggregation_data_by_query9 + + """ + pass + + def test_get_count11(self): + """Test case for get_count11 + + """ + pass + + def test_get_count_post11(self): + """Test case for get_count_post11 + + """ + pass + + def test_get_post_aggregation_app_data_by_query9(self): + """Test case for get_post_aggregation_app_data_by_query9 + + """ + pass + + def test_get_post_aggregation_data_by_query9(self): + """Test case for get_post_aggregation_data_by_query9 + + """ + pass + + def test_get_post_stat_bulk_raw_data9(self): + """Test case for get_post_stat_bulk_raw_data9 + + """ + pass + + def test_get_stat_bulk_raw_data9(self): + """Test case for get_stat_bulk_raw_data9 + + """ + pass + + def test_get_stat_data_fields11(self): + """Test case for get_stat_data_fields11 + + """ + pass + + def test_get_stat_data_raw_data9(self): + """Test case for get_stat_data_raw_data9 + + """ + pass + + def test_get_stat_data_raw_data_as_csv9(self): + """Test case for get_stat_data_raw_data_as_csv9 + + """ + pass + + def test_get_stat_query_fields11(self): + """Test case for get_stat_query_fields11 + + """ + pass + + def test_get_stats_raw_data9(self): + """Test case for get_stats_raw_data9 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_device_details_api.py b/test/test_monitoring_device_details_api.py new file mode 100644 index 0000000..11658d6 --- /dev/null +++ b/test/test_monitoring_device_details_api.py @@ -0,0 +1,233 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_device_details_api import MonitoringDeviceDetailsApi # noqa: E501 + + +class TestMonitoringDeviceDetailsApi(unittest.TestCase): + """MonitoringDeviceDetailsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringDeviceDetailsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_tier(self): + """Test case for add_tier + + """ + pass + + def test_delete_tier(self): + """Test case for delete_tier + + """ + pass + + def test_enable_sdavcon_device(self): + """Test case for enable_sdavcon_device + + """ + pass + + def test_generate_device_state_data(self): + """Test case for generate_device_state_data + + """ + pass + + def test_generate_device_state_data_fields(self): + """Test case for generate_device_state_data_fields + + """ + pass + + def test_generate_device_state_data_with_query_string(self): + """Test case for generate_device_state_data_with_query_string + + """ + pass + + def test_get_all_device_status(self): + """Test case for get_all_device_status + + """ + pass + + def test_get_device_counters(self): + """Test case for get_device_counters + + """ + pass + + def test_get_device_list_as_key_value(self): + """Test case for get_device_list_as_key_value + + """ + pass + + def test_get_device_models(self): + """Test case for get_device_models + + """ + pass + + def test_get_device_only_status(self): + """Test case for get_device_only_status + + """ + pass + + def test_get_device_running_config(self): + """Test case for get_device_running_config + + """ + pass + + def test_get_device_running_config_html(self): + """Test case for get_device_running_config_html + + """ + pass + + def test_get_device_tloc_status(self): + """Test case for get_device_tloc_status + + """ + pass + + def test_get_device_tloc_util(self): + """Test case for get_device_tloc_util + + """ + pass + + def test_get_device_tloc_util_details(self): + """Test case for get_device_tloc_util_details + + """ + pass + + def test_get_hardware_health_details(self): + """Test case for get_hardware_health_details + + """ + pass + + def test_get_hardware_health_summary(self): + """Test case for get_hardware_health_summary + + """ + pass + + def test_get_stats_queues(self): + """Test case for get_stats_queues + + """ + pass + + def test_get_sync_queues(self): + """Test case for get_sync_queues + + """ + pass + + def test_get_tiers(self): + """Test case for get_tiers + + """ + pass + + def test_get_unconfigured(self): + """Test case for get_unconfigured + + """ + pass + + def test_get_v_manage_system_ip(self): + """Test case for get_v_manage_system_ip + + """ + pass + + def test_get_vedge_inventory(self): + """Test case for get_vedge_inventory + + """ + pass + + def test_get_vedge_inventory_summary(self): + """Test case for get_vedge_inventory_summary + + """ + pass + + def test_list_all_device_models(self): + """Test case for list_all_device_models + + """ + pass + + def test_list_all_devices(self): + """Test case for list_all_devices + + """ + pass + + def test_list_all_monitor_details_devices(self): + """Test case for list_all_monitor_details_devices + + """ + pass + + def test_list_currently_syncing_devices(self): + """Test case for list_currently_syncing_devices + + """ + pass + + def test_list_reachable_devices(self): + """Test case for list_reachable_devices + + """ + pass + + def test_list_unreachable_devices(self): + """Test case for list_unreachable_devices + + """ + pass + + def test_remove_unreachable_device(self): + """Test case for remove_unreachable_device + + """ + pass + + def test_set_block_sync(self): + """Test case for set_block_sync + + """ + pass + + def test_sync_all_devices_mem_db(self): + """Test case for sync_all_devices_mem_db + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_device_statistics_api.py b/test/test_monitoring_device_statistics_api.py new file mode 100644 index 0000000..e1a7f93 --- /dev/null +++ b/test/test_monitoring_device_statistics_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_device_statistics_api import MonitoringDeviceStatisticsApi # noqa: E501 + + +class TestMonitoringDeviceStatisticsApi(unittest.TestCase): + """MonitoringDeviceStatisticsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringDeviceStatisticsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query15(self): + """Test case for get_aggregation_data_by_query15 + + """ + pass + + def test_get_count17(self): + """Test case for get_count17 + + """ + pass + + def test_get_count_post17(self): + """Test case for get_count_post17 + + """ + pass + + def test_get_post_aggregation_app_data_by_query14(self): + """Test case for get_post_aggregation_app_data_by_query14 + + """ + pass + + def test_get_post_aggregation_data_by_query14(self): + """Test case for get_post_aggregation_data_by_query14 + + """ + pass + + def test_get_post_stat_bulk_raw_data15(self): + """Test case for get_post_stat_bulk_raw_data15 + + """ + pass + + def test_get_stat_bulk_raw_data15(self): + """Test case for get_stat_bulk_raw_data15 + + """ + pass + + def test_get_stat_data_fields17(self): + """Test case for get_stat_data_fields17 + + """ + pass + + def test_get_stat_data_raw_data14(self): + """Test case for get_stat_data_raw_data14 + + """ + pass + + def test_get_stat_data_raw_data_as_csv15(self): + """Test case for get_stat_data_raw_data_as_csv15 + + """ + pass + + def test_get_stat_query_fields17(self): + """Test case for get_stat_query_fields17 + + """ + pass + + def test_get_stats_raw_data15(self): + """Test case for get_stats_raw_data15 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_device_statistics_details_api.py b/test/test_monitoring_device_statistics_details_api.py new file mode 100644 index 0000000..1b1c098 --- /dev/null +++ b/test/test_monitoring_device_statistics_details_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_device_statistics_details_api import MonitoringDeviceStatisticsDetailsApi # noqa: E501 + + +class TestMonitoringDeviceStatisticsDetailsApi(unittest.TestCase): + """MonitoringDeviceStatisticsDetailsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringDeviceStatisticsDetailsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_generate_device_statistics_data(self): + """Test case for generate_device_statistics_data + + """ + pass + + def test_get_active_alarms(self): + """Test case for get_active_alarms + + """ + pass + + def test_get_count_with_state_data_type(self): + """Test case for get_count_with_state_data_type + + """ + pass + + def test_get_stat_data_fields_by_state_data_type(self): + """Test case for get_stat_data_fields_by_state_data_type + + """ + pass + + def test_get_statistics_type(self): + """Test case for get_statistics_type + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_dpi_api.py b/test/test_monitoring_dpi_api.py new file mode 100644 index 0000000..054aa38 --- /dev/null +++ b/test/test_monitoring_dpi_api.py @@ -0,0 +1,143 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_dpi_api import MonitoringDPIApi # noqa: E501 + + +class TestMonitoringDPIApi(unittest.TestCase): + """MonitoringDPIApi unit test stubs""" + + def setUp(self): + self.api = MonitoringDPIApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_dpi_device_and_app_details(self): + """Test case for create_dpi_device_and_app_details + + """ + pass + + def test_create_dpi_device_grid_data(self): + """Test case for create_dpi_device_grid_data + + """ + pass + + def test_create_dpi_flows_grid_list_query(self): + """Test case for create_dpi_flows_grid_list_query + + """ + pass + + def test_create_dpi_summary(self): + """Test case for create_dpi_summary + + """ + pass + + def test_get_aggregation_data_by_query12(self): + """Test case for get_aggregation_data_by_query12 + + """ + pass + + def test_get_aggregation_data_dpi(self): + """Test case for get_aggregation_data_dpi + + """ + pass + + def test_get_aggregation_data_for_packet_dup(self): + """Test case for get_aggregation_data_for_packet_dup + + """ + pass + + def test_get_count14(self): + """Test case for get_count14 + + """ + pass + + def test_get_count_post14(self): + """Test case for get_count_post14 + + """ + pass + + def test_get_post_aggregation_app_data(self): + """Test case for get_post_aggregation_app_data + + """ + pass + + def test_get_post_aggregation_data(self): + """Test case for get_post_aggregation_data + + """ + pass + + def test_get_post_stat_bulk_raw_data12(self): + """Test case for get_post_stat_bulk_raw_data12 + + """ + pass + + def test_get_stat_bulk_raw_data12(self): + """Test case for get_stat_bulk_raw_data12 + + """ + pass + + def test_get_stat_data_fields14(self): + """Test case for get_stat_data_fields14 + + """ + pass + + def test_get_stat_data_raw_data12(self): + """Test case for get_stat_data_raw_data12 + + """ + pass + + def test_get_stat_data_raw_data_as_csv12(self): + """Test case for get_stat_data_raw_data_as_csv12 + + """ + pass + + def test_get_stat_query_fields14(self): + """Test case for get_stat_query_fields14 + + """ + pass + + def test_get_stats_raw_data12(self): + """Test case for get_stats_raw_data12 + + """ + pass + + def test_get_unique_flow_count(self): + """Test case for get_unique_flow_count + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_dpion_demand_troubleshooting_api.py b/test/test_monitoring_dpion_demand_troubleshooting_api.py new file mode 100644 index 0000000..2fa3758 --- /dev/null +++ b/test/test_monitoring_dpion_demand_troubleshooting_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_dpion_demand_troubleshooting_api import MonitoringDPIOnDemandTroubleshootingApi # noqa: E501 + + +class TestMonitoringDPIOnDemandTroubleshootingApi(unittest.TestCase): + """MonitoringDPIOnDemandTroubleshootingApi unit test stubs""" + + def setUp(self): + self.api = MonitoringDPIOnDemandTroubleshootingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_queue_entry(self): + """Test case for create_queue_entry + + """ + pass + + def test_delete_queue_entry(self): + """Test case for delete_queue_entry + + """ + pass + + def test_get_queue_entries(self): + """Test case for get_queue_entries + + """ + pass + + def test_get_queue_properties(self): + """Test case for get_queue_properties + + """ + pass + + def test_update_queue_entry(self): + """Test case for update_queue_entry + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_endpoint_tracker_status_api.py b/test/test_monitoring_endpoint_tracker_status_api.py new file mode 100644 index 0000000..29bb748 --- /dev/null +++ b/test/test_monitoring_endpoint_tracker_status_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_endpoint_tracker_status_api import MonitoringEndpointTrackerStatusApi # noqa: E501 + + +class TestMonitoringEndpointTrackerStatusApi(unittest.TestCase): + """MonitoringEndpointTrackerStatusApi unit test stubs""" + + def setUp(self): + self.api = MonitoringEndpointTrackerStatusApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query18(self): + """Test case for get_aggregation_data_by_query18 + + """ + pass + + def test_get_count20(self): + """Test case for get_count20 + + """ + pass + + def test_get_count_post20(self): + """Test case for get_count_post20 + + """ + pass + + def test_get_post_aggregation_app_data_by_query17(self): + """Test case for get_post_aggregation_app_data_by_query17 + + """ + pass + + def test_get_post_aggregation_data_by_query17(self): + """Test case for get_post_aggregation_data_by_query17 + + """ + pass + + def test_get_post_stat_bulk_raw_data18(self): + """Test case for get_post_stat_bulk_raw_data18 + + """ + pass + + def test_get_stat_bulk_raw_data18(self): + """Test case for get_stat_bulk_raw_data18 + + """ + pass + + def test_get_stat_data_fields20(self): + """Test case for get_stat_data_fields20 + + """ + pass + + def test_get_stat_data_raw_data17(self): + """Test case for get_stat_data_raw_data17 + + """ + pass + + def test_get_stat_data_raw_data_as_csv18(self): + """Test case for get_stat_data_raw_data_as_csv18 + + """ + pass + + def test_get_stat_query_fields20(self): + """Test case for get_stat_query_fields20 + + """ + pass + + def test_get_stats_raw_data18(self): + """Test case for get_stats_raw_data18 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_events_api.py b/test/test_monitoring_events_api.py new file mode 100644 index 0000000..dc49b07 --- /dev/null +++ b/test/test_monitoring_events_api.py @@ -0,0 +1,149 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_events_api import MonitoringEventsApi # noqa: E501 + + +class TestMonitoringEventsApi(unittest.TestCase): + """MonitoringEventsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringEventsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_events_query_config(self): + """Test case for create_events_query_config + + """ + pass + + def test_enable_events_from_file(self): + """Test case for enable_events_from_file + + """ + pass + + def test_find_events(self): + """Test case for find_events + + """ + pass + + def test_get_aggregation_data_by_query25(self): + """Test case for get_aggregation_data_by_query25 + + """ + pass + + def test_get_components_as_key_value(self): + """Test case for get_components_as_key_value + + """ + pass + + def test_get_count27(self): + """Test case for get_count27 + + """ + pass + + def test_get_count_post27(self): + """Test case for get_count_post27 + + """ + pass + + def test_get_event_types_as_key_value(self): + """Test case for get_event_types_as_key_value + + """ + pass + + def test_get_events_by_component(self): + """Test case for get_events_by_component + + """ + pass + + def test_get_listeners_info(self): + """Test case for get_listeners_info + + """ + pass + + def test_get_post_aggregation_app_data_by_query24(self): + """Test case for get_post_aggregation_app_data_by_query24 + + """ + pass + + def test_get_post_aggregation_data_by_query24(self): + """Test case for get_post_aggregation_data_by_query24 + + """ + pass + + def test_get_post_stat_bulk_raw_data25(self): + """Test case for get_post_stat_bulk_raw_data25 + + """ + pass + + def test_get_severity_histogram(self): + """Test case for get_severity_histogram + + """ + pass + + def test_get_stat_bulk_raw_data25(self): + """Test case for get_stat_bulk_raw_data25 + + """ + pass + + def test_get_stat_data_fields27(self): + """Test case for get_stat_data_fields27 + + """ + pass + + def test_get_stat_data_raw_data24(self): + """Test case for get_stat_data_raw_data24 + + """ + pass + + def test_get_stat_data_raw_data_as_csv25(self): + """Test case for get_stat_data_raw_data_as_csv25 + + """ + pass + + def test_get_stat_query_fields27(self): + """Test case for get_stat_query_fields27 + + """ + pass + + def test_get_stats_raw_data25(self): + """Test case for get_stats_raw_data25 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_flowlog_api.py b/test/test_monitoring_flowlog_api.py new file mode 100644 index 0000000..bbeb879 --- /dev/null +++ b/test/test_monitoring_flowlog_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_flowlog_api import MonitoringFlowlogApi # noqa: E501 + + +class TestMonitoringFlowlogApi(unittest.TestCase): + """MonitoringFlowlogApi unit test stubs""" + + def setUp(self): + self.api = MonitoringFlowlogApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query26(self): + """Test case for get_aggregation_data_by_query26 + + """ + pass + + def test_get_count28(self): + """Test case for get_count28 + + """ + pass + + def test_get_count_post28(self): + """Test case for get_count_post28 + + """ + pass + + def test_get_post_aggregation_app_data_by_query25(self): + """Test case for get_post_aggregation_app_data_by_query25 + + """ + pass + + def test_get_post_aggregation_data_by_query26(self): + """Test case for get_post_aggregation_data_by_query26 + + """ + pass + + def test_get_post_stat_bulk_raw_data26(self): + """Test case for get_post_stat_bulk_raw_data26 + + """ + pass + + def test_get_stat_bulk_raw_data26(self): + """Test case for get_stat_bulk_raw_data26 + + """ + pass + + def test_get_stat_data_fields28(self): + """Test case for get_stat_data_fields28 + + """ + pass + + def test_get_stat_data_raw_data25(self): + """Test case for get_stat_data_raw_data25 + + """ + pass + + def test_get_stat_data_raw_data_as_csv26(self): + """Test case for get_stat_data_raw_data_as_csv26 + + """ + pass + + def test_get_stat_query_fields28(self): + """Test case for get_stat_query_fields28 + + """ + pass + + def test_get_stats_raw_data26(self): + """Test case for get_stats_raw_data26 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_health_api.py b/test/test_monitoring_health_api.py new file mode 100644 index 0000000..f1e5ed9 --- /dev/null +++ b/test/test_monitoring_health_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_health_api import MonitoringHealthApi # noqa: E501 + + +class TestMonitoringHealthApi(unittest.TestCase): + """MonitoringHealthApi unit test stubs""" + + def setUp(self): + self.api = MonitoringHealthApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_devices_health(self): + """Test case for get_devices_health + + """ + pass + + def test_get_devices_health_overview(self): + """Test case for get_devices_health_overview + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_interface_statistics_api.py b/test/test_monitoring_interface_statistics_api.py new file mode 100644 index 0000000..f8b1907 --- /dev/null +++ b/test/test_monitoring_interface_statistics_api.py @@ -0,0 +1,113 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_interface_statistics_api import MonitoringInterfaceStatisticsApi # noqa: E501 + + +class TestMonitoringInterfaceStatisticsApi(unittest.TestCase): + """MonitoringInterfaceStatisticsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringInterfaceStatisticsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query10(self): + """Test case for get_aggregation_data_by_query10 + + """ + pass + + def test_get_bandwidth_distribution(self): + """Test case for get_bandwidth_distribution + + """ + pass + + def test_get_count12(self): + """Test case for get_count12 + + """ + pass + + def test_get_count_post12(self): + """Test case for get_count_post12 + + """ + pass + + def test_get_post_aggregation_app_data_by_query10(self): + """Test case for get_post_aggregation_app_data_by_query10 + + """ + pass + + def test_get_post_aggregation_data_by_query10(self): + """Test case for get_post_aggregation_data_by_query10 + + """ + pass + + def test_get_post_stat_bulk_raw_data10(self): + """Test case for get_post_stat_bulk_raw_data10 + + """ + pass + + def test_get_stat_bulk_raw_data10(self): + """Test case for get_stat_bulk_raw_data10 + + """ + pass + + def test_get_stat_data_fields12(self): + """Test case for get_stat_data_fields12 + + """ + pass + + def test_get_stat_data_raw_data10(self): + """Test case for get_stat_data_raw_data10 + + """ + pass + + def test_get_stat_data_raw_data_as_csv10(self): + """Test case for get_stat_data_raw_data_as_csv10 + + """ + pass + + def test_get_stat_query_fields12(self): + """Test case for get_stat_query_fields12 + + """ + pass + + def test_get_statistics_per_interface(self): + """Test case for get_statistics_per_interface + + """ + pass + + def test_get_stats_raw_data10(self): + """Test case for get_stats_raw_data10 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_ips_alert_api.py b/test/test_monitoring_ips_alert_api.py new file mode 100644 index 0000000..9abb21b --- /dev/null +++ b/test/test_monitoring_ips_alert_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_ips_alert_api import MonitoringIPsAlertApi # noqa: E501 + + +class TestMonitoringIPsAlertApi(unittest.TestCase): + """MonitoringIPsAlertApi unit test stubs""" + + def setUp(self): + self.api = MonitoringIPsAlertApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query21(self): + """Test case for get_aggregation_data_by_query21 + + """ + pass + + def test_get_count23(self): + """Test case for get_count23 + + """ + pass + + def test_get_count_post23(self): + """Test case for get_count_post23 + + """ + pass + + def test_get_post_aggregation_app_data_by_query20(self): + """Test case for get_post_aggregation_app_data_by_query20 + + """ + pass + + def test_get_post_aggregation_data_by_query20(self): + """Test case for get_post_aggregation_data_by_query20 + + """ + pass + + def test_get_post_stat_bulk_raw_data21(self): + """Test case for get_post_stat_bulk_raw_data21 + + """ + pass + + def test_get_stat_bulk_raw_data21(self): + """Test case for get_stat_bulk_raw_data21 + + """ + pass + + def test_get_stat_data_fields23(self): + """Test case for get_stat_data_fields23 + + """ + pass + + def test_get_stat_data_raw_data20(self): + """Test case for get_stat_data_raw_data20 + + """ + pass + + def test_get_stat_data_raw_data_as_csv21(self): + """Test case for get_stat_data_raw_data_as_csv21 + + """ + pass + + def test_get_stat_query_fields23(self): + """Test case for get_stat_query_fields23 + + """ + pass + + def test_get_stats_raw_data21(self): + """Test case for get_stats_raw_data21 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_qo_s_api.py b/test/test_monitoring_qo_s_api.py new file mode 100644 index 0000000..4b4a6ef --- /dev/null +++ b/test/test_monitoring_qo_s_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_qo_s_api import MonitoringQoSApi # noqa: E501 + + +class TestMonitoringQoSApi(unittest.TestCase): + """MonitoringQoSApi unit test stubs""" + + def setUp(self): + self.api = MonitoringQoSApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query13(self): + """Test case for get_aggregation_data_by_query13 + + """ + pass + + def test_get_count15(self): + """Test case for get_count15 + + """ + pass + + def test_get_count_post15(self): + """Test case for get_count_post15 + + """ + pass + + def test_get_post_aggregation_app_data_by_query12(self): + """Test case for get_post_aggregation_app_data_by_query12 + + """ + pass + + def test_get_post_aggregation_data_by_query12(self): + """Test case for get_post_aggregation_data_by_query12 + + """ + pass + + def test_get_post_stat_bulk_raw_data13(self): + """Test case for get_post_stat_bulk_raw_data13 + + """ + pass + + def test_get_stat_bulk_raw_data13(self): + """Test case for get_stat_bulk_raw_data13 + + """ + pass + + def test_get_stat_data_fields15(self): + """Test case for get_stat_data_fields15 + + """ + pass + + def test_get_stat_data_raw_data13(self): + """Test case for get_stat_data_raw_data13 + + """ + pass + + def test_get_stat_data_raw_data_as_csv13(self): + """Test case for get_stat_data_raw_data_as_csv13 + + """ + pass + + def test_get_stat_query_fields15(self): + """Test case for get_stat_query_fields15 + + """ + pass + + def test_get_stats_raw_data13(self): + """Test case for get_stats_raw_data13 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_security_unified_logging_connection_events_api.py b/test/test_monitoring_security_unified_logging_connection_events_api.py new file mode 100644 index 0000000..5528150 --- /dev/null +++ b/test/test_monitoring_security_unified_logging_connection_events_api.py @@ -0,0 +1,107 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_security_unified_logging_connection_events_api import MonitoringSecurityUnifiedLoggingConnectionEventsApi # noqa: E501 + + +class TestMonitoringSecurityUnifiedLoggingConnectionEventsApi(unittest.TestCase): + """MonitoringSecurityUnifiedLoggingConnectionEventsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringSecurityUnifiedLoggingConnectionEventsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query14(self): + """Test case for get_aggregation_data_by_query14 + + """ + pass + + def test_get_count16(self): + """Test case for get_count16 + + """ + pass + + def test_get_count_post16(self): + """Test case for get_count_post16 + + """ + pass + + def test_get_filter_policy_name_list(self): + """Test case for get_filter_policy_name_list + + """ + pass + + def test_get_post_aggregation_app_data_by_query13(self): + """Test case for get_post_aggregation_app_data_by_query13 + + """ + pass + + def test_get_post_aggregation_data_by_query13(self): + """Test case for get_post_aggregation_data_by_query13 + + """ + pass + + def test_get_post_stat_bulk_raw_data14(self): + """Test case for get_post_stat_bulk_raw_data14 + + """ + pass + + def test_get_stat_bulk_raw_data14(self): + """Test case for get_stat_bulk_raw_data14 + + """ + pass + + def test_get_stat_data_fields16(self): + """Test case for get_stat_data_fields16 + + """ + pass + + def test_get_stat_data_raw_data_as_csv14(self): + """Test case for get_stat_data_raw_data_as_csv14 + + """ + pass + + def test_get_stat_query_fields16(self): + """Test case for get_stat_query_fields16 + + """ + pass + + def test_get_stats_raw_data14(self): + """Test case for get_stats_raw_data14 + + """ + pass + + def test_get_sul_stat_data_raw_data(self): + """Test case for get_sul_stat_data_raw_data + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_server_info_api.py b/test/test_monitoring_server_info_api.py new file mode 100644 index 0000000..dad5664 --- /dev/null +++ b/test/test_monitoring_server_info_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_server_info_api import MonitoringServerInfoApi # noqa: E501 + + +class TestMonitoringServerInfoApi(unittest.TestCase): + """MonitoringServerInfoApi unit test stubs""" + + def setUp(self): + self.api = MonitoringServerInfoApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_server_info(self): + """Test case for create_server_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_stats_download_api.py b/test/test_monitoring_stats_download_api.py new file mode 100644 index 0000000..c6e8219 --- /dev/null +++ b/test/test_monitoring_stats_download_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_stats_download_api import MonitoringStatsDownloadApi # noqa: E501 + + +class TestMonitoringStatsDownloadApi(unittest.TestCase): + """MonitoringStatsDownloadApi unit test stubs""" + + def setUp(self): + self.api = MonitoringStatsDownloadApi() # noqa: E501 + + def tearDown(self): + pass + + def test_download1(self): + """Test case for download1 + + """ + pass + + def test_download_list(self): + """Test case for download_list + + """ + pass + + def test_fetch_list(self): + """Test case for fetch_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_stats_processing_api.py b/test/test_monitoring_stats_processing_api.py new file mode 100644 index 0000000..13209cf --- /dev/null +++ b/test/test_monitoring_stats_processing_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_stats_processing_api import MonitoringStatsProcessingApi # noqa: E501 + + +class TestMonitoringStatsProcessingApi(unittest.TestCase): + """MonitoringStatsProcessingApi unit test stubs""" + + def setUp(self): + self.api = MonitoringStatsProcessingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_enable_statistics_demo_mode(self): + """Test case for enable_statistics_demo_mode + + """ + pass + + def test_generate_stats_collect_thread_report(self): + """Test case for generate_stats_collect_thread_report + + """ + pass + + def test_generate_stats_process_report(self): + """Test case for generate_stats_process_report + + """ + pass + + def test_generate_stats_process_thread_report(self): + """Test case for generate_stats_process_thread_report + + """ + pass + + def test_get_statistic_type(self): + """Test case for get_statistic_type + + """ + pass + + def test_get_statistics_processing_counters(self): + """Test case for get_statistics_processing_counters + + """ + pass + + def test_process_statistics_data(self): + """Test case for process_statistics_data + + """ + pass + + def test_reset_stats_collection(self): + """Test case for reset_stats_collection + + """ + pass + + def test_start_stats_collection(self): + """Test case for start_stats_collection + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_status_api.py b/test/test_monitoring_status_api.py new file mode 100644 index 0000000..d0c7ec0 --- /dev/null +++ b/test/test_monitoring_status_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_status_api import MonitoringStatusApi # noqa: E501 + + +class TestMonitoringStatusApi(unittest.TestCase): + """MonitoringStatusApi unit test stubs""" + + def setUp(self): + self.api = MonitoringStatusApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_disabled_device_list(self): + """Test case for get_disabled_device_list + + """ + pass + + def test_get_enabled_index_for_device(self): + """Test case for get_enabled_index_for_device + + """ + pass + + def test_get_statistics_settings(self): + """Test case for get_statistics_settings + + """ + pass + + def test_update_statistics_device_list(self): + """Test case for update_statistics_device_list + + """ + pass + + def test_update_statistics_settings(self): + """Test case for update_statistics_settings + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_system_status_stats_api.py b/test/test_monitoring_system_status_stats_api.py new file mode 100644 index 0000000..9ccf42c --- /dev/null +++ b/test/test_monitoring_system_status_stats_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_system_status_stats_api import MonitoringSystemStatusStatsApi # noqa: E501 + + +class TestMonitoringSystemStatusStatsApi(unittest.TestCase): + """MonitoringSystemStatusStatsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringSystemStatusStatsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query17(self): + """Test case for get_aggregation_data_by_query17 + + """ + pass + + def test_get_count19(self): + """Test case for get_count19 + + """ + pass + + def test_get_count_post19(self): + """Test case for get_count_post19 + + """ + pass + + def test_get_post_aggregation_app_data_by_query16(self): + """Test case for get_post_aggregation_app_data_by_query16 + + """ + pass + + def test_get_post_aggregation_data_by_query16(self): + """Test case for get_post_aggregation_data_by_query16 + + """ + pass + + def test_get_post_stat_bulk_raw_data17(self): + """Test case for get_post_stat_bulk_raw_data17 + + """ + pass + + def test_get_stat_bulk_raw_data17(self): + """Test case for get_stat_bulk_raw_data17 + + """ + pass + + def test_get_stat_data_fields19(self): + """Test case for get_stat_data_fields19 + + """ + pass + + def test_get_stat_data_raw_data16(self): + """Test case for get_stat_data_raw_data16 + + """ + pass + + def test_get_stat_data_raw_data_as_csv17(self): + """Test case for get_stat_data_raw_data_as_csv17 + + """ + pass + + def test_get_stat_query_fields19(self): + """Test case for get_stat_query_fields19 + + """ + pass + + def test_get_stats_raw_data17(self): + """Test case for get_stats_raw_data17 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_umbrella_api.py b/test/test_monitoring_umbrella_api.py new file mode 100644 index 0000000..13dd3af --- /dev/null +++ b/test/test_monitoring_umbrella_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_umbrella_api import MonitoringUmbrellaApi # noqa: E501 + + +class TestMonitoringUmbrellaApi(unittest.TestCase): + """MonitoringUmbrellaApi unit test stubs""" + + def setUp(self): + self.api = MonitoringUmbrellaApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query24(self): + """Test case for get_aggregation_data_by_query24 + + """ + pass + + def test_get_count26(self): + """Test case for get_count26 + + """ + pass + + def test_get_count_post26(self): + """Test case for get_count_post26 + + """ + pass + + def test_get_post_aggregation_app_data_by_query23(self): + """Test case for get_post_aggregation_app_data_by_query23 + + """ + pass + + def test_get_post_aggregation_data_by_query23(self): + """Test case for get_post_aggregation_data_by_query23 + + """ + pass + + def test_get_post_stat_bulk_raw_data24(self): + """Test case for get_post_stat_bulk_raw_data24 + + """ + pass + + def test_get_stat_bulk_raw_data24(self): + """Test case for get_stat_bulk_raw_data24 + + """ + pass + + def test_get_stat_data_fields26(self): + """Test case for get_stat_data_fields26 + + """ + pass + + def test_get_stat_data_raw_data23(self): + """Test case for get_stat_data_raw_data23 + + """ + pass + + def test_get_stat_data_raw_data_as_csv24(self): + """Test case for get_stat_data_raw_data_as_csv24 + + """ + pass + + def test_get_stat_query_fields26(self): + """Test case for get_stat_query_fields26 + + """ + pass + + def test_get_stats_raw_data24(self): + """Test case for get_stats_raw_data24 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_umbrella_patterns_api.py b/test/test_monitoring_umbrella_patterns_api.py new file mode 100644 index 0000000..e0179d1 --- /dev/null +++ b/test/test_monitoring_umbrella_patterns_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_umbrella_patterns_api import MonitoringUmbrellaPatternsApi # noqa: E501 + + +class TestMonitoringUmbrellaPatternsApi(unittest.TestCase): + """MonitoringUmbrellaPatternsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringUmbrellaPatternsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query23(self): + """Test case for get_aggregation_data_by_query23 + + """ + pass + + def test_get_count25(self): + """Test case for get_count25 + + """ + pass + + def test_get_count_post25(self): + """Test case for get_count_post25 + + """ + pass + + def test_get_post_aggregation_app_data_by_query22(self): + """Test case for get_post_aggregation_app_data_by_query22 + + """ + pass + + def test_get_post_aggregation_data_by_query22(self): + """Test case for get_post_aggregation_data_by_query22 + + """ + pass + + def test_get_post_stat_bulk_raw_data23(self): + """Test case for get_post_stat_bulk_raw_data23 + + """ + pass + + def test_get_stat_bulk_raw_data23(self): + """Test case for get_stat_bulk_raw_data23 + + """ + pass + + def test_get_stat_data_fields25(self): + """Test case for get_stat_data_fields25 + + """ + pass + + def test_get_stat_data_raw_data22(self): + """Test case for get_stat_data_raw_data22 + + """ + pass + + def test_get_stat_data_raw_data_as_csv23(self): + """Test case for get_stat_data_raw_data_as_csv23 + + """ + pass + + def test_get_stat_query_fields25(self): + """Test case for get_stat_query_fields25 + + """ + pass + + def test_get_stats_raw_data23(self): + """Test case for get_stats_raw_data23 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_url_filtering_api.py b/test/test_monitoring_url_filtering_api.py new file mode 100644 index 0000000..b8c0a3d --- /dev/null +++ b/test/test_monitoring_url_filtering_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_url_filtering_api import MonitoringURLFilteringApi # noqa: E501 + + +class TestMonitoringURLFilteringApi(unittest.TestCase): + """MonitoringURLFilteringApi unit test stubs""" + + def setUp(self): + self.api = MonitoringURLFilteringApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query22(self): + """Test case for get_aggregation_data_by_query22 + + """ + pass + + def test_get_count24(self): + """Test case for get_count24 + + """ + pass + + def test_get_count_post24(self): + """Test case for get_count_post24 + + """ + pass + + def test_get_post_aggregation_app_data_by_query21(self): + """Test case for get_post_aggregation_app_data_by_query21 + + """ + pass + + def test_get_post_aggregation_data_by_query21(self): + """Test case for get_post_aggregation_data_by_query21 + + """ + pass + + def test_get_post_stat_bulk_raw_data22(self): + """Test case for get_post_stat_bulk_raw_data22 + + """ + pass + + def test_get_stat_bulk_raw_data22(self): + """Test case for get_stat_bulk_raw_data22 + + """ + pass + + def test_get_stat_data_fields24(self): + """Test case for get_stat_data_fields24 + + """ + pass + + def test_get_stat_data_raw_data21(self): + """Test case for get_stat_data_raw_data21 + + """ + pass + + def test_get_stat_data_raw_data_as_csv22(self): + """Test case for get_stat_data_raw_data_as_csv22 + + """ + pass + + def test_get_stat_query_fields24(self): + """Test case for get_stat_query_fields24 + + """ + pass + + def test_get_stats_raw_data22(self): + """Test case for get_stats_raw_data22 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_vnf_interface_statistics_api.py b/test/test_monitoring_vnf_interface_statistics_api.py new file mode 100644 index 0000000..f6098d0 --- /dev/null +++ b/test/test_monitoring_vnf_interface_statistics_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_vnf_interface_statistics_api import MonitoringVNFInterfaceStatisticsApi # noqa: E501 + + +class TestMonitoringVNFInterfaceStatisticsApi(unittest.TestCase): + """MonitoringVNFInterfaceStatisticsApi unit test stubs""" + + def setUp(self): + self.api = MonitoringVNFInterfaceStatisticsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query11(self): + """Test case for get_aggregation_data_by_query11 + + """ + pass + + def test_get_count13(self): + """Test case for get_count13 + + """ + pass + + def test_get_count_post13(self): + """Test case for get_count_post13 + + """ + pass + + def test_get_post_aggregation_app_data_by_query11(self): + """Test case for get_post_aggregation_app_data_by_query11 + + """ + pass + + def test_get_post_aggregation_data_by_query11(self): + """Test case for get_post_aggregation_data_by_query11 + + """ + pass + + def test_get_post_stat_bulk_raw_data11(self): + """Test case for get_post_stat_bulk_raw_data11 + + """ + pass + + def test_get_stat_bulk_raw_data11(self): + """Test case for get_stat_bulk_raw_data11 + + """ + pass + + def test_get_stat_data_fields13(self): + """Test case for get_stat_data_fields13 + + """ + pass + + def test_get_stat_data_raw_data11(self): + """Test case for get_stat_data_raw_data11 + + """ + pass + + def test_get_stat_data_raw_data_as_csv11(self): + """Test case for get_stat_data_raw_data_as_csv11 + + """ + pass + + def test_get_stat_query_fields13(self): + """Test case for get_stat_query_fields13 + + """ + pass + + def test_get_stats_raw_data11(self): + """Test case for get_stats_raw_data11 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_wlan_client_info_api.py b/test/test_monitoring_wlan_client_info_api.py new file mode 100644 index 0000000..16abbf2 --- /dev/null +++ b/test/test_monitoring_wlan_client_info_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.monitoring_wlan_client_info_api import MonitoringWlanClientInfoApi # noqa: E501 + + +class TestMonitoringWlanClientInfoApi(unittest.TestCase): + """MonitoringWlanClientInfoApi unit test stubs""" + + def setUp(self): + self.api = MonitoringWlanClientInfoApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aggregation_data_by_query19(self): + """Test case for get_aggregation_data_by_query19 + + """ + pass + + def test_get_count21(self): + """Test case for get_count21 + + """ + pass + + def test_get_count_post21(self): + """Test case for get_count_post21 + + """ + pass + + def test_get_post_aggregation_app_data_by_query18(self): + """Test case for get_post_aggregation_app_data_by_query18 + + """ + pass + + def test_get_post_aggregation_data_by_query18(self): + """Test case for get_post_aggregation_data_by_query18 + + """ + pass + + def test_get_post_stat_bulk_raw_data19(self): + """Test case for get_post_stat_bulk_raw_data19 + + """ + pass + + def test_get_stat_bulk_raw_data19(self): + """Test case for get_stat_bulk_raw_data19 + + """ + pass + + def test_get_stat_data_fields21(self): + """Test case for get_stat_data_fields21 + + """ + pass + + def test_get_stat_data_raw_data18(self): + """Test case for get_stat_data_raw_data18 + + """ + pass + + def test_get_stat_data_raw_data_as_csv19(self): + """Test case for get_stat_data_raw_data_as_csv19 + + """ + pass + + def test_get_stat_query_fields21(self): + """Test case for get_stat_query_fields21 + + """ + pass + + def test_get_stats_raw_data19(self): + """Test case for get_stats_raw_data19 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_mpls_timer.py b/test/test_mpls_timer.py new file mode 100644 index 0000000..45b6051 --- /dev/null +++ b/test/test_mpls_timer.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.mpls_timer import MplsTimer + + +class TestMplsTimer(unittest.TestCase): + """MplsTimer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMplsTimer(self): + """Test MplsTimer""" + # FIXME: construct object with mandatory attributes with example values + # model = MplsTimer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_msla_api.py b/test/test_msla_api.py new file mode 100644 index 0000000..4a4103a --- /dev/null +++ b/test/test_msla_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.msla_api import MSLAApi # noqa: E501 + + +class TestMSLAApi(unittest.TestCase): + """MSLAApi unit test stubs""" + + def setUp(self): + self.api = MSLAApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_all_template(self): + """Test case for get_all_template + + """ + pass + + def test_get_license_and_device_count(self): + """Test case for get_license_and_device_count + + """ + pass + + def test_get_license_and_device_count1(self): + """Test case for get_license_and_device_count1 + + """ + pass + + def test_get_msla_devices(self): + """Test case for get_msla_devices + + """ + pass + + def test_get_packaging_distribution_details(self): + """Test case for get_packaging_distribution_details + + """ + pass + + def test_get_subscriptions(self): + """Test case for get_subscriptions + + """ + pass + + def test_get_subscriptions1(self): + """Test case for get_subscriptions1 + + """ + pass + + def test_sync_licenses2(self): + """Test case for sync_licenses2 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multi_cloud_account_info.py b/test/test_multi_cloud_account_info.py new file mode 100644 index 0000000..e84dd33 --- /dev/null +++ b/test/test_multi_cloud_account_info.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.aws_iam_credentials import AwsIamCredentials +from openapi_client.model.aws_key_credentials import AwsKeyCredentials +from openapi_client.model.azure_credentials import AzureCredentials +from openapi_client.model.gcp_credentials import GcpCredentials +globals()['AwsIamCredentials'] = AwsIamCredentials +globals()['AwsKeyCredentials'] = AwsKeyCredentials +globals()['AzureCredentials'] = AzureCredentials +globals()['GcpCredentials'] = GcpCredentials +from openapi_client.model.multi_cloud_account_info import MultiCloudAccountInfo + + +class TestMultiCloudAccountInfo(unittest.TestCase): + """MultiCloudAccountInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMultiCloudAccountInfo(self): + """Test MultiCloudAccountInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = MultiCloudAccountInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multi_cloud_edge_account_info.py b/test/test_multi_cloud_edge_account_info.py new file mode 100644 index 0000000..f5abd0b --- /dev/null +++ b/test/test_multi_cloud_edge_account_info.py @@ -0,0 +1,46 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_credentials import EquinixCredentials +from openapi_client.model.megaport_credentials import MegaportCredentials +from openapi_client.model.multi_cloud_edge_billing_account_info import MultiCloudEdgeBillingAccountInfo +from openapi_client.model.multi_cloud_edge_location_info import MultiCloudEdgeLocationInfo +from openapi_client.model.multi_cloud_edge_partner_port import MultiCloudEdgePartnerPort +globals()['EquinixCredentials'] = EquinixCredentials +globals()['MegaportCredentials'] = MegaportCredentials +globals()['MultiCloudEdgeBillingAccountInfo'] = MultiCloudEdgeBillingAccountInfo +globals()['MultiCloudEdgeLocationInfo'] = MultiCloudEdgeLocationInfo +globals()['MultiCloudEdgePartnerPort'] = MultiCloudEdgePartnerPort +from openapi_client.model.multi_cloud_edge_account_info import MultiCloudEdgeAccountInfo + + +class TestMultiCloudEdgeAccountInfo(unittest.TestCase): + """MultiCloudEdgeAccountInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMultiCloudEdgeAccountInfo(self): + """Test MultiCloudEdgeAccountInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = MultiCloudEdgeAccountInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multi_cloud_edge_billing_account_info.py b/test/test_multi_cloud_edge_billing_account_info.py new file mode 100644 index 0000000..fa07b92 --- /dev/null +++ b/test/test_multi_cloud_edge_billing_account_info.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.multi_cloud_edge_billing_account_info import MultiCloudEdgeBillingAccountInfo + + +class TestMultiCloudEdgeBillingAccountInfo(unittest.TestCase): + """MultiCloudEdgeBillingAccountInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMultiCloudEdgeBillingAccountInfo(self): + """Test MultiCloudEdgeBillingAccountInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = MultiCloudEdgeBillingAccountInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multi_cloud_edge_location_info.py b/test/test_multi_cloud_edge_location_info.py new file mode 100644 index 0000000..f207688 --- /dev/null +++ b/test/test_multi_cloud_edge_location_info.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_location_info import EquinixLocationInfo +from openapi_client.model.megaport_location_info import MegaportLocationInfo +globals()['EquinixLocationInfo'] = EquinixLocationInfo +globals()['MegaportLocationInfo'] = MegaportLocationInfo +from openapi_client.model.multi_cloud_edge_location_info import MultiCloudEdgeLocationInfo + + +class TestMultiCloudEdgeLocationInfo(unittest.TestCase): + """MultiCloudEdgeLocationInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMultiCloudEdgeLocationInfo(self): + """Test MultiCloudEdgeLocationInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = MultiCloudEdgeLocationInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multi_cloud_edge_partner_port.py b/test/test_multi_cloud_edge_partner_port.py new file mode 100644 index 0000000..6e08bc1 --- /dev/null +++ b/test/test_multi_cloud_edge_partner_port.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.equinix_partner_port import EquinixPartnerPort +from openapi_client.model.megaport_partner_port import MegaportPartnerPort +globals()['EquinixPartnerPort'] = EquinixPartnerPort +globals()['MegaportPartnerPort'] = MegaportPartnerPort +from openapi_client.model.multi_cloud_edge_partner_port import MultiCloudEdgePartnerPort + + +class TestMultiCloudEdgePartnerPort(unittest.TestCase): + """MultiCloudEdgePartnerPort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMultiCloudEdgePartnerPort(self): + """Test MultiCloudEdgePartnerPort""" + # FIXME: construct object with mandatory attributes with example values + # model = MultiCloudEdgePartnerPort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multitenant_apis_provider_api.py b/test/test_multitenant_apis_provider_api.py new file mode 100644 index 0000000..e03d7a0 --- /dev/null +++ b/test/test_multitenant_apis_provider_api.py @@ -0,0 +1,155 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.multitenant_apis_provider_api import MultitenantAPIsProviderApi # noqa: E501 + + +class TestMultitenantAPIsProviderApi(unittest.TestCase): + """MultitenantAPIsProviderApi unit test stubs""" + + def setUp(self): + self.api = MultitenantAPIsProviderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_tenant(self): + """Test case for create_tenant + + """ + pass + + def test_create_tenant_async(self): + """Test case for create_tenant_async + + """ + pass + + def test_create_tenant_async_bulk(self): + """Test case for create_tenant_async_bulk + + """ + pass + + def test_delete_tenant(self): + """Test case for delete_tenant + + """ + pass + + def test_delete_tenant_async_bulk(self): + """Test case for delete_tenant_async_bulk + + """ + pass + + def test_delete_tenant_backup(self): + """Test case for delete_tenant_backup + + """ + pass + + def test_download_existing_backup_file(self): + """Test case for download_existing_backup_file + + """ + pass + + def test_export_tenant_backup(self): + """Test case for export_tenant_backup + + """ + pass + + def test_force_status_collection(self): + """Test case for force_status_collection + + """ + pass + + def test_get_all_tenant_statuses(self): + """Test case for get_all_tenant_statuses + + """ + pass + + def test_get_all_tenants(self): + """Test case for get_all_tenants + + """ + pass + + def test_get_tenant(self): + """Test case for get_tenant + + """ + pass + + def test_get_tenant_hosting_capacity_onv_smarts(self): + """Test case for get_tenant_hosting_capacity_onv_smarts + + """ + pass + + def test_get_tenantv_smart_mapping(self): + """Test case for get_tenantv_smart_mapping + + """ + pass + + def test_import_tenant_backup(self): + """Test case for import_tenant_backup + + """ + pass + + def test_list_tenant_backup(self): + """Test case for list_tenant_backup + + """ + pass + + def test_switch_tenant(self): + """Test case for switch_tenant + + """ + pass + + def test_tenantv_smart_mt_migrate(self): + """Test case for tenantv_smart_mt_migrate + + """ + pass + + def test_update_tenant(self): + """Test case for update_tenant + + """ + pass + + def test_update_tenantv_smart_placement(self): + """Test case for update_tenantv_smart_placement + + """ + pass + + def test_v_session_id(self): + """Test case for v_session_id + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_name_value_pair.py b/test/test_name_value_pair.py new file mode 100644 index 0000000..6c1a48e --- /dev/null +++ b/test/test_name_value_pair.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.name_value_pair import NameValuePair + + +class TestNameValuePair(unittest.TestCase): + """NameValuePair unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNameValuePair(self): + """Test NameValuePair""" + # FIXME: construct object with mandatory attributes with example values + # model = NameValuePair() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_nat_rule.py b/test/test_nat_rule.py new file mode 100644 index 0000000..eed1e9e --- /dev/null +++ b/test/test_nat_rule.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.nat_rule import NATRule + + +class TestNATRule(unittest.TestCase): + """NATRule unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNATRule(self): + """Test NATRule""" + # FIXME: construct object with mandatory attributes with example values + # model = NATRule() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_network_protocol.py b/test/test_network_protocol.py new file mode 100644 index 0000000..05a4344 --- /dev/null +++ b/test/test_network_protocol.py @@ -0,0 +1,46 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.dhcp_pool import DHCPPool +from openapi_client.model.nat_rule import NATRule +from openapi_client.model.network_protocol_all_of import NetworkProtocolAllOf +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.variable import Variable +globals()['DHCPPool'] = DHCPPool +globals()['NATRule'] = NATRule +globals()['NetworkProtocolAllOf'] = NetworkProtocolAllOf +globals()['ProfileParcel'] = ProfileParcel +globals()['Variable'] = Variable +from openapi_client.model.network_protocol import NetworkProtocol + + +class TestNetworkProtocol(unittest.TestCase): + """NetworkProtocol unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNetworkProtocol(self): + """Test NetworkProtocol""" + # FIXME: construct object with mandatory attributes with example values + # model = NetworkProtocol() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_network_protocol_all_of.py b/test/test_network_protocol_all_of.py new file mode 100644 index 0000000..a1498ca --- /dev/null +++ b/test/test_network_protocol_all_of.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.dhcp_pool import DHCPPool +from openapi_client.model.nat_rule import NATRule +globals()['DHCPPool'] = DHCPPool +globals()['NATRule'] = NATRule +from openapi_client.model.network_protocol_all_of import NetworkProtocolAllOf + + +class TestNetworkProtocolAllOf(unittest.TestCase): + """NetworkProtocolAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNetworkProtocolAllOf(self): + """Test NetworkProtocolAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = NetworkProtocolAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_node.py b/test/test_node.py new file mode 100644 index 0000000..0b5a43e --- /dev/null +++ b/test/test_node.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.node import Node + + +class TestNode(unittest.TestCase): + """Node unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNode(self): + """Test Node""" + # FIXME: construct object with mandatory attributes with example values + # model = Node() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_nwpi_api.py b/test/test_nwpi_api.py new file mode 100644 index 0000000..8716588 --- /dev/null +++ b/test/test_nwpi_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.nwpi_api import NWPIApi # noqa: E501 + + +class TestNWPIApi(unittest.TestCase): + """NWPIApi unit test stubs""" + + def setUp(self): + self.api = NWPIApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_agg_flow(self): + """Test case for get_agg_flow + + """ + pass + + def test_get_app_qos_data(self): + """Test case for get_app_qos_data + + """ + pass + + def test_get_app_qos_state(self): + """Test case for get_app_qos_state + + """ + pass + + def test_get_concurrent_data(self): + """Test case for get_concurrent_data + + """ + pass + + def test_get_concurrent_domain_data(self): + """Test case for get_concurrent_domain_data + + """ + pass + + def test_get_event_app_hop_list(self): + """Test case for get_event_app_hop_list + + """ + pass + + def test_get_event_app_score_bandwidth(self): + """Test case for get_event_app_score_bandwidth + + """ + pass + + def test_get_event_flow_from_app_hop(self): + """Test case for get_event_flow_from_app_hop + + """ + pass + + def test_get_event_readout(self): + """Test case for get_event_readout + + """ + pass + + def test_get_routing_detail_from_local(self): + """Test case for get_routing_detail_from_local + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_nwpi_domain_monitor.py b/test/test_nwpi_domain_monitor.py new file mode 100644 index 0000000..6bb0355 --- /dev/null +++ b/test/test_nwpi_domain_monitor.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.domain_detail import DomainDetail +from openapi_client.model.uuid_to_domain_id import UuidToDomainId +globals()['DomainDetail'] = DomainDetail +globals()['UuidToDomainId'] = UuidToDomainId +from openapi_client.model.nwpi_domain_monitor import NwpiDomainMonitor + + +class TestNwpiDomainMonitor(unittest.TestCase): + """NwpiDomainMonitor unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNwpiDomainMonitor(self): + """Test NwpiDomainMonitor""" + # FIXME: construct object with mandatory attributes with example values + # model = NwpiDomainMonitor() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_omp.py b/test/test_omp.py new file mode 100644 index 0000000..996743c --- /dev/null +++ b/test/test_omp.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.omp import OMP + + +class TestOMP(unittest.TestCase): + """OMP unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOMP(self): + """Test OMP""" + # FIXME: construct object with mandatory attributes with example values + # model = OMP() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_on_demand_queue_entry.py b/test/test_on_demand_queue_entry.py new file mode 100644 index 0000000..ba6edeb --- /dev/null +++ b/test/test_on_demand_queue_entry.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.on_demand_queue_entry import OnDemandQueueEntry + + +class TestOnDemandQueueEntry(unittest.TestCase): + """OnDemandQueueEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOnDemandQueueEntry(self): + """Test OnDemandQueueEntry""" + # FIXME: construct object with mandatory attributes with example values + # model = OnDemandQueueEntry() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_partner_aci_policy_builder_api.py b/test/test_partner_aci_policy_builder_api.py new file mode 100644 index 0000000..686cc89 --- /dev/null +++ b/test/test_partner_aci_policy_builder_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.partner_aci_policy_builder_api import PartnerACIPolicyBuilderApi # noqa: E501 + + +class TestPartnerACIPolicyBuilderApi(unittest.TestCase): + """PartnerACIPolicyBuilderApi unit test stubs""" + + def setUp(self): + self.api = PartnerACIPolicyBuilderApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_dscp_mappings(self): + """Test case for create_dscp_mappings + + """ + pass + + def test_delete_dscp_mappings(self): + """Test case for delete_dscp_mappings + + """ + pass + + def test_get_aci_definitions(self): + """Test case for get_aci_definitions + + """ + pass + + def test_get_data_prefix_mappings(self): + """Test case for get_data_prefix_mappings + + """ + pass + + def test_get_data_prefix_sequences(self): + """Test case for get_data_prefix_sequences + + """ + pass + + def test_get_dscp_mappings(self): + """Test case for get_dscp_mappings + + """ + pass + + def test_get_events(self): + """Test case for get_events + + """ + pass + + def test_set_data_prefix_mappings(self): + """Test case for set_data_prefix_mappings + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_partner_dnacsdaapi_api.py b/test/test_partner_dnacsdaapi_api.py new file mode 100644 index 0000000..5fe63a5 --- /dev/null +++ b/test/test_partner_dnacsdaapi_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.partner_dnacsdaapi_api import PartnerDNACSDAAPIApi # noqa: E501 + + +class TestPartnerDNACSDAAPIApi(unittest.TestCase): + """PartnerDNACSDAAPIApi unit test stubs""" + + def setUp(self): + self.api = PartnerDNACSDAAPIApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_sda_config(self): + """Test case for create_sda_config + + """ + pass + + def test_create_sda_config_from_netconf(self): + """Test case for create_sda_config_from_netconf + + """ + pass + + def test_get_device_details(self): + """Test case for get_device_details + + """ + pass + + def test_get_overlay_vpn_list(self): + """Test case for get_overlay_vpn_list + + """ + pass + + def test_get_sda_enabled_devices(self): + """Test case for get_sda_enabled_devices + + """ + pass + + def test_get_sites_for_partner(self): + """Test case for get_sites_for_partner + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_partner_registration_api.py b/test/test_partner_registration_api.py new file mode 100644 index 0000000..c7aaa83 --- /dev/null +++ b/test/test_partner_registration_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.partner_registration_api import PartnerRegistrationApi # noqa: E501 + + +class TestPartnerRegistrationApi(unittest.TestCase): + """PartnerRegistrationApi unit test stubs""" + + def setUp(self): + self.api = PartnerRegistrationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_device_mapping(self): + """Test case for delete_device_mapping + + """ + pass + + def test_delete_partner(self): + """Test case for delete_partner + + """ + pass + + def test_get_data_change_info(self): + """Test case for get_data_change_info + + """ + pass + + def test_get_partner(self): + """Test case for get_partner + + """ + pass + + def test_get_partner_devices(self): + """Test case for get_partner_devices + + """ + pass + + def test_get_partners(self): + """Test case for get_partners + + """ + pass + + def test_get_partners_by_partner_type(self): + """Test case for get_partners_by_partner_type + + """ + pass + + def test_get_vpn_list(self): + """Test case for get_vpn_list + + """ + pass + + def test_map_devices(self): + """Test case for map_devices + + """ + pass + + def test_register_partner(self): + """Test case for register_partner + + """ + pass + + def test_unmap_devices(self): + """Test case for unmap_devices + + """ + pass + + def test_update_partner(self): + """Test case for update_partner + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_partner_type.py b/test/test_partner_type.py new file mode 100644 index 0000000..00044e9 --- /dev/null +++ b/test/test_partner_type.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.partner_type import PartnerType + + +class TestPartnerType(unittest.TestCase): + """PartnerType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPartnerType(self): + """Test PartnerType""" + # FIXME: construct object with mandatory attributes with example values + # model = PartnerType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_partner_wcm_configs_api.py b/test/test_partner_wcm_configs_api.py new file mode 100644 index 0000000..d9db31f --- /dev/null +++ b/test/test_partner_wcm_configs_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.partner_wcm_configs_api import PartnerWCMConfigsApi # noqa: E501 + + +class TestPartnerWCMConfigsApi(unittest.TestCase): + """PartnerWCMConfigsApi unit test stubs""" + + def setUp(self): + self.api = PartnerWCMConfigsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_push_netconf_configs(self): + """Test case for push_netconf_configs + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_policy_rule.py b/test/test_policy_rule.py new file mode 100644 index 0000000..96fa468 --- /dev/null +++ b/test/test_policy_rule.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.policy_rule import PolicyRule + + +class TestPolicyRule(unittest.TestCase): + """PolicyRule unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPolicyRule(self): + """Test PolicyRule""" + # FIXME: construct object with mandatory attributes with example values + # model = PolicyRule() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_profile_parcel.py b/test/test_profile_parcel.py new file mode 100644 index 0000000..7916f6e --- /dev/null +++ b/test/test_profile_parcel.py @@ -0,0 +1,52 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.cellular import Cellular +from openapi_client.model.ethernet import Ethernet +from openapi_client.model.global_settings import GlobalSettings +from openapi_client.model.network_protocol import NetworkProtocol +from openapi_client.model.security_policy import SecurityPolicy +from openapi_client.model.variable import Variable +from openapi_client.model.vpn import Vpn +from openapi_client.model.wifi import Wifi +globals()['Cellular'] = Cellular +globals()['Ethernet'] = Ethernet +globals()['GlobalSettings'] = GlobalSettings +globals()['NetworkProtocol'] = NetworkProtocol +globals()['SecurityPolicy'] = SecurityPolicy +globals()['Variable'] = Variable +globals()['Vpn'] = Vpn +globals()['Wifi'] = Wifi +from openapi_client.model.profile_parcel import ProfileParcel + + +class TestProfileParcel(unittest.TestCase): + """ProfileParcel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfileParcel(self): + """Test ProfileParcel""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfileParcel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_property_definition.py b/test/test_property_definition.py new file mode 100644 index 0000000..8c78ff6 --- /dev/null +++ b/test/test_property_definition.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.property_definition import PropertyDefinition + + +class TestPropertyDefinition(unittest.TestCase): + """PropertyDefinition unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPropertyDefinition(self): + """Test PropertyDefinition""" + # FIXME: construct object with mandatory attributes with example values + # model = PropertyDefinition() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_public_internet_timer.py b/test/test_public_internet_timer.py new file mode 100644 index 0000000..cedf10a --- /dev/null +++ b/test/test_public_internet_timer.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.public_internet_timer import PublicInternetTimer + + +class TestPublicInternetTimer(unittest.TestCase): + """PublicInternetTimer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPublicInternetTimer(self): + """Test PublicInternetTimer""" + # FIXME: construct object with mandatory attributes with example values + # model = PublicInternetTimer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_queue_entries.py b/test/test_queue_entries.py new file mode 100644 index 0000000..2b4ce6f --- /dev/null +++ b/test/test_queue_entries.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.on_demand_queue_entry import OnDemandQueueEntry +globals()['OnDemandQueueEntry'] = OnDemandQueueEntry +from openapi_client.model.queue_entries import QueueEntries + + +class TestQueueEntries(unittest.TestCase): + """QueueEntries unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testQueueEntries(self): + """Test QueueEntries""" + # FIXME: construct object with mandatory attributes with example values + # model = QueueEntries() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_queue_properties.py b/test/test_queue_properties.py new file mode 100644 index 0000000..70bb2ac --- /dev/null +++ b/test/test_queue_properties.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.queue_properties import QueueProperties + + +class TestQueueProperties(unittest.TestCase): + """QueueProperties unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testQueueProperties(self): + """Test QueueProperties""" + # FIXME: construct object with mandatory attributes with example values + # model = QueueProperties() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_radio_band_setting24_g.py b/test/test_radio_band_setting24_g.py new file mode 100644 index 0000000..3d68526 --- /dev/null +++ b/test/test_radio_band_setting24_g.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.radio_band_setting24_g import RadioBandSetting24G + + +class TestRadioBandSetting24G(unittest.TestCase): + """RadioBandSetting24G unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRadioBandSetting24G(self): + """Test RadioBandSetting24G""" + # FIXME: construct object with mandatory attributes with example values + # model = RadioBandSetting24G() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_radio_band_setting5_g.py b/test/test_radio_band_setting5_g.py new file mode 100644 index 0000000..2f58c3a --- /dev/null +++ b/test/test_radio_band_setting5_g.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.radio_band_setting5_g import RadioBandSetting5G + + +class TestRadioBandSetting5G(unittest.TestCase): + """RadioBandSetting5G unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRadioBandSetting5G(self): + """Test RadioBandSetting5G""" + # FIXME: construct object with mandatory attributes with example values + # model = RadioBandSetting5G() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_radius_server.py b/test/test_radius_server.py new file mode 100644 index 0000000..9d88e47 --- /dev/null +++ b/test/test_radius_server.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.radius_server import RadiusServer + + +class TestRadiusServer(unittest.TestCase): + """RadiusServer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRadiusServer(self): + """Test RadiusServer""" + # FIXME: construct object with mandatory attributes with example values + # model = RadiusServer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_aaa_api.py b/test/test_real_time_monitoring_aaa_api.py new file mode 100644 index 0000000..d299af9 --- /dev/null +++ b/test/test_real_time_monitoring_aaa_api.py @@ -0,0 +1,71 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_aaa_api import RealTimeMonitoringAAAApi # noqa: E501 + + +class TestRealTimeMonitoringAAAApi(unittest.TestCase): + """RealTimeMonitoringAAAApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringAAAApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aa_aservers(self): + """Test case for get_aa_aservers + + """ + pass + + def test_get_aaa_users(self): + """Test case for get_aaa_users + + """ + pass + + def test_get_acl_match_counter_users(self): + """Test case for get_acl_match_counter_users + + """ + pass + + def test_get_all_device_users(self): + """Test case for get_all_device_users + + """ + pass + + def test_get_logging_from_device(self): + """Test case for get_logging_from_device + + """ + pass + + def test_get_unclaimed_vedges(self): + """Test case for get_unclaimed_vedges + + """ + pass + + def test_get_users_from_device(self): + """Test case for get_users_from_device + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_app_hosting_api.py b/test/test_real_time_monitoring_app_hosting_api.py new file mode 100644 index 0000000..0c45d96 --- /dev/null +++ b/test/test_real_time_monitoring_app_hosting_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_app_hosting_api import RealTimeMonitoringAppHostingApi # noqa: E501 + + +class TestRealTimeMonitoringAppHostingApi(unittest.TestCase): + """RealTimeMonitoringAppHostingApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringAppHostingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_app_hosting_attached_devices(self): + """Test case for get_app_hosting_attached_devices + + """ + pass + + def test_get_app_hosting_details(self): + """Test case for get_app_hosting_details + + """ + pass + + def test_get_app_hosting_guest_routes(self): + """Test case for get_app_hosting_guest_routes + + """ + pass + + def test_get_app_hosting_network_devices(self): + """Test case for get_app_hosting_network_devices + + """ + pass + + def test_get_app_hosting_network_utils(self): + """Test case for get_app_hosting_network_utils + + """ + pass + + def test_get_app_hosting_processes(self): + """Test case for get_app_hosting_processes + + """ + pass + + def test_get_app_hosting_storage_utils(self): + """Test case for get_app_hosting_storage_utils + + """ + pass + + def test_get_app_hosting_utilization(self): + """Test case for get_app_hosting_utilization + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_app_logs_api.py b/test/test_real_time_monitoring_app_logs_api.py new file mode 100644 index 0000000..c8e2195 --- /dev/null +++ b/test/test_real_time_monitoring_app_logs_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_app_logs_api import RealTimeMonitoringAppLogsApi # noqa: E501 + + +class TestRealTimeMonitoringAppLogsApi(unittest.TestCase): + """RealTimeMonitoringAppLogsApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringAppLogsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_app_log_flow_count(self): + """Test case for get_app_log_flow_count + + """ + pass + + def test_get_app_log_flows(self): + """Test case for get_app_log_flows + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_application_aware_route_api.py b/test/test_real_time_monitoring_application_aware_route_api.py new file mode 100644 index 0000000..9f3c913 --- /dev/null +++ b/test/test_real_time_monitoring_application_aware_route_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_application_aware_route_api import RealTimeMonitoringApplicationAwareRouteApi # noqa: E501 + + +class TestRealTimeMonitoringApplicationAwareRouteApi(unittest.TestCase): + """RealTimeMonitoringApplicationAwareRouteApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringApplicationAwareRouteApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_app_route_sla_class_list(self): + """Test case for create_app_route_sla_class_list + + """ + pass + + def test_create_app_route_statistics_list(self): + """Test case for create_app_route_statistics_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_appqoe_api.py b/test/test_real_time_monitoring_appqoe_api.py new file mode 100644 index 0000000..a71e900 --- /dev/null +++ b/test/test_real_time_monitoring_appqoe_api.py @@ -0,0 +1,125 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_appqoe_api import RealTimeMonitoringAppqoeApi # noqa: E501 + + +class TestRealTimeMonitoringAppqoeApi(unittest.TestCase): + """RealTimeMonitoringAppqoeApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringAppqoeApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_appqoe_active_flow_id_details(self): + """Test case for create_appqoe_active_flow_id_details + + """ + pass + + def test_create_appqoe_flow_id_expired_details(self): + """Test case for create_appqoe_flow_id_expired_details + + """ + pass + + def test_create_appqoe_vpn_id_list(self): + """Test case for create_appqoe_vpn_id_list + + """ + pass + + def test_get_appqoe_cluster_summary(self): + """Test case for get_appqoe_cluster_summary + + """ + pass + + def test_get_appqoe_error_recent(self): + """Test case for get_appqoe_error_recent + + """ + pass + + def test_get_appqoe_expired(self): + """Test case for get_appqoe_expired + + """ + pass + + def test_get_appqoe_flow_closed_error(self): + """Test case for get_appqoe_flow_closed_error + + """ + pass + + def test_get_appqoe_hput_stats(self): + """Test case for get_appqoe_hput_stats + + """ + pass + + def test_get_appqoe_nat_stats(self): + """Test case for get_appqoe_nat_stats + + """ + pass + + def test_get_appqoe_rm_resources(self): + """Test case for get_appqoe_rm_resources + + """ + pass + + def test_get_appqoe_rm_stats(self): + """Test case for get_appqoe_rm_stats + + """ + pass + + def test_get_appqoe_service_controllers(self): + """Test case for get_appqoe_service_controllers + + """ + pass + + def test_get_appqoe_services_status(self): + """Test case for get_appqoe_services_status + + """ + pass + + def test_get_appqoe_sppi_pipe_stats(self): + """Test case for get_appqoe_sppi_pipe_stats + + """ + pass + + def test_get_appqoe_sppi_queue_stats(self): + """Test case for get_appqoe_sppi_queue_stats + + """ + pass + + def test_get_appqoe_status(self): + """Test case for get_appqoe_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_arp_api.py b/test/test_real_time_monitoring_arp_api.py new file mode 100644 index 0000000..9607d38 --- /dev/null +++ b/test/test_real_time_monitoring_arp_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_arp_api import RealTimeMonitoringARPApi # noqa: E501 + + +class TestRealTimeMonitoringARPApi(unittest.TestCase): + """RealTimeMonitoringARPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringARPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_arp_interface(self): + """Test case for get_arp_interface + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_bfd_api.py b/test/test_real_time_monitoring_bfd_api.py new file mode 100644 index 0000000..a6c889e --- /dev/null +++ b/test/test_real_time_monitoring_bfd_api.py @@ -0,0 +1,107 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_bfd_api import RealTimeMonitoringBFDApi # noqa: E501 + + +class TestRealTimeMonitoringBFDApi(unittest.TestCase): + """RealTimeMonitoringBFDApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringBFDApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_bfd_history_list(self): + """Test case for create_bfd_history_list + + """ + pass + + def test_create_bfd_link_list(self): + """Test case for create_bfd_link_list + + """ + pass + + def test_create_bfd_sessions(self): + """Test case for create_bfd_sessions + + """ + pass + + def test_create_bfd_summary(self): + """Test case for create_bfd_summary + + """ + pass + + def test_create_synced_bfd_session(self): + """Test case for create_synced_bfd_session + + """ + pass + + def test_create_tloc_summary(self): + """Test case for create_tloc_summary + + """ + pass + + def test_get_bfd_site_state_detail(self): + """Test case for get_bfd_site_state_detail + + """ + pass + + def test_get_bfd_sites_summary(self): + """Test case for get_bfd_sites_summary + + """ + pass + + def test_get_device_bfd_state_summary(self): + """Test case for get_device_bfd_state_summary + + """ + pass + + def test_get_device_bfd_state_summary_tloc(self): + """Test case for get_device_bfd_state_summary_tloc + + """ + pass + + def test_get_device_bfd_status(self): + """Test case for get_device_bfd_status + + """ + pass + + def test_get_device_bfd_status_summary(self): + """Test case for get_device_bfd_status_summary + + """ + pass + + def test_get_device_tloc_to_intf_list(self): + """Test case for get_device_tloc_to_intf_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_bgp_api.py b/test/test_real_time_monitoring_bgp_api.py new file mode 100644 index 0000000..cd4c974 --- /dev/null +++ b/test/test_real_time_monitoring_bgp_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_bgp_api import RealTimeMonitoringBGPApi # noqa: E501 + + +class TestRealTimeMonitoringBGPApi(unittest.TestCase): + """RealTimeMonitoringBGPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringBGPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_bgp_neighbors_list(self): + """Test case for create_bgp_neighbors_list + + """ + pass + + def test_create_bgp_routes_list(self): + """Test case for create_bgp_routes_list + + """ + pass + + def test_create_bgp_summary(self): + """Test case for create_bgp_summary + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_bridge_api.py b/test/test_real_time_monitoring_bridge_api.py new file mode 100644 index 0000000..d73adbb --- /dev/null +++ b/test/test_real_time_monitoring_bridge_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_bridge_api import RealTimeMonitoringBridgeApi # noqa: E501 + + +class TestRealTimeMonitoringBridgeApi(unittest.TestCase): + """RealTimeMonitoringBridgeApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringBridgeApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_bridge_interface_list(self): + """Test case for get_bridge_interface_list + + """ + pass + + def test_get_bridge_interface_mac(self): + """Test case for get_bridge_interface_mac + + """ + pass + + def test_get_bridge_interface_table(self): + """Test case for get_bridge_interface_table + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cellular_aon_ipsec_interface_api.py b/test/test_real_time_monitoring_cellular_aon_ipsec_interface_api.py new file mode 100644 index 0000000..3241b47 --- /dev/null +++ b/test/test_real_time_monitoring_cellular_aon_ipsec_interface_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cellular_aon_ipsec_interface_api import RealTimeMonitoringCellularAONIpsecInterfaceApi # noqa: E501 + + +class TestRealTimeMonitoringCellularAONIpsecInterfaceApi(unittest.TestCase): + """RealTimeMonitoringCellularAONIpsecInterfaceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCellularAONIpsecInterfaceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_aon_ipsec_interface_counters_info(self): + """Test case for get_aon_ipsec_interface_counters_info + + """ + pass + + def test_get_aon_ipsec_interface_sessionnfo(self): + """Test case for get_aon_ipsec_interface_sessionnfo + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cellular_api.py b/test/test_real_time_monitoring_cellular_api.py new file mode 100644 index 0000000..1d57bd2 --- /dev/null +++ b/test/test_real_time_monitoring_cellular_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cellular_api import RealTimeMonitoringCellularApi # noqa: E501 + + +class TestRealTimeMonitoringCellularApi(unittest.TestCase): + """RealTimeMonitoringCellularApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCellularApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_cellular_connection_list(self): + """Test case for create_cellular_connection_list + + """ + pass + + def test_create_hardware_list(self): + """Test case for create_hardware_list + + """ + pass + + def test_create_modem_list(self): + """Test case for create_modem_list + + """ + pass + + def test_create_network_list(self): + """Test case for create_network_list + + """ + pass + + def test_create_profile_list(self): + """Test case for create_profile_list + + """ + pass + + def test_create_radio_list(self): + """Test case for create_radio_list + + """ + pass + + def test_create_sessions_list(self): + """Test case for create_sessions_list + + """ + pass + + def test_get_cellular_status_list(self): + """Test case for get_cellular_status_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cellular_eiolte_connection_service_api.py b/test/test_real_time_monitoring_cellular_eiolte_connection_service_api.py new file mode 100644 index 0000000..1942d19 --- /dev/null +++ b/test/test_real_time_monitoring_cellular_eiolte_connection_service_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cellular_eiolte_connection_service_api import RealTimeMonitoringCellularEIOLTEConnectionServiceApi # noqa: E501 + + +class TestRealTimeMonitoringCellularEIOLTEConnectionServiceApi(unittest.TestCase): + """RealTimeMonitoringCellularEIOLTEConnectionServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCellularEIOLTEConnectionServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_eiolte_connection_info(self): + """Test case for get_eiolte_connection_info + + """ + pass + + def test_get_eiolte_radio_info(self): + """Test case for get_eiolte_radio_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cellular_eiolte_hardware_service_api.py b/test/test_real_time_monitoring_cellular_eiolte_hardware_service_api.py new file mode 100644 index 0000000..6bada58 --- /dev/null +++ b/test/test_real_time_monitoring_cellular_eiolte_hardware_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cellular_eiolte_hardware_service_api import RealTimeMonitoringCellularEIOLTEHardwareServiceApi # noqa: E501 + + +class TestRealTimeMonitoringCellularEIOLTEHardwareServiceApi(unittest.TestCase): + """RealTimeMonitoringCellularEIOLTEHardwareServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCellularEIOLTEHardwareServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_eiolte_hardware_info(self): + """Test case for get_eiolte_hardware_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cellular_eiolte_network_service_api.py b/test/test_real_time_monitoring_cellular_eiolte_network_service_api.py new file mode 100644 index 0000000..72e93a0 --- /dev/null +++ b/test/test_real_time_monitoring_cellular_eiolte_network_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cellular_eiolte_network_service_api import RealTimeMonitoringCellularEIOLTENetworkServiceApi # noqa: E501 + + +class TestRealTimeMonitoringCellularEIOLTENetworkServiceApi(unittest.TestCase): + """RealTimeMonitoringCellularEIOLTENetworkServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCellularEIOLTENetworkServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_eiolte_network_info(self): + """Test case for get_eiolte_network_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cellular_eiolte_sim_service_api.py b/test/test_real_time_monitoring_cellular_eiolte_sim_service_api.py new file mode 100644 index 0000000..8235415 --- /dev/null +++ b/test/test_real_time_monitoring_cellular_eiolte_sim_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cellular_eiolte_sim_service_api import RealTimeMonitoringCellularEIOLTESimServiceApi # noqa: E501 + + +class TestRealTimeMonitoringCellularEIOLTESimServiceApi(unittest.TestCase): + """RealTimeMonitoringCellularEIOLTESimServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCellularEIOLTESimServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_eiolte_sim_info(self): + """Test case for get_eiolte_sim_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cfm_api.py b/test/test_real_time_monitoring_cfm_api.py new file mode 100644 index 0000000..2bd9d3a --- /dev/null +++ b/test/test_real_time_monitoring_cfm_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cfm_api import RealTimeMonitoringCFMApi # noqa: E501 + + +class TestRealTimeMonitoringCFMApi(unittest.TestCase): + """RealTimeMonitoringCFMApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCFMApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_mp_database(self): + """Test case for get_mp_database + + """ + pass + + def test_get_mp_local_mep(self): + """Test case for get_mp_local_mep + + """ + pass + + def test_get_mp_local_mip(self): + """Test case for get_mp_local_mip + + """ + pass + + def test_get_mp_remote_mep(self): + """Test case for get_mp_remote_mep + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_cloud_express_api.py b/test/test_real_time_monitoring_cloud_express_api.py new file mode 100644 index 0000000..6dae4dc --- /dev/null +++ b/test/test_real_time_monitoring_cloud_express_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_cloud_express_api import RealTimeMonitoringCloudExpressApi # noqa: E501 + + +class TestRealTimeMonitoringCloudExpressApi(unittest.TestCase): + """RealTimeMonitoringCloudExpressApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCloudExpressApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_applications_detail_list(self): + """Test case for create_applications_detail_list + + """ + pass + + def test_create_applications_list(self): + """Test case for create_applications_list + + """ + pass + + def test_create_gateway_exits_list(self): + """Test case for create_gateway_exits_list + + """ + pass + + def test_create_lb_applications_list(self): + """Test case for create_lb_applications_list + + """ + pass + + def test_create_local_exits_list(self): + """Test case for create_local_exits_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_commit_list_api.py b/test/test_real_time_monitoring_commit_list_api.py new file mode 100644 index 0000000..32aaacd --- /dev/null +++ b/test/test_real_time_monitoring_commit_list_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_commit_list_api import RealTimeMonitoringCommitListApi # noqa: E501 + + +class TestRealTimeMonitoringCommitListApi(unittest.TestCase): + """RealTimeMonitoringCommitListApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCommitListApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_device_configuration_commit_list(self): + """Test case for get_device_configuration_commit_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_container_lifecycle_api.py b/test/test_real_time_monitoring_container_lifecycle_api.py new file mode 100644 index 0000000..773de97 --- /dev/null +++ b/test/test_real_time_monitoring_container_lifecycle_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_container_lifecycle_api import RealTimeMonitoringContainerLifecycleApi # noqa: E501 + + +class TestRealTimeMonitoringContainerLifecycleApi(unittest.TestCase): + """RealTimeMonitoringContainerLifecycleApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringContainerLifecycleApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_device_containers_info(self): + """Test case for create_device_containers_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_crash_log_api.py b/test/test_real_time_monitoring_crash_log_api.py new file mode 100644 index 0000000..4f7fa0a --- /dev/null +++ b/test/test_real_time_monitoring_crash_log_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_crash_log_api import RealTimeMonitoringCrashLogApi # noqa: E501 + + +class TestRealTimeMonitoringCrashLogApi(unittest.TestCase): + """RealTimeMonitoringCrashLogApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringCrashLogApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_all_device_crash_logs(self): + """Test case for get_all_device_crash_logs + + """ + pass + + def test_get_device_crash_information(self): + """Test case for get_device_crash_information + + """ + pass + + def test_get_device_crash_logs(self): + """Test case for get_device_crash_logs + + """ + pass + + def test_get_device_crash_logs_synced(self): + """Test case for get_device_crash_logs_synced + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_device_api.py b/test/test_real_time_monitoring_device_api.py new file mode 100644 index 0000000..b0bccfa --- /dev/null +++ b/test/test_real_time_monitoring_device_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_device_api import RealTimeMonitoringDeviceApi # noqa: E501 + + +class TestRealTimeMonitoringDeviceApi(unittest.TestCase): + """RealTimeMonitoringDeviceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDeviceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_ipv6_data(self): + """Test case for get_ipv6_data + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_device_control_api.py b/test/test_real_time_monitoring_device_control_api.py new file mode 100644 index 0000000..9cad15a --- /dev/null +++ b/test/test_real_time_monitoring_device_control_api.py @@ -0,0 +1,155 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_device_control_api import RealTimeMonitoringDeviceControlApi # noqa: E501 + + +class TestRealTimeMonitoringDeviceControlApi(unittest.TestCase): + """RealTimeMonitoringDeviceControlApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDeviceControlApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_connection_history_list_real_time(self): + """Test case for create_connection_history_list_real_time + + """ + pass + + def test_create_connections_summary(self): + """Test case for create_connections_summary + + """ + pass + + def test_create_link_list(self): + """Test case for create_link_list + + """ + pass + + def test_create_local_properties_list_list_real_t_ime(self): + """Test case for create_local_properties_list_list_real_t_ime + + """ + pass + + def test_create_local_properties_synced_list(self): + """Test case for create_local_properties_synced_list + + """ + pass + + def test_create_real_time_connection_list(self): + """Test case for create_real_time_connection_list + + """ + pass + + def test_create_real_time_connection_list1(self): + """Test case for create_real_time_connection_list1 + + """ + pass + + def test_create_synced_connection_list(self): + """Test case for create_synced_connection_list + + """ + pass + + def test_create_valid_devices_list_real_time(self): + """Test case for create_valid_devices_list_real_time + + """ + pass + + def test_create_valid_v_smarts_list_real_time(self): + """Test case for create_valid_v_smarts_list_real_time + + """ + pass + + def test_create_wan_interface_list_list(self): + """Test case for create_wan_interface_list_list + + """ + pass + + def test_create_wan_interface_synced_list(self): + """Test case for create_wan_interface_synced_list + + """ + pass + + def test_get_affinity_config(self): + """Test case for get_affinity_config + + """ + pass + + def test_get_affinity_status(self): + """Test case for get_affinity_status + + """ + pass + + def test_get_connection_statistics(self): + """Test case for get_connection_statistics + + """ + pass + + def test_get_device_control_status_summary(self): + """Test case for get_device_control_status_summary + + """ + pass + + def test_get_local_device_status(self): + """Test case for get_local_device_status + + """ + pass + + def test_get_port_hop_color(self): + """Test case for get_port_hop_color + + """ + pass + + def test_get_total_count_for_device_states(self): + """Test case for get_total_count_for_device_states + + """ + pass + + def test_get_valid_v_manage_id_real_time(self): + """Test case for get_valid_v_manage_id_real_time + + """ + pass + + def test_network_summary(self): + """Test case for network_summary + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_device_feature_list_api.py b/test/test_real_time_monitoring_device_feature_list_api.py new file mode 100644 index 0000000..a9dfacd --- /dev/null +++ b/test/test_real_time_monitoring_device_feature_list_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_device_feature_list_api import RealTimeMonitoringDeviceFeatureListApi # noqa: E501 + + +class TestRealTimeMonitoringDeviceFeatureListApi(unittest.TestCase): + """RealTimeMonitoringDeviceFeatureListApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDeviceFeatureListApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_feature_list(self): + """Test case for get_feature_list + + """ + pass + + def test_get_synced_feature_list(self): + """Test case for get_synced_feature_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_device_system_stats_api.py b/test/test_real_time_monitoring_device_system_stats_api.py new file mode 100644 index 0000000..4e620a1 --- /dev/null +++ b/test/test_real_time_monitoring_device_system_stats_api.py @@ -0,0 +1,113 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_device_system_stats_api import RealTimeMonitoringDeviceSystemStatsApi # noqa: E501 + + +class TestRealTimeMonitoringDeviceSystemStatsApi(unittest.TestCase): + """RealTimeMonitoringDeviceSystemStatsApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDeviceSystemStatsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_device_system_cpu_stat(self): + """Test case for create_device_system_cpu_stat + + """ + pass + + def test_create_device_system_memory_stat(self): + """Test case for create_device_system_memory_stat + + """ + pass + + def test_get_aggregation_data_by_query16(self): + """Test case for get_aggregation_data_by_query16 + + """ + pass + + def test_get_count18(self): + """Test case for get_count18 + + """ + pass + + def test_get_count_post18(self): + """Test case for get_count_post18 + + """ + pass + + def test_get_post_aggregation_app_data_by_query15(self): + """Test case for get_post_aggregation_app_data_by_query15 + + """ + pass + + def test_get_post_aggregation_data_by_query15(self): + """Test case for get_post_aggregation_data_by_query15 + + """ + pass + + def test_get_post_stat_bulk_raw_data16(self): + """Test case for get_post_stat_bulk_raw_data16 + + """ + pass + + def test_get_stat_bulk_raw_data16(self): + """Test case for get_stat_bulk_raw_data16 + + """ + pass + + def test_get_stat_data_fields18(self): + """Test case for get_stat_data_fields18 + + """ + pass + + def test_get_stat_data_raw_data15(self): + """Test case for get_stat_data_raw_data15 + + """ + pass + + def test_get_stat_data_raw_data_as_csv16(self): + """Test case for get_stat_data_raw_data_as_csv16 + + """ + pass + + def test_get_stat_query_fields18(self): + """Test case for get_stat_query_fields18 + + """ + pass + + def test_get_stats_raw_data16(self): + """Test case for get_stats_raw_data16 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_dhcp_api.py b/test/test_real_time_monitoring_dhcp_api.py new file mode 100644 index 0000000..01a889b --- /dev/null +++ b/test/test_real_time_monitoring_dhcp_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_dhcp_api import RealTimeMonitoringDHCPApi # noqa: E501 + + +class TestRealTimeMonitoringDHCPApi(unittest.TestCase): + """RealTimeMonitoringDHCPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDHCPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_dhcp_client(self): + """Test case for get_dhcp_client + + """ + pass + + def test_get_dhcp_interface(self): + """Test case for get_dhcp_interface + + """ + pass + + def test_get_dhcp_server(self): + """Test case for get_dhcp_server + + """ + pass + + def test_get_dhcpv6_interface(self): + """Test case for get_dhcpv6_interface + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_dot1x_api.py b/test/test_real_time_monitoring_dot1x_api.py new file mode 100644 index 0000000..f037077 --- /dev/null +++ b/test/test_real_time_monitoring_dot1x_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_dot1x_api import RealTimeMonitoringDOT1xApi # noqa: E501 + + +class TestRealTimeMonitoringDOT1xApi(unittest.TestCase): + """RealTimeMonitoringDOT1xApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDOT1xApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_dot1x_radius(self): + """Test case for get_dot1x_radius + + """ + pass + + def test_get_wlandot1x_clients(self): + """Test case for get_wlandot1x_clients + + """ + pass + + def test_get_wlandot1x_interfaces(self): + """Test case for get_wlandot1x_interfaces + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_dpi_api.py b/test/test_real_time_monitoring_dpi_api.py new file mode 100644 index 0000000..58749b5 --- /dev/null +++ b/test/test_real_time_monitoring_dpi_api.py @@ -0,0 +1,95 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_dpi_api import RealTimeMonitoringDPIApi # noqa: E501 + + +class TestRealTimeMonitoringDPIApi(unittest.TestCase): + """RealTimeMonitoringDPIApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDPIApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_dpi_collector_list(self): + """Test case for create_dpi_collector_list + + """ + pass + + def test_create_dpi_flows_list(self): + """Test case for create_dpi_flows_list + + """ + pass + + def test_create_dpi_statistics(self): + """Test case for create_dpi_statistics + + """ + pass + + def test_create_dpi_summary_real_time(self): + """Test case for create_dpi_summary_real_time + + """ + pass + + def test_get_common_application_list(self): + """Test case for get_common_application_list + + """ + pass + + def test_get_dpi_device_details_field_json(self): + """Test case for get_dpi_device_details_field_json + + """ + pass + + def test_get_dpi_device_field_json(self): + """Test case for get_dpi_device_field_json + + """ + pass + + def test_get_dpi_field_json(self): + """Test case for get_dpi_field_json + + """ + pass + + def test_get_qosmos_application_list(self): + """Test case for get_qosmos_application_list + + """ + pass + + def test_get_qosmos_static_application_list(self): + """Test case for get_qosmos_static_application_list + + """ + pass + + def test_get_supported_application_list(self): + """Test case for get_supported_application_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_dre_api.py b/test/test_real_time_monitoring_dre_api.py new file mode 100644 index 0000000..d0b94f6 --- /dev/null +++ b/test/test_real_time_monitoring_dre_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_dre_api import RealTimeMonitoringDREApi # noqa: E501 + + +class TestRealTimeMonitoringDREApi(unittest.TestCase): + """RealTimeMonitoringDREApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDREApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_dre_auto_bypass_stats(self): + """Test case for get_dre_auto_bypass_stats + + """ + pass + + def test_get_dre_peer_stats(self): + """Test case for get_dre_peer_stats + + """ + pass + + def test_get_dre_stats(self): + """Test case for get_dre_stats + + """ + pass + + def test_get_dre_status(self): + """Test case for get_dre_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_dual_static_route_tracker_service_api.py b/test/test_real_time_monitoring_dual_static_route_tracker_service_api.py new file mode 100644 index 0000000..d1c63c2 --- /dev/null +++ b/test/test_real_time_monitoring_dual_static_route_tracker_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_dual_static_route_tracker_service_api import RealTimeMonitoringDualStaticRouteTrackerServiceApi # noqa: E501 + + +class TestRealTimeMonitoringDualStaticRouteTrackerServiceApi(unittest.TestCase): + """RealTimeMonitoringDualStaticRouteTrackerServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringDualStaticRouteTrackerServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_dual_static_route_tracker_info(self): + """Test case for get_dual_static_route_tracker_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_eigrp_api.py b/test/test_real_time_monitoring_eigrp_api.py new file mode 100644 index 0000000..6eeb490 --- /dev/null +++ b/test/test_real_time_monitoring_eigrp_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_eigrp_api import RealTimeMonitoringEIGRPApi # noqa: E501 + + +class TestRealTimeMonitoringEIGRPApi(unittest.TestCase): + """RealTimeMonitoringEIGRPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringEIGRPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_eigrp_interface(self): + """Test case for create_eigrp_interface + + """ + pass + + def test_create_eigrp_route(self): + """Test case for create_eigrp_route + + """ + pass + + def test_create_eigrp_topology(self): + """Test case for create_eigrp_topology + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_endpoint_tracker_group_service_api.py b/test/test_real_time_monitoring_endpoint_tracker_group_service_api.py new file mode 100644 index 0000000..861deec --- /dev/null +++ b/test/test_real_time_monitoring_endpoint_tracker_group_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_endpoint_tracker_group_service_api import RealTimeMonitoringEndpointTrackerGroupServiceApi # noqa: E501 + + +class TestRealTimeMonitoringEndpointTrackerGroupServiceApi(unittest.TestCase): + """RealTimeMonitoringEndpointTrackerGroupServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringEndpointTrackerGroupServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_endpoint_tracker_group_info(self): + """Test case for get_endpoint_tracker_group_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_endpoint_tracker_service_api.py b/test/test_real_time_monitoring_endpoint_tracker_service_api.py new file mode 100644 index 0000000..0375f47 --- /dev/null +++ b/test/test_real_time_monitoring_endpoint_tracker_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_endpoint_tracker_service_api import RealTimeMonitoringEndpointTrackerServiceApi # noqa: E501 + + +class TestRealTimeMonitoringEndpointTrackerServiceApi(unittest.TestCase): + """RealTimeMonitoringEndpointTrackerServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringEndpointTrackerServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_endpoint_tracker_info(self): + """Test case for get_endpoint_tracker_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_geo_fencing_api.py b/test/test_real_time_monitoring_geo_fencing_api.py new file mode 100644 index 0000000..a635f5d --- /dev/null +++ b/test/test_real_time_monitoring_geo_fencing_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_geo_fencing_api import RealTimeMonitoringGeoFencingApi # noqa: E501 + + +class TestRealTimeMonitoringGeoFencingApi(unittest.TestCase): + """RealTimeMonitoringGeoFencingApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringGeoFencingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_geofence_status(self): + """Test case for get_geofence_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_hardware_api.py b/test/test_real_time_monitoring_hardware_api.py new file mode 100644 index 0000000..ad78cbc --- /dev/null +++ b/test/test_real_time_monitoring_hardware_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_hardware_api import RealTimeMonitoringHardwareApi # noqa: E501 + + +class TestRealTimeMonitoringHardwareApi(unittest.TestCase): + """RealTimeMonitoringHardwareApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringHardwareApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_alarm_list(self): + """Test case for create_alarm_list + + """ + pass + + def test_create_environment_list(self): + """Test case for create_environment_list + + """ + pass + + def test_create_error_alarm_list(self): + """Test case for create_error_alarm_list + + """ + pass + + def test_create_inventory_list(self): + """Test case for create_inventory_list + + """ + pass + + def test_create_status_summary(self): + """Test case for create_status_summary + + """ + pass + + def test_create_synced_alarm_list(self): + """Test case for create_synced_alarm_list + + """ + pass + + def test_create_synced_environment_list(self): + """Test case for create_synced_environment_list + + """ + pass + + def test_create_synced_inventory_list(self): + """Test case for create_synced_inventory_list + + """ + pass + + def test_create_system_list(self): + """Test case for create_system_list + + """ + pass + + def test_create_temp_threshold_list(self): + """Test case for create_temp_threshold_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_i_psec_api.py b/test/test_real_time_monitoring_i_psec_api.py new file mode 100644 index 0000000..ae94053 --- /dev/null +++ b/test/test_real_time_monitoring_i_psec_api.py @@ -0,0 +1,101 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_i_psec_api import RealTimeMonitoringIPsecApi # noqa: E501 + + +class TestRealTimeMonitoringIPsecApi(unittest.TestCase): + """RealTimeMonitoringIPsecApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringIPsecApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_crypto_ipsec_identity(self): + """Test case for create_crypto_ipsec_identity + + """ + pass + + def test_create_cryptov1_local_sa_list(self): + """Test case for create_cryptov1_local_sa_list + + """ + pass + + def test_create_cryptov2_local_sa_list(self): + """Test case for create_cryptov2_local_sa_list + + """ + pass + + def test_create_i_psec_pwk_inbound_connections(self): + """Test case for create_i_psec_pwk_inbound_connections + + """ + pass + + def test_create_i_psec_pwk_local_sa(self): + """Test case for create_i_psec_pwk_local_sa + + """ + pass + + def test_create_i_psec_pwk_outbound_connections(self): + """Test case for create_i_psec_pwk_outbound_connections + + """ + pass + + def test_create_ike_inbound_list(self): + """Test case for create_ike_inbound_list + + """ + pass + + def test_create_ike_outbound_list(self): + """Test case for create_ike_outbound_list + + """ + pass + + def test_create_ike_sessions(self): + """Test case for create_ike_sessions + + """ + pass + + def test_create_in_bound_list(self): + """Test case for create_in_bound_list + + """ + pass + + def test_create_local_sa_list(self): + """Test case for create_local_sa_list + + """ + pass + + def test_create_out_bound_list(self): + """Test case for create_out_bound_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_igmp_api.py b/test/test_real_time_monitoring_igmp_api.py new file mode 100644 index 0000000..138c49d --- /dev/null +++ b/test/test_real_time_monitoring_igmp_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_igmp_api import RealTimeMonitoringIGMPApi # noqa: E501 + + +class TestRealTimeMonitoringIGMPApi(unittest.TestCase): + """RealTimeMonitoringIGMPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringIGMPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_igmp_groups_list(self): + """Test case for create_igmp_groups_list + + """ + pass + + def test_create_igmp_interface_list(self): + """Test case for create_igmp_interface_list + + """ + pass + + def test_create_igmp_statistics_list(self): + """Test case for create_igmp_statistics_list + + """ + pass + + def test_create_igmp_summary(self): + """Test case for create_igmp_summary + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_interface_api.py b/test/test_real_time_monitoring_interface_api.py new file mode 100644 index 0000000..eed3a45 --- /dev/null +++ b/test/test_real_time_monitoring_interface_api.py @@ -0,0 +1,107 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_interface_api import RealTimeMonitoringInterfaceApi # noqa: E501 + + +class TestRealTimeMonitoringInterfaceApi(unittest.TestCase): + """RealTimeMonitoringInterfaceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringInterfaceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_generate_device_interface_vpn(self): + """Test case for generate_device_interface_vpn + + """ + pass + + def test_get_device_interface(self): + """Test case for get_device_interface + + """ + pass + + def test_get_device_interface_arp_stats(self): + """Test case for get_device_interface_arp_stats + + """ + pass + + def test_get_device_interface_error_stats(self): + """Test case for get_device_interface_error_stats + + """ + pass + + def test_get_device_interface_ipv6_stats(self): + """Test case for get_device_interface_ipv6_stats + + """ + pass + + def test_get_device_interface_pkt_sizes(self): + """Test case for get_device_interface_pkt_sizes + + """ + pass + + def test_get_device_interface_port_stats(self): + """Test case for get_device_interface_port_stats + + """ + pass + + def test_get_device_interface_qos_stats(self): + """Test case for get_device_interface_qos_stats + + """ + pass + + def test_get_device_interface_queue_stats(self): + """Test case for get_device_interface_queue_stats + + """ + pass + + def test_get_device_interface_stats(self): + """Test case for get_device_interface_stats + + """ + pass + + def test_get_device_serial_interface(self): + """Test case for get_device_serial_interface + + """ + pass + + def test_get_synced_device_interface(self): + """Test case for get_synced_device_interface + + """ + pass + + def test_trustsec(self): + """Test case for trustsec + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ip_api.py b/test/test_real_time_monitoring_ip_api.py new file mode 100644 index 0000000..6ddea16 --- /dev/null +++ b/test/test_real_time_monitoring_ip_api.py @@ -0,0 +1,95 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ip_api import RealTimeMonitoringIPApi # noqa: E501 + + +class TestRealTimeMonitoringIPApi(unittest.TestCase): + """RealTimeMonitoringIPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringIPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_fib_list(self): + """Test case for create_fib_list + + """ + pass + + def test_create_ietf_routing_list(self): + """Test case for create_ietf_routing_list + + """ + pass + + def test_create_ip_mfib_oil_list(self): + """Test case for create_ip_mfib_oil_list + + """ + pass + + def test_create_ip_mfib_stats_list(self): + """Test case for create_ip_mfib_stats_list + + """ + pass + + def test_create_ip_mfib_summary_list(self): + """Test case for create_ip_mfib_summary_list + + """ + pass + + def test_create_nat64_translation_list(self): + """Test case for create_nat64_translation_list + + """ + pass + + def test_create_nat_filter_list(self): + """Test case for create_nat_filter_list + + """ + pass + + def test_create_nat_interface_list(self): + """Test case for create_nat_interface_list + + """ + pass + + def test_create_nat_interface_statistics_list(self): + """Test case for create_nat_interface_statistics_list + + """ + pass + + def test_create_nat_translation_list(self): + """Test case for create_nat_translation_list + + """ + pass + + def test_create_route_table_list(self): + """Test case for create_route_table_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ipv4_fib_api.py b/test/test_real_time_monitoring_ipv4_fib_api.py new file mode 100644 index 0000000..535d02f --- /dev/null +++ b/test/test_real_time_monitoring_ipv4_fib_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ipv4_fib_api import RealTimeMonitoringIPv4FIBApi # noqa: E501 + + +class TestRealTimeMonitoringIPv4FIBApi(unittest.TestCase): + """RealTimeMonitoringIPv4FIBApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringIPv4FIBApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_ipv4_fib_list(self): + """Test case for create_ipv4_fib_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ipv6_fib_api.py b/test/test_real_time_monitoring_ipv6_fib_api.py new file mode 100644 index 0000000..1631c87 --- /dev/null +++ b/test/test_real_time_monitoring_ipv6_fib_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ipv6_fib_api import RealTimeMonitoringIPv6FIBApi # noqa: E501 + + +class TestRealTimeMonitoringIPv6FIBApi(unittest.TestCase): + """RealTimeMonitoringIPv6FIBApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringIPv6FIBApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_ipv6_fib_list(self): + """Test case for create_ipv6_fib_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ipv6_neighbours_api.py b/test/test_real_time_monitoring_ipv6_neighbours_api.py new file mode 100644 index 0000000..505cd5a --- /dev/null +++ b/test/test_real_time_monitoring_ipv6_neighbours_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ipv6_neighbours_api import RealTimeMonitoringIPv6NeighboursApi # noqa: E501 + + +class TestRealTimeMonitoringIPv6NeighboursApi(unittest.TestCase): + """RealTimeMonitoringIPv6NeighboursApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringIPv6NeighboursApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_ipv6_interface(self): + """Test case for get_ipv6_interface + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_license_info_api.py b/test/test_real_time_monitoring_license_info_api.py new file mode 100644 index 0000000..1cc602a --- /dev/null +++ b/test/test_real_time_monitoring_license_info_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_license_info_api import RealTimeMonitoringLicenseInfoApi # noqa: E501 + + +class TestRealTimeMonitoringLicenseInfoApi(unittest.TestCase): + """RealTimeMonitoringLicenseInfoApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringLicenseInfoApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_license_eval_info(self): + """Test case for get_license_eval_info + + """ + pass + + def test_get_license_pak_info(self): + """Test case for get_license_pak_info + + """ + pass + + def test_get_license_privacy_info(self): + """Test case for get_license_privacy_info + + """ + pass + + def test_get_license_reg_info(self): + """Test case for get_license_reg_info + + """ + pass + + def test_get_license_udi_info(self): + """Test case for get_license_udi_info + + """ + pass + + def test_get_license_usage_info(self): + """Test case for get_license_usage_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_multicast_api.py b/test/test_real_time_monitoring_multicast_api.py new file mode 100644 index 0000000..d1daa93 --- /dev/null +++ b/test/test_real_time_monitoring_multicast_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_multicast_api import RealTimeMonitoringMulticastApi # noqa: E501 + + +class TestRealTimeMonitoringMulticastApi(unittest.TestCase): + """RealTimeMonitoringMulticastApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringMulticastApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_pim_tunnel_list(self): + """Test case for create_pim_tunnel_list + + """ + pass + + def test_create_replicator_list(self): + """Test case for create_replicator_list + + """ + pass + + def test_create_rpf_list(self): + """Test case for create_rpf_list + + """ + pass + + def test_create_topology_list(self): + """Test case for create_topology_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_network_hub_resources_api.py b/test/test_real_time_monitoring_network_hub_resources_api.py new file mode 100644 index 0000000..e314407 --- /dev/null +++ b/test/test_real_time_monitoring_network_hub_resources_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_network_hub_resources_api import RealTimeMonitoringNetworkHubResourcesApi # noqa: E501 + + +class TestRealTimeMonitoringNetworkHubResourcesApi(unittest.TestCase): + """RealTimeMonitoringNetworkHubResourcesApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringNetworkHubResourcesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_allocation_info(self): + """Test case for get_allocation_info + + """ + pass + + def test_get_cpu_info(self): + """Test case for get_cpu_info + + """ + pass + + def test_get_vnf_info(self): + """Test case for get_vnf_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_nms_api.py b/test/test_real_time_monitoring_nms_api.py new file mode 100644 index 0000000..8aef869 --- /dev/null +++ b/test/test_real_time_monitoring_nms_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_nms_api import RealTimeMonitoringNMSApi # noqa: E501 + + +class TestRealTimeMonitoringNMSApi(unittest.TestCase): + """RealTimeMonitoringNMSApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringNMSApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_running(self): + """Test case for get_running + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ntp_api.py b/test/test_real_time_monitoring_ntp_api.py new file mode 100644 index 0000000..f4e35bf --- /dev/null +++ b/test/test_real_time_monitoring_ntp_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ntp_api import RealTimeMonitoringNTPApi # noqa: E501 + + +class TestRealTimeMonitoringNTPApi(unittest.TestCase): + """RealTimeMonitoringNTPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringNTPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_associations_list(self): + """Test case for create_associations_list + + """ + pass + + def test_create_ntp_status_list(self): + """Test case for create_ntp_status_list + + """ + pass + + def test_create_peer_list(self): + """Test case for create_peer_list + + """ + pass + + def test_create_te_list(self): + """Test case for create_te_list + + """ + pass + + def test_create_utd_list(self): + """Test case for create_utd_list + + """ + pass + + def test_create_waas_list(self): + """Test case for create_waas_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_omp_api.py b/test/test_real_time_monitoring_omp_api.py new file mode 100644 index 0000000..535b565 --- /dev/null +++ b/test/test_real_time_monitoring_omp_api.py @@ -0,0 +1,131 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_omp_api import RealTimeMonitoringOMPApi # noqa: E501 + + +class TestRealTimeMonitoringOMPApi(unittest.TestCase): + """RealTimeMonitoringOMPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringOMPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_advertised_routes_list(self): + """Test case for create_advertised_routes_list + + """ + pass + + def test_create_advertised_routes_list_ipv6(self): + """Test case for create_advertised_routes_list_ipv6 + + """ + pass + + def test_create_advertised_tlocs_list(self): + """Test case for create_advertised_tlocs_list + + """ + pass + + def test_create_omp_cloud_x_recv(self): + """Test case for create_omp_cloud_x_recv + + """ + pass + + def test_create_omp_link_list(self): + """Test case for create_omp_link_list + + """ + pass + + def test_create_omp_mcast_auto_discover_advt(self): + """Test case for create_omp_mcast_auto_discover_advt + + """ + pass + + def test_create_omp_mcast_auto_discover_recv(self): + """Test case for create_omp_mcast_auto_discover_recv + + """ + pass + + def test_create_omp_mcast_routes_advt(self): + """Test case for create_omp_mcast_routes_advt + + """ + pass + + def test_create_omp_mcast_routes_recv(self): + """Test case for create_omp_mcast_routes_recv + + """ + pass + + def test_create_omp_services(self): + """Test case for create_omp_services + + """ + pass + + def test_create_omp_session_list(self): + """Test case for create_omp_session_list + + """ + pass + + def test_create_omp_summary(self): + """Test case for create_omp_summary + + """ + pass + + def test_create_received_routes_list(self): + """Test case for create_received_routes_list + + """ + pass + + def test_create_received_routes_list_ipv6(self): + """Test case for create_received_routes_list_ipv6 + + """ + pass + + def test_create_received_tlocs_list(self): + """Test case for create_received_tlocs_list + + """ + pass + + def test_create_synced_omp_session_list(self): + """Test case for create_synced_omp_session_list + + """ + pass + + def test_get_device_omp_status(self): + """Test case for get_device_omp_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_orchestrator_api.py b/test/test_real_time_monitoring_orchestrator_api.py new file mode 100644 index 0000000..eb32234 --- /dev/null +++ b/test/test_real_time_monitoring_orchestrator_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_orchestrator_api import RealTimeMonitoringOrchestratorApi # noqa: E501 + + +class TestRealTimeMonitoringOrchestratorApi(unittest.TestCase): + """RealTimeMonitoringOrchestratorApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringOrchestratorApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_connection_history_list(self): + """Test case for create_connection_history_list + + """ + pass + + def test_create_connection_list_from_device(self): + """Test case for create_connection_list_from_device + + """ + pass + + def test_create_connection_summary(self): + """Test case for create_connection_summary + + """ + pass + + def test_create_local_properties_list_list(self): + """Test case for create_local_properties_list_list + + """ + pass + + def test_create_reverse_proxy_mapping_list(self): + """Test case for create_reverse_proxy_mapping_list + + """ + pass + + def test_create_valid_devices_list(self): + """Test case for create_valid_devices_list + + """ + pass + + def test_create_valid_v_smarts_list(self): + """Test case for create_valid_v_smarts_list + + """ + pass + + def test_get_statistics(self): + """Test case for get_statistics + + """ + pass + + def test_get_valid_v_manage_id(self): + """Test case for get_valid_v_manage_id + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ospf_api.py b/test/test_real_time_monitoring_ospf_api.py new file mode 100644 index 0000000..636eead --- /dev/null +++ b/test/test_real_time_monitoring_ospf_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ospf_api import RealTimeMonitoringOSPFApi # noqa: E501 + + +class TestRealTimeMonitoringOSPFApi(unittest.TestCase): + """RealTimeMonitoringOSPFApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringOSPFApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_ospf_database_external(self): + """Test case for create_ospf_database_external + + """ + pass + + def test_create_ospf_database_list(self): + """Test case for create_ospf_database_list + + """ + pass + + def test_create_ospf_database_summary_list(self): + """Test case for create_ospf_database_summary_list + + """ + pass + + def test_create_ospf_interface(self): + """Test case for create_ospf_interface + + """ + pass + + def test_create_ospf_neighbors(self): + """Test case for create_ospf_neighbors + + """ + pass + + def test_create_ospf_process(self): + """Test case for create_ospf_process + + """ + pass + + def test_create_ospf_routes_list(self): + """Test case for create_ospf_routes_list + + """ + pass + + def test_create_ospfv3_interface(self): + """Test case for create_ospfv3_interface + + """ + pass + + def test_create_ospfv3_neighbors(self): + """Test case for create_ospfv3_neighbors + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_pim_api.py b/test/test_real_time_monitoring_pim_api.py new file mode 100644 index 0000000..b461768 --- /dev/null +++ b/test/test_real_time_monitoring_pim_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_pim_api import RealTimeMonitoringPIMApi # noqa: E501 + + +class TestRealTimeMonitoringPIMApi(unittest.TestCase): + """RealTimeMonitoringPIMApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringPIMApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_pim_interface_list(self): + """Test case for create_pim_interface_list + + """ + pass + + def test_create_pim_neighbor_list(self): + """Test case for create_pim_neighbor_list + + """ + pass + + def test_create_pim_statistics_list(self): + """Test case for create_pim_statistics_list + + """ + pass + + def test_create_pimrp_mapping_list(self): + """Test case for create_pimrp_mapping_list + + """ + pass + + def test_create_ppp_interface_list(self): + """Test case for create_ppp_interface_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_policer_api.py b/test/test_real_time_monitoring_policer_api.py new file mode 100644 index 0000000..7050214 --- /dev/null +++ b/test/test_real_time_monitoring_policer_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_policer_api import RealTimeMonitoringPolicerApi # noqa: E501 + + +class TestRealTimeMonitoringPolicerApi(unittest.TestCase): + """RealTimeMonitoringPolicerApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringPolicerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_policed_interface(self): + """Test case for get_policed_interface + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_policy_api.py b/test/test_real_time_monitoring_policy_api.py new file mode 100644 index 0000000..787c29b --- /dev/null +++ b/test/test_real_time_monitoring_policy_api.py @@ -0,0 +1,173 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_policy_api import RealTimeMonitoringPolicyApi # noqa: E501 + + +class TestRealTimeMonitoringPolicyApi(unittest.TestCase): + """RealTimeMonitoringPolicyApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringPolicyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_polic_data_policy_filter(self): + """Test case for create_polic_data_policy_filter + + """ + pass + + def test_create_polic_qos_map_info(self): + """Test case for create_polic_qos_map_info + + """ + pass + + def test_create_polic_qos_scheduler_info(self): + """Test case for create_polic_qos_scheduler_info + + """ + pass + + def test_create_policy_access_list_associations(self): + """Test case for create_policy_access_list_associations + + """ + pass + + def test_create_policy_access_list_associations_ipv6(self): + """Test case for create_policy_access_list_associations_ipv6 + + """ + pass + + def test_create_policy_access_list_counters(self): + """Test case for create_policy_access_list_counters + + """ + pass + + def test_create_policy_access_list_counters_ipv6(self): + """Test case for create_policy_access_list_counters_ipv6 + + """ + pass + + def test_create_policy_access_list_names(self): + """Test case for create_policy_access_list_names + + """ + pass + + def test_create_policy_access_list_names_ipv6(self): + """Test case for create_policy_access_list_names_ipv6 + + """ + pass + + def test_create_policy_access_list_policers(self): + """Test case for create_policy_access_list_policers + + """ + pass + + def test_create_policy_access_list_policers_ipv6(self): + """Test case for create_policy_access_list_policers_ipv6 + + """ + pass + + def test_create_policy_app_route_policy_filter(self): + """Test case for create_policy_app_route_policy_filter + + """ + pass + + def test_create_policy_filter_memory_usage(self): + """Test case for create_policy_filter_memory_usage + + """ + pass + + def test_create_policy_rewrite_associations_info(self): + """Test case for create_policy_rewrite_associations_info + + """ + pass + + def test_get_zbfw_statistics(self): + """Test case for get_zbfw_statistics + + """ + pass + + def test_get_zone_drop_statistics(self): + """Test case for get_zone_drop_statistics + + """ + pass + + def test_get_zone_pair_sessions(self): + """Test case for get_zone_pair_sessions + + """ + pass + + def test_get_zone_pairs(self): + """Test case for get_zone_pairs + + """ + pass + + def test_get_zone_policy_filters(self): + """Test case for get_zone_policy_filters + + """ + pass + + def test_show_sdwan_policy_from_vsmart(self): + """Test case for show_sdwan_policy_from_vsmart + + """ + pass + + def test_show_vsmart_ipto_user_binding(self): + """Test case for show_vsmart_ipto_user_binding + + """ + pass + + def test_show_vsmart_px_grid_status(self): + """Test case for show_vsmart_px_grid_status + + """ + pass + + def test_show_vsmart_px_grid_user_sessions(self): + """Test case for show_vsmart_px_grid_user_sessions + + """ + pass + + def test_show_vsmart_user_usergroup_bindings(self): + """Test case for show_vsmart_user_usergroup_bindings + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_pppo_e_api.py b/test/test_real_time_monitoring_pppo_e_api.py new file mode 100644 index 0000000..6860e46 --- /dev/null +++ b/test/test_real_time_monitoring_pppo_e_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_pppo_e_api import RealTimeMonitoringPPPoEApi # noqa: E501 + + +class TestRealTimeMonitoringPPPoEApi(unittest.TestCase): + """RealTimeMonitoringPPPoEApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringPPPoEApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_pppo_e_interface_list(self): + """Test case for create_pppo_e_interface_list + + """ + pass + + def test_create_pppo_e_neighbor_list(self): + """Test case for create_pppo_e_neighbor_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_rbac_api.py b/test/test_real_time_monitoring_rbac_api.py new file mode 100644 index 0000000..9cdfff8 --- /dev/null +++ b/test/test_real_time_monitoring_rbac_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_rbac_api import RealTimeMonitoringRBACApi # noqa: E501 + + +class TestRealTimeMonitoringRBACApi(unittest.TestCase): + """RealTimeMonitoringRBACApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringRBACApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_pnic_stats(self): + """Test case for get_pnic_stats + + """ + pass + + def test_get_pnic_stats_from_device(self): + """Test case for get_pnic_stats_from_device + + """ + pass + + def test_get_rbac_interface(self): + """Test case for get_rbac_interface + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_reboot_history_api.py b/test/test_real_time_monitoring_reboot_history_api.py new file mode 100644 index 0000000..bc50939 --- /dev/null +++ b/test/test_real_time_monitoring_reboot_history_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_reboot_history_api import RealTimeMonitoringRebootHistoryApi # noqa: E501 + + +class TestRealTimeMonitoringRebootHistoryApi(unittest.TestCase): + """RealTimeMonitoringRebootHistoryApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringRebootHistoryApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_reboot_history_list(self): + """Test case for create_reboot_history_list + + """ + pass + + def test_create_synced_reboot_history_list(self): + """Test case for create_synced_reboot_history_list + + """ + pass + + def test_get_reboot_history_details(self): + """Test case for get_reboot_history_details + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_sdwan_statistics_api.py b/test/test_real_time_monitoring_sdwan_statistics_api.py new file mode 100644 index 0000000..77d10ab --- /dev/null +++ b/test/test_real_time_monitoring_sdwan_statistics_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_sdwan_statistics_api import RealTimeMonitoringSDWANStatisticsApi # noqa: E501 + + +class TestRealTimeMonitoringSDWANStatisticsApi(unittest.TestCase): + """RealTimeMonitoringSDWANStatisticsApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSDWANStatisticsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_sd_wan_global_drop_statistics(self): + """Test case for get_sd_wan_global_drop_statistics + + """ + pass + + def test_get_sd_wan_stats(self): + """Test case for get_sd_wan_stats + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_security_api.py b/test/test_real_time_monitoring_security_api.py new file mode 100644 index 0000000..bc8a053 --- /dev/null +++ b/test/test_real_time_monitoring_security_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_security_api import RealTimeMonitoringSecurityApi # noqa: E501 + + +class TestRealTimeMonitoringSecurityApi(unittest.TestCase): + """RealTimeMonitoringSecurityApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSecurityApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_session_list(self): + """Test case for create_session_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_sfp_api.py b/test/test_real_time_monitoring_sfp_api.py new file mode 100644 index 0000000..29be188 --- /dev/null +++ b/test/test_real_time_monitoring_sfp_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_sfp_api import RealTimeMonitoringSFPApi # noqa: E501 + + +class TestRealTimeMonitoringSFPApi(unittest.TestCase): + """RealTimeMonitoringSFPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSFPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_detail(self): + """Test case for get_detail + + """ + pass + + def test_get_diagnostic(self): + """Test case for get_diagnostic + + """ + pass + + def test_get_diagnostic_measurement_alarm(self): + """Test case for get_diagnostic_measurement_alarm + + """ + pass + + def test_get_diagnostic_measurement_value(self): + """Test case for get_diagnostic_measurement_value + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_show_on_demand_local_api.py b/test/test_real_time_monitoring_show_on_demand_local_api.py new file mode 100644 index 0000000..3af58ee --- /dev/null +++ b/test/test_real_time_monitoring_show_on_demand_local_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_show_on_demand_local_api import RealTimeMonitoringShowOnDemandLocalApi # noqa: E501 + + +class TestRealTimeMonitoringShowOnDemandLocalApi(unittest.TestCase): + """RealTimeMonitoringShowOnDemandLocalApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringShowOnDemandLocalApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_on_demand_local(self): + """Test case for get_on_demand_local + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_show_on_demand_remote_api.py b/test/test_real_time_monitoring_show_on_demand_remote_api.py new file mode 100644 index 0000000..b602398 --- /dev/null +++ b/test/test_real_time_monitoring_show_on_demand_remote_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_show_on_demand_remote_api import RealTimeMonitoringShowOnDemandRemoteApi # noqa: E501 + + +class TestRealTimeMonitoringShowOnDemandRemoteApi(unittest.TestCase): + """RealTimeMonitoringShowOnDemandRemoteApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringShowOnDemandRemoteApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_on_demand_remote(self): + """Test case for get_on_demand_remote + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_sig_api.py b/test/test_real_time_monitoring_sig_api.py new file mode 100644 index 0000000..c98f449 --- /dev/null +++ b/test/test_real_time_monitoring_sig_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_sig_api import RealTimeMonitoringSIGApi # noqa: E501 + + +class TestRealTimeMonitoringSIGApi(unittest.TestCase): + """RealTimeMonitoringSIGApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSIGApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_sig_tunnel_list(self): + """Test case for get_sig_tunnel_list + + """ + pass + + def test_get_sig_tunnel_total(self): + """Test case for get_sig_tunnel_total + + """ + pass + + def test_get_sig_umbrella_tunnels(self): + """Test case for get_sig_umbrella_tunnels + + """ + pass + + def test_get_sig_zscaler_tunnels(self): + """Test case for get_sig_zscaler_tunnels + + """ + pass + + def test_tunnel_dashboard(self): + """Test case for tunnel_dashboard + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_software_api.py b/test/test_real_time_monitoring_software_api.py new file mode 100644 index 0000000..dca8a48 --- /dev/null +++ b/test/test_real_time_monitoring_software_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_software_api import RealTimeMonitoringSoftwareApi # noqa: E501 + + +class TestRealTimeMonitoringSoftwareApi(unittest.TestCase): + """RealTimeMonitoringSoftwareApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSoftwareApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_smu_list(self): + """Test case for create_smu_list + + """ + pass + + def test_create_synced_smu_list(self): + """Test case for create_synced_smu_list + + """ + pass + + def test_create_synced_software_list(self): + """Test case for create_synced_software_list + + """ + pass + + def test_get_aaa_ucreate_software_listsers(self): + """Test case for get_aaa_ucreate_software_listsers + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_sslproxy_api.py b/test/test_real_time_monitoring_sslproxy_api.py new file mode 100644 index 0000000..cffd92a --- /dev/null +++ b/test/test_real_time_monitoring_sslproxy_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_sslproxy_api import RealTimeMonitoringSslproxyApi # noqa: E501 + + +class TestRealTimeMonitoringSslproxyApi(unittest.TestCase): + """RealTimeMonitoringSslproxyApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSslproxyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_ssl_proxy_statistics(self): + """Test case for get_ssl_proxy_statistics + + """ + pass + + def test_get_ssl_proxy_status(self): + """Test case for get_ssl_proxy_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_static_route_tracker_service_api.py b/test/test_real_time_monitoring_static_route_tracker_service_api.py new file mode 100644 index 0000000..4e4e94b --- /dev/null +++ b/test/test_real_time_monitoring_static_route_tracker_service_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_static_route_tracker_service_api import RealTimeMonitoringStaticRouteTrackerServiceApi # noqa: E501 + + +class TestRealTimeMonitoringStaticRouteTrackerServiceApi(unittest.TestCase): + """RealTimeMonitoringStaticRouteTrackerServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringStaticRouteTrackerServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_static_route_tracker_info(self): + """Test case for get_static_route_tracker_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_system_api.py b/test/test_real_time_monitoring_system_api.py new file mode 100644 index 0000000..9d1432d --- /dev/null +++ b/test/test_real_time_monitoring_system_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_system_api import RealTimeMonitoringSystemApi # noqa: E501 + + +class TestRealTimeMonitoringSystemApi(unittest.TestCase): + """RealTimeMonitoringSystemApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringSystemApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_device_info_list(self): + """Test case for create_device_info_list + + """ + pass + + def test_create_device_system_process_list(self): + """Test case for create_device_system_process_list + + """ + pass + + def test_create_device_system_setting(self): + """Test case for create_device_system_setting + + """ + pass + + def test_create_device_system_setting_native_info(self): + """Test case for create_device_system_setting_native_info + + """ + pass + + def test_create_device_system_stats_list(self): + """Test case for create_device_system_stats_list + + """ + pass + + def test_create_device_system_status(self): + """Test case for create_device_system_status + + """ + pass + + def test_create_device_system_status_list(self): + """Test case for create_device_system_status_list + + """ + pass + + def test_create_synced_device_system_status_list(self): + """Test case for create_synced_device_system_status_list + + """ + pass + + def test_get_device_system_clock(self): + """Test case for get_device_system_clock + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_tcp_optimization_api.py b/test/test_real_time_monitoring_tcp_optimization_api.py new file mode 100644 index 0000000..d072def --- /dev/null +++ b/test/test_real_time_monitoring_tcp_optimization_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_tcp_optimization_api import RealTimeMonitoringTCPOptimizationApi # noqa: E501 + + +class TestRealTimeMonitoringTCPOptimizationApi(unittest.TestCase): + """RealTimeMonitoringTCPOptimizationApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringTCPOptimizationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_active_tcp_flows(self): + """Test case for get_active_tcp_flows + + """ + pass + + def test_get_expired_tcp_flows(self): + """Test case for get_expired_tcp_flows + + """ + pass + + def test_get_tcp_summary(self): + """Test case for get_tcp_summary + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_tcpproxy_api.py b/test/test_real_time_monitoring_tcpproxy_api.py new file mode 100644 index 0000000..ac9c654 --- /dev/null +++ b/test/test_real_time_monitoring_tcpproxy_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_tcpproxy_api import RealTimeMonitoringTcpproxyApi # noqa: E501 + + +class TestRealTimeMonitoringTcpproxyApi(unittest.TestCase): + """RealTimeMonitoringTcpproxyApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringTcpproxyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_tcp_proxy_statistics(self): + """Test case for get_tcp_proxy_statistics + + """ + pass + + def test_get_tcp_proxy_status(self): + """Test case for get_tcp_proxy_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_tools_api.py b/test/test_real_time_monitoring_tools_api.py new file mode 100644 index 0000000..2289399 --- /dev/null +++ b/test/test_real_time_monitoring_tools_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_tools_api import RealTimeMonitoringToolsApi # noqa: E501 + + +class TestRealTimeMonitoringToolsApi(unittest.TestCase): + """RealTimeMonitoringToolsApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringToolsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_device_tools_n_slookup(self): + """Test case for get_device_tools_n_slookup + + """ + pass + + def test_get_device_tools_netstat(self): + """Test case for get_device_tools_netstat + + """ + pass + + def test_get_device_tools_ss(self): + """Test case for get_device_tools_ss + + """ + pass + + def test_get_real_timeinfo(self): + """Test case for get_real_timeinfo + + """ + pass + + def test_get_system_netfilter(self): + """Test case for get_system_netfilter + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_transport_api.py b/test/test_real_time_monitoring_transport_api.py new file mode 100644 index 0000000..b78ef77 --- /dev/null +++ b/test/test_real_time_monitoring_transport_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_transport_api import RealTimeMonitoringTransportApi # noqa: E501 + + +class TestRealTimeMonitoringTransportApi(unittest.TestCase): + """RealTimeMonitoringTransportApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringTransportApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_transport_connection_list(self): + """Test case for create_transport_connection_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_trustsec_api.py b/test/test_real_time_monitoring_trustsec_api.py new file mode 100644 index 0000000..2ef91a7 --- /dev/null +++ b/test/test_real_time_monitoring_trustsec_api.py @@ -0,0 +1,83 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_trustsec_api import RealTimeMonitoringTrustsecApi # noqa: E501 + + +class TestRealTimeMonitoringTrustsecApi(unittest.TestCase): + """RealTimeMonitoringTrustsecApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringTrustsecApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_cts_pac(self): + """Test case for get_cts_pac + + """ + pass + + def test_get_environment_data(self): + """Test case for get_environment_data + + """ + pass + + def test_get_radius_server(self): + """Test case for get_radius_server + + """ + pass + + def test_get_role_based_counters(self): + """Test case for get_role_based_counters + + """ + pass + + def test_get_role_based_ipv6_counters(self): + """Test case for get_role_based_ipv6_counters + + """ + pass + + def test_get_role_based_ipv6_permissions(self): + """Test case for get_role_based_ipv6_permissions + + """ + pass + + def test_get_role_based_permissions(self): + """Test case for get_role_based_permissions + + """ + pass + + def test_get_role_based_sgt_map(self): + """Test case for get_role_based_sgt_map + + """ + pass + + def test_get_sxp_connections(self): + """Test case for get_sxp_connections + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_tunnel_api.py b/test/test_real_time_monitoring_tunnel_api.py new file mode 100644 index 0000000..84fdc44 --- /dev/null +++ b/test/test_real_time_monitoring_tunnel_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_tunnel_api import RealTimeMonitoringTunnelApi # noqa: E501 + + +class TestRealTimeMonitoringTunnelApi(unittest.TestCase): + """RealTimeMonitoringTunnelApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringTunnelApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_bfd_statistics_list(self): + """Test case for create_bfd_statistics_list + + """ + pass + + def test_create_fec_statistics(self): + """Test case for create_fec_statistics + + """ + pass + + def test_create_gre_keepalives_list(self): + """Test case for create_gre_keepalives_list + + """ + pass + + def test_create_ipsec_statistics_list(self): + """Test case for create_ipsec_statistics_list + + """ + pass + + def test_create_packet_duplicate_statistics(self): + """Test case for create_packet_duplicate_statistics + + """ + pass + + def test_create_statistics_list(self): + """Test case for create_statistics_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_ucse_api.py b/test/test_real_time_monitoring_ucse_api.py new file mode 100644 index 0000000..9afcb24 --- /dev/null +++ b/test/test_real_time_monitoring_ucse_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_ucse_api import RealTimeMonitoringUcseApi # noqa: E501 + + +class TestRealTimeMonitoringUcseApi(unittest.TestCase): + """RealTimeMonitoringUcseApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringUcseApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_ucse_stats(self): + """Test case for create_ucse_stats + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_umbrella_api.py b/test/test_real_time_monitoring_umbrella_api.py new file mode 100644 index 0000000..ec1f9b4 --- /dev/null +++ b/test/test_real_time_monitoring_umbrella_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_umbrella_api import RealTimeMonitoringUmbrellaApi # noqa: E501 + + +class TestRealTimeMonitoringUmbrellaApi(unittest.TestCase): + """RealTimeMonitoringUmbrellaApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringUmbrellaApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_umbrella_config(self): + """Test case for get_umbrella_config + + """ + pass + + def test_get_umbrella_dev_reg(self): + """Test case for get_umbrella_dev_reg + + """ + pass + + def test_get_umbrella_dns_crypt(self): + """Test case for get_umbrella_dns_crypt + + """ + pass + + def test_get_umbrella_dp_stats(self): + """Test case for get_umbrella_dp_stats + + """ + pass + + def test_get_umbrella_overview(self): + """Test case for get_umbrella_overview + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_utd_api.py b/test/test_real_time_monitoring_utd_api.py new file mode 100644 index 0000000..8abab34 --- /dev/null +++ b/test/test_real_time_monitoring_utd_api.py @@ -0,0 +1,107 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_utd_api import RealTimeMonitoringUTDApi # noqa: E501 + + +class TestRealTimeMonitoringUTDApi(unittest.TestCase): + """RealTimeMonitoringUTDApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringUTDApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_signature_version_info(self): + """Test case for get_signature_version_info + + """ + pass + + def test_get_utd_dataplane_config(self): + """Test case for get_utd_dataplane_config + + """ + pass + + def test_get_utd_dataplane_global(self): + """Test case for get_utd_dataplane_global + + """ + pass + + def test_get_utd_dataplane_stats(self): + """Test case for get_utd_dataplane_stats + + """ + pass + + def test_get_utd_dataplane_stats_summary(self): + """Test case for get_utd_dataplane_stats_summary + + """ + pass + + def test_get_utd_engine_instance_status(self): + """Test case for get_utd_engine_instance_status + + """ + pass + + def test_get_utd_engine_status(self): + """Test case for get_utd_engine_status + + """ + pass + + def test_get_utd_file_analysis_status(self): + """Test case for get_utd_file_analysis_status + + """ + pass + + def test_get_utd_file_reputation_status(self): + """Test case for get_utd_file_reputation_status + + """ + pass + + def test_get_utd_ips_update_status(self): + """Test case for get_utd_ips_update_status + + """ + pass + + def test_get_utd_urlf_connection_status(self): + """Test case for get_utd_urlf_connection_status + + """ + pass + + def test_get_utd_urlf_update_status(self): + """Test case for get_utd_urlf_update_status + + """ + pass + + def test_get_utd_version_status(self): + """Test case for get_utd_version_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_vdsl_service_api.py b/test/test_real_time_monitoring_vdsl_service_api.py new file mode 100644 index 0000000..e7796c2 --- /dev/null +++ b/test/test_real_time_monitoring_vdsl_service_api.py @@ -0,0 +1,71 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_vdsl_service_api import RealTimeMonitoringVDSLServiceApi # noqa: E501 + + +class TestRealTimeMonitoringVDSLServiceApi(unittest.TestCase): + """RealTimeMonitoringVDSLServiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringVDSLServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_co_line_specific_stats(self): + """Test case for get_co_line_specific_stats + + """ + pass + + def test_get_co_stats(self): + """Test case for get_co_stats + + """ + pass + + def test_get_cpe_line_specific_stats(self): + """Test case for get_cpe_line_specific_stats + + """ + pass + + def test_get_cpe_stats(self): + """Test case for get_cpe_stats + + """ + pass + + def test_get_line_bonding_stats(self): + """Test case for get_line_bonding_stats + + """ + pass + + def test_get_line_specific_stats(self): + """Test case for get_line_specific_stats + + """ + pass + + def test_get_vdsl_info(self): + """Test case for get_vdsl_info + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_vm_api.py b/test/test_real_time_monitoring_vm_api.py new file mode 100644 index 0000000..474f51c --- /dev/null +++ b/test/test_real_time_monitoring_vm_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_vm_api import RealTimeMonitoringVMApi # noqa: E501 + + +class TestRealTimeMonitoringVMApi(unittest.TestCase): + """RealTimeMonitoringVMApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringVMApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_cloud_dock_vm_lifecycle_nics(self): + """Test case for get_cloud_dock_vm_lifecycle_nics + + """ + pass + + def test_get_vbranch_vm_lifecycle(self): + """Test case for get_vbranch_vm_lifecycle + + """ + pass + + def test_get_vbranch_vm_lifecycle_nics(self): + """Test case for get_vbranch_vm_lifecycle_nics + + """ + pass + + def test_get_vm_life_cycle_state(self): + """Test case for get_vm_life_cycle_state + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_voice_api.py b/test/test_real_time_monitoring_voice_api.py new file mode 100644 index 0000000..99a015c --- /dev/null +++ b/test/test_real_time_monitoring_voice_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_voice_api import RealTimeMonitoringVoiceApi # noqa: E501 + + +class TestRealTimeMonitoringVoiceApi(unittest.TestCase): + """RealTimeMonitoringVoiceApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringVoiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_controller_t1e1_info_current15_min_stats(self): + """Test case for get_controller_t1e1_info_current15_min_stats + + """ + pass + + def test_get_controller_t1e1_info_total_stats(self): + """Test case for get_controller_t1e1_info_total_stats + + """ + pass + + def test_get_dsp_active(self): + """Test case for get_dsp_active + + """ + pass + + def test_get_dsp_farm_profiles(self): + """Test case for get_dsp_farm_profiles + + """ + pass + + def test_get_phone_info(self): + """Test case for get_phone_info + + """ + pass + + def test_get_sccp_ccm_groups(self): + """Test case for get_sccp_ccm_groups + + """ + pass + + def test_get_sccp_connections(self): + """Test case for get_sccp_connections + + """ + pass + + def test_get_t1e1_isdn_status(self): + """Test case for get_t1e1_isdn_status + + """ + pass + + def test_get_voice_calls(self): + """Test case for get_voice_calls + + """ + pass + + def test_get_voip_calls(self): + """Test case for get_voip_calls + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_vpn_api.py b/test/test_real_time_monitoring_vpn_api.py new file mode 100644 index 0000000..0fa8709 --- /dev/null +++ b/test/test_real_time_monitoring_vpn_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_vpn_api import RealTimeMonitoringVPNApi # noqa: E501 + + +class TestRealTimeMonitoringVPNApi(unittest.TestCase): + """RealTimeMonitoringVPNApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringVPNApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_vpn_instances(self): + """Test case for get_vpn_instances + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_vrrp_api.py b/test/test_real_time_monitoring_vrrp_api.py new file mode 100644 index 0000000..38169f9 --- /dev/null +++ b/test/test_real_time_monitoring_vrrp_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_vrrp_api import RealTimeMonitoringVRRPApi # noqa: E501 + + +class TestRealTimeMonitoringVRRPApi(unittest.TestCase): + """RealTimeMonitoringVRRPApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringVRRPApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_vrrp_interface(self): + """Test case for get_vrrp_interface + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_wireless_api.py b/test/test_real_time_monitoring_wireless_api.py new file mode 100644 index 0000000..812deb7 --- /dev/null +++ b/test/test_real_time_monitoring_wireless_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_wireless_api import RealTimeMonitoringWirelessApi # noqa: E501 + + +class TestRealTimeMonitoringWirelessApi(unittest.TestCase): + """RealTimeMonitoringWirelessApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringWirelessApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_wireless_clients(self): + """Test case for get_wireless_clients + + """ + pass + + def test_get_wireless_radios(self): + """Test case for get_wireless_radios + + """ + pass + + def test_get_wireless_ssid(self): + """Test case for get_wireless_ssid + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_real_time_monitoring_wlan_api.py b/test/test_real_time_monitoring_wlan_api.py new file mode 100644 index 0000000..3be2a2b --- /dev/null +++ b/test/test_real_time_monitoring_wlan_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.real_time_monitoring_wlan_api import RealTimeMonitoringWLANApi # noqa: E501 + + +class TestRealTimeMonitoringWLANApi(unittest.TestCase): + """RealTimeMonitoringWLANApi unit test stubs""" + + def setUp(self): + self.api = RealTimeMonitoringWLANApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_wlan_clients(self): + """Test case for get_wlan_clients + + """ + pass + + def test_get_wlan_interfaces(self): + """Test case for get_wlan_interfaces + + """ + pass + + def test_get_wlan_radios(self): + """Test case for get_wlan_radios + + """ + pass + + def test_get_wlan_radius(self): + """Test case for get_wlan_radius + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_resource_group.py b/test/test_resource_group.py new file mode 100644 index 0000000..15a2588 --- /dev/null +++ b/test/test_resource_group.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.resource_group import ResourceGroup + + +class TestResourceGroup(unittest.TestCase): + """ResourceGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testResourceGroup(self): + """Test ResourceGroup""" + # FIXME: construct object with mandatory attributes with example values + # model = ResourceGroup() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_resource_pool_api.py b/test/test_resource_pool_api.py new file mode 100644 index 0000000..6682b9c --- /dev/null +++ b/test/test_resource_pool_api.py @@ -0,0 +1,47 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.resource_pool_api import ResourcePoolApi # noqa: E501 + + +class TestResourcePoolApi(unittest.TestCase): + """ResourcePoolApi unit test stubs""" + + def setUp(self): + self.api = ResourcePoolApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_resources(self): + """Test case for create_resources + + """ + pass + + def test_delete_resources(self): + """Test case for delete_resources + + """ + pass + + def test_get_resources(self): + """Test case for get_resources + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scheduled_backup_restore_api.py b/test/test_scheduled_backup_restore_api.py new file mode 100644 index 0000000..33f9bdf --- /dev/null +++ b/test/test_scheduled_backup_restore_api.py @@ -0,0 +1,95 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.scheduled_backup_restore_api import ScheduledBackupRestoreApi # noqa: E501 + + +class TestScheduledBackupRestoreApi(unittest.TestCase): + """ScheduledBackupRestoreApi unit test stubs""" + + def setUp(self): + self.api = ScheduledBackupRestoreApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_schduled_backup(self): + """Test case for delete_schduled_backup + + """ + pass + + def test_delete_schedule(self): + """Test case for delete_schedule + + """ + pass + + def test_download_backup_file(self): + """Test case for download_backup_file + + """ + pass + + def test_export_backup(self): + """Test case for export_backup + + """ + pass + + def test_get_local_backup_info(self): + """Test case for get_local_backup_info + + """ + pass + + def test_get_schedule_record_for_backup(self): + """Test case for get_schedule_record_for_backup + + """ + pass + + def test_import_scheduled_backup(self): + """Test case for import_scheduled_backup + + """ + pass + + def test_list_backup(self): + """Test case for list_backup + + """ + pass + + def test_list_schedules(self): + """Test case for list_schedules + + """ + pass + + def test_remote_import_backup(self): + """Test case for remote_import_backup + + """ + pass + + def test_schedule_backup(self): + """Test case for schedule_backup + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_schema_definition.py b/test/test_schema_definition.py new file mode 100644 index 0000000..6436903 --- /dev/null +++ b/test/test_schema_definition.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.vertex_definition import VertexDefinition +globals()['VertexDefinition'] = VertexDefinition +from openapi_client.model.schema_definition import SchemaDefinition + + +class TestSchemaDefinition(unittest.TestCase): + """SchemaDefinition unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSchemaDefinition(self): + """Test SchemaDefinition""" + # FIXME: construct object with mandatory attributes with example values + # model = SchemaDefinition() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sdavc_cloud_connector_api.py b/test/test_sdavc_cloud_connector_api.py new file mode 100644 index 0000000..5233a57 --- /dev/null +++ b/test/test_sdavc_cloud_connector_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.sdavc_cloud_connector_api import SDAVCCloudConnectorApi # noqa: E501 + + +class TestSDAVCCloudConnectorApi(unittest.TestCase): + """SDAVCCloudConnectorApi unit test stubs""" + + def setUp(self): + self.api = SDAVCCloudConnectorApi() # noqa: E501 + + def tearDown(self): + pass + + def test_disable_cloud_connector(self): + """Test case for disable_cloud_connector + + """ + pass + + def test_enable_cloud_connector(self): + """Test case for enable_cloud_connector + + """ + pass + + def test_get_cloud_connector(self): + """Test case for get_cloud_connector + + """ + pass + + def test_get_cloud_connector_status(self): + """Test case for get_cloud_connector_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sdavc_domain_based_app_rules_api.py b/test/test_sdavc_domain_based_app_rules_api.py new file mode 100644 index 0000000..b2eee4c --- /dev/null +++ b/test/test_sdavc_domain_based_app_rules_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.sdavc_domain_based_app_rules_api import SDAVCDomainBasedAppRulesApi # noqa: E501 + + +class TestSDAVCDomainBasedAppRulesApi(unittest.TestCase): + """SDAVCDomainBasedAppRulesApi unit test stubs""" + + def setUp(self): + self.api = SDAVCDomainBasedAppRulesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_cloud_connector_domain_app_rules(self): + """Test case for get_cloud_connector_domain_app_rules + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sdavcip_address_based_app_rules_api.py b/test/test_sdavcip_address_based_app_rules_api.py new file mode 100644 index 0000000..33eb35c --- /dev/null +++ b/test/test_sdavcip_address_based_app_rules_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.sdavcip_address_based_app_rules_api import SDAVCIPAddressBasedAppRulesApi # noqa: E501 + + +class TestSDAVCIPAddressBasedAppRulesApi(unittest.TestCase): + """SDAVCIPAddressBasedAppRulesApi unit test stubs""" + + def setUp(self): + self.api = SDAVCIPAddressBasedAppRulesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_cloud_connector_ip_address_app_rules(self): + """Test case for get_cloud_connector_ip_address_app_rules + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_security_policy.py b/test/test_security_policy.py new file mode 100644 index 0000000..2f5987f --- /dev/null +++ b/test/test_security_policy.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.policy_rule import PolicyRule +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.security_policy_all_of import SecurityPolicyAllOf +from openapi_client.model.variable import Variable +globals()['PolicyRule'] = PolicyRule +globals()['ProfileParcel'] = ProfileParcel +globals()['SecurityPolicyAllOf'] = SecurityPolicyAllOf +globals()['Variable'] = Variable +from openapi_client.model.security_policy import SecurityPolicy + + +class TestSecurityPolicy(unittest.TestCase): + """SecurityPolicy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSecurityPolicy(self): + """Test SecurityPolicy""" + # FIXME: construct object with mandatory attributes with example values + # model = SecurityPolicy() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_security_policy_all_of.py b/test/test_security_policy_all_of.py new file mode 100644 index 0000000..19d3fcb --- /dev/null +++ b/test/test_security_policy_all_of.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.policy_rule import PolicyRule +globals()['PolicyRule'] = PolicyRule +from openapi_client.model.security_policy_all_of import SecurityPolicyAllOf + + +class TestSecurityPolicyAllOf(unittest.TestCase): + """SecurityPolicyAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSecurityPolicyAllOf(self): + """Test SecurityPolicyAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = SecurityPolicyAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sim_slot_config.py b/test/test_sim_slot_config.py new file mode 100644 index 0000000..f6c36ec --- /dev/null +++ b/test/test_sim_slot_config.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.cellular_profile import CellularProfile +globals()['CellularProfile'] = CellularProfile +from openapi_client.model.sim_slot_config import SimSlotConfig + + +class TestSimSlotConfig(unittest.TestCase): + """SimSlotConfig unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSimSlotConfig(self): + """Test SimSlotConfig""" + # FIXME: construct object with mandatory attributes with example values + # model = SimSlotConfig() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_site_health.py b/test/test_site_health.py new file mode 100644 index 0000000..2ce4a38 --- /dev/null +++ b/test/test_site_health.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.site_health import SiteHealth + + +class TestSiteHealth(unittest.TestCase): + """SiteHealth unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSiteHealth(self): + """Test SiteHealth""" + # FIXME: construct object with mandatory attributes with example values + # model = SiteHealth() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_site_to_site_vpn.py b/test/test_site_to_site_vpn.py new file mode 100644 index 0000000..62709ae --- /dev/null +++ b/test/test_site_to_site_vpn.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.site_to_site_vpn import SiteToSiteVpn + + +class TestSiteToSiteVpn(unittest.TestCase): + """SiteToSiteVpn unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSiteToSiteVpn(self): + """Test SiteToSiteVpn""" + # FIXME: construct object with mandatory attributes with example values + # model = SiteToSiteVpn() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_smart_account_model.py b/test/test_smart_account_model.py new file mode 100644 index 0000000..91dc378 --- /dev/null +++ b/test/test_smart_account_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.smart_account_model import SmartAccountModel + + +class TestSmartAccountModel(unittest.TestCase): + """SmartAccountModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSmartAccountModel(self): + """Test SmartAccountModel""" + # FIXME: construct object with mandatory attributes with example values + # model = SmartAccountModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_smart_license_api.py b/test/test_smart_license_api.py new file mode 100644 index 0000000..e683c5e --- /dev/null +++ b/test/test_smart_license_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.smart_license_api import SmartLicenseApi # noqa: E501 + + +class TestSmartLicenseApi(unittest.TestCase): + """SmartLicenseApi unit test stubs""" + + def setUp(self): + self.api = SmartLicenseApi() # noqa: E501 + + def tearDown(self): + pass + + def test_fetch_accounts(self): + """Test case for fetch_accounts + + """ + pass + + def test_fetch_reports(self): + """Test case for fetch_reports + + """ + pass + + def test_fetch_reports1(self): + """Test case for fetch_reports1 + + """ + pass + + def test_get_settings(self): + """Test case for get_settings + + """ + pass + + def test_sleauthenticate(self): + """Test case for sleauthenticate + + """ + pass + + def test_sync_licenses(self): + """Test case for sync_licenses + + """ + pass + + def test_sync_licenses1(self): + """Test case for sync_licenses1 + + """ + pass + + def test_upload_ack(self): + """Test case for upload_ack + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_software_upload_file_data.py b/test/test_software_upload_file_data.py new file mode 100644 index 0000000..7f95aab --- /dev/null +++ b/test/test_software_upload_file_data.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.get_o365_preferred_path_from_v_analytics_request_value import GetO365PreferredPathFromVAnalyticsRequestValue +globals()['GetO365PreferredPathFromVAnalyticsRequestValue'] = GetO365PreferredPathFromVAnalyticsRequestValue +from openapi_client.model.software_upload_file_data import SoftwareUploadFileData + + +class TestSoftwareUploadFileData(unittest.TestCase): + """SoftwareUploadFileData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSoftwareUploadFileData(self): + """Test SoftwareUploadFileData""" + # FIXME: construct object with mandatory attributes with example values + # model = SoftwareUploadFileData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ssid_config.py b/test/test_ssid_config.py new file mode 100644 index 0000000..1c01981 --- /dev/null +++ b/test/test_ssid_config.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ssid_config import SSIDConfig + + +class TestSSIDConfig(unittest.TestCase): + """SSIDConfig unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSSIDConfig(self): + """Test SSIDConfig""" + # FIXME: construct object with mandatory attributes with example values + # model = SSIDConfig() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_statistics_processing_counters.py b/test/test_statistics_processing_counters.py new file mode 100644 index 0000000..4e76cfe --- /dev/null +++ b/test/test_statistics_processing_counters.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.stats_type_processing_counters import StatsTypeProcessingCounters +globals()['StatsTypeProcessingCounters'] = StatsTypeProcessingCounters +from openapi_client.model.statistics_processing_counters import StatisticsProcessingCounters + + +class TestStatisticsProcessingCounters(unittest.TestCase): + """StatisticsProcessingCounters unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStatisticsProcessingCounters(self): + """Test StatisticsProcessingCounters""" + # FIXME: construct object with mandatory attributes with example values + # model = StatisticsProcessingCounters() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stats_type_processing_counters.py b/test/test_stats_type_processing_counters.py new file mode 100644 index 0000000..4f3449e --- /dev/null +++ b/test/test_stats_type_processing_counters.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.stats_type_processing_counters import StatsTypeProcessingCounters + + +class TestStatsTypeProcessingCounters(unittest.TestCase): + """StatsTypeProcessingCounters unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStatsTypeProcessingCounters(self): + """Test StatsTypeProcessingCounters""" + # FIXME: construct object with mandatory attributes with example values + # model = StatsTypeProcessingCounters() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_system_cloud_service_api.py b/test/test_system_cloud_service_api.py new file mode 100644 index 0000000..45f7fa2 --- /dev/null +++ b/test/test_system_cloud_service_api.py @@ -0,0 +1,149 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.system_cloud_service_api import SystemCloudServiceApi # noqa: E501 + + +class TestSystemCloudServiceApi(unittest.TestCase): + """SystemCloudServiceApi unit test stubs""" + + def setUp(self): + self.api = SystemCloudServiceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_cloud_credentials(self): + """Test case for add_cloud_credentials + + """ + pass + + def test_connect(self): + """Test case for connect + + """ + pass + + def test_delete_webex_data_centers(self): + """Test case for delete_webex_data_centers + + """ + pass + + def test_entity_ownership_info(self): + """Test case for entity_ownership_info + + """ + pass + + def test_get_access_tokenfor_device(self): + """Test case for get_access_tokenfor_device + + """ + pass + + def test_get_azure_token(self): + """Test case for get_azure_token + + """ + pass + + def test_get_cloud_credentials(self): + """Test case for get_cloud_credentials + + """ + pass + + def test_get_cloud_settings(self): + """Test case for get_cloud_settings + + """ + pass + + def test_get_device_code(self): + """Test case for get_device_code + + """ + pass + + def test_get_o365_preferred_path_from_v_analytics(self): + """Test case for get_o365_preferred_path_from_v_analytics + + """ + pass + + def test_get_otp(self): + """Test case for get_otp + + """ + pass + + def test_get_telemetry_state(self): + """Test case for get_telemetry_state + + """ + pass + + def test_getv_analytics(self): + """Test case for getv_analytics + + """ + pass + + def test_is_staging(self): + """Test case for is_staging + + """ + pass + + def test_list_entity_ownership_info(self): + """Test case for list_entity_ownership_info + + """ + pass + + def test_opt_in(self): + """Test case for opt_in + + """ + pass + + def test_opt_out(self): + """Test case for opt_out + + """ + pass + + def test_set_webex_data_centers_sync_status(self): + """Test case for set_webex_data_centers_sync_status + + """ + pass + + def test_update_webex_data_centers(self): + """Test case for update_webex_data_centers + + """ + pass + + def test_updatet_otp(self): + """Test case for updatet_otp + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_system_cloud_service_webex_api.py b/test/test_system_cloud_service_webex_api.py new file mode 100644 index 0000000..42ac325 --- /dev/null +++ b/test/test_system_cloud_service_webex_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.system_cloud_service_webex_api import SystemCloudServiceWebexApi # noqa: E501 + + +class TestSystemCloudServiceWebexApi(unittest.TestCase): + """SystemCloudServiceWebexApi unit test stubs""" + + def setUp(self): + self.api = SystemCloudServiceWebexApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_webex_data_centers(self): + """Test case for get_webex_data_centers + + """ + pass + + def test_get_webex_data_centers_sync_status(self): + """Test case for get_webex_data_centers_sync_status + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_system_container_api.py b/test/test_system_container_api.py new file mode 100644 index 0000000..2a03eed --- /dev/null +++ b/test/test_system_container_api.py @@ -0,0 +1,77 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.system_container_api import SystemContainerApi # noqa: E501 + + +class TestSystemContainerApi(unittest.TestCase): + """SystemContainerApi unit test stubs""" + + def setUp(self): + self.api = SystemContainerApi() # noqa: E501 + + def tearDown(self): + pass + + def test_activate_container(self): + """Test case for activate_container + + """ + pass + + def test_activate_container_on_remote_host(self): + """Test case for activate_container_on_remote_host + + """ + pass + + def test_de_activate_container(self): + """Test case for de_activate_container + + """ + pass + + def test_does_valid_image_exist(self): + """Test case for does_valid_image_exist + + """ + pass + + def test_get_container_inspect_data(self): + """Test case for get_container_inspect_data + + """ + pass + + def test_get_container_settings(self): + """Test case for get_container_settings + + """ + pass + + def test_get_custom_app(self): + """Test case for get_custom_app + + """ + pass + + def test_test_load_balancer(self): + """Test case for test_load_balancer + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_system_reverse_proxy_api.py b/test/test_system_reverse_proxy_api.py new file mode 100644 index 0000000..9aa71d8 --- /dev/null +++ b/test/test_system_reverse_proxy_api.py @@ -0,0 +1,41 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.system_reverse_proxy_api import SystemReverseProxyApi # noqa: E501 + + +class TestSystemReverseProxyApi(unittest.TestCase): + """SystemReverseProxyApi unit test stubs""" + + def setUp(self): + self.api = SystemReverseProxyApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_reverse_proxy_mappings(self): + """Test case for create_reverse_proxy_mappings + + """ + pass + + def test_get_reverse_proxy_mappings(self): + """Test case for get_reverse_proxy_mappings + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_systems.py b/test/test_systems.py new file mode 100644 index 0000000..4ee7c17 --- /dev/null +++ b/test/test_systems.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.systems import Systems + + +class TestSystems(unittest.TestCase): + """Systems unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSystems(self): + """Test Systems""" + # FIXME: construct object with mandatory attributes with example values + # model = Systems() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tag_api.py b/test/test_tag_api.py new file mode 100644 index 0000000..7692073 --- /dev/null +++ b/test/test_tag_api.py @@ -0,0 +1,89 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.tag_api import TagApi # noqa: E501 + + +class TestTagApi(unittest.TestCase): + """TagApi unit test stubs""" + + def setUp(self): + self.api = TagApi() # noqa: E501 + + def tearDown(self): + pass + + def test_check_for_conflicts_when_tagging(self): + """Test case for check_for_conflicts_when_tagging + + """ + pass + + def test_check_rules(self): + """Test case for check_rules + + """ + pass + + def test_create_tag(self): + """Test case for create_tag + + """ + pass + + def test_create_tag_rule(self): + """Test case for create_tag_rule + + """ + pass + + def test_delete_tag(self): + """Test case for delete_tag + + """ + pass + + def test_delete_tag_rule(self): + """Test case for delete_tag_rule + + """ + pass + + def test_edit_tag_rule(self): + """Test case for edit_tag_rule + + """ + pass + + def test_get_tag(self): + """Test case for get_tag + + """ + pass + + def test_get_tag_rules(self): + """Test case for get_tag_rules + + """ + pass + + def test_reindex_tag(self): + """Test case for reindex_tag + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tag_restful_resource.py b/test/test_tag_restful_resource.py new file mode 100644 index 0000000..62446c5 --- /dev/null +++ b/test/test_tag_restful_resource.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.software_upload_file_data import SoftwareUploadFileData +globals()['SoftwareUploadFileData'] = SoftwareUploadFileData +from openapi_client.model.tag_restful_resource import TagRestfulResource + + +class TestTagRestfulResource(unittest.TestCase): + """TagRestfulResource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTagRestfulResource(self): + """Test TagRestfulResource""" + # FIXME: construct object with mandatory attributes with example values + # model = TagRestfulResource() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tenant_backup_restore_api.py b/test/test_tenant_backup_restore_api.py new file mode 100644 index 0000000..46af803 --- /dev/null +++ b/test/test_tenant_backup_restore_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.tenant_backup_restore_api import TenantBackupRestoreApi # noqa: E501 + + +class TestTenantBackupRestoreApi(unittest.TestCase): + """TenantBackupRestoreApi unit test stubs""" + + def setUp(self): + self.api = TenantBackupRestoreApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_tenant_backup(self): + """Test case for delete_tenant_backup + + """ + pass + + def test_download_existing_backup_file(self): + """Test case for download_existing_backup_file + + """ + pass + + def test_export_tenant_backup(self): + """Test case for export_tenant_backup + + """ + pass + + def test_import_tenant_backup(self): + """Test case for import_tenant_backup + + """ + pass + + def test_list_tenant_backup(self): + """Test case for list_tenant_backup + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tenant_management_api.py b/test/test_tenant_management_api.py new file mode 100644 index 0000000..7dd75ad --- /dev/null +++ b/test/test_tenant_management_api.py @@ -0,0 +1,125 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.tenant_management_api import TenantManagementApi # noqa: E501 + + +class TestTenantManagementApi(unittest.TestCase): + """TenantManagementApi unit test stubs""" + + def setUp(self): + self.api = TenantManagementApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_tenant(self): + """Test case for create_tenant + + """ + pass + + def test_create_tenant_async(self): + """Test case for create_tenant_async + + """ + pass + + def test_create_tenant_async_bulk(self): + """Test case for create_tenant_async_bulk + + """ + pass + + def test_delete_tenant(self): + """Test case for delete_tenant + + """ + pass + + def test_delete_tenant_async_bulk(self): + """Test case for delete_tenant_async_bulk + + """ + pass + + def test_force_status_collection(self): + """Test case for force_status_collection + + """ + pass + + def test_get_all_tenant_statuses(self): + """Test case for get_all_tenant_statuses + + """ + pass + + def test_get_all_tenants(self): + """Test case for get_all_tenants + + """ + pass + + def test_get_tenant(self): + """Test case for get_tenant + + """ + pass + + def test_get_tenant_hosting_capacity_onv_smarts(self): + """Test case for get_tenant_hosting_capacity_onv_smarts + + """ + pass + + def test_get_tenantv_smart_mapping(self): + """Test case for get_tenantv_smart_mapping + + """ + pass + + def test_switch_tenant(self): + """Test case for switch_tenant + + """ + pass + + def test_tenantv_smart_mt_migrate(self): + """Test case for tenantv_smart_mt_migrate + + """ + pass + + def test_update_tenant(self): + """Test case for update_tenant + + """ + pass + + def test_update_tenantv_smart_placement(self): + """Test case for update_tenantv_smart_placement + + """ + pass + + def test_v_session_id(self): + """Test case for v_session_id + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tenant_migration_api.py b/test/test_tenant_migration_api.py new file mode 100644 index 0000000..e6d119e --- /dev/null +++ b/test/test_tenant_migration_api.py @@ -0,0 +1,65 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.tenant_migration_api import TenantMigrationApi # noqa: E501 + + +class TestTenantMigrationApi(unittest.TestCase): + """TenantMigrationApi unit test stubs""" + + def setUp(self): + self.api = TenantMigrationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_download_tenant_data(self): + """Test case for download_tenant_data + + """ + pass + + def test_export_tenant_data(self): + """Test case for export_tenant_data + + """ + pass + + def test_get_migration_token(self): + """Test case for get_migration_token + + """ + pass + + def test_import_tenant_data(self): + """Test case for import_tenant_data + + """ + pass + + def test_migrate_network(self): + """Test case for migrate_network + + """ + pass + + def test_re_trigger_network_migration(self): + """Test case for re_trigger_network_migration + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tenant_status.py b/test/test_tenant_status.py new file mode 100644 index 0000000..397d14f --- /dev/null +++ b/test/test_tenant_status.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.control_status import ControlStatus +from openapi_client.model.site_health import SiteHealth +from openapi_client.model.v_edge_health import VEdgeHealth +from openapi_client.model.v_smart_status import VSmartStatus +globals()['ControlStatus'] = ControlStatus +globals()['SiteHealth'] = SiteHealth +globals()['VEdgeHealth'] = VEdgeHealth +globals()['VSmartStatus'] = VSmartStatus +from openapi_client.model.tenant_status import TenantStatus + + +class TestTenantStatus(unittest.TestCase): + """TenantStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTenantStatus(self): + """Test TenantStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = TenantStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tenant_status_list_model.py b/test/test_tenant_status_list_model.py new file mode 100644 index 0000000..a1f0ff6 --- /dev/null +++ b/test/test_tenant_status_list_model.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.header import Header +from openapi_client.model.tenant_status import TenantStatus +globals()['Header'] = Header +globals()['TenantStatus'] = TenantStatus +from openapi_client.model.tenant_status_list_model import TenantStatusListModel + + +class TestTenantStatusListModel(unittest.TestCase): + """TenantStatusListModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTenantStatusListModel(self): + """Test TenantStatusListModel""" + # FIXME: construct object with mandatory attributes with example values + # model = TenantStatusListModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_thread_pool_definition.py b/test/test_thread_pool_definition.py new file mode 100644 index 0000000..d006426 --- /dev/null +++ b/test/test_thread_pool_definition.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.thread_pool_definition import ThreadPoolDefinition + + +class TestThreadPoolDefinition(unittest.TestCase): + """ThreadPoolDefinition unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testThreadPoolDefinition(self): + """Test ThreadPoolDefinition""" + # FIXME: construct object with mandatory attributes with example values + # model = ThreadPoolDefinition() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_thread_pools_definition.py b/test/test_thread_pools_definition.py new file mode 100644 index 0000000..a2ab4cb --- /dev/null +++ b/test/test_thread_pools_definition.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.thread_pool_definition import ThreadPoolDefinition +globals()['ThreadPoolDefinition'] = ThreadPoolDefinition +from openapi_client.model.thread_pools_definition import ThreadPoolsDefinition + + +class TestThreadPoolsDefinition(unittest.TestCase): + """ThreadPoolsDefinition unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testThreadPoolsDefinition(self): + """Test ThreadPoolsDefinition""" + # FIXME: construct object with mandatory attributes with example values + # model = ThreadPoolsDefinition() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tools_tac_cases_api.py b/test/test_tools_tac_cases_api.py new file mode 100644 index 0000000..964d2af --- /dev/null +++ b/test/test_tools_tac_cases_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.tools_tac_cases_api import ToolsTACCasesApi # noqa: E501 + + +class TestToolsTACCasesApi(unittest.TestCase): + """ToolsTACCasesApi unit test stubs""" + + def setUp(self): + self.api = ToolsTACCasesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_call(self): + """Test case for delete_call + + """ + pass + + def test_get_call(self): + """Test case for get_call + + """ + pass + + def test_get_client_id(self): + """Test case for get_client_id + + """ + pass + + def test_oauth_access(self): + """Test case for oauth_access + + """ + pass + + def test_post_call(self): + """Test case for post_call + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_troubleshooting_tools_device_connectivity_api.py b/test/test_troubleshooting_tools_device_connectivity_api.py new file mode 100644 index 0000000..13b06d4 --- /dev/null +++ b/test/test_troubleshooting_tools_device_connectivity_api.py @@ -0,0 +1,149 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.troubleshooting_tools_device_connectivity_api import TroubleshootingToolsDeviceConnectivityApi # noqa: E501 + + +class TestTroubleshootingToolsDeviceConnectivityApi(unittest.TestCase): + """TroubleshootingToolsDeviceConnectivityApi unit test stubs""" + + def setUp(self): + self.api = TroubleshootingToolsDeviceConnectivityApi() # noqa: E501 + + def tearDown(self): + pass + + def test_copy_admin_tech_on_device(self): + """Test case for copy_admin_tech_on_device + + """ + pass + + def test_create_admin_tech(self): + """Test case for create_admin_tech + + """ + pass + + def test_delete_admin_tech_file(self): + """Test case for delete_admin_tech_file + + """ + pass + + def test_delete_admin_tech_on_device(self): + """Test case for delete_admin_tech_on_device + + """ + pass + + def test_download_admin_tech_file(self): + """Test case for download_admin_tech_file + + """ + pass + + def test_factory_reset(self): + """Test case for factory_reset + + """ + pass + + def test_get_control_connections(self): + """Test case for get_control_connections + + """ + pass + + def test_get_device_configuration(self): + """Test case for get_device_configuration + + """ + pass + + def test_get_in_progress_count(self): + """Test case for get_in_progress_count + + """ + pass + + def test_list_admin_techs(self): + """Test case for list_admin_techs + + """ + pass + + def test_list_admin_techs_on_device(self): + """Test case for list_admin_techs_on_device + + """ + pass + + def test_nping_device(self): + """Test case for nping_device + + """ + pass + + def test_ping_device(self): + """Test case for ping_device + + """ + pass + + def test_process_interface_reset(self): + """Test case for process_interface_reset + + """ + pass + + def test_process_port_hop_color(self): + """Test case for process_port_hop_color + + """ + pass + + def test_process_reset_user(self): + """Test case for process_reset_user + + """ + pass + + def test_service_path(self): + """Test case for service_path + + """ + pass + + def test_traceroute_device(self): + """Test case for traceroute_device + + """ + pass + + def test_tunnel_path(self): + """Test case for tunnel_path + + """ + pass + + def test_upload_admin_tech(self): + """Test case for upload_admin_tech + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_troubleshooting_tools_device_group_api.py b/test/test_troubleshooting_tools_device_group_api.py new file mode 100644 index 0000000..d4be5e1 --- /dev/null +++ b/test/test_troubleshooting_tools_device_group_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.troubleshooting_tools_device_group_api import TroubleshootingToolsDeviceGroupApi # noqa: E501 + + +class TestTroubleshootingToolsDeviceGroupApi(unittest.TestCase): + """TroubleshootingToolsDeviceGroupApi unit test stubs""" + + def setUp(self): + self.api = TroubleshootingToolsDeviceGroupApi() # noqa: E501 + + def tearDown(self): + pass + + def test_list_device_group_list(self): + """Test case for list_device_group_list + + """ + pass + + def test_list_device_groups(self): + """Test case for list_device_groups + + """ + pass + + def test_list_group_devices(self): + """Test case for list_group_devices + + """ + pass + + def test_list_group_devices_for_map(self): + """Test case for list_group_devices_for_map + + """ + pass + + def test_list_group_links_for_map(self): + """Test case for list_group_links_for_map + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_troubleshooting_tools_diagnostics_api.py b/test/test_troubleshooting_tools_diagnostics_api.py new file mode 100644 index 0000000..b28addd --- /dev/null +++ b/test/test_troubleshooting_tools_diagnostics_api.py @@ -0,0 +1,557 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.troubleshooting_tools_diagnostics_api import TroubleshootingToolsDiagnosticsApi # noqa: E501 + + +class TestTroubleshootingToolsDiagnosticsApi(unittest.TestCase): + """TroubleshootingToolsDiagnosticsApi unit test stubs""" + + def setUp(self): + self.api = TroubleshootingToolsDiagnosticsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_clear_session(self): + """Test case for clear_session + + """ + pass + + def test_disable_device_log(self): + """Test case for disable_device_log + + """ + pass + + def test_disable_packet_capture_session(self): + """Test case for disable_packet_capture_session + + """ + pass + + def test_disable_speed_test_session(self): + """Test case for disable_speed_test_session + + """ + pass + + def test_download_debug_log(self): + """Test case for download_debug_log + + """ + pass + + def test_download_file(self): + """Test case for download_file + + """ + pass + + def test_force_stop_pcap_session(self): + """Test case for force_stop_pcap_session + + """ + pass + + def test_form_post_packet_capture(self): + """Test case for form_post_packet_capture + + """ + pass + + def test_get_agg_flow(self): + """Test case for get_agg_flow + + """ + pass + + def test_get_aggregation_data_by_query27(self): + """Test case for get_aggregation_data_by_query27 + + """ + pass + + def test_get_aggregation_data_by_query28(self): + """Test case for get_aggregation_data_by_query28 + + """ + pass + + def test_get_app_qos_data(self): + """Test case for get_app_qos_data + + """ + pass + + def test_get_app_qos_state(self): + """Test case for get_app_qos_state + + """ + pass + + def test_get_concurrent_data(self): + """Test case for get_concurrent_data + + """ + pass + + def test_get_concurrent_domain_data(self): + """Test case for get_concurrent_domain_data + + """ + pass + + def test_get_count29(self): + """Test case for get_count29 + + """ + pass + + def test_get_count30(self): + """Test case for get_count30 + + """ + pass + + def test_get_count_post29(self): + """Test case for get_count_post29 + + """ + pass + + def test_get_count_post30(self): + """Test case for get_count_post30 + + """ + pass + + def test_get_current_timestamp(self): + """Test case for get_current_timestamp + + """ + pass + + def test_get_db_schema(self): + """Test case for get_db_schema + + """ + pass + + def test_get_device_log(self): + """Test case for get_device_log + + """ + pass + + def test_get_domain_metric(self): + """Test case for get_domain_metric + + """ + pass + + def test_get_event_app_hop_list(self): + """Test case for get_event_app_hop_list + + """ + pass + + def test_get_event_app_score_bandwidth(self): + """Test case for get_event_app_score_bandwidth + + """ + pass + + def test_get_event_flow_from_app_hop(self): + """Test case for get_event_flow_from_app_hop + + """ + pass + + def test_get_event_readout(self): + """Test case for get_event_readout + + """ + pass + + def test_get_file_download_status(self): + """Test case for get_file_download_status + + """ + pass + + def test_get_fin_flow_time_range(self): + """Test case for get_fin_flow_time_range + + """ + pass + + def test_get_finalized_data(self): + """Test case for get_finalized_data + + """ + pass + + def test_get_finalized_domain_data(self): + """Test case for get_finalized_domain_data + + """ + pass + + def test_get_finalized_flow_count(self): + """Test case for get_finalized_flow_count + + """ + pass + + def test_get_flow_detail(self): + """Test case for get_flow_detail + + """ + pass + + def test_get_flow_metric(self): + """Test case for get_flow_metric + + """ + pass + + def test_get_interface_bandwidth(self): + """Test case for get_interface_bandwidth + + """ + pass + + def test_get_log_type(self): + """Test case for get_log_type + + """ + pass + + def test_get_monitor_state(self): + """Test case for get_monitor_state + + """ + pass + + def test_get_nwpi_dscp(self): + """Test case for get_nwpi_dscp + + """ + pass + + def test_get_nwpi_nbar_app_group(self): + """Test case for get_nwpi_nbar_app_group + + """ + pass + + def test_get_nwpi_protocol(self): + """Test case for get_nwpi_protocol + + """ + pass + + def test_get_packet_features(self): + """Test case for get_packet_features + + """ + pass + + def test_get_post_aggregation_app_data_by_query26(self): + """Test case for get_post_aggregation_app_data_by_query26 + + """ + pass + + def test_get_post_aggregation_app_data_by_query27(self): + """Test case for get_post_aggregation_app_data_by_query27 + + """ + pass + + def test_get_post_aggregation_data_by_query27(self): + """Test case for get_post_aggregation_data_by_query27 + + """ + pass + + def test_get_post_aggregation_data_by_query28(self): + """Test case for get_post_aggregation_data_by_query28 + + """ + pass + + def test_get_post_stat_bulk_raw_data27(self): + """Test case for get_post_stat_bulk_raw_data27 + + """ + pass + + def test_get_post_stat_bulk_raw_data28(self): + """Test case for get_post_stat_bulk_raw_data28 + + """ + pass + + def test_get_preload_info(self): + """Test case for get_preload_info + + """ + pass + + def test_get_routing_detail_from_local(self): + """Test case for get_routing_detail_from_local + + """ + pass + + def test_get_session(self): + """Test case for get_session + + """ + pass + + def test_get_session_info_capture(self): + """Test case for get_session_info_capture + + """ + pass + + def test_get_session_info_log(self): + """Test case for get_session_info_log + + """ + pass + + def test_get_sessions(self): + """Test case for get_sessions + + """ + pass + + def test_get_speed_test(self): + """Test case for get_speed_test + + """ + pass + + def test_get_speed_test_status(self): + """Test case for get_speed_test_status + + """ + pass + + def test_get_stat_bulk_raw_data27(self): + """Test case for get_stat_bulk_raw_data27 + + """ + pass + + def test_get_stat_bulk_raw_data28(self): + """Test case for get_stat_bulk_raw_data28 + + """ + pass + + def test_get_stat_data_fields29(self): + """Test case for get_stat_data_fields29 + + """ + pass + + def test_get_stat_data_fields30(self): + """Test case for get_stat_data_fields30 + + """ + pass + + def test_get_stat_data_raw_data26(self): + """Test case for get_stat_data_raw_data26 + + """ + pass + + def test_get_stat_data_raw_data27(self): + """Test case for get_stat_data_raw_data27 + + """ + pass + + def test_get_stat_data_raw_data_as_csv27(self): + """Test case for get_stat_data_raw_data_as_csv27 + + """ + pass + + def test_get_stat_data_raw_data_as_csv28(self): + """Test case for get_stat_data_raw_data_as_csv28 + + """ + pass + + def test_get_stat_query_fields29(self): + """Test case for get_stat_query_fields29 + + """ + pass + + def test_get_stat_query_fields30(self): + """Test case for get_stat_query_fields30 + + """ + pass + + def test_get_stats_raw_data27(self): + """Test case for get_stats_raw_data27 + + """ + pass + + def test_get_stats_raw_data28(self): + """Test case for get_stats_raw_data28 + + """ + pass + + def test_get_thread_pools(self): + """Test case for get_thread_pools + + """ + pass + + def test_get_trace_flow(self): + """Test case for get_trace_flow + + """ + pass + + def test_get_trace_history(self): + """Test case for get_trace_history + + """ + pass + + def test_get_vnic_info_by_vnf_id(self): + """Test case for get_vnic_info_by_vnf_id + + """ + pass + + def test_monitor_override_start(self): + """Test case for monitor_override_start + + """ + pass + + def test_monitor_start(self): + """Test case for monitor_start + + """ + pass + + def test_monitor_stop(self): + """Test case for monitor_stop + + """ + pass + + def test_nwpi_post_flow_data(self): + """Test case for nwpi_post_flow_data + + """ + pass + + def test_process_device_status(self): + """Test case for process_device_status + + """ + pass + + def test_renew_session_info(self): + """Test case for renew_session_info + + """ + pass + + def test_save_speed_test_results(self): + """Test case for save_speed_test_results + + """ + pass + + def test_search_device_log(self): + """Test case for search_device_log + + """ + pass + + def test_start_pcap_session(self): + """Test case for start_pcap_session + + """ + pass + + def test_start_speed_test(self): + """Test case for start_speed_test + + """ + pass + + def test_stop_pcap_session(self): + """Test case for stop_pcap_session + + """ + pass + + def test_stop_speed_test(self): + """Test case for stop_speed_test + + """ + pass + + def test_stream_log(self): + """Test case for stream_log + + """ + pass + + def test_trace_delete(self): + """Test case for trace_delete + + """ + pass + + def test_trace_fin_flow_with_query(self): + """Test case for trace_fin_flow_with_query + + """ + pass + + def test_trace_start(self): + """Test case for trace_start + + """ + pass + + def test_trace_stop(self): + """Test case for trace_stop + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_umbrella_api.py b/test/test_umbrella_api.py new file mode 100644 index 0000000..ae780a4 --- /dev/null +++ b/test/test_umbrella_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.umbrella_api import UmbrellaApi # noqa: E501 + + +class TestUmbrellaApi(unittest.TestCase): + """UmbrellaApi unit test stubs""" + + def setUp(self): + self.api = UmbrellaApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_all_keys_from_umbrella(self): + """Test case for get_all_keys_from_umbrella + + """ + pass + + def test_get_management_keys_from_umbrella(self): + """Test case for get_management_keys_from_umbrella + + """ + pass + + def test_get_network_keys_from_umbrella(self): + """Test case for get_network_keys_from_umbrella + + """ + pass + + def test_get_reporting_keys_from_umbrella(self): + """Test case for get_reporting_keys_from_umbrella + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_tenant_model.py b/test/test_update_tenant_model.py new file mode 100644 index 0000000..37999ac --- /dev/null +++ b/test/test_update_tenant_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.update_tenant_model import UpdateTenantModel + + +class TestUpdateTenantModel(unittest.TestCase): + """UpdateTenantModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateTenantModel(self): + """Test UpdateTenantModel""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateTenantModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_tenantv_smart_model.py b/test/test_update_tenantv_smart_model.py new file mode 100644 index 0000000..4e1e9df --- /dev/null +++ b/test/test_update_tenantv_smart_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.update_tenantv_smart_model import UpdateTenantvSmartModel + + +class TestUpdateTenantvSmartModel(unittest.TestCase): + """UpdateTenantvSmartModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateTenantvSmartModel(self): + """Test UpdateTenantvSmartModel""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateTenantvSmartModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_utility_configuration_db_api.py b/test/test_utility_configuration_db_api.py new file mode 100644 index 0000000..de6a9b4 --- /dev/null +++ b/test/test_utility_configuration_db_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.utility_configuration_db_api import UtilityConfigurationDBApi # noqa: E501 + + +class TestUtilityConfigurationDBApi(unittest.TestCase): + """UtilityConfigurationDBApi unit test stubs""" + + def setUp(self): + self.api = UtilityConfigurationDBApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_db_size_on_file(self): + """Test case for get_db_size_on_file + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_utility_logging_api.py b/test/test_utility_logging_api.py new file mode 100644 index 0000000..eee5f5a --- /dev/null +++ b/test/test_utility_logging_api.py @@ -0,0 +1,59 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.utility_logging_api import UtilityLoggingApi # noqa: E501 + + +class TestUtilityLoggingApi(unittest.TestCase): + """UtilityLoggingApi unit test stubs""" + + def setUp(self): + self.api = UtilityLoggingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_debug_log(self): + """Test case for debug_log + + """ + pass + + def test_list_log_file_details(self): + """Test case for list_log_file_details + + """ + pass + + def test_list_loggers(self): + """Test case for list_loggers + + """ + pass + + def test_list_v_manage_server_log_last_n_lines(self): + """Test case for list_v_manage_server_log_last_n_lines + + """ + pass + + def test_set_log_level(self): + """Test case for set_log_level + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_utility_security_api.py b/test/test_utility_security_api.py new file mode 100644 index 0000000..84e26a5 --- /dev/null +++ b/test/test_utility_security_api.py @@ -0,0 +1,35 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.utility_security_api import UtilitySecurityApi # noqa: E501 + + +class TestUtilitySecurityApi(unittest.TestCase): + """UtilitySecurityApi unit test stubs""" + + def setUp(self): + self.api = UtilitySecurityApi() # noqa: E501 + + def tearDown(self): + pass + + def test_check_given_ip_list(self): + """Test case for check_given_ip_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_uuid.py b/test/test_uuid.py new file mode 100644 index 0000000..a1bc003 --- /dev/null +++ b/test/test_uuid.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.uuid import Uuid + + +class TestUuid(unittest.TestCase): + """Uuid unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUuid(self): + """Test Uuid""" + # FIXME: construct object with mandatory attributes with example values + # model = Uuid() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_uuid_to_domain_id.py b/test/test_uuid_to_domain_id.py new file mode 100644 index 0000000..653cc97 --- /dev/null +++ b/test/test_uuid_to_domain_id.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.uuid_to_domain_id_mapping import UuidToDomainIdMapping +globals()['UuidToDomainIdMapping'] = UuidToDomainIdMapping +from openapi_client.model.uuid_to_domain_id import UuidToDomainId + + +class TestUuidToDomainId(unittest.TestCase): + """UuidToDomainId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUuidToDomainId(self): + """Test UuidToDomainId""" + # FIXME: construct object with mandatory attributes with example values + # model = UuidToDomainId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_uuid_to_domain_id_mapping.py b/test/test_uuid_to_domain_id_mapping.py new file mode 100644 index 0000000..85fb9ce --- /dev/null +++ b/test/test_uuid_to_domain_id_mapping.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.uuid_to_domain_id_mapping import UuidToDomainIdMapping + + +class TestUuidToDomainIdMapping(unittest.TestCase): + """UuidToDomainIdMapping unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUuidToDomainIdMapping(self): + """Test UuidToDomainIdMapping""" + # FIXME: construct object with mandatory attributes with example values + # model = UuidToDomainIdMapping() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_v_edge_bootstrap_config.py b/test/test_v_edge_bootstrap_config.py new file mode 100644 index 0000000..90e57c0 --- /dev/null +++ b/test/test_v_edge_bootstrap_config.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.v_edge_bootstrap_config import VEdgeBootstrapConfig + + +class TestVEdgeBootstrapConfig(unittest.TestCase): + """VEdgeBootstrapConfig unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVEdgeBootstrapConfig(self): + """Test VEdgeBootstrapConfig""" + # FIXME: construct object with mandatory attributes with example values + # model = VEdgeBootstrapConfig() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_v_edge_health.py b/test/test_v_edge_health.py new file mode 100644 index 0000000..95b7fab --- /dev/null +++ b/test/test_v_edge_health.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.v_edge_health import VEdgeHealth + + +class TestVEdgeHealth(unittest.TestCase): + """VEdgeHealth unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVEdgeHealth(self): + """Test VEdgeHealth""" + # FIXME: construct object with mandatory attributes with example values + # model = VEdgeHealth() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_v_resource_group_name_model.py b/test/test_v_resource_group_name_model.py new file mode 100644 index 0000000..479300d --- /dev/null +++ b/test/test_v_resource_group_name_model.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.v_resource_group_name_model import VResourceGroupNameModel + + +class TestVResourceGroupNameModel(unittest.TestCase): + """VResourceGroupNameModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVResourceGroupNameModel(self): + """Test VResourceGroupNameModel""" + # FIXME: construct object with mandatory attributes with example values + # model = VResourceGroupNameModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_v_smart_status.py b/test/test_v_smart_status.py new file mode 100644 index 0000000..fabf506 --- /dev/null +++ b/test/test_v_smart_status.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.v_smart_status import VSmartStatus + + +class TestVSmartStatus(unittest.TestCase): + """VSmartStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVSmartStatus(self): + """Test VSmartStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = VSmartStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_variable.py b/test/test_variable.py new file mode 100644 index 0000000..00552a4 --- /dev/null +++ b/test/test_variable.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.variable import Variable + + +class TestVariable(unittest.TestCase): + """Variable unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVariable(self): + """Test Variable""" + # FIXME: construct object with mandatory attributes with example values + # model = Variable() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_vertex_definition.py b/test/test_vertex_definition.py new file mode 100644 index 0000000..b6d6538 --- /dev/null +++ b/test/test_vertex_definition.py @@ -0,0 +1,38 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.property_definition import PropertyDefinition +globals()['PropertyDefinition'] = PropertyDefinition +from openapi_client.model.vertex_definition import VertexDefinition + + +class TestVertexDefinition(unittest.TestCase): + """VertexDefinition unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVertexDefinition(self): + """Test VertexDefinition""" + # FIXME: construct object with mandatory attributes with example values + # model = VertexDefinition() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_vpn.py b/test/test_vpn.py new file mode 100644 index 0000000..adca7dc --- /dev/null +++ b/test/test_vpn.py @@ -0,0 +1,46 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ip_sec_policy import IpSecPolicy +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.site_to_site_vpn import SiteToSiteVpn +from openapi_client.model.variable import Variable +from openapi_client.model.vpn_all_of import VpnAllOf +globals()['IpSecPolicy'] = IpSecPolicy +globals()['ProfileParcel'] = ProfileParcel +globals()['SiteToSiteVpn'] = SiteToSiteVpn +globals()['Variable'] = Variable +globals()['VpnAllOf'] = VpnAllOf +from openapi_client.model.vpn import Vpn + + +class TestVpn(unittest.TestCase): + """Vpn unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVpn(self): + """Test Vpn""" + # FIXME: construct object with mandatory attributes with example values + # model = Vpn() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_vpn_all_of.py b/test/test_vpn_all_of.py new file mode 100644 index 0000000..476c137 --- /dev/null +++ b/test/test_vpn_all_of.py @@ -0,0 +1,40 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.ip_sec_policy import IpSecPolicy +from openapi_client.model.site_to_site_vpn import SiteToSiteVpn +globals()['IpSecPolicy'] = IpSecPolicy +globals()['SiteToSiteVpn'] = SiteToSiteVpn +from openapi_client.model.vpn_all_of import VpnAllOf + + +class TestVpnAllOf(unittest.TestCase): + """VpnAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVpnAllOf(self): + """Test VpnAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = VpnAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_vpnid.py b/test/test_vpnid.py new file mode 100644 index 0000000..1b8c9a4 --- /dev/null +++ b/test/test_vpnid.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.vpnid import VPNID + + +class TestVPNID(unittest.TestCase): + """VPNID unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVPNID(self): + """Test VPNID""" + # FIXME: construct object with mandatory attributes with example values + # model = VPNID() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_wan_spec.py b/test/test_wan_spec.py new file mode 100644 index 0000000..dcefaca --- /dev/null +++ b/test/test_wan_spec.py @@ -0,0 +1,36 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.wan_spec import WanSpec + + +class TestWanSpec(unittest.TestCase): + """WanSpec unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWanSpec(self): + """Test WanSpec""" + # FIXME: construct object with mandatory attributes with example values + # model = WanSpec() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_wifi.py b/test/test_wifi.py new file mode 100644 index 0000000..c3ea301 --- /dev/null +++ b/test/test_wifi.py @@ -0,0 +1,50 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.advanced_radio_setting import AdvancedRadioSetting +from openapi_client.model.corporate_wifi import CorporateWifi +from openapi_client.model.guest_wifi import GuestWifi +from openapi_client.model.profile_parcel import ProfileParcel +from openapi_client.model.ssid_config import SSIDConfig +from openapi_client.model.variable import Variable +from openapi_client.model.wifi_all_of import WifiAllOf +globals()['AdvancedRadioSetting'] = AdvancedRadioSetting +globals()['CorporateWifi'] = CorporateWifi +globals()['GuestWifi'] = GuestWifi +globals()['ProfileParcel'] = ProfileParcel +globals()['SSIDConfig'] = SSIDConfig +globals()['Variable'] = Variable +globals()['WifiAllOf'] = WifiAllOf +from openapi_client.model.wifi import Wifi + + +class TestWifi(unittest.TestCase): + """Wifi unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWifi(self): + """Test Wifi""" + # FIXME: construct object with mandatory attributes with example values + # model = Wifi() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_wifi_all_of.py b/test/test_wifi_all_of.py new file mode 100644 index 0000000..e9e818a --- /dev/null +++ b/test/test_wifi_all_of.py @@ -0,0 +1,44 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import openapi_client +from openapi_client.model.advanced_radio_setting import AdvancedRadioSetting +from openapi_client.model.corporate_wifi import CorporateWifi +from openapi_client.model.guest_wifi import GuestWifi +from openapi_client.model.ssid_config import SSIDConfig +globals()['AdvancedRadioSetting'] = AdvancedRadioSetting +globals()['CorporateWifi'] = CorporateWifi +globals()['GuestWifi'] = GuestWifi +globals()['SSIDConfig'] = SSIDConfig +from openapi_client.model.wifi_all_of import WifiAllOf + + +class TestWifiAllOf(unittest.TestCase): + """WifiAllOf unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWifiAllOf(self): + """Test WifiAllOf""" + # FIXME: construct object with mandatory attributes with example values + # model = WifiAllOf() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_workflow_management_api.py b/test/test_workflow_management_api.py new file mode 100644 index 0000000..32b37f7 --- /dev/null +++ b/test/test_workflow_management_api.py @@ -0,0 +1,53 @@ +""" + Cisco SD-WAN vManage API + + The vManage API exposes the functionality of operations maintaining devices and the overlay network # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Contact: vmanage@cisco.com + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import openapi_client +from openapi_client.api.workflow_management_api import WorkflowManagementApi # noqa: E501 + + +class TestWorkflowManagementApi(unittest.TestCase): + """WorkflowManagementApi unit test stubs""" + + def setUp(self): + self.api = WorkflowManagementApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_workflow(self): + """Test case for create_workflow + + """ + pass + + def test_delete_workflow(self): + """Test case for delete_workflow + + """ + pass + + def test_get_workflows(self): + """Test case for get_workflows + + """ + pass + + def test_save_workflow(self): + """Test case for save_workflow + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..1a9028b --- /dev/null +++ b/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + pytest --cov=openapi_client